Cisco TelePresence System Codec C90 User manual

1
Cisco TelePresence System Codec C90 API Reference Guide
D14641.06 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Software version TC5.0
November 2011
Application Programmer Interface (API)
Reference Guide
Cisco TelePresence System Codec C90

2
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
TA - ToC -
Hidden text
anchor
Table of Contents
Introduction
About this guide .................................................................. 5
User documentation ........................................................ 5
What’s new in this version .................................................. 6
Software release notes ................................................... 6
Software download ......................................................... 6
New features and improvements .................................... 6
xConguration changes .................................................. 7
xCommand changes ....................................................... 7
xStatus changes.............................................................. 7
About the API
About the API ...................................................................... 9
Basic Principles ............................................................... 9
The API-Engine ............................................................... 9
Structuring of Information................................................ 9
Addressing Using XPath or SimplePath ........................ 10
Feedback....................................................................... 10
Connecting to the codec ...................................................11
Accessing XACLI ............................................................11
Telnet/SSH login .........................................................11
Serial port login...........................................................11
Serial port congurations ...........................................11
Reboot ........................................................................11
Hardware & Cabling (RS-232)........................................11
Troubleshooting (RS-232) ..............................................11
Value types and formats ....................................................12
User commands.................................................................13
Main type of commands.....................................................14
Conguration type commands.......................................14
Command type commands ............................................14
Status type commands ..................................................14
Special commands.........................................................14
Feedback type command...........................................14
Preferences type command .......................................14
What’s in
this guide? About xConguration ........................................................ 15
xConguration operations................................................. 16
Return result parameters............................................... 16
xConguration Help....................................................... 16
xConguration Read...................................................... 16
xConguration Write...................................................... 16
About xCommand ..............................................................17
xCommand operations...................................................... 18
Return result parameters............................................... 18
xCommand Help............................................................ 18
xCommand Write........................................................... 18
About xStatus commands................................................. 19
Quering status information ............................................ 20
About xHistory................................................................... 21
About xEvent..................................................................... 22
About xFeedback .............................................................. 23
About xPreferences .......................................................... 24
The xPreferences output modes................................... 24
The SystemTools commands ............................................ 25
XML API service................................................................ 27
Description of the xConguration commands
Description of the xConguration commands .................. 29
Description of the xCommand commands
Description of the xCommands commands...................... 71
Description of the xStatus commands
Description of the xStatus commands .............................113
The top menu bar and the entries in the Table of
Contents are all hyperlinks, just click on them to
go to the topic.
We recommend you visit our web site regularly
for updated versions of the user documentation.
Go to: http://www.cisco.com/go/telepresence/
docs

3
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Appendices
The Video Input Matrix .....................................................170
About the matrix...........................................................170
API commands .............................................................170
Default congurations...................................................170
Startup script....................................................................171
Adding a startup script .................................................171
Cisco TelePresence Remote Control ...............................172
Remote control key map ..................................................173
Overview of the xConguration commands.....................174
Overview of the xCommand commands .........................178
Overview of the xStatus commands ................................181

4
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Chapter 1
Introduction

5
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
About this guide
This guide will introduce you to the Application Programmer
Interface (API) for the TC software in general, and serve as
a reference guide for the command line commands for the
Codec C Series listed below:
• Cisco TelePresence System Codec C90
User documentation
The user documentation for the Cisco TelePresence systems,
running the TC software, have several guides suitable to
various user groups.
• Video conference room primer
• Video conference room acoustics guidelines
• Installation guides for the TelePresence systems
• Software release notes for the TC software
• Getting started guide for the TelePresence systems
• User guide for the TelePresence systems (Touch controller)
• User guide for the TelePresence systems (Remote Control)
• Quick reference guides for the TelePresence systems
• Administrator guides for the TelePresence systems
• Camera user guide for the PrecisionHD cameras
• API reference guides for the Codec C Series
• TC Console user guide for the Codec C Series
• Physical interfaces guides for the Codec C Series
• Regulatory compliance and safety information guides
• Legal & license information for the TC software
Download the user documentation
Go to: http://www.cisco.com/go/telepresence/docs
- in the right pane, select:
• TelePresence Solutions Platform for the Codec C Series
and Quick Set C20.
• TelePresence Peripherals for the PrecisionHD cameras,
microphones, Touch unit, and remote controls.

6
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
What’s new in this version
This section provides an overview of the new and changed
advanced settings and new features in the TC5.0 software
version.
Software release notes
For a complete overview of the news and changes, we
recommend reading the Software Release Notes (TC5).
Go to: http://www.cisco.com/en/US/products/ps11422/
tsd_products_support_series_home.html
Software download
For software download go to: http://www.cisco.com/cisco/
software/navigator.html
New features and improvements
Support for native CUCM registration
With TC5 the video systems are able to register to the Cisco
Unied Communications Manager (CUCM) version 8.6 as a
native Cisco device. Supported features are:
• Basic telephony features like call, hold/resume, transfer
• CUCM provisioning
• CUCM phonebook
• Software upgrade
Encrypted calls are not supported.
Support for Cisco TelePresence Multipoint Switch (CTMS)
In TC5 interoperability with CTMS version 1.8 is achieved.
The following features are supported:
• Multipoint conferences hosted on CTMS
• Unrestricted 720p/1080p conferences (unrestricted
1080p is not available when there is a CTS system in the
conference)
• H.264 GDR (Gradual Decoder Refresh)
• Legacy stream (CIF/360p) to WebEX and MXE
• Informational Black Screen Codes
Encryption is not supported. CTMS calls must be SIP only.
Support for One Button To Push (OBTP) meetings
Both the Touch controller and the OSD (On Screen Display)
menu will display scheduled OBTP meetings from CTS-MAN
(version 1.8 or later) or TelePresence Management Suite
(TMS, version 13.1 or later). Supported features are:
• A reminder for scheduled meetings will appear on screen.
Press one button to start the meeting
• Press the Meetings button to see a list of all scheduled
meetings
• WebEx indication
• Meeting extension if the meeting is booked using CTS-
MAN
Web interface enhancements
New call application with support for:
• Making calls and start/stop presentation
• Selecting source for both main source and presentation
• Volume control
• Microphone mute
• Local camera control including preset selection
• Layout control
• Diagnostics information
• Web snapshots of any local source
Cisco Touch enhancements
The user interface has been changed:
• Call rate button. If changed from default, the new call rate
is displayed on the button
• Meetings button on the main menu
• Possibility to enable/disable web snapshots when the
Touch controller is connected directly to the system/
codec (direct pairing).
• Local camera control, including preset selection
New languages supported:
• Finnish
• French
• German
• Japanese
• Russian
• Simplied Chinese
• Swedish
Other enhancements
• Local presentation only mode (the presentation is only
displayed locally; it is not sent to the remote sites)
• FIPS (The Federal Information Processing Standards)
mode is introduced to facilitate FIPS 140-2 certication

7
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
xConguration changes
New commands
xConguration Conference [1..1] Presentation Policy
xConguration Experimental SystemUnit CrashReporting
Mode
xConguration Experimental SystemUnit CrashReporting
URI
xConguration Experimental CTMSSupport Mode
xConguration Experimental PacketOverloadHandling
WhenDetected
xConguration Experimental CustomSoftbuttons
HoldResume
xConguration Network [1..1] IEEE8021X TlsVerify
xConguration Network [1..1] IEEE8021X UseClientCerticate
xConguration Network [1..1] IEEE8021X Eap Tls
xConguration Provisioning Connectivity
xConguration UserInterface TouchPanel DefaultPanel
Commands that are removed
xConguration Network VLAN Voice Priority
Commands that are modied
xConguration Audio Input Microphone[1..8] Equalizer ID
OLD: <1..16>
NEW: <1..17>
xConguration Network [1..1] VLAN Voice Mode
OLD: <Manual/O>
NEW: <Auto/Manual/O>
xConguration Phonebook Server [1..1] Type
OLD: <VCS/TMS/CallWay>
NEW: <VCS/TMS/CallWay/CUCM>
xConguration Provisioning Mode
OLD: <O/TMS/VCS/CallWay/Auto>
NEW: <O/TMS/VCS/CallWay/CUCM/Auto>
xConguration Video Wallpaper
OLD: <None/Growing/Summersky/Custom>
NEW: <None/Growing/Summersky/Custom/Waves>
xConguration Video Input Source [1..5] CameraControl
CameraID
OLD: <1..5>
NEW: <1..7>
xCommand changes
New commands
xCommand Bookings Clear
xCommand Bookings List
xCommand Call ExtendConference
xCommand Camera Preset Activate
xCommand Camera Preset Edit
xCommand Camera Preset List
xCommand Camera Preset Remove
xCommand Camera Preset Store
xCommand Security FIPSMode Activate
Commands that are removed
xCommand Audio RemoteInput Update
xCommand Video Layout ListLayoutFamily
xCommand Video Layout ListLayoutGraphic
Commands that are modied
xCommand Experimental TakeWebSnapshot
ADDED: SourceId: <0..65534>
ADDED: SourceType: <localInput/localMain/
localPresentation>
xStatus changes
New commands
xStatus Camera [1..7] Flip
xStatus Experimental CTMS
xStatus Network 1 VLAN Voice VlanId
xStatus Security FIPS Mode
xStatus SystemUnit Hardware Module CompatibilityLevel
xStatus SystemUnit Hardware MonitoringSoftware
xStatus SystemUnit Hardware Monitoring Fan [1..n] Status
xStatus SystemUnit Hardware Temperature

