stream.active
Stream active returns a list of streams and details for all active streams on a given application.
Details include: stream name, whether the stream is being recording, encoder connect and publish times,
audio and video codec, transcoder data, pushpublish sessions, and other metadata that has been sent to the stream.
Example Code (PHP)
$request = array(
'command' => 'stream.active',
'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
'timestamp' => time(),
'cdn' => 158,
'app' => 'demo-origin',
'inst' => 'live',
'origin_url' => 'jb-origin.secdn.net', // 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);
}
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 |
inst |
[REQUIRED] [String] - Name of the Application Instance |
origin_url |
[REQUIRED] [string] - Defines the url address of an origin to be called.
Defaults to jb-origin.secdn.net for origins and jb-chorigin.secdn.net
for channels.
|
Example Result (JSON)
{
"streams": [
{
"name" : "my_channel",
"isRecording": "false",
"publish_time": "2018/11/06 17:24:51",
"video": "mp4:sestore4/jb/path/play_first.mp4",
"playlist_id": "1",
"transcoders": [],
"transcoder_count": 0,
"type": "channel",
"codec": {
"audio_type": "AAC",
"video_type": "H264",
"audio": "mp4a.40.2",
"video": "avc1.42c01e"
},
"pushpublish": [
{
"entry_name": "pushentry1",
"stream": "my_channel",
"status": "Connected"
},
],
"metadata" : {
"key" : "value",
...
}
},
],
"message": "Found stream details",
"status": "success",
"handle_time":"0.3795 seconds"
}
Result Fields
message |
[string] - Debugging message |
status |
[string] - "success" or "failure" |
handle_time |
[float] - The amount of time spent processing your request |
streams |
[array] - Array of streams
|
[array] - Stream details
name |
[string] - Stream Name |
type |
[string] - type of stream: origin, channel, transcoded, or edge |
is_recording |
[int] - 1 if the stream is record, 0 if it is not recording |
publish_time |
[string] - date and time the encoder published to the stream |
connect_time |
[string] - date and time the encoder connected to the server |
codec |
[array] - array containing audio and video codec type |
metadata |
[array] - array of key value pairs containing various metadata
sent to the stream about the encoder and stream settings
|
pushpublish |
[array] - pushpublish session data for each of the active sessions.
This includes: entry_name, stream, and connected status.
|
transcoders |
[array] - information about the various transcoded streams that are active. (Transcoders Only) |
transcoder_count |
[int] - # of transcoders active on the stream. |
playlist_id |
[int] - ID of the playlist running on a channel. (Channel Only) |
video |
[string] - name of the video or live stream being played on a channel. (Channel Only) |
|
|