Control Panel — API Documentation

Create a switchboard stream that will output source streams based on a priority list. Source priority is based on the "stream_list" field. The switchboard will detect new streams being published or when the current source goes away and find the next highest priority stream. When no sources are available, the switchboard will shutdown and wait.

To create a switchboard provide the application name, the stream name to play out on, and a list of streams to play when they are published. New switchboards are not sent to the server by default, to force the new changes to take affect immediately set 'recheck_list' to true.

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 disable dvr using 'enable_dvr'. To edit the dvr settings see stream.dvrsettings api.

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

	$request = array(
		'command' => 'switchboard.add',
		'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
		'timestamp' => time(),
		'cdn' => 158,
		'app' => 'demo-origin',
		'stream' => 'switchboard_stream',
		'stream_list' => array("stream1","stream2","stream3"),
		'recheck_list' => true, //optional
		
		// dvr settings
		'playlist_count' => 4, //optional
		'playlist_timeout' => 60, //optional
		'enable_dvr' => true, //optional
		
		'origin_url' => 'jb-chorigin.secdn.net', // optional
		
		'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);
    }
    	

	{
	"message": "Switchboard created",
	"status": "success",
	"handle_time":"0.3795 seconds"
	"switchboard_id" : 1,
	}