Commands

🎛️ Commands

All command modules for device control and API operations.

🎛️ API Endpoint Commands

APIEndpointCommands

APIEndpointCommands(client)

config_set_session_alias async

config_set_session_alias(mode: Literal['on', 'off']) -> bool

Configure Alias mode for API responses or notifications from NHD-CTL

Parameters:

Name	Type	Description	Default
mode	Literal['on', 'off']	Alias mode setting on: API responses and notifications will reference the endpoint by Alias off: API responses and notifications will reference the endpoint by hostname	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-000-CTL, NHD-CTL-PRO

Notes

New session default: on

🎛️ API Notifications

APINotificationsCommands

APINotificationsCommands(client)

config_set_device_cec_notify async

config_set_device_cec_notify(state: Literal['on', 'off'], devices: str | list[str] | Literal['ALL_DEV', 'ALL_TX', 'ALL_RX']) -> bool

Enable or disable the CEC API notifications

Parameters:

Name	Type	Description	Default
state	Literal['on', 'off']	Notification state on: Enable CEC API notifications off: Disable CEC API notifications	required
devices	str | list[str] | Literal['ALL_DEV', 'ALL_TX', 'ALL_RX']	Device reference or bulk selector TX: Encoder reference (alias or hostname) RX: Decoder reference (alias or hostname) bulk: Multiple devices ALL_DEV: All endpoints ALL_TX: All encoders ALL_RX: All decoders	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX

Notes

Some API notifications can be suppressed to remove large amounts of data being sent to the 3^rd-party control system.

🎛️ API Query Commands

APIQueryCommands

APIQueryCommands(client)

config_get_version async

config_get_version() -> Version

Query NHD-CTL version

Returns:

Name	Type	Description
Version	Version	Parsed version information

Command applies to

NHD-000-CTL, NHD-CTL-PRO

config_get_ipsetting async

config_get_ipsetting() -> IpSetting

Query NHD-CTL "AV" port network interface details

Returns:

Name	Type	Description
IpSetting	IpSetting	Parsed IP setting information

Command applies to

NHD-000-CTL, NHD-CTL-PRO

Notes

Values can be assigned using the NetworkHD Console application. Default gateway values will be listed but might not be active for the interface. The NHD-CTL can only have one active gateway IP. The interface with the disabled gateway will list gw as 0.0.0.0

config_get_ipsetting2 async

config_get_ipsetting2() -> IpSetting

Query NHD-CTL "CONTROL" port network interface details

Returns:

Name	Type	Description
IpSetting	IpSetting	Parsed IP setting information

Command applies to

NHD-000-CTL, NHD-CTL-PRO

Notes

Values can be assigned using the NetworkHD Console application. Default gateway values will be listed but might not be active for the interface. The NHD-CTL can only have one active gateway IP. The interface with the disabled gateway will list gw as 0.0.0.0

config_get_devicelist async

config_get_devicelist() -> list[str]

Query online endpoint names

Returns:

Type	Description
list[str]	list[str]: List of device names (aliases or hostnames)

Raises:

Type	Description
ValueError	If devicelist response format is invalid

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

This will not return offline device names.

config_get_devicejsonstring async

config_get_devicejsonstring() -> dict[str, Any]

Query general information for all TX or RX saved in the NHD-CTL

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Parsed JSON device information

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Refer to Appendix A for further JSON format response data information.

config_get_name async

config_get_name(device: str | None = None) -> EndpointAliasHostname | list[EndpointAliasHostname]

Query endpoint Alias and Hostname

Parameters:

Name	Type	Description	Default
device	str | None	Optional device reference (alias or hostname)	None

Returns:

Type	Description
EndpointAliasHostname | list[EndpointAliasHostname]	EndpointAliasHostname | list[EndpointAliasHostname]: Parsed alias/hostname information

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Alias may be null if the endpoint has not had the default Alias changed using the NetworkHD Console utility.

config_get_device_info async

config_get_device_info(device: str | None = None) -> dict[str, Any]

Query TX or RX device working parameters

Parameters:

Name	Type	Description	Default
device	str | None	Optional device reference (TX or RX alias/hostname)	None

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Parsed device information

Raises:

Type	Description
DeviceQueryError	If device is not found or returns an error

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Refer to Appendix A for further JSON format response data information.

config_get_device_status async

config_get_device_status(device: str | None = None) -> dict[str, Any]

Query TX or RX device real-time status

Parameters:

Name	Type	Description	Default
device	str | None	Optional device reference (TX or RX alias/hostname)	None

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Parsed device status information

Raises:

Type	Description
DeviceQueryError	If device is not found or returns an error

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Refer to Appendix A for further JSON format response data information.

matrix_get async

matrix_get(rx_devices: list[str] | None = None) -> Matrix

Query RX assignments where using all primary media streams

Parameters:

Name	Type	Description	Default
rx_devices	list[str] | None	Optional list of RX device references (alias or hostname)	None

Returns:

Name	Type	Description
Matrix	Matrix	Parsed matrix information

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

The RX assignment will show NULL if: 1) The RX is in a default state and has not yet been assigned a TX 2) The RX has been assigned NULL using the matrix set command found in section 6.1 – Stream Matrix Switching – All Media 3) The RX has been assigned discrete media streams. E.g. using the matrix video set, matrix audio set commands found in section 6 – Media Stream Matrix Switch Commands The response does not return assignments for RXs using Multiview.

matrix_video_get async

matrix_video_get(rx_devices: list[str] | None = None) -> MatrixVideo

Query RX stream assignments for video output

Parameters:

Name	Type	Description	Default
rx_devices	list[str] | None	Optional list of RX device references (alias or hostname)	None

Returns:

Name	Type	Description
MatrixVideo	MatrixVideo	Parsed matrix video information

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

The RX assignment will show NULL if: 1) The RX is in a default state and has not yet been assigned a TX 2) The RX has been assigned NULL using the matrix set, matrix video set command found in section 6 – Media Stream Matrix Switch Commands The response does not return assignments for RXs using Multiview.

