Skip to main content

Nodes

A node describes one hardware module of the device, with its status and configuration.

{
"type" : String,
"index" : Integer,
"configuration" : Object,
"status" : Object,
"inputs" : [NodeInput, ...]
}
Member nameTypeDescription
typeStringType of node, which is one of the following:
STEREO_AUDIO_INPUT
STEREO_AUDIO_INPUT_OUTPUT
STEREO_AUDIO_OUTPUT
CEC
COLOR_GENERATOR
FRAME_BUFFER
FRAME_RATE_CONVERTER
HDMI_DECODER
HDMI_ENCODER
HDMI_MONITOR
LED
MULTICH_AUDIO_INPUT
MULTICH_AUDIO_OUTPUT
INFRARED_DECODER
INFRARED_ENCODER
NETWORK_INTERFACE
NETWORK_PORT
NETWORK_SWITCH
SCALER
UART
USB_HID
USB_ICRON (legacy, see USB_EXTENDER)
USB_EXTENDER
VIDEO_COMPRESSOR
VIDEO_DECOMPRESSOR
VIDEO_INPUT

Other types might be present and should be ignored.
indexIntegerIndex of the node of the given type (nodes are indexed individually by type, not necessarily contiguous)
configurationObjectNode configuration. The structure of this object varies according to the node type. See the page for each node type.
statusObjectNode status. The structure of this object varies according to the node type. See the page for each node type.
inputsArray of NodeInputArray describing how the node is connected to upstream nodes and/or subscriptions