Getting Started
Introduction
- Pirsonal helps you create videos automatically from a structure or “template”. The process is as follows:
- Create an account with Pirsonal.
- 1. Choose from different accounts (Plus, Professional, Premier, Enterprise)
- Create the template.
- descriptive inputs.
- Video Definition Script.
- Define and add Inputs:
- Template Medias.
- Dynamic Medias.
- Save.
- Test the template.
- Create a template's client.
- Connect client with the Pirsonal API.
- Assign Dynamic Medias.
- Create code for a new video from client.
Video Template: Creating automatically videos
- A template is a fixed structure that allows us to represent different elements (videos, audios, texts, or rectangles), their behavior, transformations, and their interactions with each other. This allows us to create any video using one such structure. Other videos may be created with the same structure using different media. To create new videos, it is necessary to create a template first.
How create a Template
- Go to template page and select "blank template".
- The "create Template"" page has different sections that is necessary to fill:
- Template Information: General Information about the template.
- Name: Template Name
- Description: General Description
- Webhook: URL to where we send an HTTP POST request every time a video is generated. Learn more...
- Videos Output: Information about the video that will be generated, its destination and encoding information.
- Storage: Where the generated video is stored.
- Pirsonal: • Inside the Pirsonal platform in media storage. Using this method, the only way to download the generated video is from your Pirsonal account.
- Amazon S3: Destination Bucket in Amazon S3. It is necessary to give permission to Pirsonal to store the video in your Amazon account. Learn more...
- Youtube: Send the final videos to a linked YouTube account. It’s necessary to link the YouTube account first with Pirsonal in the account page. The options in a linked YouTube account are:
- Account: The YouTube account to where the videos will be sent.
- Privacy: Privacy of the video on YouTube. learn more...
- License: Types licenses accepted by YouTube.
- Category: Definition of the category of video on YouTube.
- Tags: Different words split by a comma that help to classify the video on YouTube.
- Title and Description: the title and description of YouTube will be the same as the title and description in Pirsonal for each video generated.
- Output Profiles: Profiles that encode the final video. Defining the format, codec, resolution, and frame per second. It is possible select multiple profiles and the final video will be generated for each of them. (For YouTube, the output recommended is 'high quality’ because YouTube automatically generates the lowest resolution.)
- SCRIPT: A script consists of a JSON text defining an array of objects. These objects are the different elements that we want to define in the final video. Every object can have properties and different events that define the composition of the final video in the timeline. You can see the syntax and more examples how to create a script in our Script Documentation.
- Example: We going to generate a template with a background image and a text that appear twice during 1 second over the image.
-
[ {"image" : { "id" : "image1", "duration": 3000, "play": 0 }}, {"text" : { "id" : "text1", "duration": 1000, "play": ["image1.start", 2000], "textLines": 3 }} ] - When the script is defined it is necessary to check and validate the script by clicking ‘check’. If the code is OK, it will appear in the next message.
- A new list of elements will appear at the bottom of the page that will be the content of the final video. In our example, there should appear 2 elements: an image and a text.
- Input Medias: This section defines the contents in the final video. The elements that appear here are images, videos, audios or texts defined previously in the script. This section only appears when the script is validated and can be as follows:
- Template Media: The media can be uploaded from the computer, amazon, URL or Pirsonal -if the media was previously uploaded. This kind of Input media ALWAYS appears in all the videos generated, this is part of the structure, and is what will be used in all videos.
- Dynamic Media: This is media that can be variable for every generated video. It can be changed every time a video is made. Using a combination of static and dynamic media allows every video to be unique but still have a corporate image or the same structure.
- Example: CContinuing with the previous example we are going to define the two inputs media:
- the element "image1" is static media (all video generated with the template will have this image).
- the element "text1" is dynamic media. This element could be different in every new video generated by the client.
- Save the template: When you click here the template will be uploaded to Pirsonal and all the static media that you select from your computer
- Testing the template: Once the template is created, a summary of all the options appears and a button to create your own videos from the admin website. This template test acts like a client of the template.
- The first thing is go to the template test page. On this page we have different inputs to fill:
- Video Information: this input is optional but could help identify the final video. Each video generated with a template could have a different name or description.
- Name: the name of the final video element.
- Description: the description of the final video element. There parameters are availables for each video generated.
- Dynamic Medias: All the dynamic media that we have already defined in the template will now appear here so we can insert them for any new video. Now we can assign media to each input. This input could be uploaded from the computer, Amazon or URL
- Example: Continuing with the previous example we defined only one dynamic media. A text element:
- The title and description don't need to be unique. They are only descriptive elements.
- In this example we will generate 2 videos with the test template with different texts.
Now you can create your own website, mobile app, and client connected to a database for creating new videos with a template using the API.