matrix_audio_get async

matrix_audio_get(rx_devices: list[str] | None = None) -> MatrixAudio

Query RX stream assignments for HDMI audio output

Parameters:

Name	Type	Description	Default
rx_devices	list[str] | None	Optional list of RX device references (alias or hostname)	None

Returns:

Name	Type	Description
MatrixAudio	MatrixAudio	Parsed matrix audio information

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

The RX assignment will show NULL if: 1) The RX is in a default state and has not yet been assigned a TX 2) The RX has been assigned NULL using the matrix set, matrix audio set command found in section 6 – Media Stream Matrix Switch Commands The response does not return assignments for RXs using Multiview.

matrix_audio2_get async

matrix_audio2_get(rx_devices: list[str] | None = None) -> MatrixAudio2

Query RX stream assignments for analog audio output

Parameters:

Name	Type	Description	Default
rx_devices	list[str] | None	Optional list of RX device references (alias or hostname)	None

Returns:

Name	Type	Description
MatrixAudio2	MatrixAudio2	Parsed matrix audio2 information

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

The RX assignment will show NULL if: 1) The RX is in a default state and has not yet been assigned a TX 2) The RX has been assigned NULL using the matrix set, matrix audio2 set command found in section 6 – Media Stream Matrix Switch Commands Note that while an assignment may be made to a TX, the audio path may not be set in the RX. See the config set device audio2source command found in section 7.2 – Port Switching - Audio The response does not return assignments for RXs using Multiview.

matrix_audio3_get async

matrix_audio3_get(rx_device: str | None = None, tx_device: str | None = None) -> MatrixAudio3

Query RX stream assignments for ARC

Parameters:

Name	Type	Description	Default
rx_device	str | None	Optional RX device reference (alias or hostname)	None
tx_device	str | None	Optional TX device reference (alias or hostname)	None

Returns:

Name	Type	Description
MatrixAudio3	MatrixAudio3	Parsed matrix audio3 information

Command applies to

NHD-500-TX, NHD-500-RX

matrix_usb_get async

matrix_usb_get(rx_devices: list[str] | None = None) -> MatrixUsb

Query RX stream assignments for USB

Parameters:

Name	Type	Description	Default
rx_devices	list[str] | None	Optional list of RX device references (alias or hostname)	None

Returns:

Name	Type	Description
MatrixUsb	MatrixUsb	Parsed matrix USB information

Command applies to

NHD-110-TX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX

Notes

The RX assignment will show NULL if: 1) The RX is in a default state and has not yet been assigned a TX 2) The RX has been assigned NULL using the matrix set, matrix usb set command found in section 6 – Media Stream Matrix Switch Commands

matrix_infrared_get async

matrix_infrared_get(rx_devices: list[str] | None = None) -> MatrixInfrared

Query RX stream assignments for infrared

Parameters:

Name	Type	Description	Default
rx_devices	list[str] | None	Optional list of RX device references (alias or hostname)	None

Returns:

Name	Type	Description
MatrixInfrared	MatrixInfrared	Parsed matrix infrared information

Command applies to

NHD-110-TX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX

Notes

The RX assignment will show NULL if: 1) The RX is in a default state and has not yet been assigned a TX 2) The RX has been assigned NULL using the matrix set, matrix infrared set command found in section 6 – Media Stream Matrix Switch Commands

matrix_infrared2_get async

matrix_infrared2_get(devices: list[str] | None = None) -> MatrixInfrared2

Query TX or RX stream assignments for infrared receiver port

Parameters:

Name	Type	Description	Default
devices	list[str] | None	Optional list of device references (TX or RX alias or hostname)	None

Returns:

Name	Type	Description
MatrixInfrared2	MatrixInfrared2	Parsed matrix infrared2 information

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

The endpoint IR receiver assignment will show NULL if: 1) The endpoint is in a default state and has not yet been assigned a TX 2) The endpoint IR receiver has been assigned NULL using the matrix set, matrix infrared2 set command found in section 6 – Media Stream Matrix Switch Commands

matrix_serial_get async

matrix_serial_get(rx_devices: list[str] | None = None) -> MatrixSerial

Query RX stream assignments for RS-232

Parameters:

Name	Type	Description	Default
rx_devices	list[str] | None	Optional list of RX device references (alias or hostname)	None

Returns:

Name	Type	Description
MatrixSerial	MatrixSerial	Parsed matrix serial information

Command applies to

NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX

Notes

The RX assignment will show NULL if: 1) The RX is in a default state and has not yet been assigned a TX 2) The RX has been assigned NULL using the matrix set, matrix serial set command found in section 6 – Media Stream Matrix Switch Commands

matrix_serial2_get async

matrix_serial2_get(devices: list[str] | None = None) -> MatrixSerial2

Query TX or RX stream assignments for RS-232 port

Parameters:

Name	Type	Description	Default
devices	list[str] | None	Optional list of device references (TX or RX alias or hostname)	None

Returns:

Name	Type	Description
MatrixSerial2	MatrixSerial2	Parsed matrix serial2 information

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

The endpoint RS-232 port assignment will show NULL if: 1) The endpoint is in a default state and has not yet been assigned a TX 2) The endpoint IR receiver has been assigned NULL using the matrix set, matrix serial2 set command found in section 6 – Media Stream Matrix Switch Commands

scene_get async

scene_get() -> VideoWallSceneList

Query 'standard video wall' Scene list

Returns:

Name	Type	Description
VideoWallSceneList	VideoWallSceneList	Parsed video wall scene list

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Video wall names are given to physical video wall arrays when created in the NetworkHD Console software utility. Scene names are given to Scenes when created in the NetworkHD Console software utility.

vw_get async

vw_get() -> VideoWallLogicalScreenList

Query 'standard video wall' logical screen list

Returns:

Name	Type	Description
VideoWallLogicalScreenList	VideoWallLogicalScreenList	Parsed video wall logical screen list

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Video wall names are given to physical video wall arrays when created in the NetworkHD Console software utility. Scene names are given to Scenes when created in the NetworkHD Console software utility. Logical screen names are given to logical screens when created in the NetworkHD Console software utility.

