Control Panel — API Documentation



This API will return the current playlist order for a requested channel. The response will have a list of VOD files and live streams that are still left to be played. If the playlist is set to repeat, then the previously shown items will be added to the end.

Example Code (PHP)

    $request = array(
        'command' => 'channel.currentchannels',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'app' => 'jb-chorigin', 
        'stream' => 'my_channel_stream_name',
        'appinst' => 'live'                     /* 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
app [OPTIONAL][string] - Application name, defaults to jb-chorigin
stream [REQUIRED] [string] - The channel you wish to retrieve a playlist for.
appinst [OPTIONAL] [string] - The Application instance name.
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed

Example Result (JSON)

    "message": "Current Playlist Order",
    "status": "success",
    "playlist" : [{
        'video' => 'sestore1/username/path/play_first.mp4',
        'start' => 0,
        'length' => -1,
        'sort_order' => 3
        'video' : 'my_livestream_1',
        'start' : 0,
        'length' : -2,
        'sort_order' : 4
    "handle_time":"0.3795 seconds"

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
videos [array] - current playlist order
video [string] - The stream name or path of the VOD video the user is restricted to. VOD examples look like like: sestore3/username/path/filename.mp4
start [int] - the time in seconds where the VOD file should begin. set to 0 to start at the beginning.
length [int] - the number of seconds to play of the stream or VOD file.
-1 to play to the end of a VOD file
-2 to play to the end of a live stream
sort_order [int] - the order in which the video should appear in the playlist.
handle_time [float] - The amount of time spent processing your request