property

set property sets an individual configuration property on one or more devices, addressed by its path within the device object.

Command Type	SDVoE
Minimum Version	2.x.x

Usage

set <target> property <key> <value>

Arguments

Argument	Required	Description
target	Yes	Device ID of a single device, or a device group (ALL, ALL_TX, ALL_RX).
key	Yes	Path to a configurable property inside the device object. See Key syntax.
value	Yes	A value of the type appropriate for that property.

Key syntax

The key is a path referring to a child object inside the device object, starting at its root:

• The key starts with the name of one of the root members of the device object.
• Child objects are accessed by appending a period (.) followed by the child object name.
• Array elements are accessed by appending an array selector in square brackets. An array selector is a name and an index separated by a colon, e.g. [HDMI_ENCODER:0]. The matched element is the one whose type or name member (checked in that order) matches the name, and whose index member matches the index.

Configurable properties

The available device, stream, and node properties are documented in the device object reference:

Property	Reference section
Device Configuration	Device Configuration
Stream Configuration	Stream Configuration
Stereo Audio Input/Output	Stereo Audio Input/Output
Stereo Audio Output	Stereo Audio Output
Frame Buffer	Frame Buffer
CEC	CEC
Color Generator	Color Generator
HDMI Audio	HDMI Audio
HDMI Decoder	HDMI Decoder
HDMI Encoder	HDMI Encoder
Multi Channel Input	Multi Channel Input
Multi Channel Output	Multi Channel Output
Network Port	Network Port
Network Switch	Network Switch
Scaler	Scaler
UART	UART
USB Extender (USB 2.0)	USB Extender (legacy: Icron USB Extender)
Video Compressor	Video Compressor
Video Decompressor	Video Decompressor

Examples

Rename a device
set 341B22F00158 property configuration.device_name Main Monitor

Return value

set 341B22F00158 property configuration.device_name Main Monitor
{
  "status": "PROCESSING",
  "request_id": 57,
  "result": null,
  "error": null
}

Errors

Error	Cause
ILLEGAL_ARGUMENT	The target is not a valid device ID or group name
DEVICE_TYPE	The property, or the chosen value, is not supported by the target device

Notifications

set 341B22F00158 property configuration.device_name Main Monitor
{
  "status": "NOTIFICATION",
  "request_id": null,
  "result": {
    "events": [
      {
        "device_id": "341b22f00158",
        "device_name": "Main Monitor",
        "event_id": 96899,
        "event_type": "SETTINGS_CHANGED",
        "timestamp": 1690742766,
        "request_id": 96900
      }
    ]
  },
  "error": null
}

REST API

Endpoint type	SDVoE API command, forwarded to the Control Server
Address	/api/device/{target}
Role	Governed by the device lock rather than by a DisplayNet role

POST /api/device/{target}

{
  "op": "set:property",
  "key": "String",
  "value": "Varies"
}

Values labeled with a type name such as String or Integer are placeholders, not literal text. Replace them with actual values; fields marked (optional) can be omitted.

{target} takes a DisplayNet device name as readily as a device ID, and a locked device refuses a mutating operation. See SDVoE API operations for what DisplayNet adds to these calls.

See also

• Device Object: the property paths this command addresses
• query: read one property back without pulling the whole device
• config: DisplayNet settings, which persist where a device property does not