Available States

The room's current mode: "Off" or one of the Room Modes defined in the configuration, such as "Presentation".

• During a room reset CE briefly publishes "Reset" before restoring the previous mode.

Whether the room is powered on, meaning the current Room Mode is anything other than "Off".

• !PowerIsOn is published only when the room turns on or off.
• !Changing between two on modes does not republish PowerIsOn.

The AV Source ID currently routed to each Destination Type: "Off" when powered off, "None" when deselected.

• The "All" key mirrors the value once every Destination Type shows the same one.
• The "All" key is empty while the Destination Types differ.

Whether the source is currently routed to at least one destination in the room.

Whether the source's configured Video Sync Devices report a live video signal.

The AV Source ID currently routed to the Destination Group: "Off" or "None" when its destinations are all powered off or deselected.

• The value is empty while the group's destinations show different sources.

• !The key is the Destination Group's Label, not its ID.

True/false flags flipped with the room Toggle action, typically from a macro behind a UI or keypad button.

• The first Toggle of an id creates the flag and sets it to true.
• Other macros and visibility conditions read these flags to branch behaviour.

Whether room-wide image mute is active, hiding video on every AV Destination through its Source Deselection Behaviour.

• !Room-wide image mute does not change the current routes.

Whether the same audio origin, resolved through each source's Audio Encoder ID, is feeding more than one Destination Type at once.

• The value is recomputed on every routing change.

• !AnyAudioSourceDuplicated is never evaluated in rooms with a single Destination Type or a single display.

Whether the number of wireless microphones docked at the room's Microphone Stations is below the configured Total Dockable Microphone Quantity.

Whether any of the room's occupancy sensors currently reports occupied.

Seconds remaining until the room automatically powers off, armed by the Time Based Shutdown time or a meeting-end shutdown.

• 0 means no countdown is running.
• On expiry CE sets the Room Mode to "Off".

Whether the touch panel lock is engaged. CE locks the panel on a lock request or after the inactivity timeout.

Whether the room has finished initialising, with configuration loaded and devices created.

• !Ready turns true once per startup and never reverts.

Whether the audio channel is muted, updated from the touch panel, macros, or mute feedback from the DSP.

The audio channel's current level (0-100).

• The published level updates on every level change from the touch panel, macros, or level feedback from the DSP.
• A level of 0 also mutes the channel.

Whether the DSP reports signal present on the audio channel.

• !This state is published only for channels with Signal Present feedback configured.

Whether phantom or line power is on for the audio channel, as reported by the DSP.

• !Only power feedback from the DSP publishes this state; a power command alone does not.

Whether the room's Ceiling Microphones are muted as one set.

• Room power changes and the Set Ceiling Mic Mute action always set every ceiling microphone together.

Whether the wireless microphone's transmitter is switched on, as reported by its Microphone Receiver.

The wireless microphone's battery charge percentage (0-100), reported by its Microphone Receiver.

The wireless microphone battery's health as a percentage of its original capacity, reported by its Microphone Receiver.

The Program Audio level remembered for each AV source, reapplied when that source is selected again.

• !This state is published only when Unique Source Levels is enabled.

The Program Audio mute state remembered for each AV source, reapplied when that source is selected again.

• !This state is published only when Unique Source Levels is enabled.

Whether the display is powered on, tracking the commands CE sends rather than power feedback from the display.

• !A display switched on or off outside CE does not change this state.

Whether the display has been switched to its configured "Secondary Input" instead of its "Default Input".

• The flag is cleared when the "Secondary Input Timeout" expires or a source is next routed to that display's Destination Type.
• The flag also follows the display's reported input, so it corrects itself if the input is changed at the display.

The ID of the scene currently active on the Content Layout (video wall), as defined under that layout's Scenes.

• This state follows the preset reported by the device, so it also updates when a scene is recalled outside CE.

The last position CE drove the projection screen motor to: "down" after an extend and "up" after a retract.

• !The published position follows CE's own motor commands but not the motor device actions or movement at the wall plate.

Whether this is the room's currently selected camera.

• Selecting a camera routes its stream to the camera decoder destinations.

