14
D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved
API for Programming In-Room Controls (Cont.)
API
Commands and Statuses
The SetValue command, which sets the value of a
widget, is essential when working with in-room controls:
xCommand UserInterface Extensions Widget SetValue
Value: Value WidgetId: WidgetId
When the video system receives a SetValue command,
the video system’s status and the Touch10/DX In-Room
Control panel are updated accordingly.
It is important that the control system sends
SetValue
commands in the following situations, so that the
Touch10/DX In-Room Control panel truly reects the
status of the room:
•
When the control system initially connects to the video
system.
•
When the video system restarts.
•
When the control system restarts.
•
When a new In-Room Control panel is exported to
the video system from the In-Room Control editor (as
response to the LayoutUpdated event).
•
When someone physically changes something in the
room, for example turns on the lights using a wall
control.
•
As a response to an event, for example when
someone has tapped the Lights On button on the
Touch10/DX In-Room Control panel.
•
The control system must also do all that is necessary
in the room to reect the action on the Touch10/DX
In-Room Control panel, for example switch on the
light.
Consult the Widgets chapter for more details about
which commands apply to the dierent widgets (user
interface elements).
Examples
User
Control
system Lights
Video system
with Touch 10/DX
Tap Lights On
Pressed and
Released events for
Lights On widget
Turn lights on
Set the value of the
Lights On widget to
active
The appearance of
the light widget has
changed to match
what the user can
see in the room
Message flow—turn on the lights using the controls on Touch10/DX
User
Control
system Lights
Video system with
Touch 10/DX
Set the value
of the Lights
On widget to
active
The
appearance of
the light widget
has changed to
match what the
user can see in
the room
User
Turn lights
on with wall
control
Signal that
lights are on
Message flow—turn on the lights using the wall control