Control Panel — API Documentation



The recording API provides the ability to interact with live stream recordings. The start command will start recording a live stream. A wildcard can be sent in the stream parameter to run the request over multiple streams. Default recordings are saved to folders by year, month, and day, by providing a filepath the destination folder and/or filename can be changed.

When filepath is set to a file name that ends with .mp4, the recordings will be saved as recordings/<filepath>. If transcoding has been enabled for the streams, then the transcoded versions of your streams will be saved with the bitrate appended to the file name. For eg:- if the filepath is set to test/recording.mp4 and transcoding has been enabled for your stream, then your recordings will be saved as recordings/test/recording.mp4, recordings/test/recording_360p.mp4, recordings/test/recording_720p.mp4 and so on.

When filepath is set to a name not ending with .mp4, it will be assumed to be the name of a rolder, and the recordings will be saved inside the recordings/<filepath>/ folder with the name of the stream. The date when the recoding stopped will be appened to the names of the saved files. Transcoded versions of the stream will also have the bitrate appended to their file names. For eg:- if the filepath is set to 'test_folder', transcoding has been enabled for your stream and you stopped recording your stream on 2019-07-08 at 9:52 p.m. UTC, then your recordings will be saved as recordings/test_folder/stream-2019-07-08_21-52.mp4, recordings/test_folder/stream_360p-2019-07-08_21-52.mp4, recordings/test_folder/stream_720p-2019-07-08_21-52.mp4 and so on.

If the filepath points to a location where a file already exists, then the recordings will fallback to being saved with the dates appended to the file names.

Example Code (PHP)

    $request = array(
        'command' => 'recording.start',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'app' => 'jb-origin/live',
        'stream' => 'test-record',
        'filepath' => 'event_1/test-record1.mp4', //optional
        //Create request signature
    $json_request = json_encode($request);
    $sig = base64_encode(hash_hmac('sha256', $json_request,
        '8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f', true));
    $request['signature'] = $sig;
    $json_request = json_encode($request);
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, ''); // Set the URL
    curl_setopt($ch, CURLOPT_POST, true); // Perform a POST
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // If not set, curl prints output to the browser
    curl_setopt($ch, CURLOPT_HEADER, false); // If set, curl returns headers as part of the data stream
    curl_setopt($ch, CURLOPT_POSTFIELDS, array('json' => $json_request)); //'Json' string or 'PHP' serialized return
    //If your PHP host does not have a proper SSL certificate bundle, you will need to turn off SSL Certificate Verification
    //This is dangerous, and should only be done temporarily until a proper certificate bundle can be installed
    //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
    //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.
    $response = curl_exec($ch); //Execute the API Call
    if (!$response) {
        die('Failed to connect to ScaleEngine API');
    //Decode the response as an associative array 
    $arrResponse = json_decode($response, true); 
    if ($arrResponse) {
        //Operation completed successfully
        //TODO Add work here
    } else {
        //Operation failed
        echo 'An error occured processing your request:';

Request Fields

command [REQUIRED] [string] - API command to execute
cdn [REQUIRED] [int] - The ScaleEngine CDN ID of your account
api_key [REQUIRED] [string] - The API key provided as part of your account
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed
app [REQUIRED] [string] - The ScaleEngine Application name / instance name (example: jb-origin/live)
stream [REQUIRED] [string] - The ScaleEngine stream name
filepath [OPTIONAL] [String] - Defines the destination folder and/or filename to be used when the recording is saved. Folders and Filenames are limited to letters, numbers, dashes, and underscores and filenames must end with a ".mp4" extension.

Example Result (JSON)

    "message": "Recording Started",
    "status": "success",
    "handle_time":"0.3795 seconds",
            "message":"Stream test-record_*: Default Recording started"
            "message":"Stream test-record_*: Default Recording started"

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
streams [Array] - array of streams
name [string] - The name of the stream
message [string] - successful result message
error [string] - error message. this property will only appear if there was an error