Returns the last known status for one or more Live Slicers.
Request syntax:
/api2/slicer/status
Pass the following request parameters:
| Request Parameter | Type | Description |
|---|---|---|
| slicer_ids Required | list | Identifies one or more Live Slicers by their slicer IDs. |
The response for a successful request contain the following parameters.
| Response Parameter | Type | Description | |
|---|---|---|---|
| slicers | List | Contains the set of Live Slicers identified by the slicer_ids parameter. | |
| cc_last_seen | Object | Indicates the time at which the Live Slicer received the most recent caption for each channel. The Live Slicer updates these timestamps every ten seconds. Syntax: "Channel Number":Unix Time This parameter will report a null value until a caption is detected. | |
| dropped | Integer | Indicates the number of frames that have been dropped for the current beam. Prior to Live Slicer version 19022000, this metric reported the number of dropped frames since the Live Slicer was started. Dropped frames are indicative that the Live Slicer is experiencing severe egress bandwidth problems or insufficient system resources (CPU/memory). | |
| id | String | Indicates the Live Slicer's ID as defined in the Live Slicer configuration file. | |
| lastmod | Integer | Indicates when a Live Slicer's status was last updated in Unix time. | |
| luma | Integer | Indicates the average luminosity percentage for the last few seconds of video. This percentage will only be returned when the Live Slicer has reported a luma value. | |
| outdated | Integer | A value of 1 indicates that either: The Live Slicer has been shut down. The Live Slicer is having trouble uploading data and communicating with the Uplynk system. | |
| signal | String | Indicates the input signal type. Blackmagic Capture Devices: Indicates the signal format reported by the card. Sample value: HD 1080i 60fps UDP Transport Streams Reports the following information: TS multicast | unicastSource IP Address:PortResolution Width x Height * No Signal: Reports the following value when the signal is lost: No signal |
| source_queue_depth | Integer | Requires Live Slicer version 15080600 or higher Indicates the number of packets waiting to be read by the Live Slicer. | |
| source_queue_max_depth | Integer | Requires Live Slicer version 15080600 or higher Indicates the maximum number of packets waiting to be read by the Live Slicer since it started running. | |
| state | Integer | Valid values are: -1: No status found 0: Capturing 1: Ad break 2: Replacing content * 3: Blackout | |
| state_str | String | Indicates the Live Slicer's state. | |
| version | String | Indicates the Live Slicer's version number. | |
| vol | Integer | Indicates the average loudness percentage for the last few seconds of audio. This percentage will only be returned when the Live Slicer has reported a volume value. | |
| waiting | Integer | Requires Live Slicer version 15071501 or higher Indicates the number of slices waiting to be uploaded. |
Sample request/response:
The Call() function, which is imported from uplynk_api2_auth module, prepares the message body and digital signature.
from uplynk_api2_auth import Call
print(Call('/api2/slicer/status', slicer_ids=['my_slicer_1', 'my_slicer_2']))
{
"slicers": [
{
"state_str": "No status found",
"lastmod": -1,
"outdated": 1,
"state": -1,
"id": "my_slicer_2"
},
{
"state_str": "capture",
"lastmod": 1367520728,
"outdated": 0,
"state": 0,
"id": "my_slicer_1",
"signal": "HD 1080i 60fps",
"luma": 20,
"vol": 30,
"version": 15061800,
"dropped": 0,
"cc_last_seen": {"0": 1367520728}
}
],
"error": 0
}