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.

    $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, '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);
    }
        

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