Update the settings for a stream. Only the settings provided in the call will be updated.
$request = array( 'command' => 'sevu.updatestream', 'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE', 'timestamp' => time(), 'cdn' => 158, 'stream_id' => '1', 'record' => true, //optional 'record_type' => 'stream', //optional 'segment_type' => 'size', //optional 'segment_value' => 15, //optional 'save_folder' => 'stream_folder', //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); }
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_id | [REQUIRED] [int] - Unique ID of the stream. This can be found by calling sevu.liststreamusers |
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]
|
segment_type | [OPTIONAL] [string] Segmented recording will automatically split files based on the type selected.
|
segment_value | [OPTIONAL] the segment_value data type is determined by which segment_type you choose.
|
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. |
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 "") |
{ "code": 2111, "message": "Stream updated", "status": "success", "handle_time":"0.3795 seconds" }
code | [int] - API Response Code
|
message | [string] - Debugging message |
status | [string] - "success" or "failure" |
handle_time | [float] - The amount of time spent processing your request |