Cisco Codec C20 Reference Manual page 85

Cisco TelePresence System Codec C20
Contents Introduction
The Key commands
xCommand Key Click
Emulates a remote control key press, followed by a key release.
Requires user role: ADMIN
Parameters:
Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/Mute/
MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/SrcDocCam/SrcPc/
SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut>
example:
xCommand Key Click Key:Down
*r KeyClickResult (status=OK):
** end
xCommand Key Press
Emulates a remote control key press without releasing it. The Key Press command must be followed by
a Key Release command to emulate releasing the key.
Requires user role: ADMIN
Parameters:
Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/Mute/
MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/SrcDocCam/SrcPc/
SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut>
example:
xCommand Key Press Key:Home
*r KeyPressResult (status=OK):
** end
xCommand Key Release
Emulates a remote control key release. The Key Release command is issued after a Key Press command.
Requires user role: ADMIN
Parameters:
Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/Mute/
MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/SrcDocCam/SrcPc/
SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut>
example:
xCommand Key Release Key:Home
*r KeyReleaseResult (status=OK):
** end
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
About the API xConfiguration
The Message commands
xCommand Message Alert Display
xCommand Message Alert Clear
85
xCommand xCommand
Display a message on screen, for a specified duration of time (in seconds). NOTE: If Duration is not set,
the command must be followed by xCommand Message Alert Clear.
Use the xFeedback commands to monitor the feedback from the user. Read more about the xFeedback
commands in the API introduction section in this guide.
Title: Enter a message title.
Text: Enter the message to be displayed.
Duration: Set how long (in seconds) the message is to be displayed on the screen. If set to 0 (zero) the
message does not disappear until a xCommand Message Alert Clear message has been sent.
Requires user role: ADMIN
Parameters:
Title: <S: 0, 255>
Text(r): <S: 0, 255>
Duration: <0..3600>
example:
xCommand Message Alert Display Title: "Message" Text: "The meeting will end
in 5 minutes." Duration: 20
OK
*r MessageAlertDisplayResult (status=OK):
** end
Remove the message which was displayed using the xCommand Message Alert Display command. This
is required when the Duration parameter is not set.
Requires user role: ADMIN
example:
xCommand Message Alert Clear
OK
*r MessageAlertClearResult (status=OK):
** end
API Reference Guide
xStatus Appendices
Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.