DeviceSpecific

The DeviceSpecific object is used to get and set data for various device‑specific properties for the DM NVX device.

Syntax

  • HTTP Methods: GET, POST
  • Base URI: /Device/DeviceSpecific/

Properties

Property Name Parent Path Version Description Type Methods Validation Rules
DeviceSpecific /Device/ 2.0.0 The top‑level DeviceSpecific object. Devices will only support a subset of the properties defined here. Object N/A N/A
LedsEnabled /Device/DeviceSpecific/ 2.0.0 Indicates whether device LEDs are enabled (true) or disabled (false). Boolean GET, POST N/A
DeviceMode /Device/DeviceSpecific/ 2.0.0 The device operational mode. String GET, POST "Transmitter", "Receiver"
DeviceReady /Device/DeviceSpecific/ 2.0.0 Indicates the device is ready for use (true) or not (false). Boolean GET N/A
AudioMode /Device/DeviceSpecific/ 2.0.0 The device audio mode. String GET, POST "Insert", "Extract"
AutoInitiationMode /Device/DeviceSpecific/ 2.0.0 Indicates whether the device is set to auto initiation mode (true) or not (false). Boolean GET, POST N/A
AudioSource /Device/DeviceSpecific/ 2.0.0 The device audio source. String GET, POST "AudioFollowsVideo", "Input1", "Input2", "AnalogAudio", "PrimaryStreamAudio", "SecondaryStreamAudio"
VideoSource /Device/DeviceSpecific/ 2.0.0 The device video mode. String GET, POST "None", "Input1","Input2","Stream"
NaxAudioSource /Device/DeviceSpecific/ 2.1.0 The NAX audio source for the device. String GET, POST "None", "Auto", "Input1", "Input2", "Analog", "PrimaryAudio", "SecondaryAudio", "DanteAES67"
NaxAudioSourceOptionsName /Device/DeviceSpecific/ 2.1.0 Indicates the name of the supported Options Group. String GET N/A
NaxAudioSourceOptionsVersion /Device/DeviceSpecific/ 2.1.0 Indicates the version of the supported Options Group. String GET N/A
ActiveAudioSource /Device/DeviceSpecific/ 2.0.0 The selected audio source. String GET "AudioFollowsVideo", "Input1", "Input2", "AnalogAudio", "PrimaryStreamAudio", "SecondaryStreamAudio"
ActiveVideoSource /Device/DeviceSpecific/ 2.0.0 The selected video source. String GET "None", "Input1", "Input2", "Stream"
NaxActiveAudioSource /Device/DeviceSpecific/ 2.1.0 The active NAX audio source. String GET "None", "Auto", "Input1", "Input2", "Analog", "PrimaryAudio", "SecondaryAudio", "DanteAES67"
IsFrontPanelLockoutEnabled /Device/DeviceSpecific/ 2.1.0 Indicates whether a user can change the device mode from the physical device (true) or not (false). Boolean GET N/A
MotionDetected /Device/DeviceSpecific/ 2.4.0 Indicates the motion detected status on an input or stream. String GET 0d = No sync (no source),

1d = Motion is detected and a sync is present (for the currently selected input or stream,

2d = Still image is detected (for the currently selected input or stream,
Version /Device/DeviceSpecific/ 2.4.0 "2.0.0": Initial public release,
"2.0.1": Added LanguageSupport Object, and CourtesyNetworkPortStatus,
"2.0.2": Moved LanguageSupport Object to DeviceCapabilities, Added IsOemBoardHostLinkDetected, IsTxOutConnected,
"2.0.3": Added IsAm100JoinCompatibilityModeEnabled,
"2.0.4": Added StreamingDeviceUUID, deprecated IsTxOutConnected,
"2.1.0": Added NaxAudioSource and NaxActiveAudioSource properties. Added missed field IsFrontPanelLockoutEnabled property,
"2.4.0": Added the MotionDetected property.		 String GET N/A

Example JSON

The following example JSON uses the current object version (2.4.0).

Copy 
{
  "Device":{
    "DeviceSpecific":{
      "LedsEnabled":true,
      "DeviceMode":"Transmitter|Receiver",
      "DeviceReady":true,
      "AudioMode":"DAC|ADC",
      "AudioSource":"Automatic|Input1|Input2|Analog|PrimaryAudio|SecondaryAudio",
      "VideoSource":"None|Input1|Input2|Stream",
      "ActiveAudioSource":"Input1|Input2|Analog|PrimaryAudio|SecondaryAudio",
      "ActiveVideoSource":"None|Input1|Input2|Stream",
      "NaxAudioSource":"Input1",
      "NaxAudioSourceOptionsName":"NVX3XXNaxAudioSelection",
      "NaxAudioSourceOptionsVersion":"1.0.0",
      "NaxActiveAudioSource":"Input1",   
      "IsFrontPanelLockoutEnabled":true,
      "MotionDetected":"1d",
      "Version":"2.4.0"
    }
  }
}