Obtain stream status
1. API Description
This API is used to obtain stream status.
Request mode: GET/POST [ip]/api/stream/status/get
| Administrator Rights |
Logged-in |
| No |
Yes |
None
3. Output Parameters
| Name |
Type |
Description |
| status |
Integer |
Status code |
| code |
String |
Status description |
| data |
struct |
Refer to stream status. |
Stream Status
| Name |
Type |
Description |
| name |
String |
Name of current stream. |
| protocol |
String |
Protocol of current stream. |
| state |
Integer |
Connection status. 2 indicates connected. |
| uptime |
Integer |
Up time in milliseconds. |
| extra |
struct |
Refer to tally status. |
| video |
struct |
Refer to video status. |
| audio |
struct |
Refer to audio status. |
Tally Status (NDI)
| Name |
Type |
Description |
| tally-prview |
Boolean |
Preview indicator (reserved). |
| tally-program |
Boolean |
Program indicator (reserved). |
Video Status
| Name |
Type |
Description |
| codec |
String |
Video format. |
| jitter |
Integer |
Video jitter. |
| kbps |
Integer |
Video biterate. |
| width |
Integer |
Video width. |
| height |
Integer |
Video height. |
| field_rate |
Double |
Video field rate. |
| drops |
Integer |
The number of video drop packets. |
Audio Status
| Name |
Type |
Description |
| codec |
String |
Audio format. |
| jitter |
Integer |
Audio jitter. |
| kbps |
Integer |
Audio biterate. |
| sample_rate |
Integer |
Sample rate. |
| bit_count |
Integer |
Bit depth. |
| channels |
Integer |
The number of audio channels. |
| drops |
Integer |
The number of audio drop packets. |
4. Example
Obtain stream status.
None
Output Example
{
"data": {
"audio": {
"codec": "ADTS",
"jitter": 118856,
"kbps": 123,
"sample_rate": 48000,
"bit_count": 16,
"channels": 2,
"drops": 0
},
"video": {
"codec": "H264",
"jitter": 210575,
"kbps": 8029,
"scan_mode:": "progressive",
"width": 1920,
"height": 1080,
"field_rate": 60.0,
"drops": 0
},
"extra": {
"tally_preview": false,
"tally_program": false
},
"state": 2,
"uptime": 2028,
"name": "NDI Server",
"protocol": "ndi"
},
"status": 0,
"code": "Success"
}
5. Error Code
No error code related to the API business logic. For other error codes, see Common Error Codes.