TANDBERG Codec C Series Api Manual page 71

TANDBERG Codec C60 and Codec C40
Contents Contents Introduction Introduction
The Message command
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 on TANDBERG Developer Zone web site. Go to: http://developer.
tandberg.com/web/guest/howtos/cseries-api/feedback.
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.
Parameters:
Text(r): <S: 0, 255>
Duration: <0..3600>
Example:
xCommand Message Alert Display 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.
Parameters:
No paramters.
Example:
xCommand Message Alert Clear
OK
*r MessageAlertClearResult (status=OK):
** end
D14642.02—MAY 2010
About the API About the API xConfiguration xConfiguration
xCommand
xCommand xCommand xStatus xStatus
The Message commands,
cont...
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 will display 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 on TANDBERG Developer Zone web site. Go to: TANDBERG Developer
Zone.
Title: Enter the title of the message.
Text: Enter the message.
FeedbackId: To identify the feedback enter a FeedbackId.
Option.1 to Option.5: Enter the text to appear on the feedback options.
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
71
API Guide
Appendices Appendices Contact us Contact us
www.tandberg.com