Module name: tally

Basic URL: /api/v1/tally/

Tally status and control act both on Encoder and Decoder mode. Under Encoder mode，you can get current Tally status through API, even control Tally light’s on/off (although it looks like it is not necessary); under Decoder mode，you can set up Tally status (Program On/Off, Preview On/Off) will send to the decoding NDI source.

Get current Tally status

---

API URL

​ /api/v1/tally/status

Request

​ Method: GET/POST

​ Parameters: NONE

Response

Example:

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

Data field description:

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

Set current Tally status

---

API URL

​ /api/v1/tally/set

Request

​ Method: GET/POST

Parameter	Value	Description
pgm	[INT], Optional	1: Set Program On 0: Set Program Off not specified: keep previous status
pvw	[INT], Optional	1: 设置Preview On 0: Set Preview Off not specified: keep previous status

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.

Note:

• If current NDI Device is in Encoder mode and it is connected by one of NDI Receiver, as NDI Receiver can probably update Tally status, so setup of Tally may be covered by updated Tally status. Please pay attention to this detail.
• If NDI is in Decoder mode, the Tally status which set will send to the NDI source which is decoding; if you switch to another NDI source, it will clear the previous Tally status of NDI source, and send new status to new NDI Source.