wscene2_get async

wscene2_get() -> VideowallWithinWallSceneList

Query 'videowall within a wall' Scene list

Returns:

Name	Type	Description
VideowallWithinWallSceneList	VideowallWithinWallSceneList	Parsed videowall within wall scene list

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Video wall names are given to physical video wall arrays when created in the NetworkHD Console software utility. Scene names are given to Scenes when created in the NetworkHD Console software utility.

mscene_get async

mscene_get(rx: str | None = None) -> PresetMultiviewLayoutList

Query preset Multiview layout list

Parameters:

Name	Type	Description	Default
rx	str | None	Optional decoder reference (alias or hostname)	None

Returns:

Name	Type	Description
PresetMultiviewLayoutList	PresetMultiviewLayoutList	Parsed preset multiview layout list

Command applies to

NHD-220-RX, NHD-250-RX NHD-0401-MV NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Multiview layout names are given to preset layouts when they are created. These are listed and selected in NetworkHD Console.

mview_get async

mview_get(rx: str | None = None) -> CustomMultiviewLayoutList

Query custom Multiview layout list

Parameters:

Name	Type	Description	Default
rx	str | None	Optional decoder reference (alias or hostname)	None

Returns:

Name	Type	Description
CustomMultiviewLayoutList	CustomMultiviewLayoutList	Parsed custom multiview layout list

Command applies to

NHD-220-RX, NHD-250-RX

Notes

tile: Use for non-overlapping tile layouts overlay: Use for overlapping tile layouts fit: Scales source to fit window without distortion stretch: Scales source to fit window completely

🔊 Audio Output

AudioOutputCommands

AudioOutputCommands(client)

config_set_device_audio_volume_analog async

config_set_device_audio_volume_analog(level: Literal['up', 'down', 'mute', 'unmute'], device: str) -> bool

Alter the analog audio volume from a TX or RX

Parameters:

Name	Type	Description	Default
level	Literal['up', 'down', 'mute', 'unmute']	Volume command up: Increase the audio volume level down: Decrease the audio volume level mute: Mute the audio output unmute: Unmute the audio output	required
device	str	Device reference TX: Encoder reference (alias or hostname) RX: Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX/RX, NHD-100-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-TX, NHD-400-RX

Notes

NetworkHD 400 Series endpoints only support volume up and volume down commands and not the mute and unmute commands. NetworkHD 100/200 Series endpoints only support mute and unmute and not the volume up and down commands. The factory default volume level for a NetworkHD endpoint is maximum volume level (unmuted).

📋 Connected Device Control

ConnectedDeviceControlCommands

ConnectedDeviceControlCommands(client)

config_set_device_sinkpower async

config_set_device_sinkpower(power: Literal['on', 'off'], rx: str | list[str]) -> bool

Send "power" proxy command for device attached to RX

Parameters:

Name	Type	Description	Default
power	Literal['on', 'off']	Power state on: Power on proxy command off: Power off proxy command	required
rx	str | list[str]	Single decoder reference or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-100-RX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Power on and power off commands are defined as either CEC, RS-232 or both within NetworkHD Console. By default, power commands are disabled on each endpoint. Power commands can be specified uniquely for each endpoint.

config_set_device_cec async

config_set_device_cec(command_type: Literal['onetouchplay', 'standby'], rx: str | list[str]) -> bool

Send CEC proxy command for device attached to RX

Parameters:

Name	Type	Description	Default
command_type	Literal['onetouchplay', 'standby']	CEC command onetouchplay: CEC power on proxy command standby: CEC power off proxy command	required
rx	str | list[str]	Single decoder reference or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-100-RX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

CEC power on and power off commands are defined within the NetworkHD Console. By default, CEC power commands will use the default CEC data commands. For details on the default CEC commands, see the NetworkHD Technical Reference Guide. Custom CEC power on and power off commands can be set within the NetworkHD Console to replace the default CEC commands. Unlike config set device sinkpower, the config set device cec command cannot be disabled in the NetworkHD Console and will always generate data from the decoder.

cec async

cec(cecdata: str, rx: str) -> bool

Send custom CEC command to device attached to RX

Parameters:

Name	Type	Description	Default
cecdata	str	CEC data bytes in hex format	required
rx	str	Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-100-RX, NHD-200-RX, NHD-210-RX, NHD-250-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

CEC data bytes are in hexadecimal notation with no space separation between bytes.

infrared async

infrared(irdata: str, device: str) -> bool

Send custom infrared command to device attached to RX or TX

Parameters:

Name	Type	Description	Default
irdata	str	Infrared command data	required
device	str	Device reference TX: Encoder reference (alias or hostname) RX: Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

NHD-400 & 600 series require infrared data in Pronto CCF Hex format. NHD-110 series FW v6.0.xx requires infrared data in Global Cache format. FW v7.0.xx requires Pronto Hex format.

serial async

serial(baud: int, bits: Literal[6, 7, 8], parity: Literal['o', 'e', 'n'], stop: Literal[1, 2], cr: bool, lf: bool, hex_format: bool, data: str, device: str) -> bool

Send custom RS-232 command to device attached to RX or TX

    Args:
        baud: Baud rate
            2400, 4800, 9600, 19200, 38400, 57600, 115200
        bits: Number of data bits
            6, 7, 8
        parity: Parity bit
            o: odd
            e: even
            n: none
        stop: Number of stop bits
            1, 2
        cr: Append carriage return delimiter (

)(CR) True: on False: off lf: Append line feed delimiter ( )(LF) True: on False: off hex_format: Data format True: Hexadecimal format False: ASCII format data: RS-232 command data device: Device reference TX: Encoder reference (alias or hostname) RX: Decoder reference (alias or hostname)

    Returns:
        bool: True if command was successful

    Command applies to:
        NHD-110-TX/RX, NHD-100-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX
        NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX
        NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

    Notes:
        Where specified, delimiters are appended to the end of the transmitted data.
        Delimiters cannot be included in command data (data) when using ASCII format e.g.

