Commands - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec
Contents Introduction

Commands

Commands instruct the codec to execute actions, such as
to dial a number or to search the phone book. All commands
start with the prefix xCommand followed by a command path.
Writing xCommand ? on the command line will list all the top
level commands.
To view the complete list of commands and their parameters,
write xCommand ?? on the command line.
Command arguments are key-value pairs. The
argument name indicates that the argument is required for
the command.
When issuing a xCommand, the command consists of one
argument and one required parameter:
Example: xCommand Dial Number: 123
• xCommand is the command prefix.
executed is Dial.
• The example contains one argument, Number: 123.
Number is the key and 123 is its value. The key/value pair
is separated with ':'.
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API About the API
xCommand ?
- User Commands -
Audio
Bookings
Boot
Call
CallHistory
CallLog
CamCtrlPip
Camera
(r) behind the
OK
xCommand ??
xCommand Audio Microphones Mute
xCommand Audio Microphones Unmute
xCommand Audio Sound Play
Loop: <On/Off>
The command to be
Sound(r): <Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/KeyInputDelete/KeyTone/Nav/
NavBack/Notification/OK/PresentationConnect/Ringing/SpecialInfo/TelephoneCall/VideoCall/VolumeAdjust>
.
.
.
xCommand Video PreviewFilmstrip Set
Position(r): <LowerCenter/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight>
xCommand Video Selfview Set
FullscreenMode: <On/Off>
Mode: <On/Off>
OnMonitorRole: <First/Fourth/Second/Third>
PIPPosition: <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight>
OK
xConfiguration xCommand
Conference Logging
Dial Message
DTMFSend Peripherals
Experimental Phonebook
FacilityService Presentation
FarEndControl Preset
HttpFeedback Provisioning
Key Security
14
API Reference Guide
xStatus
Standby
SystemUnit
UserInterface
UserManagement
Video
Copyright © 2015 Cisco Systems, Inc. All rights reserved.
Appendices