Whether the camera is powered on, updated from the camera driver's power feedback.

• !For cameras whose "Power Off Behaviour" is "Privacy", CE's room power-off sends the camera to its "Privacy Preset Value" instead of powering it off and publishes this state as false.
• !For cameras whose "Power Off Behaviour" is "Privacy", the flag is set again when the camera's reported preset leaves the "Privacy Preset Value" position.

The ID of the document camera source currently selected on the touch panel, or empty when none has been selected yet.

The media player's transport state as reported by its device driver.

• The published value is "Play", "Stop", "Pause", "FastForward", "Rewind", "Next", "Previous", "Record", or "Stream".
• The published value is "Unknown" when the driver has not reported a recognised state.

This room's role in a room link: "primary", "secondary", or "unlinked".

Whether this room can currently join another room's link as a secondary, as broadcast to its configured partner rooms.

• !This room is available for linking only when it is off, or when it is on with "Available When On" enabled and not already linked to a non-overflow secondary room.

The link relationship with each configured partner room: "primary", "secondary", or "unlinked".

• The value is "primary" when the partner room is this room's primary.
• The value is "secondary" when the partner room is this room's secondary.
• The value is "unlinked" for any other partner room.

• !Each configured partner room's link relationship is empty before any link activity.

Whether an occupancy sensor currently detects presence.

• The room counts as occupied while any sensor detects presence.

• !Occupancy registers immediately, but vacancy only applies after the sensor's configured Trigger Timeout passes with no further detection.
• !Sensors with no Trigger Timeout read vacant immediately.

Whether any configured EWIS (Early Warning and Intercommunication System) sensor is currently triggered.

• CE raises the EWIS warning on touch panels while it is true.

• !The EWIS triggered state clears only when every EWIS sensor returns to normal.

Seconds remaining before the sensor-based automatic shutdown sets the Room Mode to "Off".

The ID of the pod currently sharing its local source to the other pods, or empty when no pod is sharing.

• !The active pod ID clears once nothing is viewing the sharing pod.

Each pod's own mode: "On", "Group Mode", or "Off".

• The value is "On" for independent operation.
• The value is "Group Mode" while the pod follows the room's shared feed.
• The value is "Off" once the pod's displays are shut down.

• !The room's automatic shutdown publishes a pod's mode as lower case "off" while every other path publishes "Off", so triggers should match either.

The pod local source each pod has routed to its pod displays, or "None" or "Off" after a deselection or pod shutdown.

• Local source ids are the pod's ID, a dot, then the Local Source ID from the configuration.

• !Currently a deselect keeps the capitalisation it was requested with, so match the deselect value case-insensitively.

The level of each pod's Pod Audio fader (0-100), following the DSP feedback for the channel named by the pod's Audio Source ID.

Whether each pod's Pod Audio fader is muted, following the DSP feedback for the channel named by the pod's Audio Source ID.

• CE mutes every pod together when "Mute Pods Audio When Lecturer Is Sharing" is set and the lecturer routes a source.

Whether the source on the Lecturer Destination is shared to every pod that is not "Off".

• CE raises it once every on pod is showing its "Lecturer" source and drops it when the last one leaves.

• !"Auto Share Pod Source Always Enabled" forces AutoShareToPods on.

Whether an HVAC zone is currently active.

• Activation fires the zone's relay Triggers and starts its Active Duration countdown.
• The zone deactivates when the countdown expires or its digital IO sensors report it inactive.

The current transport state reported by the recorder, typically "Record", "Pause", or "Stop".

• When it becomes "Stop", CE also clears the current recording details.

Minutes remaining in the current recording, as reported by the recorder.

Whether the recorder's audio feed is muted, following mute feedback for the DSP channels configured under Recorder Audio Mute.

Whether the recorder detects audio on its configured audio input.

Whether a recorder video input has video sync.

• !Which HDMI input each key reports on comes from the configured Capture Profile, so a profile using only HDMI-2 reports that input under "video 1".

The codec's collapsed call state: "Idle", "Dialling", "Ringing", or "InCall".

