device_opcode_mgr_add
Back to SOAP Architecture Method Reference
Description
The device_opcode_mgr_add method adds a device control (for example, volume adjustment) to a display unit on your domain.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| device_opcode_type_id | The unique ID# of the device control type. | bstypes:ResourceId | R |
| device_type |
The device type:
|
bstypes:DeviceType | R |
| domain_id |
The unique ID# of your domain. |
bstypes:ResourceId | R |
| name | The name of the device control. | string | R |
| parent_id | The unique ID# of the display unit. | bstypes:ResourceId | R |
| value | The value of the device control, for example, volume = "77". | string | R |
| attributes | The attributes of the device control. | string | O |
| com_port_id | The unique ID# of the communication port. | bstypes:ResourceId | O |
| 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 Control 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 | O |
| end_time | The end time of the device control time span. | bstypes:SimpleTime | O |
| frequency | The value of the device control frequency. | bstypes:NullableInt | O |
| playback_state |
The playback state:
|
bstypes:PlaybackState | O |
| quiet_time | If applicable, the scheduled quiet time of the device control. | bstypes:NullableInt | O |
| start_time | The start time of the device control time span. | bstypes:SimpleTime | O |
| tcp_host | The TCP host information. | string | O |
| tcp_port | The TCP communication port. | int | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the device control. | bstypes:ResourceId | R |