In a Space CE configuration, the AV Destinations section defines the destinations that sources are that will be available to be shared to destinations in the room.
Each AV Destination object defines information necessary to render the destination on the UI, as well as routing information.
There are multiple types of destinations:
- Displays
- Preview
- Auxiliary (Speaker Audio / Hearing Augmentation / etc.)
Configuration Properties – Common
Some AV Destination types have properties that expand upon the typical definition of an AV Definition.
Some destination types (Preview & Auxiliary) do not, and use only the common properties.
The following configuration components apply to all AV Destinations:
| Property: | Type: | Description: |
|---|---|---|
| ID | string | The unique identifier for this display. To be used to refer to this destination object in the rest of the configuration. |
| Label | string | The label that will be shown on the user interface when reprenting the destination. |
| Type | string / enum | The ‘Type’ of this destination. Used for source routing. |
| Decoder ID | string | The Device ID of the decoder device where the source’s encoder stream will be shared to. |
| Encoder ID | string | The Device ID of the encoder device that is to be routed to the decoder device defined in Decoder ID. Used for setting up and enforcing static routes. |
| Output Switch | list of objects | The list of Output Switch Objects that will be actioned when this destination is routed to. Expanded definition can be found in the following table. |
| Has Audio | boolean | Whether this destination has an audio output. |
| Shutdown Behaviour | string / enum | The action that will be triggered when the room is powered off. Destination actions listed below. |
| Source Deselection Behaviour | string / enum | The action that will be triggered when this destination has its source unrouted. Destination actions listed below. |
| Disabled On Link | boolean | Whether this destination will be disabled when this room is linked. |
Output Switch
Additionally, the output switch definition is shared across all AV Destinations.
Output switches define the switch action that will be performed every time a source is routed to a destination.
Output switches on a device of type ‘Matrix’ will only be triggered when the source that is routed to this Destination has an input switch on the same matrix device.
Output switches on a device of type ‘Switcher’ will be triggered every time this destination is routed.
Multiple output switch objects can be defined.
| Property: | Type: | Description: |
|---|---|---|
| ID | string | The unique ID of the output switch. |
| Switcher ID | string | The Device ID of the device that the output switch will be triggered on. |
| Output | string / enum | The output that the device will be switched to. |
| Type | string / enum | The type of switch that will be triggered on the device. Eg. AudioVideo / Audio / Video |
| Break Input | string / enum | The input to be recalled when the Source Deselection Behaviour is Matrix Break. Defaults to 0 when none defined. |
Destination Actions
The following are the destination actions that Source Deselection Behaviour and Shutdown Behaviour refer to.
| Destination Action: | Description: |
|---|---|
| Power Off | Powers off the display immediately. Only available for Displays. |
| Video Mute | Video mutes the display immediately. Only available for Displays. |
| Soft Off | Video mutes the display immediately, and after the defined Soft Off Delay, powers off the display.Only available for Displays. |
| Decoder Break | Clears the input stream on the decoder device defined in Decoder ID. |
| Decoder Mute | Mutes the output on the decoder device defined in Decoder ID. |
| Matrix Break | Triggers all the defined output switches with a matrix to the Break Input defined in each output switch object. |
| Matrix Mute | For each output switch defined against a matrix, mutes the output. |
Configuration Properties – Displays
In addition to the common AV Destination properties, Displays have the following available to be defined:
| Property: | Type: | Description: |
|---|---|---|
| Display ID | string | The Device ID of the display device that this destination object controls. |
| Warm Time | integer | The amount of seconds after powering on that no commands will be sent to allow the display to warm up. If left as 0, the device driver’s default will be used. |
| Cool Time | integer | The amount of seconds after powering off that no commands will be sent to allow the display to cool down. If left as 0, the device driver’s default will be used. |
| Default Input | string / enum | The device input that will be recalled every time the display is powered on or a source is routed to. Also, if the device has Enforce States set to true with Automation/State Enforcement Style set to Ce As Truth, this input will be enforced on the display. |
| Secondary Input | string / enum | The device input that will be recalled when allowing students to share to this display. (Only triggered manually via the UI, does not get actioned automatically) |
| Secondary Input Unique Audio | boolean | Whether the Secondary Input will be treated as a unique audio source. (Used for audio deduplication logic) |
| Default Volume | integer | The volume level, in percentage, that will be recalled on the display when it is powered on. |
| Soft Off Delay | integer | The amount of time, in seconds, that the display will be video muted before it is powered off when the Soft Off action is triggered. |
| Deselect On Sync Loss | boolean | Whether the display will be unrouted when the source it is sharing loses sync. |
| Auto Off Interval | integer | The amount of time, in seconds, between source sync loss and the display being powered off. Requires Deselect On Sync Loss to be true. |
| Video Freeze Capable | boolean | Whether the display supports video freeze. If enabled, video freeze toggle will be shown on the UI (if the UI supports it). |
| Motors | list of objects | The list of motors / motorised screens attached to this display. Expanded definition can be found in the following table. |
Motors
Motor objects in the configuration represent motorised screens logically attached to a display.
Motors are extended when a source is routed to the display, and retracted when the room is powered off (and on source deselection if Retract On Mute is enabled).
Multiple motor objects can be defined against a display.
| Property: | Type: | Description: |
|---|---|---|
| ID | string | The unique ID of the motor. |
| Label | string | The label that will be shown on the user interface when representing the motor. |
| Motor ID | string | The Device ID of the motorised screen / relay device controlling the motor. |
| Module ID | string | The module ID that will be triggered on the motor device. |
| Type | string / enum | The type of relay device that is being controlled. Options: Pulse, Double Pulse, Latch, Reverse Latch |
| Extend Trigger ID | integer | The relay port that will be triggered when extending the screen. |
| Retract Trigger ID | integer | The relay port that will be triggered when retracting the screen. |
| Manual Control Only | boolean | Whether the motor will only be controlled from the UI. |
| Retract On Mute | boolean | Whether the motor will retract when the display is muted. |