JSON2Video SDKs

JSON2Video provides you with SDKs for the most popular programming languages to make the implementation even easier. We currently support PHP and NodeJS, but other SDKs are in the short-term pipeline: Python, Go and other.

• JSON2Video PHP SDK
• JSON2Video NodeJS SDK

SDK basic concepts

All our SDKs have common concepts you should understand:

• SDKs are Object-oriented

  There are 2 main classes to use: Movie and Scene

• Movie class

  Represents the movie JSON schema and allows to define the output video properties and the calls to the API (render and getStatus).

• Scene class

  Represents the scene JSON schema and defines the different scenes in the Movie object.

• Elements are created as JSON objects

  Elements do not have a dedicated class or object. Instead, they are created as simple JSON objects.

• Hyphens become underscores in property names

  Property names in the Movie and Scene schemes that include hyphens (like background-color), the hyphen is always translated to underscores (like in $scene->background_color).

Steps for creating a video with the SDKs

1. Create and setup the Movie object

1. Create the Movie object
2. Set your API key (that will be sent in the x-api-key header)
3. Define your desired resolution and quality (optional)

{
    "resolution": "full-hd",
    "quality": "high"
}

require 'vendor/autoload.php';

use JSON2Video\Movie;
use JSON2Video\Scene;

// Create and initialize the movie object
$movie = new Movie;
$movie->setAPIKey(YOUR_API_KEY);
$movie->resolution = 'full-hd';
$movie->quality = 'high';

let movie = new Movie;
movie.setAPIKey(YOUR_API_KEY);
movie.set("resolution", "full-hd");
movie.set("quality", "high");

2. Create one or more Scenes

1. Create one or more Scene objects
2. Add elements to them with the addElement method
3. Add the scenes to the movie with the addScene method

{
    "resolution": "full-hd",
    "quality": "high",
    "scenes": [
        {
            "background-color": "#4392F1",
            "elements": [
                {
                    "type": "text",
                    "text": "Hello world",
                    "duration": 10
                }
            ]
        }
    ]
}

// Create the scenes of the movie

// Create SCENE 1
$scene1 = new Scene;
$scene1->background_color = '#4392F1';
$scene1->addElement([
	'type' => 'text',
	'text' => 'Hello world',
	'duration' => 10
]);
$movie->addScene($scene1);

// Create the scenes of the movie

// Create SCENE 1
let scene1 = new Scene;
scene1.set("background-color", "#4392F1");
scene1.addElement({
	"type": "text",
	"text": "Hello world",
	"duration": 10
});
movie.addScene(scene1);

3. Send the render request

1. Post the movie to be rendered with the render method

{
    "resolution": "full-hd",
    "quality": "high",
    "scenes": [
        {
            "background-color": "#4392F1",
            "elements": [
                {
                    "type": "text",
                    "text": "Hello world",
                    "duration": 10
                }
            ]
        }
    ]
}

// Finally, render the movie
$movie->render();

// Finally, render the movie
movie.render();

4. Check the render status

1. Check the status of your rendering job calling the getStatus method every few seconds

{
    "resolution": "full-hd",
    "quality": "high",
    "scenes": [
        {
            "background-color": "#4392F1",
            "elements": [
                {
                    "type": "text",
                    "text": "Hello world",
                    "duration": 10
                }
            ]
        }
    ]
}

// Check for the rendering job status
$movie->getStatus();

// Check for the rendering job status
movie.getStatus();