Devices Resources
Synopsis
The devices API is used to get information about connected Haivision Set-Top Boxes, as well as send commands to them.
Device Parameters
Note
The returned contents of each device record contains information intended for display, as well as internal information specific to STB management functions. It is recommended to limit integration only to the documented fields below.
Property | JSON Type | Description |
|---|---|---|
| String | Set-Top Box ID. Used for targeting the STB with remote commands. |
hostname | String | IT friendly STB name. |
| String | The network address (IPv4 or domain) of the STB. |
| String | MAC address of the STB. |
| String | Friendly STB name. |
| Array of strings | List of tag names associated with the STB. |
status | String | Current STB status: Never, Offline, Warning, Standby, Online. |
channelId | UUID | Internal ID of currently active resource. |
channelName | String | Display name of currently viewed resource (e.g., asset title or source name). |
channelType | String | Type of currently viewed resource: asset, source, session. |
lastAcceptedUpdate | Number | Epoch timestamp (ms), designates the time that current status values were recorded from the STB. |
lastConnectedAt | Number | Epoch timestamp(ms), designates the most recent time that device was confirmed to be connected to the server. |
muted | Boolean | Flag indicating volume muted or unmuted, independent of volume setting. |
standby | Boolean | Flag indicating STB is in standby (off but connected and in service). |
volume | Float | Current volume, independent of mute setting. Valid range 0.00-1.00. |