8
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Chapter 2
About the API

9
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
About the API
Basic Principles
The heart of the API is the API-Engine. This is
where all information is stored and processed.
The API-engine can be accessed by an easy-
to-use Command Line Interface called XACLI
using RS-232, Telnet or SSH, or by the XML
API Service (TXAS) over HTTP/HTTPS.
Working with the API-engine is very similar
to working with catalogues and les on
a computer. All information is stored in a
hierarchic tree structure which is accessible
from dierent interfaces.
• When accessing the API-engine using
XACLI (RS-232, Telnet or SSH), the
information is formatted in a proprietary
Command Line style or in XML formatting.
• When accessing the API-engine using
the TXAS interface (HTTP/HTTPS), XML
formatting is supported.
This is similar to viewing les on a computer.
Accessing catalogues on a Windows
computer using the Command Prompt gives
a dierent view than using Windows Explorer,
but the information is the same.
About Telnet
Telnet is disabled by default. Before
connecting to the codec using Telnet you will
need to enable the interface via either RS-232
or SSH.
The following command can be set from the
Administrator settings menu or from the API
command interface:
• xConguration NetworkServices
Telnet Mode: On
The API-Engine
The API-Engine is optimized for easy, yet
advanced, machine-machine interaction
between a Cisco system and an external
control application.
The main features can be summarized to:
1. Structuring of information
2. Addressing using XPath (XML Path
Language) or SimplePath
3. Feedback
API-Engine
RS-232
cable
Main types of information
• READ information (R)
• WRITE information (W)
• READ/WRITE information (RW)
(R) READ information. This is Status
Information about the system and system
processes, i.e. information generated by the
system.
Typical examples include: status about
ongoing calls, network status, conference
status etc. All status information is structured
in a hierarchy, making up a database
constantly being updated by the system to
reect process changes.
(W) WRITE information. This is Command
information the user/control application supply
to initiate an action.
Typical examples include: instructing the
system to place a call, adjust volume,
disconnect a call etc.
A command is usually followed by a set of
parameters to specify how the given action is
to be executed.
(RW) READ/WRITE information. This is
Conguration Information dening system
settings. This information can both be
supplied and read by the user/control
application. Typical examples include: default
call rate, baud rate of a serial port, enabling/
disabling of various features etc.
All conguration information is structured in
a hierarchy making up a database of system
settings. But for the Conguration information,
the data in the database can only be updated
by the user/control application.
XACLI
(XML)
TXAS
(XML)
HTTP/
HTTPS
Telnet/SSH
via LAN
Structuring of Information
An application programming interface (API)
can be seen as a gate where information is
exchanged between two systems – a control
application and a target system.
The control application transmits instructions
to the target system, while the target system
supplies information about how these
instructions are executed, in addition to other
system related information.
Consequently, the exchange of information
can be divided into:
1. Information owing from target. This
we call READ information (R). The (R)
should not be confused with the (r) used
to indicate required parameters in the
Commands tables.
2. Information owing to target. This we call
WRITE information (W).

