Control Panel — API Documentation



This API grants permission for a user to publish to a stream by creating username and password for that stream. Once added the user can start publishing to the stream using their username and password. Optionally, record settings can be configured to have the stream record automatically and split based size, schedule, or duration. To disable authentication, but allow record settings, set user and pass to null.

A wildcard (*) in the place of a stream name allows unified authentication with one user/pass combination, on all application streams.

DVR applications additionally can set the # of chunks to keep in their playlist and how long to keep the dvr session alive by providing a 'playlist_count' and 'playlist_timeout' or disbale dvr using 'enable_dvr'. To edit the dvr settings see stream.dvrsettings api.

You can track viewer session data on your live stream from Google Analytics (GA) by providing your GA key.

Example Code (PHP)

    $request = array(
        'command' => 'sevu.addstreamuser',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'app' => 'demo-origin',
        'stream' => 'mystream',
        'user' => 'username_1', // null to disable
        'pass' => 'unique_random_string_per_request', // null to disable
        /* optional record settings */
        'record' => true,
        'record_type' => 'stream',
        'segment_type' => 'size',
        'segment_value' =>  15,
        'save_folder' => 'stream_folder', 
                // DVR Settigns
        'playlist_count' => 6, //optional
        'playlist_timeout' => 600, //optional
        'enable_dvr' => true, //optional
        //Google Anayltics
        'ga_key' => '' //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
stream [REQUIRED] [string] - Stream name that you wish to publish to. "*" allows unified authentication with one user/pass combination, on all application streams
user [REQUIRED] [string] - Username that will be assigned to this stream. Set User and Pass to null to disable authentication
pass [REQUIRED] [string] - A randomly generated password. Should be unique for each request. Recommended length atleast 10 characters.
Record Settings
record [OPTIONAL] [boolean] - Auto Record when a stream is published. When disabled, recording can be started by calling recording.start
record_type [OPTIONAL] [string]
  • "stream" - recordings will append the date the recording finished onto the recorded file name.
  • "event" recordings will append the date the recording start to the recorded file name, and a "pt#" if necessary
segment_type [OPTIONAL] [string] Segmented recording will automatically split files based on the type selected.
  • "duration" - split recordings based the a number of minutes provided.
  • "size" - split recordings based the a number in MBs provided.
  • "schedule" - split recordings based the a crontab expression.
  • "disabled" - recordings will run until the stream is unpublished
segment_value [OPTIONAL] the segment_value data type is determined by which segment_type you choose.
  • Duration [int] - # of minutes
  • Size [int] - # of MBs
  • Schedule [string] - valid crontab expression (ex. '*/15 * * * *' every 15 minutes)
save_folder [OPTIONAL] [String] - Defines the destination folder used when the recording is saved. Folders limited to letters, numbers, dashes, and underscores. Providing a save_folder will disable the filepath parameter used in the recording API.
playlist_count [OPTIONAL] [int] - How many chunks to have on the manifest for each rendition. Number must be between 4 and [Default: 4]
playlist_timeout [OPTIONAL] [int] - How many seconds to keep the playlist after the stream disconnects. Value must be between 60 and 1200 [Default: 600]
enable_dvr [OPTIONAL] [boolean] - Enables dvr settings when true, disables dvr when false. Only valid for DVR enabled ScaleEngine Accounts. [default true]
ga_key [OPTIONAL] [String] - The Google analytics (GA) key to be used when a stream or channel is viewed. This key is used to capture viewer data and send it to the associated GA account. GA Keys saved to a channel will be applied to all playlists on that channel, and if no key is provided the default GA key for the your ScaleEngine account will be used. (default "")

Example Result (JSON)

    "code": 2071 ,
    "message": "Stream User Added",
    "status": "success",
    "handle_time":"0.3795 seconds"

Result Fields

code [int] - API Response Code
  • 0009 - Segment Type may only be schedule, size, or duration.
  • 0010 - Segments of Duration and Size require a value greater than 0.
  • 0011 - Invalid CRONTAB expression given.
  • 2070 - Stream User could not be created
  • 2071 - Stream User Added
  • 2072 - Exceeded maximum stream accounts
message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request