• "Ringing" wins over "InCall" while an incoming call is presented during another call.

• !A call that never connected stays "Dialling" through its teardown, so a failed dial never reads as a call that happened.

The run state each timer's device reports: "Idle", "Running", "Paused", "Elapsed", or "Unknown".

• "Elapsed" means a countdown has reached zero, on devices that report an expired state.
• "Unknown" is published before the device has reported a run state.

• !Devices that do not report an expired state report "Idle" instead of "Elapsed" when a countdown reaches zero.
• !Nothing is published for a timer whose Device ID does not resolve to a timer device.

The ID of the mode entry each timer is currently in, as configured under its Modes list (for example "mode.2", not the mode type "timer").

• The published value is empty when the reported mode has no matching entry in the Modes list.

The ID of the colour entry each timer is currently showing, as configured under its Colours list, or empty when the reported colour has no matching entry.

Each timer's count in whole seconds, captured when the timer last started, paused, reset or had its duration changed.

• The count is the time remaining in countdown mode and the time elapsed in stopwatch mode.

• !The published count does not tick while the timer runs.
• !The published count reads 0 whenever the timer is idle, including a countdown that is armed but not started.

Whether CE's connection to the device is open.

• This reflects the communications link itself, not whether the device is answering; use IsCommunicating for that.
• Published by every device type listed below, from the version that type first became available.

Whether the device is responding to CE's polls and commands. Goes false when responses stop or the connection drops.

• Published by every device type listed below, from the version that type first became available.

Whether the display's power is on.

• It turns true when the driver's warm-up interval completes and false when its cool-down interval completes.
• It is then verified by polling the device.

Whether the display is in its warm-up interval after a power on.

• It is true from when the power-on command is sent to the device until the driver's warm-up time elapses.

Whether the display is in its cool-down interval after a power off.

• It is true from when the power-off command is sent to the device until the driver's cool-down time elapses.

Whether the display detects an active video signal on its currently selected input.

The display's currently selected video input, published as a standard CE input name such as "Hdmi1" or "DisplayPort1".

• These names follow the same naming convention as the display's Default Input in configuration, and trigger matching is case-sensitive.

Whether the display's video mute is on, blanking the picture at the device while it stays powered.

• This is the display device state, distinct from the room's image mute routing behaviour.

Whether the display's video freeze is on, holding the last frame on screen.

Whether the display's own audio output is muted.

• This is the device-level mute on the display.

• !When an Audio Channel's mute is configured on the display, the room's Audio Channel mute is applied through the display's device-level mute.

The display's own volume level as a percentage, where 0 is the display's minimum volume and 100 is its maximum.

• The range comes from the Audio Channel Level Minimum and Maximum configuration where set, otherwise from the driver's defaults.

Whether the camera's power is on.

• It turns true when the driver's warm-up interval completes and false when its cool-down interval completes.
• It is then verified by polling the device.

Whether the camera's automatic tracking (for example presenter tracking) is on.

• It is updated immediately when CE sends a tracking on or off command, and from device feedback where the driver reports it.

The preset value most recently recalled or stored on the camera.

• !The published preset reverts to "None" after any manual adjustment (pan, tilt, zoom, focus, or iris), a power off, or turning tracking on or off.

Whether the document camera's power is on.

• It turns true when the driver's warm-up interval completes and false when its cool-down interval completes.
• It is then verified by polling the device.

Whether the document camera's lamp is on.

Whether the document camera's auto focus is enabled. Manual focus near and focus far commands turn it off.

Whether the document camera's video freeze is on, holding the current image on its video output.

The document camera's current zoom level. The value scale is driver-dependent.

The preset value most recently recalled or stored on the document camera.

• It reverts to an empty string after manual zoom in or out, focus, iris, brightness, lamp, backlight, or video freeze commands, or after a power off.

Whether the set-top box's power is on.

• It turns true when the driver's warm-up interval completes and false when its cool-down interval completes.
• It is then verified by polling the device.

The channel most recently recalled on the set-top box.

• It clears to an empty string after a channel up or channel down step.
• It then updates when the device reports the newly tuned channel.