10
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Addressing Using XPath or SimplePath
To address information in the hierarchic structure of Status
and Conguration information, the Cisco systems support
abbreviated XML Path Language (XPath) and a proprietary
notation called SimplePath (only available using XACLI).
This allows the user/control application to address everything
from a single element of data (for example the call rate of a
specic call) to larger parts of the hierarchy (for example all
information available for a given call).
Using XPath
Addressing the 1st DNS Server Address of the 1st Network:
Each level is separated with a slash (‘/’). Item numbers are
added in brackets after the element name:
• Network[1]/DNS Server[1]/Address
Example:
xConguration Network[1]/DNS Server[1]/Address
*c xConguration Network 1 DNS Server 1 Address:
“test”
OK
Using SimplePath
Addressing the 1st DNS Server Address of the 1st Network:
Both levels and item numbers are separated with white spaces:
• Network 1 DNS Server 1 Address
Example:
xConguration Network 1 DNS Server 1 Address
*c xConguration Network 1 DNS Server 1 Address:
“test”
OK
Feedback
Feedback is an extremely powerful feature where the Cisco
system actively returns updated status and conguration
information to the user/control application whenever changes
occur.
The user/control application can specify what parts of the
status and conguration hierarchies it wants to monitor by
using XPath. The user/control application can thereby limit the
amount of information it receives from the target system to only
those parts being of interest for the given application. This will
also reduce the load on the link connecting the systems.
Feedback is supported on both XACLI (RS-232/Telnet/SSH)
and TXAS (HTTP/HTTPS) simultaneously.
The system uses SimplePath when presenting congurations.
XPath and SimplePath are described thoroughly later in this
section of the manual.
The structuring of information together with XPath and
SimplePath for addressing, makes up powerful features as
the ability to search and setting of multiple instances of a
conguration.

11
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Connecting to the codec
Accessing XACLI
XACLI can be accessed through Telnet and SSH via the LAN
interface or through the COM port by connecting a serial cable
to the serial interface connector, referred to as the COM port.
The COM port (RS-232) is a 9-pin, female, D-sub connector
located on the back of the Codec C–Series. The connector i
marked with the text: Camera Control.
The port is congured as a DCE (Data Communications
Equipment). The COM port (RS-232) is default set to 38400
baud, 8 data bits, none parity and 1 stop bit from factory. The
port may also be referred to as the Data port.
Telnet/SSH login
Telnet is by default disabled. This can be changed with a
conguration command: xConguration NetworkServices
Telnet Mode: On/O
• xConguration NetworkServices Telnet Mode: On
Telnet/SSH login
• User name is: admin
• The default passworrd is blank.
Serial port login
The serial port is password protected by default. The password
protection may be congured.
• User name is: admin
• The default passworrd is blank.
Serial port congurations
On the serial port the baud rate and password protection may
be congured.
The conguration command for the baud rate is:
xConguration SerialPort BaudRate:
<9600/19200/38400/57600/115200>
• xConguration SerialPort BaudRate: 38400
The conguration command for login required is:
xConguration SerialPort LoginRequired: <On/O>
• xConguration SerialPort LoginRequired: On
Reboot
The system requires a reboot for the changes to baud rate and
password protection to take eect.
NOTE: When system boots up the baud rate of the boot
messages is 38400 regardless of the baud rate set in the
codec application.
Hardware & Cabling (RS-232)
The pin outs for the RS-232 are dened in the tables to the
right. Observe that the DTE (Data Terminal Equipment), could
be a PC or any other device capable of serial communication.
Cable. A straight-through cable should be used between
the RS-232 port and the DTE. The lower table shows the
recommended cable-wiring scheme when connecting the
Codec C–Series to a PC through RS-232.
DTR and RTS are ignored. DSR, CD, and CTS are always
asserted, while RI is not used.
Troubleshooting (RS-232)
If communication cannot be established between the PC/
terminal and the Codec data port, the following should be
checked:
1. Verify that the serial cable is a straight-through 9-pin to
9-pin cable.
2. Conrm that the conguration of the PC/terminal’s serial
RS-232 port is identical to the conguration of the RS-232
port.
3. Verify that the PC/terminal’s serial RS-232 port is working
properly by connecting it back-to-back to another PC/
terminal and send characters in both directions.
COMport(RS-232)
Pin Signal name Direction
1 Carrier detect, CD From DCE
2 Receive data, RXD From DCE
3Transmit data, TXD To DCE
4Data terminal ready, DTR From DCE
5Signal GND
6 Data set ready, DSR From DCE
7 Ready to send, RTS To DCE
8 Clear to send, CTS From DCE
9 Ring indicator, RI From DCE
Cablewiring(RS-232)DCE<->PC
DCE 9 pin Direction PC DTE, 9 pin
1 CD —> 1 CD
2 RD —> 2 RD
3 TD <— 3 TD
4 DTR <— 4 DTR
5 GND <—> 5 GND
6 DSR —> 6 DSR
7 RTS <— 7 RTS
8 CTS —> 8 CTS
9 RI —> 9 RI