or are not escaped and sent literally as ASCII. All hex data byte values are supported when using hexadecimal command data format (00 through FF) and are space-separated.

📋 Device Port Switch

DevicePortSwitchCommands

DevicePortSwitchCommands(client)

config_set_device_videosource async

config_set_device_videosource(tx: str, source: Literal['auto', 'hdmi', 'dp']) -> bool

Switch TX video input port

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
source	Literal['auto', 'hdmi', 'dp']	Video input port auto: Automatic selection (default) hdmi: HDMI port dp: DisplayPort port	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-600-TX

config_set_device_info_video_source_switch async

config_set_device_info_video_source_switch(source: Literal['hdmi', 'usb-c', 'none'], tx: str) -> bool

Switch TX video input port

Parameters:

Name	Type	Description	Default
source	Literal['hdmi', 'usb-c', 'none']	Video input port hdmi: HDMI port usb-c: USB-C port none: Audio only(NHD-500-IW-TX)	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-510-TX, NHD-500-IW-TX

config_set_device_audiosource async

config_set_device_audiosource(rx: str, source: Literal['hdmi', 'dmix', 'analog']) -> bool

Switch RX HDMI audio output port to a discrete audio stream from an assigned TX

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
source	Literal['hdmi', 'dmix', 'analog']	Assigned encoder's audio stream hdmi: HDMI audio stream (default) dmix: 2ch downmix HDMI audio stream analog: Analog port stream	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Where an encoder offers multiple audio streams, a decoder will switch to the audio stream on that encoder defined by this command. This remains the stream selection when assigning a different encoder using the Media Stream Matrix Switch commands found in section 6 – Media Stream Matrix Switch Commands.

config_set_device_audio2source async

config_set_device_audio2source(rx: str, stream: Literal['analog', 'dmix']) -> bool

Switch RX analog audio output port to a discrete audio source

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
stream	Literal['analog', 'dmix']	Audio source analog: Assigned encoder's analog audio stream (default) dmix: 2ch downmix of the RX HDMI audio output	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Where analog is selected, the decoder analog audio output port joins with the assigned encoder analog audio input port. This remains the stream selection and will assign to a different encoder when using the matrix set commands found in section 6.1 – Stream Matrix Switching – All Media or the matrix audio2 set commands found in section 6.2 – Stream Matrix Switching – Audio Stream Breakaway. The decoder analog output port will NOT assign to a different encoder when using the discrete HDMI audio matrix audio set command, found in section 6.2 – Stream Matrix Switching – Audio Stream Breakaway. Where dmix is selected, the decoder analog audio output port always follows the decoder HDMI audio output. The decoder analog audio output port offers 2 channel downmixing of up to 8 channel PCM audio.

config_set_device_audio_input_type async

config_set_device_audio_input_type(source: Literal['auto', 'hdmi', 'analog'], tx: str) -> bool

Switch audio input port on NHD-500-DNT-TX for main audio stream

Parameters:

Name	Type	Description	Default
source	Literal['auto', 'hdmi', 'analog']	Video input port auto: Automatic selection (default) hdmi: HDMI port analog: 3.5mm port	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-500-DNT-TX

config_set_device_info_dante_audio_input async

config_set_device_info_dante_audio_input(source: Literal['hdmi', 'analog'], tx: str) -> bool

Switch audio input port on NHD-500-DNT-TX for Dante stream

Parameters:

Name	Type	Description	Default
source	Literal['hdmi', 'analog']	Video input port hdmi: HDMI port (default) analog: 3.5mm port	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-500-DNT-TX

config_set_device_info_km_over_ip_enable async

config_set_device_info_km_over_ip_enable(enable: Literal['on', 'off'], device: str) -> bool

Configure USB working mode for endpoint

Parameters:

Name	Type	Description	Default
enable	Literal['on', 'off']	USB mode on: Automatic KMoIP mode enabled (default) off: KMoIP mode disabled – Use USBoIP mode	required
device	str	Device reference TX: Encoder reference (alias or hostname) RX: Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-400-TX, NHD-400-RX

Notes

When automatic KMoIP mode is enabled on an RX, this mode will be used when the RX detects a connected device that uses a USB HID Class (Base Class 03). When automatic KMoIP mode is enabled on a TX, this will prompt a connected device to enumerate a composite HID device. For more detail on the USB operating modes, please refer to the NetworkHD Technical Reference Guide.

🔀 Media Stream Matrix Switch

MediaStreamMatrixSwitchCommands

MediaStreamMatrixSwitchCommands(client)

matrix_set async

matrix_set(tx: str, rx: str | list[str]) -> bool

Assign all primary TX media streams to RX(s)

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-120-TX/RX, NHD-120-IW-TX, NHD-124-TX, NHD-150-RX, NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX NHD-400-TX/RX, NHD-400-E-TX/RX, NHD-400-DNT-TX, NHD-400-IW-TX, NHD-500-TX/RX, NHD-500-E-TX/RX, NHD-500-DNT-TX, NHD-500-IW-TX, NHD-510-TX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

matrix set commands do not apply to Multiview, only decoders. See section 11- Multiview

matrix_set_null async

matrix_set_null(rx: str | list[str]) -> bool

Unassign all primary media streams from RX

Parameters:

Name	Type	Description	Default
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-120-RX, NHD-110-RX, NHD-100-RX, NHD-200-RX, NHD-210-RX NHD-500-RX, NHD-500-E-RX, NHD-400-RX, NHD-400-E-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

matrix set commands do not apply to Multiview, only decoders. See section 11- Multiview.

matrix_video_set async

matrix_video_set(tx: str, rx: str | list[str]) -> bool

Assign RX(s) video output to TX stream

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-120-TX, NHD-120-RX, NHD-110-TX, NHD-110-RX NHD-500-TX/RX, NHD-500-E-TX/RX, NHD-500-IW-TX, NHD-500-DNT-TX, NHD-510-TX, NHD-400-TX/RX, NHD-400-E-TX/RX, NHD-400-DNT-TX, NHD-400-TX-IW, NHD-0401-MV NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

