Message Commands; Xcommand Message Alert Clear; Xcommand Message Alert Display; Xcommand Message Echo - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec
Contents Introduction

Message commands

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

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
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API xConfiguration

xCommand Message Echo

xCommand Message FarendMessage

106
xCommand xCommand
Issuing the command makes the API raise a message-echo event. The command has no other
impact on the codec. Usage can be to poll the codec from a control system or any external device/
system to check for connectivity. To monitor the feedback use the xFeedback command. You can
read more about the xFeedback command in the general API introduction section.
Text: Enter the text to be echoed.
Requires user role: ADMIN
Parameters:
Text: <S: 0, 255>
Example:
xCommand Message Echo Text:" MyEchoListner99"
This command is used to send generic messages to the participants in a conference. Not in use in
this software version.
CallId: The remote participant to whom the message needs to be sent.
Type: Type of the message.
Text: Enter the text line to be displayed.
Requires user role: USER
Parameters:
CallId: <0..65534>
Type(r): <S: 0, 255>
Text(r): <S: 1, 1450>
LocalEcho: <On/Off>
Example:
xCommand Message FarendMessage CallId: 3 Type: 3 Text: Hello
API Reference Guide
xStatus Appendices
Copyright © 2015 Cisco Systems, Inc. All rights reserved.