The Message Commands; Xcommand Message Alert Clear; Xcommand Message Alert Display; Xcommand Message Textline Clear - Cisco TelePresence System Codec C90 Reference Manual

Cisco TelePresence System Codec C90
Contents Introduction

The 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.
Duration: Set how long (in seconds) the message is to be displayed on the screen. If set to 0 (zero)
the message will 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
D14641.06 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved.
About the API xConfiguration

xCommand Message TextLine Display

xCommand Message TextLine Clear

91
xCommand xCommand
Display a text line on screen. Optionally you can place the text line at a specified location and for a
specified duration of time (in seconds). NOTE: If Duration is not set, the command must be followed
by xCommand Message TextLine Clear.
Text: Enter the text line to be displayed.
X: Enter the X-coordinate (horizontal) on screen. X=0 is in the upper left corner.
Y: Enter the Y-coordinate (vertical) on screen. Y=0 is in the upper left corner.
Duration: Set how long (in seconds) the text line is to be displayed on the screen. If set to 0 (zero) the
text line will be displayed until a xCommand Message TextLine Clear command has been sent.
Requires user role: ADMIN
Parameters:
Text(r): <S: 0, 140>
X: <1..10000>
Y: <1..10000>
Duration: <0..3600>
Example:
xCommand Message TextLine Display Text: "The message to be displayed." X:500
Y:2000 Duration: 20
OK
*r MessageTextLineDisplayResult (status=OK):
** end
Clears the text line which was defined by the xCommand Message TextLine Display command.
Requires user role: ADMIN
Example:
xCommand Message TextLine Clear
OK
*r MessageTextLineClearResult (status=OK):
** end
API Reference Guide
xStatus Appendices
www.cisco.com