Xcommand Userinterface Message Textline Clear; Xcommand Userinterface Message Textline Display; Xcommand Userinterface Osd Key Click; Xcommand Userinterface Message Prompt Response - Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Introduction

xCommand UserInterface Message Prompt Response

Give a response to the xCommand Message Prompt Display.
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.
Requires user role: ADMIN, USER, ROOMCONTROL
USAGE:
xCommand UserInterface Message Prompt Response [FeedbackId: "FeedbackId"]
OptionId:
OptionId
where
: String (0, 255)
FeedbackId
The FeedbackId corresponds to the FeedbackId given by the xCommand Message
Prompt Display command.
: Integer (1..5)
OptionId
The OptionId corresponds to the OptionIds given as possible responses in the
xCommand Message Prompt Display command.

xCommand UserInterface Message TextLine Clear

Clears the text line which was defined by the xCommand Message TextLine Display command.
Requires user role: ADMIN, USER, ROOMCONTROL
USAGE:
xCommand UserInterface Message TextLine Clear
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API
xConfiguration
xCommand
xCommand

xCommand UserInterface 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.
Requires user role: ADMIN, ROOMCONTROL
USAGE:
xCommand UserInterface Message TextLine Display Text: "Text" [X: X] [Y: Y]
[Duration: Duration]
where
: String (0, 140)
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.
: Integer (1..10000)
X
Enter the X-coordinate (horizontal) on screen. X=0 is in the upper left corner.
: Integer (1..10000)
Y
Enter the Y-coordinate (vertical) on screen. Y=0 is in the upper left corner.
: Integer (0..3600)
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.

xCommand UserInterface OSD Key Click

Emulates a remote control key press, followed by a key release.
Requires user role: ADMIN
USAGE:
xCommand UserInterface OSD Key Click Key:
where
: 0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/
Key
Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/
SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut/+/-
Define the remote key to press.
142
API Reference Guide
xStatus
Appendices
Key
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents