获取 stream 状态
1.接口描述
接口说明:获取 stream 状态。
请求方式:GET/POST [ip]/api/stream/status/get
2.输入参数
无
3.输出参数
| 参数名称 |
类型 |
描述 |
| status |
Integer |
状态码 |
| code |
String |
状态描述 |
| data |
struct |
参考stream状态 |
stream状态
| 参数名称 |
类型 |
描述 |
| name |
String |
当前流的名称 |
| protocol |
String |
当前流的类型 |
| state |
Integer |
连接状态,2:已连接 |
| uptime |
Integer |
持续时间 单位为毫秒 |
| extra |
struct |
参考tally状态 |
| video |
struct |
参考video状态 |
| audio |
struct |
参考audio状态 |
tally状态,仅ndi源有效
| 参数名称 |
类型 |
描述 |
| tally_prview |
Boolean |
预览指示(预留) |
| tally_program |
Boolean |
program指示(预留) |
video状态
| 参数名称 |
类型 |
描述 |
| codec |
String |
视频格式 |
| jitter |
Integer |
视频抖动 |
| kbps |
Integer |
视频码率 |
| width |
Integer |
视频宽度 |
| height |
Integer |
视频高度 |
| field_rate |
Double |
视频场速率 |
| drops |
Integer |
视频丢包数量 |
audio状态
| 参数名称 |
类型 |
描述 |
| codec |
String |
音频格式 |
| jitter |
Integer |
音频抖动 |
| kbps |
Integer |
音频码率 |
| sample_rate |
Integer |
采样率 |
| bit_count |
Integer |
位宽 |
| channels |
Integer |
音频通道数 |
| drops |
Integer |
音频丢包数量 |
4.示例
获取 stream 状态。
输入示例
None
输出示例
{
"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.错误码
无接口业务逻辑相关的错误码,其他错误码详见 API 状态码。