12
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Value types and formats
The system supports the following value types:
• Integer values
• Literal values
• String values
• E164 string values (strings only containing digits, ‘#’ and ‘*’)
• IPv4 Address values
• *IPv6 Address values
• IPv4 or *IPv6 Address values
Formatsforvaluetypes
Integer values:<x..y>
Denes the valid range for an integer input. x = min value, y = max value.
<1..10 0>
Literal values: <X/Y/../Z>
Denes the possible values for a given conguration.
<On/O/Auto>
String values: <S: x, y>
Denes that the valid input for this conguration is a String with minimum length x and maximum length of y
characters.
<S: 0, 49>
IPv4 Address values: <IPAddr>
Denes that the input must be an IPv4 address.
<IPAddr>
*IPv6 Address values: <IPv6Addr: x, y>
Denes that the input must be an IPv6 address with minimum length x and maximum length y.
<IPv6Addr: 0, 43>
IPv4 or *IPv6 Address values: <IPv4v6Addr: x, y>
Denes that the input must be an IPv4 or IPv6 address with minimum length x and maximum length y.
<IPv4v6Addr: 0, 43>
* Not supported in this version

13
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
?
- User Commands -
help xconguration xfeedback xgetxml xhistory
xstatus xevent xpreferences xcommand systemtools
bye log echo
OK
User commands
By typing ?or help after connecting to the Cisco TelePresence
System Codec C Series using RS-232/Telnet/SSH, the system
will list all supported root commands.
Bye
The bye command will close the command line interface.
Echo <on/o>
If echo is set to On the key inputs are displayed when entering
text in a command line interface.
If echo is set to O no user input is displayed when entering
text in a command line interface.
The oher commands
The other user commands are described in the following
pages.

14
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
Main type of commands
The XACLI is divided into three main types of
commands, reecting the information types
supported by the API Engine.
The main types are:
• Conguration type commands
• Status type commands
• Command type commands
Conguration type commands
Conguration type commands denes the
system settings. Conguration commands are
either supplied or read by the user.
System settings made by Conguration type
commands are persitant over a reboot.
Example: Set default call rate, baud rate of a
serial port and enabling/disabling of various
features etc.
The Conguration commands are structured
in a hierarchy, making up a database of
system settings.
Supported Conguration type commands:
xConguration
Command type commands
Command type commands instructs the
system to perform an action. xCommand
commands are supplied by the user.
Actions performed by a Command type
command are not persitant over a reboot.
Example: instructing the system to place a
call, assign oor to a specic site, disconnect
a call etc.
A xCommand command is usually followed by
a set of parameters to specify how the given
action is to be executed.
Supported Command type commands:
xCommand
Status type commands
Status type commands returns information
about the system and system processes.
Status type commands are read by the user.
Example: Information generated by the
system about ongoing calls, network status,
conference status etc.
All status information is structured in a
hierarchy, making up a database constantly
being updated by the system to reect system
and process changes.
Supported Status-type commands:
xStatus
xHistory
Special commands
In addition to the above sets of commands,
XACLI supports the following set of special
commands:
Feedback type command
The Feedback commands are used to specify
what parts of the conguration and status
hierarchies to monitor. Feedback will only be
issued on the RS-232/Telnet/SSH session
for which it is specied. If connecting to the
codec with multiple sessions, each session
can dene feedback individually.
More on this can be found in xfeedback.
xFeedback
xEvent
Preferences type command
The Preference type command is used to set
various preferences for the RS-232/Telnet/
SSH sessions. Each session can dene
preferences individually. IMPORTANT! This
command has various settings to dene the
formatting of the XACLI output. It is therefore
important to dene settings to match the
parser used on the control system. XACLI is
designed to make parsing of data from the
Codec C–Series very simple.
More on this can be found in xpreferences.
xPreferences

15
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
About xConguration
The xConguration type commands denes the system
settings and are either supplied or read by the user. The
xCongurations commands are organized in a hierarchic tree
structure.
To get an overview of accessible top-level conguration
elements within the xConguration commands, enter ?or help
after the xConguration command:
• xConguration ?
• xConguration help
To get an overview of all supported xConguration commands
with the corresponding value space, enter ?? after the
xConguration command:
• xConguration ??
When issuing a xConguration command, the command
consists of three parts:
1. The type of command: xConguration
2. The path: An address expression, terminated by a colon
3. The value: A value type
Example: xConguration Audio Input HDMI 1 Mode: On
The type The path The value
xConguration ?
– User Congurations –
OK
Audio
Cameras
Conference
Experimental
GPIO
H323
Network
NetworkPort
NetworkServices
Phonebook
Provisioning
RTP
Security
SerialPort
SIP
Standby
Syste mUnit
Time
Video
xConguration ??
*h xConguration Audio Volume: <0..100>
Sets the volume level [0-100] on the loudspeaker output in steps of 0.5dB from -34.5dB to 15dB.
Volume 0 = Off. The volume level bar which is displayed on screen, when using the
remote control, goes from 0 to 20. Range: The volume level goes from 0 to 100. Volum
level equals Audio gain value 0 equals 0 1 equals -34.5 dB 70 equals 0.0 dB 100
equals 15.0 dB
*h xConguration Audio Input Microphone [1..8] Type: <Microphone/Line>
The microphone inputs are intended for electret type microphones. The microphone inputs are
balanced with 48 V phantom power. The microphone input can be set to line or
microphone mode. Addresses the specic microphone. Microphone: Phantom voltage and
pre-amplication is On. Line: Select Line when you have a standard balanced line
input. The phantom voltage and pre-amplication is Off.
*h xConguration Audio Input Microphone [1..8] Mode: <On/Off>
By default, all inputs are enabled. Just plug in an audio source and it is active. Audio inputs
that are On will automatically be mixed. Unconnected inputs will automatically be
muted. Addresses the specic microphone. On: Turns the microphone On. Off: Connected
but unused inputs should be set to Off to prevent audio/noise from the inputs.
.
.
.
OK

16
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
xConguration operations
The xConguration type commands denes
system settings and are either supplied or
read by the user.
Return result parameters
Three operations can be performed on
xConguration:
CongurationHelp
• Help text for this conguration is returned
CongurationRead
• *c is used when returning the result of a
read query
CongurationWrite
• No return result parameter for
conguration set (write)
• Writes this value to the setting dened by
the path.
ExamplewithxCongurationHelp:
To get help on xConguration, type ?or help after the conguration path (address expression):
xConguration <address expression> ?
xConguration H323 Prole 1 Gatekeeper Discovery ?
*h xConguration H323 Prole 1 Gatekeeper Discovery: <Manual/Auto>
OK
xConguration Help
To get help on a system setting you can use
a help query. Enter the path followed by ?or
help.
• xConguration H323 Prole 1
Gatekeeper ?
Returns information about the setting
dened by the path.
• xConguration H323 Prole 1
Gatekeeper help
As above.
xConguration Read
When reading a value you will use the
conguration read. The level of details is
dened by the path:
• xConguration H323 Prole 1
Gatekeeper Discovery
Returns the current value of the setting
dened by the path.
xConguration Write
When dening a system setting you will
use the conguration write. The structure is
described by the example to the right.
• xConguration H323 Prole 1
Gatekeeper Discovery: Auto
Writes this value to the setting dened by
the path.
ExamplewithxCongurationRead:
To read congurations from the system just type the root command (xConguration) followed by the
path (address expression):
xConguration <address expression>
xConguration H323 Prole 1 Gatekeeper Discovery
*c xConguration H323 Prole 1 Gatekeeper Discovery: Manual
OK
ExamplewithxCongurationWrite:
To issue a command type a root command (xConguration) followed by a valid path (address
expression). The path must be terminated with a colon before the value is added:
xConguration <address expression>: <value>
xConguration H323 Prole 1 Gatekeeper Discovery: Auto
** end

17
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
About xCommand
The xCommand type commands instructs the system to
perform an action. xCommand type commands are supplied by
the user.
To get an overview of the supported xCommand type
commands, type ?or help after the xCommand:
• xCommand ?
• xCommand help
To get an overview of all supported xCommand commands
with the corresponding value space, enter ?? after the
xCommand:
• xCommand ??
When you type a command and ?or help a list of the available
parameters will show. Required parameters are identied by an
(r) behind the parameter name.
xCommand ?
– User Commands –
OK
xCommand ??
*h xCommand Audio Microphones Mute
*h xCommand Audio Microphones Unmute
*h xCommand Audio Sound Play
Sound(r): <Busy/CallWaiting/Dial/KeyTone/Ringing/SpecialInfo/TelephoneCall/VideoCall>
Loop: <On/Off>
*h xCommand Audio Sound Stop
*h xCommand Audio Vumeter Start
ConnectorType(r): <HDMI/Line/Microphone>
ConnectorId(r): <1..8>
*h xCommand Audio Vumeter Stop
ConnectorType(r): <HDMI/Line/Microphone>
ConnectorId(r): <1..8>
*h xCommand Audio Setup Clear
.
.
.
OK
Audio
Boot
Call
CallLog
CamCtrlPip
Camera
Dial
DTMFSend
Experimental
FarEndControl
GPIO
HttpFeedback
Key
Message
Phonebook
Presentation
Preset
Provisioning
SStringSend
Standby
Syste mUnit
TStringSend
Video

18
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
xCommand operations
The xCommand type commands are used to
instruct the system to perform a given action.
Return result parameters
The following operations can be performed
on xCommand:
CommandHelp
• *h is used when returning the result of a
help query
CommandWrite
• *r is used when returning the result of a
write command
ExamplewithxCommandHelp
To get help on xCommand, type ?or help after the command path (address expression):
xCommand <address expression> ?
xCommand Dial ?
*h xCommand Dial
Number(r): <S: 0, 255>
Protocol: <H323/Sip>
CallRate: <64..6000>
CallType: <Audio/Video>
ForceNewConference: <False/True>
ConferenceId: <0..65534>
OK
xCommand Help
To get help on a setting you can use a help
query. Enter the path followed by ?or help.
• xCommand dial ?
Returns a set of return values. See the
example to the right.
• xCommand dial help
As above.
xCommand Write
When issuing a command, the system will
return a set of return values. The structure is
described by the example to the right.
• xCommand Dial Number: 12345
Issues the command and gives a
response. See the example to the right.
The response will by default be on the same
format as the standard XACLI Status format.
The XML status format is also supported.
You can read more about XML in the
xPreferences section.
ExamplewithxCommandWrite
Dial a number with only the required parameter:
xCommand Dial Number: 95458458
OK
*r DialResult (status=OK):
CallId: 2
ConferenceId: 1
*r/e n d
OK

19
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
About xStatus commands
The xStatus type commands returns information about the
system and system processes. Status type commands are
read by the user.
All status information is structured in a hierarchy, making up
a database constantly being updated by the system to reect
system and process changes.
To get an overview of the supported xStatus type commands,
type ?or help after the xStatus:
• xStatus ?
• xStatus help
Return result parameters
The following operation can be performed on xStatus
commands:
xStatusRead
• *s is used when returning the result of xStatus read query
xStatus ?
– Status –
OK
Audio
C a l l[...]
C a m e r a[1..7]
Conference
Diagnostics
Experimental
GPIO
H323
HTTPFeedback[1..3]
MediaChannels
Network
Pres et[1..15]
Provisioning
SIP
Sleep
Standby
SystemUnit
Time
Video

20
Cisco TelePresence System Codec C90 API Reference Guide
D14641.0 6 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com
AddressingstatusinformationwithxStatus
To read status from the system just type the root command (xStatus) followed by the path (address expression):
xStatus <address expression>
Quering status information
The xStatus type commands returns information about the
system and system processes. You can query all information or
just some of it.
To address status information enter the xStatus command
followed by an address expression (XPath or SimplePath).
You can set up the xStatus read command to address all
information or just some of it, see the examples to the right for
illustrations.
Example 1: Query all ongoing Call information:
xstatus call
*s Call 3 Status: Connected
*s Call 3 Direction: Outgoing
*s Call 3 Protocol: “h323”
*s Call 3 RemoteNumber: “[e-mail]”
*s Call 3 CallbackNumber: “h323:[e-mail]”
*s Call 3 DisplayName: “[e-mail]”
*s Call 3 TransmitCallRate: 768
*s Call 3 ReceiveCallRate: 768
*s Call 3 Encryption Type: “None”
*s Call 3 PlacedOnHold: False
*s Call 3 Duration: 9
** end
OK
Example 2: Query the protocol for a call:
xstatus call protocol
*s Call 3 Protocol: “h323”
OK