Skip to main content

Device Object

The device object completely describes a device, including its configuration, state, and supported features. A subset of this object is returned as part of the response to the get command.

{
"device_id" : String,
"device_name" : String,
"identity" : DeviceIdentity,
"capabilities" : DeviceCapabilities,
"configuration" : DeviceConfig,
"status" : DeviceStatus,
"streams" : [StreamObject, ...],
"subscriptions" : [SubscriptionObject, ...],
"nodes" : [Node, ...]
}
Member nameTypeIncluded inDescription
device_idString(always)Device ID
device_nameString(always)Device name
identityDeviceIdentityget identity
get settings
The device's identity.
capabilitiesDeviceCapabilitiesget device
get capabilities
The device's capabilities.
configurationDeviceConfigget identity
get settings
The device's configurable settings.
statusDeviceStatusget settingsThe device's current status.
streamsArray of StreamObjectget settingsDescribes the streams of data sent on the network.
subscriptionsArray of SubscriptionObjectget settingsDescribes the streams of data received from the network.
nodesArray of Nodeget settings
get edid
The hardware modules present on the device, with their status and configuration. In a get edid response only the EDID-carrying node types appear: HDMI_DECODER and HDMI_MONITOR.