device_opcode_mgr_list
Back to SOAP Architecture Method Reference
Description
The device_opcode_mgr_list method lists the device controls (for example, volume adjustment) associated with display units on your domain.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| domain_id | The unique ID# of your domain. | bstypes:ResourceId | R |
| parent_id | The unique ID# of the display unit to which the device control is associated. | bstypes:ResourceId | R |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the device control. | bstypes:ResourceId | R |
| name | The name of the device control. | string | R |
| active | Indicates whether or not the resource is active. | boolean | R |
| domain_id | The unique ID# of your domain. | bstypes:ResourceId | R |
| device_opcode_type_id | The unique ID# of the device control type. | bstypes:ResourceId | R |
| com_port_id | The unique ID# of the communication port. | bstypes:ResourceId | R |
| value | The value, if applicable, of the device control, for example, volume = "77". | string | R |
| frequency | The value of the device control frequency. | bstypes:NullableInt | R |
| start_time | The start time of the device control time span. | bstypes:SimpleTime | R |
| end_time | The end time of the device control time span. | bstypes:SimpleTime | R |
| quiet_time | If applicable, the scheduled quiet time of the device control. | bstypes:NullableInt | R |
| drain_bytes | Some displays will periodically fill an RS-232 command buffer with unwanted garbage bytes that need to be cleaned out. By specifying a certain amount of bytes to drain, BroadSign Player will read up to that many bytes from the screen and discard the result, creating a clean command buffer to retry the operation. | bstypes:NullableInt | R |
| on_error_device_opcode_id | The unique ID# of the device control that executes as a corrective measure if the original device control fails. | bstypes:ResourceId | R |
| action_on_error | Specifies the action to perform if an error occurs:
|
bstypes:ActionOnError | R |
| parent_id | The unique ID# of the display unit. | bstypes:ResourceId | R |
| retries | The number of retries if an error occurs on an action attempt. | unsignedInt | R |
| playback_state | The playback state:
|
bstypes:PlaybackState | R |
| attributes | The attributes of the device control. | string | R |
| tcp_host | The TCP host information. | string | R |
| tcp_port | The TCP communication port. | int | R |
| device_type | The device type:
|
bstypes:DeviceType | R |