API Documentation: channel.addchannel

Synopsis

This API creates a Playlist of live streams and/or VOD files to be played on a Channel at a set time. A Playlist can be configured to play through its list once, to loop continuously, or to fallback to a previous playlist after it has finished.

Example Request (JSON)

Example Code (PHP)

    $request = array(
        'command' => 'channel.addchannel',
        'api_key' => '##API Public Key##',
        'timestamp' => time(),
        'cdn' => 158,
        'name' => 'My first playlist',
        'stream' => 'my_channel_stream_name',
        'repeat' => 1,
        'active' => 0,
        'metadata' => 0,
        'scheduled' => '2014-10-13 15:00:00',
        'videos' => array(                      /* optional */
            0 => array(
                'video' => 'sestore1/username/path/play_first.mp4',
                'start' => 0,
                'length' => -1,
                'sort_order' => 1
            ),
            1 => array(
                'video' => 'sestore1/username/path/play_second.mp4',
                'start' => 0,
                'length' => -1,
                'sort_order' => 2
            ),
        ) 
    );
    
        //Create request signature
    $json_request = json_encode($request);
    $sig = base64_encode(hash_hmac('sha256', $json_request,
        '##API Secret Key##', 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
        print_r($arrResponse);
    } else {
        //Operation failed
        echo 'An error occured processing your request:';
        print_r($response);
    }
        

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
name [REQUIRED] [string] - A descriptive name given to the playlist.
stream [REQUIRED] [string] - Name of the Channel on which the playlist will be shown.
repeat [REQUIRED] [int] - Configures how the playlist should be handled when it is finished.
0 - Channel will shutdown, until the next scheduled playlist.
1 - Playlist will loop continuously, until a new playlist is scheduled.
2 - Channel will fallback to a previous repeating playlist that is marked as active.
active [REQUIRED] [int] - Marks the playlist to be played when the scheduled time comes due, or at the next interval if no scheduled time is set.
1 - active
0 - inactive
metadata [REQUIRED] [int] - Enable or Disable the sending of metadata with VOD files.
0 - disabled
1 - enabled
scheduled [OPTIONAL] [string] - The date and time that the playlist should be shown on the Channel. If not provided and no other playlist has been scheduled, this playlist will play automatically.
videos [OPTIONAL] [array] - Array of Videos to be added to the playlist
[array]
video [REQUIRED] [string] - The stream name or file path. VOD examples look like like: mp4:sestore3/username/path/filename.mp4, mp3:sestore3/username/audio/song.mp3,
start [REQUIRED] [int] - the time in seconds where the VOD file should begin. set to 0 to start at the beginning.
length [REQUIRED] [int] - the number of seconds to play of the stream or VOD file.
-1 to play to the end of a file
-2 to play to the end of a live stream
sort_order [REQUIRED] [int] - the order in which the video should appear in the playlist.
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed

Example Result (JSON)

    {
    "message": "channel created",
    "status": "success",
    "id" : 1,
    "videos_not_added" : [{
        1 : "#1: sestore1/username/path/play_second.mp4 - video name invalid",
    }],
    "handle_time":"0.3795 seconds"
    }
    

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
id [int] - Unique ID of the Playlist
videos_not_added [array] - If a VOD file or stream name is invalid an array will be returned with the reasons they could not be added. The array key will be associated to the sort_order value that was set, and the value will be an error message.
handle_time [float] - The amount of time spent processing your request