The timer's current run state: "Idle", "Running", "Paused", or "Elapsed".

• "Elapsed" means a countdown has reached zero on devices that report an expired state; others report "Idle".

The timer's operating mode: "Clock" shows the time of day, "Timer" counts down, and "Stopwatch" counts up.

The number of seconds remaining on the countdown, only meaningful in "Timer" mode.

• It is zeroed when the mode is switched.

• !Outside "Timer" mode the published value is driver-dependent (on some devices it tracks the stopwatch count-up).

The colour string most recently set on the timer display, for example "#FF0000".

• !Setting the colour with separate red, green, and blue values does not update CurrentColour.

The motor's reported position or movement state, such as "Extended", "Extending", "Retracted", or "Retracting".

• Exact values are driver-defined.

• !Trigger matching is case-sensitive.

The state of the Bluetooth audio sink: "Idle", "Discoverable", "Paired", or "Connected".

• "Idle" means the sink is not in pairing mode and no device is connected, including after a device disconnects.
• "Discoverable" means the sink is in pairing mode, waiting for a user's device.
• "Connected" means a device is attached and can stream audio.

Whether the Lighting Preset is active.

• The value is true when the Lighting Preset is the preset most recently recalled on its Area.
• The value is false once a different preset is recalled on that Area.

Whether a Lighting Toggle is on: true when its Area's current preset is the toggle's on preset, false when it is the off preset.

• !Recalling a preset that is neither the toggle's on preset nor its off preset leaves ToggleStatus unchanged.
• !Toggles configured with Channels report through CurrentChannelLevels instead of ToggleStatus.

The level of a Lighting Fader as a percentage (0-100), reported from the first channel in its Channels list.

• Lighting Toggles configured with Channels also report their levels here.

The volume of a DSP fader as a percentage (0-100).

• Keys are the audio channel IDs from the Audio Sources configuration (Program Audio, Microphones, Auxiliary Audio, and Pod Audio faders), e.g. "program.audio.1".

Whether a DSP fader is muted.

• Keys are the same audio channel IDs as FaderVolume.

Whether the DSP detects an audio signal on a fader's metering block.

• This state is reported for faders whose "Signal Present" parameters are configured on the audio channel.
• This state is also reported for DSP-based Room Link and EWIS sensors under their sensor IDs.

Whether phantom or line power is on for a fader's "Power" block.

• !Phantom or line power is only reported for faders with a Power Block ID configured.

The most recently recalled preset value, as sent by the recall command.

The video stream currently set on the device: the stream an encoder transmits, or the stream a decoder receives.

• CE routes by setting a decoder's stream to match an encoder's, so a decoder's value identifies the encoder it is currently receiving from.

The audio stream currently set on the device: the stream an encoder transmits, or the stream a decoder receives.

• The audio stream differs from the video route only when audio is broken away and routed separately.

• !Devices that carry audio inside the video stream may leave the audio stream empty.

Whether the device detects video sync (one flag for the whole device; HasVideoInputSync reports per input).

• When the device is listed under an AV Source's Video Sync Devices, this flag drives the source's SourceHasSync detection.

Whether video sync is detected on each of the device's inputs.

• Keys match the "Device Input" values used in AV Source Video Sync Devices (e.g. "Hdmi1", "1").

Whether the device's video output is muted.

• This is video mute on the encoder or decoder itself, distinct from the room's image mute routing behaviour.

Whether the device's audio output is muted.

The input currently selected on the switcher.

• The value is the driver's input identifier, commonly the input number as a string (e.g. "1").

Whether the device detects video sync (one flag for the whole device; HasVideoInputSync reports per input).

• When the device is listed under an AV Source's Video Sync Devices, this flag drives the source's SourceHasSync detection.

Whether video sync is detected on each of the device's inputs.

• Keys match the "Device Input" values used in AV Source Video Sync Devices (e.g. "Hdmi1", "1").

Whether the switcher's audio output is muted.

• !The mute state is only published for switchers whose driver supports volume control.

The switcher's output volume as a percentage (0-100).

• !The volume is only published for switchers whose driver supports volume control.