Xcommand Userinterface Message Textline Display; Xcommand Userinterface Osd Key Click; Xcommand Userinterface Osd Key Press; Xcommand Userinterface Osd Key Release - 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 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, INTEGRATOR, 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.
SX20 Codec API Reference Guide CE9.1, JUNE 2017.
D15316.07
About the API
xConfiguration
Key
xCommand
xCommand

xCommand UserInterface OSD Key Press

Emulates a remote control key press without releasing it. The Key Press command must be
followed
by a Key Release command to emulate releasing the key.
Requires user role: ADMIN
USAGE:
xCommand UserInterface OSD Key Press 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.

xCommand UserInterface OSD Key Release

Emulates a remote control key release. The Key Release command is issued after a Key Press
command.
Requires user role: ADMIN
USAGE:
xCommand UserInterface OSD Key Release 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 control key to release.
126
API Reference Guide
xStatus
Appendices
Key
Key
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Advertisement

Table of Contents
loading

Table of Contents