D14949.13
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
Copyright © 2015 Cisco Systems, Inc. All rights reserved.
108
Cisco TelePresence SX20 Codec
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:
xCom mand Message TextLine Display Text: "The message to be displayed."
X:500 Y:2000 Duration: 20
Peripherals commands
xCommand Peripherals Connect
Register peripherals that are connected to the codec, such as control systems and touch panels.
The registered peripherals are displayed on the web interface under Configuration > Peripherals.
This command should be used when the peripheral connects to the codec for the first time or when
the software version on the peripheral has changed. The list of connected devices is available with
the command xStatus Peripherals ConnectedDevice [n] Status.
Note: Does not apply for the Cisco PrecisionHD cameras.
Requires user role:
USER
Parameters:
HardwareInfo: <S: 0, 100>
ID(r): <S: 1, 100>
Name: <S: 0, 100>
NetworkAddress: <S: 0, 100>
SerialNumber: <S: 0, 100>
SoftwareInfo: <S: 0, 100>
Type(r): <Byod, ControlSystem, Other, TouchPanel>
Example:
xCom mand Peripherals Connect ID:"00:50:60:d8:7c:e6" Type: Other
xCommand Peripherals HeartBeat
When a peripheral is registered as a connected device, you can set it to send a heartbeat to the
codec to let the codec know that it is still connected.
This will keep the device on the xStatus Peripherals ConnectedDevice list. If the peripheral is not set
to send a heartbeat, the device will disappear from the list after a while.
Note: Does not apply for ISDN Link or cameras.
Requires user role:
USER
Parameters:
ID(r): <S: 1, 100>
Timeout: <1..65535>
Example:
xCom mand Peripherals HeartBeat ID: "00:50:60:d8:7c:e6"
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
