Control Panel — API Documentation



This API returns a list of the current VOD File and live stream being shown from each of the active playlists.

Example Code (PHP)

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

Example Result (JSON)

    "message": "Current video found",
    "status": "success",
    "videos" : [{
        "app" : "demo-origin",
        "stream" : "my_channel_stream_name",
        "video" : "sestore1/username/path/play_first.mp4",
    "handle_time":"0.3795 seconds"

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
videos [array] - Array of Videos to currently being played
app [string] - The ScaleEngine Application name
stream [string] - The name of the channel the playlist is being played on.
video [string] - The stream name or file path. VOD examples look like like: sestore3/username/path/filename.mp4
handle_time [float] - The amount of time spent processing your request