matrix video set commands do not apply to Multiview, only decoders. See section 11- Multiview.

matrix_video_set_null async

matrix_video_set_null(rx: str | list[str]) -> bool

Unassign video stream from RX

Parameters:

Name	Type	Description	Default
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-120-RX, NHD-110-RX NHD-500-RX, NHD-500-E-RX, NHD-400-RX, NHD-400-E-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

matrix video set commands do not apply to Multiview, only decoders. See section 11- Multiview.

matrix_audio_set async

matrix_audio_set(tx: str, rx: str | list[str]) -> bool

Assign RX(s) HDMI audio output to TX stream

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-120-TX, NHD-120-RX, NHD-110-TX, NHD-110-RX NHD-500-TX/RX, NHD-500-E-TX/RX, NHD-500-IW-TX, NHD-500-DNT-TX, NHD-510-TX, NHD-400-TX/RX, NHD-400-E-TX/RX, NHD-400-DNT-TX, NHD-400-TX-IW NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Analog audio output on a 100, 400 & 500 Series decoder will extract the HDMI audio at the decoder. HDMI audio on a 600 Series decoder will select the TX audio stream defined using the config set device audiosource command – see section 7.2 – Port Switching – Audio. The primary HDMI or DP audio stream is the factory default setting. Analog audio output on a 600 Series decoder will output the TX primary HDMI or DP audio stream if "dmix" is set using the config set audio2source command – see section 7.2 – Port Switching – Audio. Analog audio output on a 100, 200 and 400 Series decoder will convert 2 channel PCM audio only. Analog audio output on a 600 Series decoder can also downmix up to 8 channel PCM audio. matrix audio set commands do not apply to Multiview, only decoders. See section 11- Multiview.

matrix_audio_set_null async

matrix_audio_set_null(rx: str | list[str]) -> bool

Unassign RX(s) HDMI audio output to TX stream

Parameters:

Name	Type	Description	Default
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Analog audio output on a 100, 200 and 400 Series decoder will extract the HDMI audio at the decoder. HDMI audio on a 600 Series decoder will select the TX audio stream defined using the config set device audiosource command – see section 7.2 – Port Switching – Audio. The primary HDMI or DP audio stream is the factory default setting. Analog audio output on a 600 Series decoder will output the TX primary HDMI or DP audio stream if "dmix" is set using the config set audio2source command – see section 7.2 – Port Switching – Audio. matrix audio set commands do not apply to Multiview, only decoders. See section 11- Multiview.

matrix_audio2_set async

matrix_audio2_set(tx: str, rx: str | list[str]) -> bool

Assign RX(s) analog audio output to TX analog audio stream

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Command will only be effective if "analog" is set using the config set audio2source command – see section 7.2 – Port Switching – Audio. This is the factory default setting.

matrix_audio2_set_null async

matrix_audio2_set_null(rx: str | list[str]) -> bool

Unassign RX(s) analog audio output to TX analog audio stream

Parameters:

Name	Type	Description	Default
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Command will only be effective if "analog" is set using the config set audio2source command – see section 7.2 – Port Switching – Audio. This is the factory default setting.

matrix_audio3_set async

matrix_audio3_set(rx: str, tx: str) -> bool

Assign RX(s) ARC stream to TX

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-500-TX, NHD-500-RX

matrix_usb_set async

matrix_usb_set(tx: str, rx: str | list[str]) -> bool

Assign RX(s) USB ports to TX

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX, NHD-510-TX, NHD-500-IW-TX, NHD-500-DNT-TX NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

NHD-600 devices only support a 1:1 USB communication, meaning only one RX can be linked to a TX USB host port. Multiple NHD-500-RX "USB 2.0" ports can be linked to a single TX USB host port, up to 7 devices. Command will always be effective for RX USB ports in KMoIP mode. Command will only be effective for RX USB ports in USBoIP mode if the TX has 4 or less USBoIP mode RX ports already assigned. To assign an endpoint USB mode – see section 7.3 Port Switching – USB Mode

matrix_usb_set_null async

matrix_usb_set_null(rx: str | list[str]) -> bool

Unassign RX(s) USB ports

Parameters:

Name	Type	Description	Default
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX, NHD-510-TX, NHD-500-IW-TX, NHD-500-DNT-TX NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

matrix_infrared_set async

matrix_infrared_set(tx: str, rx: str | list[str]) -> bool

Assign RX(s) infrared ports to TX

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX

Notes

Encoder to decoder(s) assignments link the IR channels in both directions - the IR receiver port on the encoder to the IR emitter port on the decoder simultaneously with the IR receiver port on the decoder to the IR emitter port on the encoder. To generate IR codes directly from an encoder or decoder using IR code Hex notation, see section 8.2 - Device Control – Custom Command Generation.

matrix_infrared_set_null async

matrix_infrared_set_null(rx: str | list[str]) -> bool

Unassign RX(s) infrared ports

Parameters:

Name	Type	Description	Default
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX, NHD-110-RX NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX

matrix_infrared2_set async

matrix_infrared2_set(device: str, mode: Literal['single', 'api', 'all'], target_device: str | None = None) -> bool

Assign RX or TX infrared receiver port to endpoint(s) or API notification

Parameters:

Name	Type	Description	Default
device	str	TX or RX device reference (alias or hostname)	required
mode	Literal['single', 'api', 'all']	Operational mode single: Assign to endpoint (requires target_device) api: Assign to API notification all: Assign to all other endpoints	required
target_device	str | None	TX or RX device reference (required for 'single' mode)	None

Returns:

Name	Type	Description
bool	bool	True if command was successful

Raises:

Type	Description
ValueError	If target_device is required but not provided for 'single' mode

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

Assignments are in one direction, from endpoint IR receiver port to endpoint IR emitter port or API notification. For details on infrared API notifications, see section 12.2 – Endpoint Notifications. To generate IR codes directly from an encoder or decoder using IR code Hex notation, see section 8.2 - Device Control – Custom Command Generation.

