D14869.11
Codec C20 API Reference Guide TC7.0, JANUARY 2014.
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
96
Cisco TelePresence System Codec C20
API Reference Guide
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
Message commands
xCommand Message Alert Display
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. The <p> and <br> HTML tags will result in line breaks as
normal; any other tags will appear as plain text.
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
xCommand Message Alert Clear
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
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
