Technical References

D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. 116
Cisco TelePresence System Codec C40/C60 API Reference Guide
xCommand Message TextLine Display
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. The <p> and <br> HTML tags will result in line breaks as
normal; any other tags will appear as plain text.
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 is 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
xCommand Message TextLine Clear
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
xCommand Message Prompt Display
Display a small window on screen with a title, text and up to five options for response from the user.
The message is displayed on screen until the user gives a response, or until the system receives
the following command xCommand Message Prompt 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 the title of the message.
Text: Enter the text line to be displayed. The <p> and <br> HTML tags will result in line breaks as
normal; any other tags will appear as plain text.
FeedbackId: To identify the feedback enter a FeedbackId.
Option.1 to Option.5: Enter the text to appear on the feedback options.
Requires user role: ADMIN
Parameters:
Title: <S: 0, 255>
Text(r): <S: 0, 255>
FeedbackId: <S: 0, 255>
Option.1: <S: 0, 255>
Option.2: <S: 0, 255>
Option.3: <S: 0, 255>
Option.4: <S: 0, 255>
Option.5: <S: 0, 255>
Example:
xCommand Message Prompt Display Title: "Meeting extension" Text: "The
meeting is about to end. Do you want to extend the meeting?" Option.1:
"No" Option.2: "Yes, extend with 5 minutes" Option.3: "Yes, extend with 10
minutes"
OK
*r MessagePromptDisplayResult (status=OK):
** end
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand