Module name: tally

Basic URL: /api/v1/tally/

Tally状态和控制对于 Encoder 和 Decoder 模式都有作用。在Encoder模式下，您可以通过API来获取当前的Tally状态，甚至可以由您来控制Tally灯的亮/灭（虽然看起来不是特别必要）；在Decoder模式下，您设置的Tally状态(Program On/Off，Preview On/Off)将会发送给它正在解码的NDI Source。

获取当前Tally状态

---

API URL

**/api/v1/tally/status**

Request

Method: **GET/POST**

Parameters: NONE

Response

Example:

{
    "result": "ok",
    "data": {
        "pgm": 1,
        "pvw": 0
    }
}

Data字段说明：

Field	Value	说明
pgm	[INT]	1: PGM(Program) On 0: PGM(Program) Off
pvw	[INT]	1: PVW(Preview) On 0: PVW(Preview) Off

设置当前Tally状态

---

API URL

**/api/v1/tally/set**

Request

Method: **GET/POST**

Parameter	Value	说明
pgm	[INT], Optional	1: 设置Program On 0: 设置Program Off 未指定：保持之前的状态
pvw	[INT], Optional	1: 设置Preview On 0: 设置Preview Off 未指定：保持之前的状态

Response

Example:

{
    "result": "ok"
}

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

注意：

• 如果当前NDI Device工作在Encoder模式，并且它正在被某个NDI Receiver连接，由于NDI Receiver可能更新Tally状态，所以Tally的设置也许会被更新的Tally状态覆盖。请注意这个细节。
• 如果NDI Device工作在Decoder模式，您所设置的Tally状态将会发送到它正在解码的NDI Source；当您切换NDI Source时，它会清除之前NDI Source的Tally状态，并且将状态发送到新的NDI Source。