status
Returns status information about a Live Slicer.
The response for this endpoint includes a status dictionary that contains the following key-value pairs:
| Response Parameter | Type | Description | |
|---|---|---|---|
| brokerid | String | Identifies the broker assigned to the Live Slicer by its system-defined ID. Sample value: 5bbf3fcf8ac8453caae8bc9a6015cb1e | |
| brokerzone | String | Identifies the zone corresponding to the broker assigned to the Live Slicer. Sample value: ausw3 | |
| capture_delay | Integer | Indicates the length of the capture delay as measured in seconds. | |
| cc_last_seen | Dictionary | 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. | |
| connect_info | Dictionary | Indicates connection information for the Live Slicer. This dictionary contains the following parameters: ips: This dictionary contains key-value pairs that identifies an interface and its IP address. Sample value: "en5" : "192.168.1.238" port: A string that identifies the port through which the Live Slicer established a connection. Sample value: 65009 public_ip: A string that indicates the Live Slicer's public IP address. Sample value: 192.16.26.2 uplynk_dns: A string that identifies the CNAME to which the Live Slicer established a connection. Sample value: f8ac3d43fee64e51bf39efe8a9fcd896.slicer.uplynk.net | |
| current_profile | String | Identifies the current encoding profile by its system-defined ID. | |
| delivered | Integer | Indicates the number of slices that have been uploaded to cloud storage since the Live Slicer was started. | |
| 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). | |
| dropped_frames_usec | Integer | Measures the duration, in microseconds, of a gap in the live stream due to dropped frames. This measurement is reset on content_start. | |
| dropped_since_last | Integer | Indicates the number of dropped frames in the CMS asset being encoded. | |
| duration | Integer | Indicates the duration, in seconds, of the live stream. | |
| lastBeamID | String | Identifies the last beam by its system-defined ID. | |
| 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. | |
| meta | Dictionary | Contains key-value pairs that describe the metadata fields that have been applied to the live stream. This dictionary does not include metadata manually defined via the CMS. It may take a few seconds before recently added metadata is reported within this dictionary. Syntax: "FieldName" : "Value" | |
| method | String | Identifies the method through which the Live Slicer communicates with the encoder. Sample value: broker | |
| rtp_stats | Dictionary | Contains statistics for each RTP feed being ingested by the Live Slicer. Learn more. | |
| 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 | unicast Source IP Address:Port Resolution Width x Height * No Signal: Reports the following value when the signal is lost: No signal |
| slicer_id | String | Indicates the Live Slicer's ID as defined in the Live Slicer configuration file. | |
| slices | List | Identifies the slices being encoded to the current CMS asset. | |
| software | String | Identifies the Live Slicer's OS version (e.g., slicer_linux_64). | |
| source_queue_depth | Integer | Requires Live Slicer version 15080700 or higher. Indicates the number of packets waiting to be read by the Live Slicer. | |
| source_queue_max_depth | Integer | Requires Live Slicer version 15080700 or higher. Indicates the highest number of packets queued to be read by the Live Slicer since it started running. | |
| state | Integer | Valid values are: 0: Capture 1: Ad break 2: Replacing content 3: Blackout | |
| sys_info | Dictionary | Contains system information (i.e., CPU, memory usage, network interface bandwidth, Nvidia graphics card, and OS) about the hardware on which the Live Slicer is running. | |
| 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 | Indicates the number of slices waiting to be uploaded. |
rtp_stats Dictionary
The rtp_stats dictionary contains the following key-value pairs:
| Response Parameter | Type | Description |
|---|---|---|
| 90Khz_stream_time | Integer | Indicates the current stream time in Unix time. |
| downstream_timeout | Boolean | Indicates whether the Live Slicer has stopped reading the payload. |
| fec | Dictionary | Contains information on how forward error correction (FEC) packets were generated. This dictionary contains the following key-value pairs: D: A string that indicates that FEC packets were generated based on the depth of the FEC matrix. L: A string that indicates that FEC packets were generated based on the spacing between non-consecutive packets. Key information: Each key-value pair defines a FEC period for packet sampling. The syntax for the value is: XORRepresents "exclusive or." XOR identifies how FEC packets are computed from either the column or row of the FEC matrix.,cnt:n,step:n Sample value: XOR,cnt:8,step:1 The value defined for cnt determines FEC strength and the bandwidth overhead required for FEC. Smaller values indicate a shorter FEC period which translates to stronger FEC and more bandwidth overhead. Configure your encoder to adjust the size of the FEC period sent to the Live Slicer. |
| realtime | Dictionary | Contains real-time statistics for the last three seconds. This dictionary contains the following key-value pairs: avg_bw: A string that indicates the average bandwidth uploaded by the Live Slicer. Sample value: 13.2Mb/sec packet_drop_rate: A string that indicates the percentage of packets dropped due to network congestion. Percentage is reported as a decimal value from 0 to 1. packet_loss_rate: A string that indicates the percentage of packets that were lost. Percentage is reported as a decimal value from 0 to 1. packet_recovery_rate: A string that indicates the percentage of packets recovered due to FEC. Percentage is reported as a decimal value from 0 to 1. |
| total | Dictionary | Contains packet statistics. This dictionary contains the following key-value pairs: gaps_detected: An integer that indicates the number of gaps between packets detected. packets_dropped: An integer that indicates the number of dropped packets that were detected. A high number of dropped packets is indicative of high CPU utilization on the computer hosting the Live Slicer. packets_lost: An integer that indicates the number of lost packets that were detected. A high number of lost packets is indicative of network issues between the Live Slicer and the origin server for RTP playout. packets_received: An integer that indicates the number of packets that were received. packets_recovered: An integer that indicates the number of dropped/lost packets that were recovered. A low number of recovered packets is indicative of either network issues, high latency between the audio/video feed and the FEC stream, or that the FEC is not sufficiently dense. timeouts_detected: An integer that indicates the number of timeouts that were detected. |
| redundancy | Dictionary | Contains information about each RTP feed. This dictionary contains the following key-value pairs: feeds: A dictionary that identifies each RTP feed. This dictionary contains the following key-value pairs: + desc: A string that indicates either the main or redundant RTP feed's IP address and port. + status: A string that indicates the status of a RTP feed. Valid values are: - active: Indicates that the RTP feeds are synchronized. - pending: Indicates that a single payload packet has not been received from this RTP feed. - incompatible: Indicates that this RTP feed is bit-stream incompatible with the other RTP feed. - timedout: Indicates that payload data is no longer being received from this RTP feed. - outofsync: Indicates that the RTP feeds are not synchronized due to latency. Check your rtp_readahead_dur and the rtp_backlog_dur parameters and increase as needed. skew_sec: A string that indicates the duration of the latency between the RTP feeds. Treat a value higher than 1 second or the rtp_readahead_dur parameter as an error. |
Sample request:
GET /status HTTP/1.1