Module name: decoder/current

Basic URL: /api/v1/decoder/current/

获取当前解码状态

---

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	Value	说明
name	[STRING]	当前正在解码的NDI Source Name。如果当前正在输出Preset 0 (Blank)，则 name = "(Blank)"
url	[STRING]	当前正在解码的NDI Source的原始URL。如果没有解码NDI Source，则 url = "" (空字符串)
ip	[STRING]	当前正在解码的NDI Source的IP地址。如果没有解码，则 ip = "0.0.0.0"
online	[BOOLEAN]	true: 当前NDI Source在线； false: 当前NDI Source不在线
resolution	[STRING]	当前NDI Source的视频分辨率（友好名称）。如果您需要获取视频的程序友好的信息，例如宽度/高度等，请参考 xRes, yRes, frame_rate, interlaced等字段。
codec	[STRING]	当前NDI Source的视频CODEC ID： SHQ0 / shq0: NDI YUV4:2:0格式编码 SHQ2 / shq2: NDI YUV4:2:2格式编码 SHQ7 / shq7: NDI YUVA4:2:2:4格式编码 其它CODEC ID可能会存在，但止前暂不被支持。
xRes	[INT]	当前NDI Source的视频分辨率宽度
yRes	[INT]	当前NDI Source的视频分辨率高度
frame_rate	[NUMBER]	当前NDI Source的帧率。 请注意：frame_rate指的是NDI Source的原始的frame_rate。另一个字段inst_frame_rate表示(Instant Frame Rate，实时的帧率)，inst_frame_rate表示的是由程序统计的、实际的帧率。
inst_frame_rate	[NUMBER]	Instant Frame Rate，由程序统计的、实际的帧率
interlaced	[BOOLEAN]	true: NDI Source是Interlaced视频 false: NDI Source是Progressive视频
de_interlace	[BOOLEAN]	NDI解码设备具有将interlaced视频执行Deinterlace并输出为Progressive格式的能力。这需要您通过 API 8.3 /api/v1/decoder/output/set 进行设置（默认不执行Deinterlace操作）。 如果您配置了Deinterlace，而且当前NDI Source原始的视频是interlaced，那么de_interlace将会为true，它用于指示您，目前Decoder进行了Deinterlace转换。
bitrate	[INT]	当前实时统计的bitrate，Kbps
audio_format	[STRING]	当前音频格式（友好名称）。如果您需要获取音频的程序友好的信息，请参考 audio_sampling，audio_channels
audio_sampling	[INT]	当前音频输出的采样率
audio_channels	[INT]	当前音频输出的声道数
warning	[STRING]	目前已定义如下string ID（粗体字）用于描述在解码输出时发生的警告/问题： WARN:url-changed Meaning: NDI source URL changed WARN:offline Meaning: Offline ERROR:no-video-output Meaning: Video output config error ERROR:no-audio-output Meaning: Audio output config error WARN:invalid Meaning: Invalid output configuration WARN:match-error Meaning: Format/resolution is unsupported WARN:unsupported-codec Meaning: CODEC is unsupported WARN:unsupported-resolution Meaning: Resolution is unsupported

将Preset或指定的NDI Source切换到当前解码输出

---

API URL

**/api/v1/decoder/current/set**

Request

Method: **GET/POST**

Parameter	Value	说明
id	[STRING], Optional	指定Preset ID (0~9)，将Preset ID所保存的NDI Source切换到当前解码输出。这个参数是可选的，如果指定了 id，那么下面的其它参数将没有意义；如果没有指定id，则您必须指定下面的 name和url参数。 如果您指定 id = "0"，表示当前不解码而直接输出Blank。请参见 关于Preset 0的描述。
name	[STRING], Optional	如果您没有指定上面的id参数，那么name和url参数是必须的；否则无需指定。 name是NDI Source的名称，通常您可以通过 5.1 /api/v1/decoder/discovery/get获得。根据NDI SDK的现有规则，url是获得NDI Source连接的关键参数，name仅提供发现NDI source的参考。所以，某种意义上说，您可以忽略name或给任意字符串。但我们强烈建议您应该提供正确和合法的name。
url	[STRING], Optional	NDI source的原始URL。如果您没有指定参数id，那么url参数是必须的。

Response

Example:

{
    "result": "ok"
}

如果切换成功，将返回 result = "ok" 的消息；否则请参见HTTP响应和错误处理 的标准错误消息描述。