Module name: decoder/current
Basic URL: /api/v1/decoder/current/
文章目录
Get current decoding status
API URL
/api/v1/decoder/current/status
Request
Method: GET/POST
Parameters: NONE
Response
Example:
{
"result": "ok",
"data": {
"name": "Spark_IO-1916001002 (Channel 1)",
"url": "192.168.100.168:5961",
"ip": "192.168.100.168",
"online": true, /*or false*/
"resolution": "1920x1080p 59.94Hz",
"codec": "SHQ7",
"xRes": 1920,
"yRes": 1080,
"frame_rate": 59.94,
"inst_frame_rate": 59.93,
"interlaced": false,
"de_interlace": false,
"bitrate": 125000,
"audio_format": "48KHz / 2CH",
"audio_sampling": 48000,
"audio_channels": 2,
"warning": ""
}
}Data field description:
| Field | Value | Description |
|---|---|---|
| name | [STRING] | The NDI Source Name that currently decoded. If currently output Preset 0 (Blank), then name should be "(Blank)" |
| url | [STRING] | The original URL of NDI Source that currently decoded. If there no decoding NDI Source，then url = "" (empty strings) |
| ip | [STRING] | IP address of of NDI Source that currently decoded. If no decoding, ip = "0.0.0.0" |
| online | [BOOLEAN] | true: Current NDI Source is online； false: current NDI Source is not online |
| resolution | [STRING] | Resolution of the current NDI Source (friendly name). If you need to obtain the program-friendly information of the video, such as width/height, please refer to xRes, yRes, frame_rate, interlaced fields. |
| codec | [STRING] | CODEC ID of of the current NDI Source:
SHQ0 / shq0: NDI YUV4:2:0 format encoding Other CODEC ID may exist, but can’t be supported yet. |
| xRes | [INT] | Video resolution width of the current NDI Source |
| yRes | [INT] | Video resolution height of the current NDI Source |
| frame_rate | [NUMBER] | Frame-rate of the current NDI Source. Please note: frame_rate means the original frame_rate of NDI Source. The other field inst_frame_rate means (Instant Frame Rate)，inst_frame_rate means the actual frame rate calculated by the program. |
| inst_frame_rate | [NUMBER] | Instant Frame Rate，the actual framerate calculated by the program. |
| interlaced | [BOOLEAN] | true: NDI Source is Interlaced video false: NDI Source is progressive video |
| de_interlace | [BOOLEAN] | The NDI decoder has the ability to execute deinterlace of interlaced video and output it in progressive format. It needs you to configure via API 8.3 /api/v1/decoder/output/set (deinterlace operation is not performed by default). If you configure deinterlace, and the original video of the current NDI Source is interlaced，then de_interlace will be true，which used to instruct you that the Decoder has now undergone deinterlace conversion. |
| bitrate | [INT] | Current real-time bitrate statistics, in Kbps |
| audio_format | [STRING] | The current audio formats (friendly name). If you need to get the program-friendly information of the audio, please refer to audio_sampling，audio_channels |
| audio_sampling | [INT] | Audio sampling of the current audio |
| audio_channels | [INT] | Channels of of the current audio |
| warning | [STRING] | The following defined string ID (bold text ) is used to describe warnings/errors that occur when decoding output:
WARN:url-changed WARN:offline ERROR:no-video-output ERROR:no-audio-output WARN:invalid WARN:match-error WARN:unsupported-codec WARN:unsupported-resolution WARN:url-changed WARN:offline ERROR:no-video-output ERROR:no-audio-output WARN:invalid WARN:match-error WARN:unsupported-codec WARN:unsupported-resolution |
Switch preset or specified NDI source to the current decoding output
API URL
/api/v1/decoder/current/set
Request
Method: GET/POST
| Parameter | Value | Description |
|---|---|---|
| id | [STRING], Optional | Specify preset ID (0~9)，switch the NDI source saved in preset ID to the current decoding output. This parameter is optional. If ID is specified, the following other parameters will be meaningless; if ID is not specified, you must specify the following name and url parameters.
If you specify id = "0", it means that Blank is output directly without decoding. Please refer to section |
| name | [STRING], Optional | If you don’t specify the parameter of the above id，then name and url parameter is a must; otherwise no need to specify. name is the name of NDI Source，usually you can get via 5.1 /api/v1/decoder/discovery/get. According to the current rules of NDI SDK，url is the key parameter to get NDI Source connection，name only providing reference for discovering NDI source. So, in a sense, you can ignore name or provide an arbitrary string. But we strongly recommend that you should provide the correct and legal name. |
| url | [STRING], Optional | The original URL of NDI source. If you don’t specify parameter id，then url parameter is required. |
Response
Example:
{
"result": "ok"
}If set successfully, it will return the message of result = "ok", or please refer to 1.3 for error message descriptions.