API Documentation: recording.stop


The recording API provides the ability to interact with live stream recordings. The stop command will stop recording a live stream. A successful stop will return the name of the file and duration. If a callback URL is provided, a notification will be sent to the callback when the recording has been moved and indexed by the file api. Additionally a wildcard can be sent in the stream parameter to run the request over multiple streams.

Example Request (JSON)

Example Code (PHP)

    $request = array(
        'command' => 'recording.stop',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'app' => 'jb-origin/live',
        'stream' => 'test-record_*',
        'callback' => 'http://jb.com/callback',
        'title' => 'few words',
        'description' => 'longer paragraph'
        //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, 'https://api.scaleengine.net/stable/'); // 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_id [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
callback [OPTIONAL]
  • [string] - The URL to POST to once the file is ready.
title [OPTIONAL] [string] - User friendly name for the file.
description [OPTIONAL] [string] - Description of the file.

Example Result (JSON)

    "message": "Recording has been stopped",
    "status": "success",
    "handle_time":"0.3795 seconds",
            "message":"Recording has stopped for stream test-record_*",
            "message":"Recording has stopped for stream test-record_*",

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
file [string] - file path and filename of the recording
duration [float] - duration in seconds of the file