matrix_infrared2_set_null async

matrix_infrared2_set_null(device: str) -> bool

Unassign TX or RX infrared receiver port

Parameters:

Name	Type	Description	Default
device	str	Device reference (TX or RX alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

matrix_serial_set async

matrix_serial_set(tx: str, rx: str | list[str]) -> bool

Assign RX(s) RS-232 ports to TX

Parameters:

Name	Type	Description	Default
tx	str	Encoder reference (alias or hostname)	required
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-400-TX-IW, NHD-400-RX, NHD-500-TX, NHD-500-RX, NHD-510-TX

Notes

The RS-232 stream is a bidirectional channel. To generate RS-232 codes directly from an encoder or decoder using ASCII or Hex notation, see section 8.2 - Device Control – Custom Command Generation.

matrix_serial_set_null async

matrix_serial_set_null(rx: str | list[str]) -> bool

Unassign RX(s) RS-232 ports

Parameters:

Name	Type	Description	Default
rx	str | list[str]	Single decoder reference (alias or hostname) or list of decoder references (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-400-TX, NHD-400-RX, NHD-500-TX, NHD-500-RX, NHD-510-TX

matrix_serial2_set async

matrix_serial2_set(device: str, mode: Literal['single', 'api', 'all'], target_device: str | None = None) -> bool

Assign RX or TX RS-232 port to endpoint(s) or API notification

Parameters:

Name	Type	Description	Default
device	str	TX or RX device reference (alias or hostname)	required
mode	Literal['single', 'api', 'all']	Operational mode single: Assign to endpoint (requires target_device) api: Assign to API notification all: Assign to all other endpoints	required
target_device	str | None	TX or RX device reference (required for 'single' mode)	None

Returns:

Name	Type	Description
bool	bool	True if command was successful

Raises:

Type	Description
ValueError	If target_device is required but not provided for 'single' mode

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

Notes

The RS-232 stream is a bidirectional channel. To generate RS-232 codes directly from an encoder or decoder using ASCII or Hex notation, see section 8.2 - Device Control – Custom Command Generation.

matrix_serial2_set_null async

matrix_serial2_set_null(device: str) -> bool

Unassign TX or RX RS-232 port

Parameters:

Name	Type	Description	Default
device	str	Device reference (TX or RX alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

📺 Multiview

MultiviewCommands

MultiviewCommands(client)

mview_set_single async

mview_set_single(rx: str, tx: str, mode: Literal['tile', 'overlay'] | None = None) -> bool

Assign a single TX audio and video stream to a Multiview RX

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
tx	str	Encoder reference (alias or hostname)	required
mode	Literal['tile', 'overlay'] | None	Optional tile mode tile: Use for non-overlapping tile layouts overlay: Use for overlapping tile layouts	None

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-220-RX, NHD-250-RX

Notes

Multiview only decoders do not respond to matrix set commands found in section 6 – Media Stream Matrix Switch Commands, equivalent functions can be applied using this command. The use of tile or overlay in the command is optional and can be used where switching to/from Preset or Custom Tile layouts where a small switching delay advantage can be obtained when staying in the same mode. For NetworkHD 600, use matrix set commands found in section 6 – Media Stream Matrix Switch Commands.

mscene_active async

mscene_active(rx: str, lname: str) -> bool

Apply a preset Multiview layout to an RX

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
lname	str	Preconfigured layout name	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-220-RX, NHD-250-RX NHD-0401-MV NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Multiview layout names are given to preset layouts when they are created. These are listed and selected in NetworkHD Console. When Multiview layouts are configured, the layout tiles will have default encoders assigned to them. Layout naming for NHD-0401-MV can't be customized.

mscene_change async

mscene_change(rx: str, lname: str, tile: int, tx: str) -> bool

Change the TX for a tile within a preset Multiview layout

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
lname	str	Preconfigured layout name	required
tile	int	Tile reference	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-220-RX, NHD-250-RX NHD-0401-MV NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Command is effective immediately and does not save to the default Scene. Tile reference is the integer reference inferred to the target tile when the layout is created. This value can be referenced when configuring the layout in NetworkHD Console.

mscene_set_audio async

mscene_set_audio(rx: str, lname: str, audio_mode: Literal['window', 'separate'], target: str | int) -> bool

Change the audio mode within a preset Multiview layout

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
lname	str	Preconfigured layout name	required
audio_mode	Literal['window', 'separate']	Audio mode window: RX audio follows video for Tile separate: RX audio is assigned to TX directly	required
target	str | int	Target reference tile: Tile reference (integer) when audio_mode is "window" tx: Encoder reference (alias or hostname) when audio_mode is "separate"	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Raises:

Type	Description
ValueError	If target type doesn't match audio_mode (int for window, str for separate)

Command applies to

NHD-220-RX, NHD-250-RX

Notes

Command saves audio mode to RX and is not effective immediately. Use the mscene active command to apply the audio mode. Tile reference is the integer reference inferred to the target tile when the layout is created. This value can be referenced when configuring the layout in NetworkHD Console. For NetworkHD 600 Series, use the relevant audio commands found in section 6.3 – Stream Matrix Switching – Audio Stream Breakaway.

config_set_device_info_audio_src async

config_set_device_info_audio_src(input_source: Literal['hdmiin1', 'hdmiin2', 'hdmiin3', 'hdmiin4'], rx: str) -> bool

Change the audio source

Parameters:

Name	Type	Description	Default
input_source	Literal['hdmiin1', 'hdmiin2', 'hdmiin3', 'hdmiin4']	hdmiin1 hdmiin2 hdmiin3 hdmiin4	required
rx	str	Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-0401-MV

config_set_device_info_audio_mute async

config_set_device_info_audio_mute(audio_type: Literal['audio_mute_hdmi', 'audio_mute_av'], mute_state: Literal['mute', 'unmute'], rx: str) -> bool

Mute the audio signal

Parameters:

Name	Type	Description	Default
audio_type	Literal['audio_mute_hdmi', 'audio_mute_av']	Audio type to control audio_mute_hdmi: use for control HDMI audio signal audio_mute_av: use for control analog audio output	required
mute_state	Literal['mute', 'unmute']	Mute state mute: Mute the audio output unmute: Unmute the audio output	required
rx	str	Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-0401-MV

Notes

Using this command you can mute the HDMI audio signal or audio signal on the Analog Audio Output.

TileConfig

TileConfig(tx: str, x: int, y: int, width: int, height: int, scaling: Literal['fit', 'stretch'] = 'fit')

Configuration for a single tile in a custom multiview layout

mview_set_custom async

mview_set_custom(rx: str, mode: Literal['tile', 'overlay'], tiles: list[TileConfig]) -> bool

Apply a custom Multiview layout to an RX

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
mode	Literal['tile', 'overlay']	Layout mode tile: Use for non-overlapping tile layouts overlay: Use for overlapping tile layouts	required
tiles	list[TileConfig]	List of tile configurations	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-220-RX, NHD-250-RX

Notes

Command is effective immediately but does not save to NHD-CTL. Tile horizontal and vertical start pixels are relative to the top left canvas pixel but can be no greater that the bottom right canvas pixel. Tile size must ensure that the tile will not exceed the available pixels in the canvas. overlay mode is only supported on NetworkHD decoders that support this feature. fit scaling will fill the tile with the source video and not distort the source video, but it may result in some missing video if the aspect ratio is not matched to the tile. stretch scaling will fill the tile with the source video, but it may introduce distortion if the aspect ratio is not matched to the tile. The tile layer order follows the order in which tiles are defined. The topmost tile is the first to be defined.

mview_set_audio_custom async

mview_set_audio_custom(rx: str, tx: str) -> bool

Change the audio source within a custom Multiview layout

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-220-RX, NHD-250-RX

Notes

Command is effective immediately but does not save to NHD-CTL. Default behavior for an RX using a custom Multiview layout is to have no audio.

mscene_set_pipposition async

mscene_set_pipposition(rx: str, position: Literal[0, 1, 2, 3]) -> bool

Set the position of PiP tile

Parameters:

Name	Type	Description	Default
rx	str	Decoder reference (alias or hostname)	required
position	Literal[0, 1, 2, 3]	PiP position 0: top left 1: bottom left 2: top right 3: bottom right	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-0401-MV

📋 Reboot Reset

RebootResetCommands

RebootResetCommands(client)

set_reboot async

set_reboot() -> bool

Reboot the NHD-CTL

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command structure

config set reboot

Response structure

system will reboot now

Reboot the NHD-CTL

config set reboot

Command acknowledgment

system will reboot now

Command applies to

NHD-000-CTL, NHD-CTL-PRO

set_device_reboot async

set_device_reboot(devices: str | list[str]) -> bool

Reboot TX or RX devices

Parameters:

Name	Type	Description	Default
devices	str | list[str]	Single device reference or list of device references TX: Encoder reference (alias or hostname) RX: Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-120-TX/RX, NHD-120-IW-TX, NHD-124-TX, NHD-150-RX, NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-500-TX/RX, NHD-500-E-TX/RX, NHD-500-IW-TX, NHD-510-TX, NHD-500-DNT-TX, NHD-400-TX/RX, NHD-400-E-TX/RX, NHD-400-DNT-TX, NHD-400-TX-IW, NHD-0401-MV NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

config_set_device_restorefactory async

config_set_device_restorefactory(devices: str | list[str]) -> bool

Reset TX or RX devices

Parameters:

Name	Type	Description	Default
devices	str | list[str]	Single device reference or list of device references TX: Encoder reference (alias or hostname) RX: Decoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-120-TX/RX, NHD-120-IW-TX, NHD-124-TX, NHD-150-RX, NHD-110-TX/RX, NHD-100-TX, NHD-140-TX, NHD-100-RX, NHD-200-TX, NHD-200-RX, NHD-210-RX, NHD-220-RX, NHD-250-RX NHD-500-TX/RX, NHD-500-E-TX/RX, NHD-500-IW-TX, NHD-510-TX, NHD-500-DNT-TX, NHD-400-TX/RX, NHD-400-E-TX/RX, NHD-400-DNT-TX, NHD-400-TX-IW, NHD-0401-MV NHD-600-TX, NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX, NHD-610-TX

📺 Video Stream Text Overlay

VideoStreamTextOverlayCommands

VideoStreamTextOverlayCommands(client)

config_set_device_osd_param async

config_set_device_osd_param(text: str, position_x: int, position_y: int, text_color: str, text_size: int, tx: str) -> bool

Configure Text Overlay

Parameters:

Name	Type	Description	Default
text	str	The text to be displayed	required
position_x	int	X coordinate of text; must be value between 0~1920	required
position_y	int	Y coordinate of text; must be value between 0~1080	required
text_color	str	Color of text in hex format Red: FFFF0000 (NHD-110/140-TX) or FC00 (NHD-200-TX) White: FFFFFFFF (NHD-110/140-TX) or FFFF (NHD-200-TX) Black: FF000000 (NHD-110/140-TX) Purple: FFFF00FF (NHD-110/140-TX) Blue: FF0000FF (NHD-110/140-TX) Green: FF00FFFF (NHD-110/140-TX) or BB00 (NHD-200-TX) Yellow: FF00 (NHD-200-TX) Gray: BDEF (NHD-200-TX)	required
text_size	int	Value between 1-4	required
tx	str	Hostname or alias of encoder	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX, NHD-140-TX, NHD-200-TX

Notes

NHD-200-TX hex format uses 4 characters vs 8 with NHD-110 & 140-TX. Use the format below if using an NHD-200-TX: Red: FC00 White: FFFF Yellow: FF00 Gray: BDEF Green: BB00

config_set_device_osd async

config_set_device_osd(state: Literal['on', 'off'], tx: str) -> bool

Enable/Disable Text Overlay

Parameters:

Name	Type	Description	Default
state	Literal['on', 'off']	Overlay state on: Enable text overlay off: Disable text overlay	required
tx	str	Hostname or alias of encoder	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-TX, NHD-140-TX, NHD-200-TX

get_color_hex staticmethod

get_color_hex(color: Literal['red', 'white', 'black', 'purple', 'blue', 'green', 'yellow', 'gray'], device_type: Literal['nhd110_140', 'nhd200'] = 'nhd110_140') -> str

Get hex color code for common colors based on device type

Parameters:

Name	Type	Description	Default
color	Literal['red', 'white', 'black', 'purple', 'blue', 'green', 'yellow', 'gray']	Color name	required
device_type	Literal['nhd110_140', 'nhd200']	Device type nhd110_140: For NHD-110/140-TX nhd200: For NHD-200-TX	'nhd110_140'

Returns:

Type	Description
str	Hex color code string

Raises:

Type	Description
ValueError	If the specified color is not available for the device type

📺 Video Wall

VideoWallCommands

VideoWallCommands(client)

scene_active async

scene_active(videowall: str, scene: str) -> bool

Apply a 'standard video wall' Scene to a physical video wall array

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
scene	str	Preconfigured Scene name	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Video wall names are given to physical video wall arrays when created in the NetworkHD Console software utility. When video wall arrays are created in Console, the physical displays will have decoders assigned to them. Scene names are given to Scenes when created in the NetworkHD Console software utility. When scenes are created in Console, the decoders will have default encoders or no encoder (NULL) assigned to them.

scene_set async

scene_set(videowall: str, scene: str, x: int, y: int, tx: str) -> bool

Change the encoder assigned to a single decoder in a 'standard video wall' Scene

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
scene	str	Preconfigured Scene name	required
x	int	Decoder's horizontal position in display array	required
y	int	Decoder's vertical position in display array	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Command commits and saves change to Scene but does not apply live until using the scene active command. Command will only be effective for decoders that are not part of a Logical Screen element in a Scene. Horizontal and vertical positions are relative to the top left display.

vw_change async

vw_change(videowall: str, scene: str, lscreen: str, tx: str) -> bool

Change the encoder assigned to a Logical Screen in a 'standard video wall' Scene

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
scene	str	Preconfigured Scene name	required
lscreen	str	Preconfigured Logical Screen name	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Command will be effective immediately for the Logical Screen and will not save to Scene. Following with a scene active command will reset the Logical Screen to the default encoder for the Scene.

wscene2_active async

wscene2_active(videowall: str, wscene: str) -> bool

Apply a 'video wall within a wall' Scene to a physical video wall array

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
wscene	str	Preconfigured Scene name	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Video wall names are given to physical video wall arrays when created in the NetworkHD Console software utility. When video wall arrays are created in the NetworkHD Console, the physical displays will have decoders assigned to them. Scene names are given to Scenes when created in the NetworkHD Console software utility. When scenes are created in the NetworkHD Console, the decoders will have no encoder (NULL) assigned to them.

wscene2_window_open async

wscene2_window_open(videowall: str, wscene: str, wname: str, x: int, y: int, h: int, v: int, tx: str) -> bool

Open a window within a 'video wall within a wall' Scene

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
wscene	str	Preconfigured Scene name	required
wname	str	Unique window name	required
x	int	Window's top left decoder horizontal position in display array	required
y	int	Window's top left decoder vertical position in display array	required
h	int	Window's horizontal size in number of displays	required
v	int	Window's vertical size in number of displays	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Positions are ZERO INDEXED in this command, e.g. top-left display is X = 0, Y = 0 Command is effective immediately and does not save to the default Scene. Horizontal and vertical positions are relative to the top left display. Window names must be unique to the command and are not defined using the NetworkHD Console software utility.

wscene2_window_close async

wscene2_window_close(videowall: str, wscene: str, wname: str) -> bool

Close a window within a 'video wall within a wall' Scene

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
wscene	str	Preconfigured Scene name	required
wname	str	Unique window name	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Command is effective immediately and does not save to the default Scene.

wscene2_window_change async

wscene2_window_change(videowall: str, wscene: str, wname: str, tx: str) -> bool

Change the TX for an open window within a 'video wall within a wall' Scene

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
wscene	str	Preconfigured Scene name	required
wname	str	Unique window name	required
tx	str	Encoder reference (alias or hostname)	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Command is effective immediately and does not save to the default Scene. Window names must use names of windows currently open in the Scene.

wscene2_window_adjust async

wscene2_window_adjust(videowall: str, wscene: str, wname: str, x: int, y: int, h: int, v: int) -> bool

Reposition and resize an open window within a 'video wall within a wall' Scene

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
wscene	str	Preconfigured Scene name	required
wname	str	Unique window name	required
x	int	Window's top left decoder horizontal position in display array	required
y	int	Window's top left decoder vertical position in display array	required
h	int	Window's horizontal size in number of displays	required
v	int	Window's vertical size in number of displays	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Command is effective immediately and does not save to the default Scene. Horizontal and vertical positions are relative to the top left display. Window names must use names of windows currently open in the Scene.

wscene2_window_move async

wscene2_window_move(videowall: str, wscene: str, wname: str, layer: Literal['up', 'down', 'top', 'bottom']) -> bool

Change the layer for an open window within a 'video wall within a wall' Scene

Parameters:

Name	Type	Description	Default
videowall	str	Preconfigured video wall name	required
wscene	str	Preconfigured Scene name	required
wname	str	Unique window name	required
layer	Literal['up', 'down', 'top', 'bottom']	Window's layer reference up: Move window up one layer down: Move window down one layer top: Move window to top layer bottom: Move window to bottom layer	required

Returns:

Name	Type	Description
bool	bool	True if command was successful

Command applies to

NHD-110-RX, NHD-210-RX NHD-400-RX, NHD-500-RX NHD-600-RX, NHD-600-TRX, NHD-600-TRXF, NHD-610-RX

Notes

Command is effective immediately and does not save to the default Scene. Window names must use names of windows currently open in the Scene.