Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
Introduction
About this guide
This guide introduces 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 C20
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
To download the user documentation go to:
http://www.cisco.com/go/quickset-docs
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
If the administrator password is not set, there is an on screen
warning in the lower right corner indicating this. The warning
disappears when the password is set.
Improved video layout
Improved local layout control when using the Touch controller
Improved local layout control when using the Touch controller.
You can easily choose between the layout options using the
Touch controller. Each option is illustrated by an icon reecting
the actual layout.
You can choose between the predened layout options as well as
any custom layouts that have been created for this TelePresence
system (for example created with the TC Console application).
Picture-in-Picture support
There is support for showing Picture-in-Picture (PIP), for example
showing full-screen presentation with both remote video and
self-view as PIP.
The PIPs can be moved to predened drop zones, typically upper
right, upper left, lower right etc. When using a Touch controller
you can see the drop zones as you star t moving the PIP.
Full screen self-view
Full screen self-view while in call is supported on dual monitor
systems.
Secure communication in a CUCM environment
As from version TC5 endpoints running TC software can register
to a Cisco Unied Communications Manager (CUCM) version
8.6.2 or newer. In TC6.0 this feature is extended to also include
secure (encrypted) connections. The encryption indicator is
shown on the on-screen interface during a call.
This feature requires that security mode is installed and cong-
ured on CUCM. Read the Administering TC Endpoints on CUCM
9.0 guide to nd how to set up this feature.
Support for SIP URI dialing when registered to CUCM
As from Cisco Unied Communications Manager (CUCM) version
9.0, endpoints registered to CUCM support URI dialing. A URI is
an alias for a directory number (DN). A call to the URI behaves
as if the call was made directly to the directory number.
URI example: conference_room@company.com. The user name
(left side) is case sensitive in CUCM 9.0, while the domain (right
side) is not.
Support for encrypted Cisco TelePresence Multipoint Switch
(CTMS) calls
Video systems running software TC5.0 or later are able to initiate or join non-encrypted multiparty conferences controlled by
CTMS version 1.8 or later. Encrypted conferences are supported
as from software versions TC6.0 and CTMS 1.9.1.
The TelePresence system must have a secure registration to
VCS or CUCM to allow encrypted calls.
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
ISDN Link support
You can pair a TelePresence system with a Cisco TelePresence
ISDN Link. As from software versions TC6.0 and IL1.1 automatic
pairing mode is supported.
When making a call via ISDN Link, choose H320 (ISDN) as the
call protocol.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
Introduction
Localization
The following new languages are supported on the Cisco
TelePresence Touch:
• Traditional Chinese
• Portuguese Brazilian
• Tu r k i s h
• Czech
• Polish
• Dutch
• Hungarian
• Italian
• Korean
Troubleshooting and diagnostics
A new troubleshooting feature introduced. The TelePresence
system runs a set of tests to detect possible problems and
provides links on the web interface to resolve the issues.
The Mediatrace diagnostics tool
Mediatrace is a diagnostic tool that discovers the routers and
switches (layer 2 and 3 devices) long the path of an IP ow.
It collects critical information hop by hop on specic media
streams as they traverse the network. Mediatrace should be
enabled on each network node you want to collect information from. Because the path of video data packets from the
endpoints is traced, troubleshooting is facilitated and network
performance can be optimized.
xStatus Provisioning CUCM CTL State
xStatus SystemUnit Hardware TemperatureThreshold
xStatus SystemUnit Diagnostics LastRun
xStatus SystemUnit Diagnostics Message Type
xStatus SystemUnit Diagnostics Message Level
xStatus Video Layout Site Output Frame VideoSourceContent
xStatus Video Selfview Mode
xStatus Video Selfview FullscreenMode
xStatus Video Selfview PIPPosition
xStatus Video Selfview OnMonitorRole
xStatus Video PIP ActiveSpeaker Position
xStatus Video PIP Presentation Position
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
API fundamentals
This chapter contains a top-level view of the mechanisms
supported by the codec API. You can use the API to manage
all parts of the TelePresence system.
Here you can read about how to access the API, how to use
the command line and what the dierent parts of the API can
be used for. Information on how to use the feedback functions
that are available for the codec is included in this chapter.
The API consists of four major groups:
• Commands
• Congurations
• Status
• Events
These four groups are hierarchically organized, which makes it
easier to nd related functionality. You can nd the complete
lists of all commands, congurations and statuses in the following chapters.
Connecting to the API
There are several ways to access the codec API. Regardless
of which method you choose, the structure of the API stays the
same. Choose the connection method that suites your application best. Before you start, please read this section about the
dierent methods, as some of those may require additional
conguration changes before being enabled.
The following commands can be set from the System conguration menu in the web interface or on the on-screen-diplay, or
from the command line interface. All of the examples are for
the command line interface.
Password
Initially, no password is set for the default admin user. We
strongly recommend that you set a password for this user, and
any other users possessing an ADMIN role, to restrict access
to system conguration. The password can be changed by
issuing the following command:
xCommand SystemUnit AdminPassword Set Password:
<password>
RS-232/serial connection
This is one of the most used connections to our products for
integrators, as it can be used without an IP-address, DNS or
a network.
Codec congurations
There are two dierent congurations that can be changed for
serial connections; the baud-rate and whether login is required
or not. A reboot of the codec is required for these settings to
For the C20 codec you need to use a Y-cable to connect to
the Camera port.
NOTE:
• For security reasons the password prompting is turned on
by default, but it can be turned o if preferred.
The default baud rate is set to 38400. The reason for this is
•
that the codec can give very much feedback. When using
9600 baud it may cause your integration to appear sluggish.
We therefore recommend keeping the connection at this
speed or higher.
•
During the initial boot sequence, the codec uses a baud rate
of 38400 regardless of the application baud rate you have set.
For details regarding the RS-232 pin-out and more, please
refer to theAdministrator Guide.
Telnet
Telnet can be viewed as the equivalent of the serial protocol in
the TCP/IP world. Telnet is disabled by default. Before connecting to the codec with Telnet you have to enable it.
Codec conguration
To enable Telnet service, congure the following setting on the
codec. Changing this setting does not require a reboot of the
device, but it may take some time to take eect.
xCong uration NetworkServices Telnet Mode: On
SSH
SSH is a secure TCP/IP connection and it is enabled by default
on the codec. It can be disabled. You need a SSH client, such
as PuTTY, to access the API over SSH.
HTTP/HTTPS
As HTTP/HTTPS are connectionless protocols, there is no
persistent connection. There are several ways of communicating
with the API over HTTP.
Codec conguration
In order to enable or disable the HTTP and HTTPS services,
congure the following settings on the codec. Changing these
settings requires a reboot of the device.
xCong uration NetworkServices HTTP Mode:
<Off/O n >
xCong uration NetworkServices HTTPS Mode:
<Off/O n >
Connecting
You can inspect the API by entering the IP-address or host name
of the codec in your favorite web browser. In the web interface, you can nd the API documents under the menu section
System Conguration > API > XML API. The HTTP POST and
GET methods are used to execute commands and get feedback
from the codec. This is described in the “Using HTTP” section
later in this document.
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Using the command line
Help
To get a list of all supported root commands you can type ?
or help after connecting to the TelePresence System using
RS-232, Telnet or SSH.
Bye
Typing the bye command closes the command line interface.
API commands
xConguration
Congurations are system settings, such as system name and
network settings. These are persistent across boots. For more
information see ”Congurations”.
xCommand
Commands instruct the codec to execute actions, such as to
dial a number or to search the phone book. For more information see ”Commands”.
xStatus
A status contains the current state of the codec, such as
connected calls, the status of the gatekeeper registration,
connected inputs and output sources. For more information
see ”Status”.
xFeedback
The Feedback commands are used to specify what parts of
the conguration and status hierarchies to monitor. Feedback
is only issued on the RS-232, Telnet or SSH session for which
it is specied. If you are connecting to the codec with multiple
sessions, you have to dene feedback individually for each
session. For more information see ”Feedback mechanism”.
?
- User Commands -
help
xstatus
bye
OK
xPreferences
The xPreferences command is used to set preferences for the
RS-232, Telnet and SSH sessions. For more information see
”API output”.
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.
xEvent
the xEvent command returns information on which events are
available for feedback. For more information see ”Events”.
xHistory
The xHistory command returns the call log.
xGetxml
The xGetxml request returns an XML document based on the
location parameter attached to the request. The elements (or a
complete document) matching the expression will be returned.
For more information see ”Using HTTP”.
xconguration
xevent
log
xfee d back
xpreferences
echo
xgetx m l
xcommand
xhistory
systemtools
Other commands
Systemtools
The systemtools commands are used for administrative control
of the codec and are only available from the command line
interface. Systemtools are not a part of the programming API.
For more information see ”The SystemTools commands” in
the Appendices chapter.
Log
The log command is used to enable advanced logs. It is only
used for debugging the system.
Command line shortcuts
If your client supports it, there are some timesaving shortcuts
you can use:
Tab-completion to complete the commands and arguments.
•
• Arrow up and arrow down keys to navigate your command
history.
• < C TR L- a >: Jump to the beginning of the line.
• < C TR L- e >: Jump to the end of the line.
• < C TR L- r >: Incremental command history search.
• < C TR L- w >: Erase the current line.
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Searching
You can use // to search for elements anywhere in the status
or conguration hierarchy (Example 1).
You can also combine multiple //’s (Example 2).
WARNING: The search shortcuts work well for inspecting the
API, but should not be used in applications. We recommend that
you always use the complete paths to avoid command ambiguity
when upgrading to newer rmware releases.
Value types and formats
The system supports the following value types (Example 3):
• Integer values: <x..y>
Denes the valid range for an integer input. x = min value,
y = max value.
• Literal values: <X/Y/../Z>
Denes the possible values for a given conguration.
• String values: <S: x, y>
Denes that the valid input for this conguration is a
string with minimum length of x and maximum length of y
characters. Strings can have rules that further specif y their
format and length.
Input values that contain spaces need to be quoted
Any values for congurations and commands containing spaces
must be enclosed in quotes. Quotes are not necessary for
values without spaces.
Examples:
Correct: xCo m mand dia l nu m be r: “my nu mber co ntai n s
spaces”
Correct: xCommand dial num ber: 12345
Incorrect:xCo mmand dia l nu m be r: my num b e r cont ains
spaces
Example 1: List all congurations that include a word that starts with DVI:
xCong uration //dvi
*c xConguration Video Input DVI 3 Ty pe: AutoDetect
*c xConguration Video Input DVI 5 Ty pe: AutoDetect
*c xConguration Video Output DVI 2 Resolution: 1366 _ 768 _ 60
*c xConguration Video Output DVI 2 OverscanLevel: None
*c xConguration Video Output DVI 2 MonitorRole: Second
*c xConguration Video Output DVI 4 Resolution: Auto
*c xConguration Video Output DVI 4 OverscanLevel: None
*c xConguration Video Output DVI 4 MonitorRole: Fourth
** end
Example 2: Get the resolution width of all connected sources for both inputs and outputs:
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
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 prex 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 (r) behind 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 prex. The command to be
1.
executed is Dial.
2.
The example contains one argument, Number: 123. Number
is the key and 123 is its value. The key/value pair is separated with ‘:’.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Congurations
Congurations are system settings that are persistent across
boots. Like commands, also congurations are structured in
a hierarchy.
Writing xConguration ? on the command line lists all the top
level congurations.
Writing xConguration ?? lists all congurations and their value
spaces.
Writing xConguration lists all congurations and their current
values. To list out only parts of the conguration, write xConguration followed by one or more parts of the conguration paths.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Status
A status contains the current state of the codec, such as connected
calls, the status of the gatekeeper registration, connected inputs
and output sources.
Writing xStatus ? on the command line lists all top level statuses.
Writing xStatus lists all statuses and their current values.
To list out only some of the statuses, write xstatus followed by
the relevant part of the status path.
xStatus ?
– Status –
Audio
C a l l [...]
Camera
Conference
Diagnostics
Experimental
H320
OK
H323
Ht t p F e e db a c k[1..4]
MediaChan nels
Network
Preset[1..15]
Provisioning
Secu rity
SIP
Standby
SystemUnit
Time
Video
Addressing status information with xStatus
To read the status from the system type the root command (xStatus) followed by a path (address expression):
xStatus <address expression>
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Events
Event returns information about the events that are available
for feedback. This overview presents examples of some the
events that are available on the API.
To get an overview of the supported events type ?, ?? or help
after xEvent:
• xEvent ? Lists the top level events
• xEvent ?? List all of the available events
• xEvent help Lists the top level events
The result for events depends on the state of the codec.
Example 1: Outgoing Call Indication
Outgoing Call Indication is an event reported when an outgoing call is about to be dialled. Returns the CallId the call has
been assigned.
*e OutgoingCallIndication CallId: x
** end
Example 2: Call Disconnect
Call Disconnect is an event reported when a call is disconnected.
Returns the CallId of the disconnected call and reason for the
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Feedback mechanism
To build solutions that can reliably keep the state between the
application and the codec synchronized; you need to set up a
notication system to report the changes in the state of the codec.
The API supports notications on the following:
• Conguration changes
• Status changes
• Event notications
These notications will not be sent unless the user has explicitly
told the codec to do so. The user is required to subscribe to
all the feedback the application needs. This is done by registering feedback expressions. The way of registering feedback
expressions varies according to the connection method used.
When using HTTP, the method of handling feedback diers
slightly from what is presented in this section. See the
”Feedback from codec over HTTP” section for more information.
WARNING: A codec may give very much feedback, especially
when calls are connected and disconnected. Therefore, you
should only subscribe to the feedback that you need.
Never register for all status feedback by issuing
xFeedback register /Status. This may give the control application too much data to handle, which may lead to sluggish
or unpredictable behavior.
Feedback expressions
The expression used when registering for feedback is a variant of the XPath language. This language describes a way to
select nodes from an XML document. TC software contains
three main feedback documents:
DocumentAPI commandPath
StatusxStatus/Status
CongurationxConguration/Conguration
EventxEvent/Event
The syntax for feedback registering is: xFeedback register <path>
Never register for all status feedback by issuing
xFeedback register /Status.
It is safe to register for all configuration changes using
xFeedback register /Conguration, as conguration changes
will most likely not occur that often.
By going through some examples, we can see how this
information can be used to build feedback expressions. A
good way to verify the expressions is to point your browser
to http://<ip-address>/getxml?location=path or to execute
xgetxml <path> from the terminal, and check that the output
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Terminal connections
Managing feedback subscriptions
To register, list and deregister feedback expressions you use
the command xFeedback and its corresponding sub commands.
The registered expressions are only valid for the currently
active connection. If you open two Telnet sessions and register
to get feedback in one session, you do not receive feedback
in the other serssion. This also means that if you disconnect
from a session, you have to re-register all expressions after
reconnecting.
You can register up to 38 expressions.
Feedback output
The feedback output is exactly the same as you get when query-
ing the system using the xConguration and xStatus commands.
E.g., if you issue the command xStatus Stand by Active
on the command line the result is:
*s Standby Active: On
** end
If you have registered for feedback on status changes the
feedback you get when the system goes to standby-mode
will be exactly the same:
*s Standby Active: On
** end
This means that when you are programming against the device
you only need to handle one format.
Example: Managing feedback subscriptions
A: Register feedback expressions.
Write in:
xFeedback register /Status/Audio
Result: ** end
OK
Write in: xFeed back register /Event/CallDisconnect
Result: ** end
OK
Write in: xFeed back register /Conguration/Video/
MainVideoSource
Result: ** end
OK
B: List out currently registered expressions.
Write in:
xFeedback list
Result: /Cong uration/Video/MainVideoSource
/Event/CallDisconnect
/Status/Audio
** end
OK
C: Deregister feedback expressions.
Write in:
xFeedback deregister /Event/CallDisconnect
Result: ** end
OK
Write in: xFeed back deregister /Status/Audio
Result: ** end
OK
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
It is possible to use HTTP GET when sending commands or
congurations to the codec. This makes it easy to test commands
using your browser.
Example 1: Setting the camera position.
http://<ip-address>/formputxml?xmldoc=
<Command><Camera><PositionSet command=”True”>
<C a meraId >1</C a m er a Id > < P a n >200</Pa n >
<Tilt>200</Tilt></Posit ionSet></Ca m e ra ></Com mand >
Example 3: Changing multiple congurations in one go.
http://<ip-address>/formputxml?xmldoc=
<Con guratio n><Audio>< Volu m e>80</Volu m e>
</Audio><Video><OSD><TodaysBookings>On
</TodaysBookings></OSD></video><Conguration>
Using HTTP POST
When sending congurations and commands to the codec,
it is impor tant that the HT TP header Content-Type is set to
text/xml, i.e. Content-Type: text/xml. The body of the POST
should contain the XML content.
Example 1: Changing the system name.
Request
POST /putxml HTTP/1.1
Co nt e nt-Ty p e: t e xt/x m l
Connection: close
<Conguration>
<SystemUnit>
<Name>newName</Name>
</SystemUnit>
</Conguration>
Example 2: Setting the camera position.
Request
POST /putxml HTTP/1.1
Co nt e nt-Ty p e: t e xt/x m l
Connection: close
<Command>
<Camera>
<PositionSet command=”True”>
<CameraId>1</CameraId>
<Pan>200< /Pan>
<Tilt>200</Tilt>
</PositionSet>
</Camera>
</Command>
Response
HTTP/1.1 200 OK
Date: <date>
Server: WSGIServer/0.1 Python/2.5.4
Cache-Control: no-cache
Co nt e nt-Ty p e: t e xt/x m l
Content-Length: 91
Connection: close
<?xml version=”1.0”?>
<Command>
<CameraPositionSetResult item=”1” status=”OK”/>
</Command>
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Feedback from codec over HTTP
To get notications from the codec, you need to register HTTP
feedback expressions. The codec will then use HT TP POST
to send feedback messages to the supplied IP-address. This
means that you have to have a HTTP ser ver running for your
application to receive updates from the codec.
Registering for feedback
The command for registering is xCommand HttpFeedback Register.
The syntax for this command and its arguments are described
in this section.
HttpFeedback Register syntax:
xCom mand HttpFeedback Register
FeedbackSlot: <1..4>
ServerUrl(r): <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
HttpFeedback Register arguments:
FeedbackSlot: The codec can register up to 4 slots of servers
requesting HTTP feedback. Set the registering to one of the.
NOTE: Avoid using FeedbackSlot 3 in an environment where
Cisco TelePresence Management Suite (TMS) is used as TMS
uses this feedbackslot to register its expressions.
ServerUrl: The URL that you want the codec to post the HTTP
feedback messages to.
Expression 1-15: Register the expressions you want to receive
feedback on. See the “Feedback mechanism” section for
more information about the expression formats.
Example: Registering feedback on conguration changes,
disconnect events and call status changes.
<Command>
<HttpFeedback>
<Register com mand=”True”>
<FeedbackSlot>1</FeedbackSlot>
<ServerUrl>http://127.0.0.1/
myhttppostscripturl</ServerUrl>
<Expression item=”1”>/Conguration</
Expression>
<Expression item=”2”>/Event/
CallDisconnect</Expression>
<Expression item=”3”>/Status/Call</
Expression>
</Register>
</HttpFeedback >
</Command>
Feedback output
When the codec noties the registered HTTP server about
changes, the body contains the same XML as when polling.
There is however one small dierence. The root-node contains
an Identication node with children that specify the codec from
which the notication originated. This means that you can handle
multiple codecs with a single HTTP server URI.
Example: Audio volume changed.
<Conguration xm lns=”http://www.company.com/XML/
CUIL /2.0” >
<Identic ation>
<SystemName>integrator</SystemName>
<MACAdd ress>00:00:de:ad:be:ef</MACAddress>
<IPA d dress>192.168.1.100</I PA d d re s s >
<ProductType>Cisco Codec</ProductType>
<ProductID>Cisco Codec C20</ProductID>
<S W Ve r sion >TC6.0.0.199465 < /S W Ve r s io n >
<HWBoard>101401-5 [08]</HWBoard>
<SerialNu m b er>PH0000000</SerialNumber>
</Identication>
<Audio item=”1”>
<Volume item=”1”>60</Volume>
</Audio>
</Conguration>
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
About the API
Dos and don’ts
Here are some issues you should consider when programming
the Cisco C- and SX-series API.
AVOID remote control emulation
The use of xCommand Key Press and xCommand Key Click
commands is highly discouraged. The commands are still available in the API, but we recommend the use of direct commands,
as this ensures backwards compatibility in your integrations.
Program against the codec, not the on-screen-display.
DO use complete commands
You should always use complete commands when programming, i.e. always use xConguration Video instead of xconf
vid. The shortcuts can be used for searches in the API on the
command line, but not for programming. The reason for this is
that you might end up with ambiguous code when additional
commands are added to the API.
DO NOT subscribe to unnecessary feedback
Subscribing to too much feedback may congest the control
application. Although the amount of feedback may seem ne
in the current version, the amount of feedback may grow in
future releases.
DO NOT use the experimental section in production
Under the listing of commands, status and congurations, you
can nd subsections that start with Experimental.
• xCommand Experimental
• xStatus Experimental
• xConguration Experimental
These sections give access to features that we are still work-
ing on and have yet to release for ocial use. This part of the
API will NOT stay backwards compatible and the structure
WILL CHANGE.
Do not use the experimental section in production - in future
versions of the rmware these sections may be hidden or removed.
DO present one screen to the end user
Avoid making the user look at two menus, one on the control
panel and one on the video screen. Do not make the control
panel a substitute for the remote control. The on-screen-display
in is using the exact same API as you have access to through
the command interface.
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
xConguration Standby Control ........................................................................................................................ 53
xConguration SystemUnit Name ..................................................................................................................... 54
Time conguration ................................................................................................................ 56
xConguration Time DateFormat ...................................................................................................................... 56
xConguration Time TimeFormat ...................................................................................................................... 56
xConguration Time Zone ................................................................................................................................. 56
Video conguration .............................................................................................................. 57
xConguration Video AllowWebSnapshots ...................................................................................................... 65
xConguration Video DefaultPresentationSource ............................................................................................ 59
xConguration Video Input DVI [2] RGBQuantizationRange .............................................................................. 59
xConguration Video Input DVI [2] Type ............................................................................................................ 60
xConguration Video Input HDMI [1..1] RGBQuantizationRange ....................................................................... 59
xConguration Video Input Source [1..2] CameraControl CameraId ................................................................ 58
xConguration Video Input Source [1..2] CameraControl Mode ....................................................................... 58
xConguration Video Input Source [1..2] Name ................................................................................................ 57
xConguration Video Input Source [1..2] OptimalDenition Prole................................................................... 58
xConguration Video Input Source [1..2] OptimalDenition Threshold60fps ................................................... 59
xConguration Video Input Source [1..2] PresentationSelection ...................................................................... 58
xConguration Video Input Source [1..2] Quality .............................................................................................. 59
xConguration Video Input Source [1..2] Type .................................................................................................. 57
xConguration Video Input Source [1] Connector ............................................................................................ 57
xConguration Video Input Source [2] Connector ............................................................................................ 57
xConguration Video Layout LocalLayoutFamily .............................................................................................. 62
xConguration Video Layout RemoteLayoutFamily .......................................................................................... 63
xConguration Video Layout ScaleToFrame ..................................................................................................... 60
xConguration Video Layout ScaleToFrameThreshold ..................................................................................... 60
xConguration Video Layout Scaling ................................................................................................................ 60
xConguration Video MainVideoSource ........................................................................................................... 59
xConguration Video Monitors .......................................................................................................................... 63
xConguration Video OSD AutoSelectPresentationSource ............................................................................. 64
xConguration Video OSD EncryptionIndicator ................................................................................................ 64
xConguration Video OSD InputMethod Cyrillic ............................................................................................... 65
xConguration Video OSD InputMethod InputLanguage .................................................................................. 65
xConguration Video OSD LoginRequired ........................................................................................................ 65
xConguration Video OSD MenuStartupMode ................................................................................................. 63
xConguration Video OSD MissedCallsNotication ......................................................................................... 64
xConguration Video OSD Mode ...................................................................................................................... 63
xConguration Video OSD MyContactsExpanded ........................................................................................... 64
xConguration Video OSD Output .................................................................................................................... 64
xConguration Video OSD TodaysBookings ..................................................................................................... 64
xConguration Video OSD VirtualKeyboard ...................................................................................................... 63
xConguration Video Output HDMI [1,2] CEC Mode ......................................................................................... 65
xConguration Video Output HDMI [1,2] MonitorRole ....................................................................................... 66
xConguration Video Output HDMI [1,2] OverscanLevel .................................................................................. 66
xConguration Video Output HDMI [1,2] Resolution ......................................................................................... 66
xConguration Video Output HDMI [1,2] RGBQuantizationRange ..................................................................... 65
xConguration Video PIP ActiveSpeaker DefaultValue Position ....................................................................... 62
xConguration Video PIP Presentation DefaultValue Position .......................................................................... 62
xConguration Video Selfview .......................................................................................................................... 60
xConguration Video SelfviewDefault FullscreenMode .....................................................................................61
xConguration Video SelfviewDefault Mode .....................................................................................................61
xConguration Video SelfviewDefault OnMonitorRole ......................................................................................61
xConguration Video SelfviewDefault PIPPosition ............................................................................................61
xConguration Video SelfviewPosition ............................................................................................................. 60
xConguration Video WallPaper ....................................................................................................................... 66
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
Audio conguration
xConguration Audio Microphones Mute Enabled
Determine whether audio-mute is allowed or not. The default value is True.
Requires user role: ADMIN
Value space: <True/InCallOnly>
Tru e: Muting of audio is always available.
InCallOnly: Muting of audio is only available when the device is in a call. When Idle it is not possible to
mute the microphone. This is useful when an external telephone service/audio system is connected
via the codec and is to be available when the codec is not in a call. When set to InCallOnly this will
prevent the audio-system from being muted by mistake.
The system can be congured to make a keyboard click sound eect (key tone) when pressing a key
on the remote control, or when typing text or numbers on a Touch controller.
Requires user role: USER
Value space: <Off/On >
O: No key tones will be played when you type.
On: You will hear a key tone when you press a key or type text.
Example: xConguration Audio SoundsAndAlerts KeyTones Mode: Off
xConguration Audio SoundsAndAlerts RingTone
Select the ring tone for incoming calls.
Requires user role: USER
Value space: <Marbles/IceCrystals/Polaris/Alert/Discreet/Fantasy/Jazz/Nordic/
Ec ho/R hy t h m ic>
Range: Select a tone from the list of ring tones.
Example: xConguration Audio SoundsAndAlerts RingTone: Jazz
xConguration Audio Volume
Adjust the speaker volume.
Requires user role: USER
Value space: <0..100>
Range: The value must be between 0 and 100. The values from 1 to 100 correspond to the range
from -34.5 dB to 15 dB (0.5 dB steps). The value 0 means that the audio is switched o.
Example: xConguration Audio Volume: 70
xConguration Audio SoundsAndAlerts RingVolume
Sets the ring volume for an incoming call.
Requires user role: USER
Value space: <0..100>
Range: The value goes in steps of 5 from 0 to 100 (from -34.5 dB to 15 dB). Volume 0 = O.
This conguration turns backlight compensation on or o. Backlight compensation is useful when there
is much light behind the persons in the room. Without compensation the persons will easily appear very
dark to the far end.
Requires user role: ADMIN
Value space: <Off/On >
O: Turn o the camera backlight compensation.
On: Turn on the camera backlight compensation.
Example: xConguration Cam eras Ca mera 1 Backlight: Off
xConguration Cameras Camera [1..1] Brightness Mode
Set the camera brightness mode.
Requires user role: ADMIN
Value space: <Auto/Manual>
Auto: The camera brightness is automatically set by the system.
Manual: Enable manual control of the camera brightness. The brightness level is set using the Cameras
Camera Brightness Level setting.
Example: xConguration Cam eras Ca mera 1 Brightness Mode: Auto
xConguration Cameras Camera [1..1] Brightness Level
Set the brightness level. NOTE: Requires the Camera Brightness Mode to be set to Manual.
Requires user role: ADMIN
Value space: <1..31>
Range: Select a value from 1 to 31.
Example: xConguration Cam eras Ca mera 1 Brightness Level: 1
xConguration Cameras Camera [1..1] Flip
With Flip mode (vertical ip) you can ip the image upside down.
Requires user role: ADMIN
Value space: <Au t o/Off/O n >
Auto: When the camera is placed upside down the image is automatically ipped upside down. This
setting will only take eect for a camera that automatically detects which way it is mounted.
O: Display the video on screen the normal way.
On: When enabled the video on screen is ipped. This setting is used when a camera is mounted
upside down, but cannot automatically detect which way it is mounted.
Example: xConguration Cam eras Ca mera 1 Flip: Off
xConguration Cameras Camera [1..1] Focus Mode
Set the camera focus mode.
Requires user role: ADMIN
Value space: <Auto/Manual>
Auto: The camera will auto focus once a call is connected, as well as after moving the camera (pan,
tilt, zoom). The system will use auto focus only for a few seconds to set the right focus; then auto
focus is turned o to prevent continuous focus adjustments of the camera.
Manual: Turn the autofocus o and adjust the camera focus manually.
Example: xConguration Cam eras Ca mera 1 Focus Mode: Auto
xConguration Cameras Camera [1..1] Gamma Mode
Applies to cameras which support gamma mode. The Gamma Mode setting enables for gamma corrections. Gamma describes the nonlinear relationship between image pixels and monitor brightness. The
Cisco TelePresence PrecisionHD 720p camera supports gamma mode. The PrecisionHD 1080p camera
does not support gamma mode.
Requires user role: ADMIN
Value space: <Auto/Manual>
Auto: Auto is the default and the recommended setting.
Manual: In severe light conditions, you may switch mode to manual and specif y explicitly which
gamma table to use by setting the Gamma Level.
Example: xConguration Cam eras Ca mera 1 Gam ma Mode: Auto
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Cameras Camera [1..1] Gamma Level
By setting the Gamma Level you can select which gamma correction table to use. This setting may be
useful in dicult lighting conditions, where changes to the brightness setting does not provide satisfactory results. NOTE: Requires the Gamma Mode to be set to Manual.
Requires user role: ADMIN
Value space: <0..7 >
Range: Select a value from 0 to 7.
Example: xConguration Cam eras Ca mera 1 Gam ma Level: 0
xConguration Cameras Camera [1..1] IrSensor
The IR sensor LED is located in the front of the camera and ickers when the IR sensor is activated from
the remote control. Both the Codec C Series and PrecisionHD camera have IR sensors, and only one
of them needs to be enabled at the time.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable the IR sensor on the camera.
On: Enable the IR sensor on the camera.
Example: xConguration Cam eras Ca mera 1 IrSensor: On
xConguration Cameras Camera [1..1] Mirror
With Mirror mode (horizontal ip) you can mirror the image on screen.
Requires user role: ADMIN
Value space: <Au t o/Off/O n >
Auto: When the camera is placed upside down the image is automatically mirrored. Use this setting
with cameras that can be mounted upside down, and that can auto detect that the camera is mounted
upside down.
O: See the self view in normal mode, that is the experience of self view is as seeing yourself as
other people see you.
On: See the self view in mirror mode, that is the self view is reversed and the experience of self view
is as seeing yourself in a mirror.
Example: xConguration Cam eras Ca mera 1 Mirror: Off
xConguration Cameras Camera [1..1] Whitebalance Mode
Set the camera whitebalance mode.
Requires user role: ADMIN
Value space: <Auto/Manual>
Auto: The camera will continuously adjust the whitebalance depending on the camera view.
Manual: Enables manual control of the camera whitebalance. The whitebalance level is set using the
Cameras Camera Whitebalance Level setting.
Example: xConguration Cam eras Ca mera 1 W hitebalance Mode: Auto
xConguration Cameras Camera [1..1] Whitebalance Level
Set the whitebalance level. NOTE: Requires the Camera Whitebalance Mode to be set to manual.
Requires user role: ADMIN
Value space: <1..16>
Range: Select a value from 1 to 16.
Example: xConguration Cam eras Ca mera 1 W hitebalance Level: 1
xConguration Cameras Camera [1..1] DHCP
Applies to cameras which support DHCP (for example the Cisco TelePresence PrecisionHD 1080p 12X
camera). The camera must be connected to a LAN. When set, the command enables support for SW
upgrade of daisy chained cameras. It will enable the camera's DHCP function and force start of MAC and
IP address retrieval. Remember to reset the DHCP when the camera is no longer connected to a LAN.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable DHCP in the camera. NOTE: This setting should be applied when the camera is not
connected to a LAN.
On: Enable DHCP in the camera. The camera is automatically re-booted. After re-boot the DHCP is
started and the IP address will be retrieved. Run the commnand "xStatus Camera" for result.
Example: xConguration Cam eras Ca mera 1 DHCP: Off
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
Conference conguration
xConguration Conference [1..1] AutoAnswer Mode
Set the auto answer mode.
Requires user role: ADMIN
Value space: <Off/On >
O: An incoming call must be answered manually by pressing the OK key or the green Call key on
the remote control, or by tapping the Accept key on the Touch controller..
On: Enable auto answer to let the system automatically answer all incoming calls.
Example: xConguration Conference 1 AutoAnswer Mode: Off
xConguration Conference [1..1] AutoAnswer Mute
Determine if the microphone shall be muted when an incoming call is automatically answered. NOTE:
Requires that AutoAnswer Mode is switched on.
Requires user role: ADMIN
Value space: <Off/On >
O: The incoming call will not be muted.
On: The incoming call will be muted when automatically answered.
Example: xConguration Conference 1 AutoAnswer Mute: Off
xConguration Conference [1..1] AutoAnswer Delay
Dene how long (in seconds) an incoming call has to wait before it is answered automatically by the
system. NOTE: Requires that AutoAnswer Mode is switched on.
Determine if the microphones shall be unmuted automatically when all calls are disconnected. In a
meeting room or other shared resources this may be done to prepare the system for the next user.
Requires user role: ADMIN
Value space: <Off/On >
O: If muted during a call, let the microphones remain muted after the call is disconnected.
On: Unmute the microphones after the call is disconnected.
Example: xConguration Conference 1 MicUnmuteOnDisconnect Mode: On
xConguration Conference [1..1] DoNotDisturb Mode
Determine if there should be an alert on incoming calls.
Requires user role: USER
Value space: <Off/On /T i m e d >
O: The incoming calls will come through as normal.
On: All incoming calls will be rejected and they will be registered as missed calls. The calling side
will receive a busy signal. A message telling that Do Not Disturb is switched on will display on the
Touch controller or main display. The calls received while in Do Not Disturb mode will be shown as
missed calls.
Timed: Select this option only if using the API to switch Do Not Disturb mode on and o (xCommand
Conference DoNotDisturb Activate and xCommand Conference DoNotDisturb Deactivate).
Example: xConguration Conference 1 DoNotDisturb Mode: Off
This setting determines the default duration of a Do Not Disturb session, i.e. the period when incoming
calls are rejected and registered as missed calls. The session can be terminated earlier by using the
user interface (remote control or Touch controller) or the Conference DoNotDisturb Mode setting. The
default value is 60 minutes.
Requires user role: ADMIN
Value space: <0..1440>
Range: Select the number of minutes (between 0 and 1440, i.e. 24 hours) before the Do Not Disturb
session times out automatically.
Lets you decide if the remote side (far end) should be allowed to select your video sources and control
your local camera (pan, tilt, zoom).
Requires user role: ADMIN
Value space: <Off/On >
O: The far end is not allowed to select your video sources or to control your local camera (pan,
tilt, zoom).
On: Allows the far end to be able to select your video sources and control your local camera (pan,
tilt, zoom). You will still be able to control your camera and select your video sources as normal.
Example: xConguration Conference 1 FarEndControl Mode: On
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Set the far end control (H.224) signal capability mode.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable the far end control signal capability.
On: Enable the far end control signal capability.
Example: xConguration Conference 1 FarEndControl SignalCapability: On
xConguration Conference [1..1] Encryption Mode
Set the conference encryption mode. A padlock with the text "Encryption On" or "Encryption O"
displays on screen for a few seconds when the conference starts.
Requires user role: ADMIN
Value space: <Off/On/BestEffort>
O: The system will not use encryption.
On: The system will only allow calls that are encr ypted.
BestEort: The system will use encryption whenever possible.
> In Point to point calls: If the far end system supports encryption (AES-128), the call will be encr ypted.
If not, the call will proceed without encryption.
> In MultiSite calls: In order to have encrypted MultiSite conferences, all sites must support encryp-
Set the Default Call Protocol to be used when placing calls from the system.
Requires user role: ADMIN
Value space: <H323/Sip/H320>
H323: H323 ensures that calls are set up as H.323 calls.
Sip: Sip ensures that calls are set up as SIP calls.
H320: H320 ensures that calls are set up as H.320 calls (only applicable if connected to a Cisco
Specify the maximum transmit bit rate to be used when placing or receiving calls. Note that this is the
maximum bit rate for each individual call; use the Conference MaxTotalTransmitCallRate setting to set
the aggregated maximum for all simultaneous active calls.
Specify the maximum receive bit rate to be used when placing or receiving calls. Note that this is the
maximum bit rate for each individual call; use the Conference MaxTotalReceiveCallRate setting to set
the aggregated maximum for all simultaneous active calls.
This conguration applies when using a video system's built-in MultiSite feature (optional) to host a
multipoint video conference.
Specify the maximum overall transmit bit rate allowed. The bit rate will be divided fairly among all active
calls at any time. This means that the individual calls will be up-speeded or down-speeded as appropriate when someone leaves or enters a multipoint conference, or when a call is put on hold (suspended)
or resumed.
The maximum transmit bit rate for each individual call is dened in the Conference MaxTransmitCallRate
setting.
This conguration applies when using a video system's built-in MultiSite feature (optional) to host a
multipoint video conference.
Specify the maximum overall receive bit rate allowed. The bit rate will be divided fairly among all active
calls at any time. This means that the individual calls will be up-speeded or down-speeded as appropriate when someone leaves or enters a multipoint conference, or when a call is put on hold (suspended)
or resumed.
The maximum receive bit rate for each individual call is dened in the Conference MaxReceiveCallRate
setting.
Dynamic: The available transmit bandwidth for the video channels are distributed among the currently
active channels. If there is no presentation, the main video channels will use the bandwidth of the
presentation channel.
Static: The available transmit bandwidth is assigned to each video channel, even if it is not active.
The available transmit video bandwidth is distributed on the main channel and presentation channel
according to "MainChannel Weight" and "PresentationChannel Weight". If the main channel weight is
2 and the presentation channel weight is 1, then the main channel will use twice as much bandwidth
as the presentation channel.
The available transmit video bandwidth is distributed on the main channel and presentation channel
according to "MainChannel Weight" and "PresentationChannel Weight". If the main channel weight is
2 and the presentation channel weight is 1, then the main channel will use twice as much bandwidth
as the presentation channel.
Requires user role: ADMIN
Value space: <1..10>
Range: 1 to 10.
Example: xC onguration Co n fe r ence 1 Vid e oBa n d w id t h Pres e nt ationC h a n n el We ig ht: 5
Dene whether or not to continue sharing a presentation af ter the remote site has put you on hold.
Requires user role: ADMIN
Value space: <Stop/NoAction>
Stop: The video system stops the presentation sharing when the remote site puts you on hold. The
presentation will not continue when the call is resumed.
NoAction: The video system will not stop the presentation sharing when put on hold. The presentation
will not be shared while you are on hold, but it will continue automatically when the call is resumed.
Dene how the video system handles multipoint video conferences. MultiWay requires that your video
network includes an external Multipoint control unit (MCU), which let you set up conferences with many
participants.
Requires user role: ADMIN
Value space: <Auto/Off/M u ltiWay>
Auto: Use MultiWay for multipoint conferences if the MultiWay service is available. If not, the multipoint
mode is set to O automatically.
O: Multipoint conferences are not allowed.
MultiWay: Use MultiWay for multipoint conferences. The Multipoint Mode will be set to O automati-
cally if the MultiWay service is unavailable, for example when a server address is not specied in the
NetworkServices MultiWay Address setting.
Example: xConguration Conference 1 Multipoint Mode: Auto
Select whether or not to allow incoming calls when already in a call/conference.
Requires user role: ADMIN
Value space: <Allow/Deny>
Allow: You will be notied when someone calls you while you are already in a call. You can accept
the incoming call or not. The ongoing call may be put on hold while answering the incoming call; or
you may merge the calls (requires MultiSite or MultiWay support).
Deny: An incoming call will be rejected if you are already in a call. You will not be notied about the
incoming call. However, the call will appear as a missed call in the call history list.
Up to ve dierent facility ser vices can be supported simultaneously. With this setting you can select
what kind of services they are.
A facility service is not available unless both the FacilityService Service Name and the FacilityService
Service Number settings are properly set.
Only FacilityService Service 1 with Type Helpdesk is available on the Touch controller. Facility services
are not available when using the remote control and on-screen menu.
Requires user role: ADMIN
Value space: <Other/Concierge/Helpdesk/Emergency/Security/Catering/Transportation>
Other: Select this option for services not covered by the other options.
Concierge: Select this option for concierge services.
Helpdesk: Select this option for helpdesk ser vices.
Emergency: Select this option for emergency services.
Security: Select this option for securit y services.
Catering: Select this option for catering services.
Transportation: Select this option for transportation services.
Example: xConguration FacilityService Service 1 Type: Helpdesk
xConguration FacilityService Service [1..5] Name
Set the name of each facility service. Up to ve dierent facility services are supported.
A facility service is not available unless both the FacilityService Service Name and the FacilityService
Service Number settings are properly set.
Only FacilityService Service 1 is available on the Touch controller, and its Name is used on the facility
service call button. Facility services are not available when using the remote control and on-screen menu.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: String with a maximum of 255 characters.
Example: xConguration FacilityService Service 1 Name: ""
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration FacilityService Service [1..5] Number
Set the number for each facility service. Up to ve dierent facility services are supported.
A facility service is not available unless both the FacilityService Service Name and the FacilityService
Service Number settings are properly set.
Only FacilityService Service 1 is available on the Touch controller. Facility services are not available
when using the remote control and on-screen menu.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: String with a maximum of 255 characters.
Example: xConguration FacilityService Service 1 Num ber: ""
xConguration FacilityService Service [1..5] CallType
Set the call type for each facility service. Up to ve dierent facility services are supported.
A facility service is not available unless both the FacilityService Service Name and the FacilityService
Service Number settings are properly set.
Only FacilityService Service 1 is available on the Touch controller. Facility services are not available
when using the remote control and on-screen menu.
Requires user role: ADMIN
Value space: <Video/Audio>
Video: Select this option for video calls.
Audio: Select this option for audio calls.
Example: xConguration FacilityService Service 1 CallType: Video
H323 conguration
xConguration H323 NAT Mode
The rewall traversal technology creates a secure path through the rewall barrier, and enables proper
exchange of audio/video data when connected to an external video conferencing system (when the IP
trac goes through a NAT router). NOTE: NAT does not work in conjunction with gatekeepers.
Requires user role: ADMIN
Value space: <Au t o/Off/O n >
Auto: The system will determine if the "NAT Address" or the real IP-address should be used in
signalling. This is done to make it possible to place calls to endpoints on the LAN as well as endpoints
on the WAN.
O: The system will signal the real IP Address.
On: The system will signal the congured "NAT Address" instead of its own IP-address in Q.931 and
H.245. The NAT Server Address will be shown in the startup-menu as: "My IP Address: 10.0.2.1".
Example: xConguration H323 NAT Mode: Off
xConguration H323 NAT Address
Enter the external/global IP-address to the router with NAT support. Packets sent to the router will then
be routed to the system.
In the router, the following ports must be routed to the system's IP-address:
* Port 1720
* Port 5555-5574
* Port 2326-2485
Requires user role: ADMIN
Value space: <S: 0, 64>
Format: String with a maximum of 64 characters.
Example: xConguration H323 NAT Address: ""
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
O: If the H.323 Gatekeeper Authentication Mode is set to O the system will not try to authenticate
itself to a H.323 Gatekeeper, but will still try a normal registration.
On: If the H.323 Gatekeeper Authentication Mode is set to On and a H.323 Gatekeeper indicates that
it requires authentication, the system will try to authenticate itself to the gatekeeper. NOTE: Requires
the Authentication LoginName and Authentication Password to be dened on both the codec and
the Gatekeeper.
Example: xConguration H323 Prole 1 Authentication Mode: Off
The system sends the Authentication Login Name and the Authentication Password to a H.323 Gatekeeper
for authentication. The authentication is a one way authentication from the codec to the H.323 Gatekeeper,
i.e. the system is authenticated to the gatekeeper. If the H.323 Gatekeeper indicates that no authentication is required, the system will still try to register. NOTE: Requires the H.323 Gatekeeper Authentication
Mode to be enabled.
The system sends the Authentication Login Name and the Authentication Password to a H.323 Gatekeeper
for authentication. The authentication is a one way authentication from the codec to the H.323 Gatekeeper,
i.e. the system is authenticated to the gatekeeper. If the H.323 Gatekeeper indicates that no authentication is required, the system will still try to register. NOTE: Requires the H.323 Gatekeeper Authentication
Mode to be enabled.
The H.323 Call Setup Mode denes whether to use a Gatekeeper or Direct calling when establishing
H323 calls.
NOTE: Direct H.323 calls can be made even though the H.323 Call Setup Mode is set to Gatekeeper.
Requires user role: ADMIN
Value space: <Direct/Gatekeeper>
Direct: An IP-address must be used when dialing in order to make the H323 call.
Gatekeeper: The system will use a Gatekeeper to make a H.323 call. When selecting this option
the H323 Prole Gatekeeper Address and H323 Prole Gatekeeper Discovery settings must also
be congured.
Determine how the system shall register to a H.323 Gatekeeper.
Requires user role: ADMIN
Value space: <Manual/Auto>
Manual: The system will use a specic Gatekeeper identied by the Gatekeeper's IP-address.
Auto: The system will automatically try to register to any available Gatekeeper. If a Gatekeeper responds
to the request sent from the codec within 30 seconds this specic Gatekeeper will be used. This
requires that the Gatekeeper is in auto discovery mode as well. If no Gatekeeper responds, the system
will not use a Gatekeeper for making H.323 calls and hence an IP-address must be specied manually.
Enter the IP address of the Gatekeeper. NOTE: Requires the H.323 Call Setup Mode to be set to Gatekeeper
and the Gatekeeper Discovery to be set to Manual.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: Only the valid IP address format is accepted. An IP address that contains letters (192.a.2.0)
or unvalid IP addresses (192.0.1234.0) will be rejected.
The H.323 Alias E.164 denes the address of the system, according to the numbering plan implemented
in the H.323 Gatekeeper. The E.164 alias is equivalent to a telephone number, sometimes combined
with access codes.
Requires user role: ADMIN
Value space: <S: 0, 30>
Format: Compact string with a maximum of 30 characters. Valid characters are 0-9, * and #.
Lets you specify the H.323 Alias ID which is used to address the system on a H.323 Gatekeeper and
will be displayed in the call lists. Example: "rstname.lastname@company.com", "My H.323 Alias ID"
Requires user role: ADMIN
Value space: <S: 0, 49>
Format: String with a maximum of 49 characters.
Example: xC ongurati on H323 Pr o le 1 H323Ali a s ID: "rs t na m e.last n a m e @c o m p a ny.co m"
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration H323 Prole [1..1] PortAllocation
The H.323 Port Allocation setting aects the H.245 port numbers used for H.323 call signalling.
Requires user role: ADMIN
Value space: <Dyna m ic/Static>
Dynamic: The system will allocate which ports to use when opening a TCP connection. The reason
for doing this is to avoid using the same por ts for subsequent calls, as some rewalls consider this
as a sign of attack. When Dynamic is selected, the H.323 ports used are from 11000 to 20999. Once
20999 is reached they restart again at 11000. For RTP and RTCP media data, the system is using UDP
ports in the range 2326 to 2487. Each media channel is using two adjacent ports, ie 2330 and 2331
for RTP and RTCP respectively. The ports are automatically selected by the system within the given
range. Firewall administrators should not try to deduce which ports are used when, as the allocation
schema within the mentioned range may change without any further notice.
Static: When set to Static the ports are given within a static predened range [5555-6555].
Select which internet protocols the system will support.
NOTE: Restart the system after changing this setting.
Requires user role: ADMIN
Value space: <IPv4/IPv6>
IPv4: IP version 4 is used for the SIP and H323 calls.
IPv6: IP version 6 is used for the SIP and H323 calls.
Example: xConguration Network 1 IPStack: IPv4
xConguration Network [1..1] Assignment
Dene how the system will obtain its IPv4 address, subnet mask and gateway address. This setting only
applies to systems on IPv4 networks.
Requires user role: ADMIN
Value space: <Static/DHCP>
Static: The addresses must be congured manually using the Network IPv4 Address, Network IPv4
Gateway and Network IPv4 SubnetMask settings (static addresses).
DHCP: The system addresses are automatically assigned by the DHCP server.
Dene how the system will obtain its IPv6 address and the default gateway address. This setting only
applies to systems on IPv6 networks.
Requires user role: ADMIN
Value space: <Static/DHCPv6/Autoconf>
Static: The codec and gateway IP-addresses must be congured manually using the Network IPv6
Address and Network IPv6 Gateway settings. The options, for example NTP and DNS server addresses,
must either be set manually or obtained from a DHCPv6 server. The Network IPv6 DHCPOptions
setting determines which method to use.
DHCPv6: All IPv6 addresses, including options, will be obtained from a DHCPv6 server. See RFC3315
for a detailed description. The Network IPv6 DHCPOptions setting will be ignored.
Autoconf: Enable IPv6 stateless autoconguration of the IPv6 network inter face. See RFC4862 for
a detailed description. The options, for example NTP and DNS server addresses, must either be set
manually or obtained from a DHCPv6 server. The Network IPv6 DHCPOptions setting determines
which method to use.
Retrieve a set of DHCP options, for example NTP and DNS server addresses, from a DHCPv6 server.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable the retrieval of DHCP options from a DHCPv6 server.
On: Enable the retrieval of a selected set of DHCP options from a DHCPv6 server.
Example: xConguration Network 1 IPv6 DHCPOptions: On
xConguration Network [1..1] DNS Domain Name
DNS Domain Name is the default domain name sux which is added to unqualied names.
Example: If the DNS Domain Name is "company.com" and the name to lookup is "MyVideoSystem",
this will result in the DNS lookup "MyVideoSystem.company.com".
Requires user role: ADMIN
Value space: <S: 0, 64>
Format: String with a maximum of 64 characters.
Example: xConguration Network 1 DNS Domain Name: ""
xConguration Network [1..1] DNS Server [1..3] Address
Dene the network addresses for DNS servers. Up to 3 addresses may be specied. If the network
addresses are unknown, contact your administrator or Internet Service Provider.
Requires user role: ADMIN
Value space: <S: 0, 64>
Format: String with a maximum of 64 characters.
Example: xConguration Network 1 DNS Server 1 Address: ""
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Network [1..1] QoS Mode
The QoS (Quality of Service) is a method which handles the priority of audio, video and data in the
network. The QoS settings must be supported by the infrastructure. Diserv (Dierentiated Services)
is a computer networking architecture that species a simple, scalable and coarse-grained mechanism
for classifying, managing network trac and providing QoS priorities on modern IP networks.
Requires user role: ADMIN
Value space: <Off/Diffserv>
O: No QoS method is used.
Diserv: When you set the QoS Mode to Diserv, the Network QoS Diserv Audio, Network QoS
Diser v Video, Network QoS Diser v Data, Network QoS Diserv Signalling, Network QoS Diserv
ICMPv6 and Network QoS Diserv NTP settings are used to prioritize packets.
Note: This setting will only take eect if Network QoS Mode is set to Diserv.
Dene which priority Audio packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priority. The
recommended class for Audio is CS4, which equals the decimal value 32. If in doubt, contact your
network administrator.
The priority set here might be overridden when packets are leaving the network controlled by the local
network administrator.
Requires user role: ADMIN
Value space: <0..6 3 >
Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default
value is 0 (best eort).
Note: This setting will only take eect if Network QoS Mode is set to Diserv.
Dene which priority Video packets should have in the IP network. The packets on the presentation
channel (shared content) are also in the Video packet category.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priority. The
recommended class for Video is CS4, which equals the decimal value 32. If in doubt, contact your
network administrator.
The priority set here might be overridden when packets are leaving the network controlled by the local
network administrator.
Requires user role: ADMIN
Value space: <0..6 3 >
Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default
value is 0 (best eort).
Note: This setting will only take eect if Network QoS Mode is set to Diserv.
Dene which priority Data packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priority. The
recommended value for Data is 0, which means best eort. If in doubt, contact your network administrator.
The priority set here might be overridden when packets are leaving the network controlled by the local
network administrator.
Requires user role: ADMIN
Value space: <0..6 3 >
Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default
value is 0 (best eort).
Note: This setting will only take eect if Network QoS Mode is set to Diserv.
Dene which priority Signalling packets that are deemed critical (time-sensitive) for the real-time opera-
tion should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priority. The
recommended class for Signalling is CS3, which equals the decimal value 24. If in doubt, contact your
network administrator.
The priority set here might be overridden when packets are leaving the network controlled by the local
network administrator.
Requires user role: ADMIN
Value space: <0..6 3 >
Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default
value is 0 (best eort).
Note: This setting will only take eect if Network QoS Mode is set to Diserv.
Dene which priority ICMPv6 packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priorit y. The recom-
mended value for ICMPv6 is 0, which means best eort. If in doubt, contact your network administrator.
The priority set here might be overridden when packets are leaving the network controlled by the local
network administrator.
Requires user role: ADMIN
Value space: <0..6 3 >
Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default
value is 0 (best eort).
Note: This setting will only take eect if Network QoS Mode is set to Diserv.
Dene which priority NTP packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priority. The
recommended value for NTP is 0, which means best eort. If in doubt, contact your network administrator.
The priority set here might be overridden when packets are leaving the network controlled by the local
network administrator.
Requires user role: ADMIN
Value space: <0..6 3 >
Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default
value is 0 (best eort).
The system can be connected to an IEEE 802.1X LAN network, with a por t-based network access control
that is used to provide authenticated network access for Ethernet networks.
Requires user role: ADMIN
Value space: <Off/On >
O: The 802.1X authentication is disabled (default).
On: The 802.1X authentication is enabled.
Example: xConguration Network 1 IEEE8021X Mode: Off
xConguration Network [1..1] IEEE8021X TlsVerify
Verication of the server-side certicate of an IEEE802.1x connection against the certicates in the local
CA-list when TLS is used. The CA-list must be uploaded to the video system.
This setting takes eect only when Network [1..1] IEEE8021X Eap Tls is enabled (On).
Requires user role: ADMIN
Value space: <Off/On >
O: When set to O, TLS connections are allowed without verifying the server-side X.509 certicate
against the local CA-list. This should typically be selected if no CA-list has been uploaded to the codec.
On: When set to On, the server-side X.509 certicate will be validated against the local CA-list for
all TLS connections. Only servers with a valid certicate will be allowed.
Example: xConguration xConguration Network 1 IEEE8021X TlsVerify: Off
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Authentication using a private key/certicate pair during an IEEE802.1x connection. The authentication
X.509 certicate must be uploaded to the video system.
Requires user role: ADMIN
Value space: <Off/On >
O: When set to O client-side authentication is not used (only server-side).
On: When set to On the client (video system) will perform a mutual authentication TLS handshake
with the server.
Example: xConguration Network 1 IEEE8021X UseClientCerticate: Off
xConguration Network [1..1] IEEE8021X Identity
The 802.1X Identity is the user name needed for 802.1X authentication.
The 802.1X Anonymous ID string is to be used as unencrypted identity with EAP (Extensible Authentication
Protocol) types that support dierent tunneled identity, like EAP-PEAP and EAP-TTLS. If set, the anonymous ID will be used for the initial (unencrypted) EAP Identity Request.
Set the Md5 (Message-Digest Algorithm 5) mode. This is a Challenge Handshake Authentication Protocol
that relies on a shared secret. Md5 is a Weak security.
Requires user role: ADMIN
Value space: <Off/On >
O: The EAP-MD5 protocol is disabled.
On: The EAP-MD5 protocol is enabled (default).
Example: xConguration Network 1 IEEE8021X Eap Md5: On
xConguration Network [1..1] IEEE8021X Eap Ttls
Set the TTLS (Tunneled Transport Layer Security) mode. Authenticates LAN clients without the need
for client certicates. Developed by Funk Software and Certicom. Usually suppor ted by Agere Systems,
Proxim and Avaya.
Requires user role: ADMIN
Value space: <Off/On >
O: The EAP-TTLS protocol is disabled.
On: The EAP-TTLS protocol is enabled (default).
Example: xConguration Network 1 IEEE8021X Eap Ttls: On
xConguration Network [1..1] IEEE8021X Eap Tls
Enable or disable the use of EAP-TLS (Transport Layer Security) for IEEE802.1x connections. The EAP-TLS
protocol, dened in RFC5216, is considered one of the most secure EAP standards. LAN clients are
authenticated using client certicates.
Requires user role: ADMIN
Value space: <Off/On >
O: The EAP-TLS protocol is disabled.
On: The EAP-TLS protocol is enabled (default).
Example: xConguration Network 1 IEEE8021X Eap Tls: On
xConguration Network [1..1] IEEE8021X Eap Peap
Set the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without
the need for client certicates. Developed by Microsoft, Cisco and RSA Securit y.
Requires user role: ADMIN
Value space: <Off/On >
O: The EAP-PEAP protocol is disabled.
On: The EAP-PEAP protocol is enabled (default).
Example: xConguration Network 1 IEEE8021X Eap Peap: On
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Network [1..1] MTU
Set the Ethernet MTU (Maximum Transmission Unit).
Requires user role: ADMIN
Value space: <576..1 5 0 0 >
Range: Select a value from 576 to 1500 bytes.
Example: xConguration Network 1 MTU: 1500
xConguration Network [1..1] Speed
Set the Ethernet link speed.
NOTE: If running older software versions than TC6.0, restart the system for any change to this setting
to take eect.
Requires user role: ADMIN
Value space: <Au t o/10half/10f u ll/100h a lf/100f u ll/1000f u l l>
Auto: Autonegotiate link speed.
10h alf: Force link to 10 Mbps half-duplex.
10ful l: Force link to 10 Mbps full-duplex.
100 half: Force link to 100 Mbps half-duplex.
100full: Force link to 100 Mbps full-duplex.
1000full: Force link to 1 Gbps full-duplex.
Example: xConguration Network 1 Speed: Auto
xConguration Network [1..1] TracControl Mode
Set the network trac control mode to decide how to control the video packets transmission speed.
Requires user role: ADMIN
Value space: <Off/On >
O: Transmit video packets at link speed.
On: Transmit video packets at maximum 20 Mbps. Can be used to smooth out bursts in the outgo-
ing network trac.
Example: xConguration Network 1 TrafcControl: On
xConguration Network [1..1] VLAN Voice Mode
Set the VL AN voice mode. The VLAN Voice Mode will be set to Auto automatically if you choose Cisco
UCM (Cisco Unied Communications Manager) as provisioning infrastructure via the Provisioning Wizard
on the Touch controller.
Requires user role: ADMIN
Value space: <Auto/Manual/Off>
Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. If CDP is
not available, VLAN is not enabled.
Manual: The VLAN ID is set manually using the Network VLAN Voice VlanId setting. If CDP is available, the manually set value will be overruled by the value assigned by CDP.
O: VLAN is not enabled.
Example: xConguration Network 1 VLAN Voice Mode: Off
xConguration Network [1..1] VLAN Voice VlanId
Set the VL AN voice ID. This setting will only take eect if VLAN Voice Mode is set to Manual.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
NetworkServices conguration
xConguration NetworkServices XMLAPI Mode
Enable or disable the video system's XML API. For security reasons this may be disabled. Disabling
the XML API will limit the remote manageability with for example TMS, which no longer will be able to
connect to the video system.
Requires user role: ADMIN
Value space: <Off/On >
O: The XML API is disabled.
On: The XML API is enabled (default).
Example: xConguration NetworkServices XMLAPI Mode: On
xConguration NetworkServices MultiWay Address
The MultiWay address must be equal to the Conference Factory Alias, as congured on the Video
Communication Server. The Multiway™ conferencing enables video endpoint users to introduce a 3rd
party into an existing call.
Multiway™ can be used in the following situations:
1) When you want to add someone else in to your existing call.
2) When you are called by a 3rd party while already in a call and you want to include that person in the call.
Requirements: The Codec C20 must run sof tware version TC3.0 (or later), Video Communication Server
(VCS) version X5 (or later) and Codian MCU version 3.1 (or later). Video systems invited to join the
Multiway™ conference must support the H.323 routeToMC facility message if in an H.323 call, or SIP
REFER message if in a SIP call.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: String with a maximum of 255 characters.
Example: xCo n g u rat io n Net w or kSe r v ice s MultiWay Add res s: "h323:multiway @c o m p a ny.co m"
xConguration NetworkServices MultiWay Protocol
Determine the protocol to be used for MultiWay calls.
Requires user role: ADMIN
Value space: <Aut o/ H323/Sip>
Auto: The system will select the protocol for MultiWay calls.
H323: The H323 protocol will be used for MultiWay calls.
Sip: The SIP protocol will be used for MultiWay calls.
Example: xConguration NetworkServices MultiWay Protocol: Auto
xConguration NetworkServices H323 Mode
Determine whether the system should be able to place and receive H.323 calls or not.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable the possibility to place and receive H.323 calls.
On: Enable the possibility to place and receive H.323 calls (default).
Example: xConguration NetworkServices H323 Mode: On
xConguration NetworkServices HTTP Mode
Set the HT TP mode to enable/disable access to the system through a web browser. The web interface is
used for system management, call management such as call transfer, diagnostics and software uploads.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: ADMIN
Value space: <Off/On >
O: The HT TP protocol is disabled.
On: The HTTP protocol is enabled.
Example: xConguration NetworkServices HTTP Mode: On
xConguration NetworkServices HTTPS Mode
HTTPS is a web protocol that encrypts and decrypts user page requests as well as the pages that are
returned by the web server.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: ADMIN
Value space: <Off/On >
O: The HT TPS protocol is disabled.
On: The HTTPS protocol is enabled.
Example: xConguration NetworkServices HTTPS Mode: On
When the video system connects to an external HTTPS server (like a phone book server or an external
manager), this server will present a certicate to the video system to identify itself.
Requires user role: ADMIN
Value space: <Off/On >
O: Do not verify server certicates.
On: Requires the system to verify that the server certicate is signed by a trusted Certicate Authority
(CA). This requires that a list of trusted CAs are uploaded to the system in advance.
Example: xConguration NetworkServices HTTPS VerifyServerCerticate: Off
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
When the video system connects to a HTTPS client (like a web browser), the client can be asked to
present a certicate to the video system to identify itself.
Requires user role: ADMIN
Value space: <Off/On >
O: Do not verify client certicates.
On: Requires the client to present a certicate that is signed by a trusted Certicate Authority (CA).
This requires that a list of trusted CAs are uploaded to the system in advance.
Example: xConguration NetworkServices HTTPS VerifyClientCerticate: Off
xConguration NetworkServices HTTPS OCSP Mode
Dene the suppor t for OCSP (Online Certicate Status Protocol) responder services. The OCSP feature
allows users to enable OCSP instead of certicate revocation lists (CRLs) to check the certicate status.
For any outgoing HTTPS connection, the OCSP responder is queried of the status. If the corresponding
certicate has been revoked, then the HTTPS connection will not be used.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable OCSP support.
On: Enable OCSP suppor t.
Example: xConguration NetworkServices HTTPS OCSP Mode: Off
xConguration NetworkServices HTTPS OCSP URL
Specify the URL of the OCSP responder (server) that will be used to check the certicate status.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: String with a maximum of 255 characters.
Example: xC onguration Ne twork S er vic es HT TPS OCSP URL: "htt p://ocsp s er ver.co m pa ny.
c o m :8 1"
xConguration NetworkServices NTP Mode
The Network Time Protocol (NTP) is used to synchronize the time of the system to a reference time
server. The time server will subsequently be queried every 24th hour for time updates. The time will be
displayed on the top of the screen. The system will use the time to timestamp messages transmitted
to Gatekeepers or Border Controllers requiring H.235 authentication. The system will use the time to
timestamp messages transmitted to Gatekeepers or Border Controllers that requires H.235 authentication. It is also used for timestamping Placed Calls, Missed Calls and Received Calls.
Requires user role: ADMIN
Value space: <Auto/Off/Manual>
Auto: The system will use the NTP server, by which address is supplied from the DHCP server in the
network. If no DHCP server is used, or the DHCP server does not provide the system with a NTP
server address, the system will use the static dened NTP server address specied by the user.
O: The system will not use an NTP server.
Manual: The system will always use the static dened NTP server address specied by the user.
Enter the NTP Address to dene the network time protocol server address. This address will be used if
NTP Mode is set to Manual, or if set to Auto and no address is supplied by a DHCP server.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration NetworkServices SNMP Mode
SNMP (Simple Network Management Protocol) is used in network management systems to monitor
network-attached devices (routers, servers, switches, projectors, etc) for conditions that warrant administrative attention. SNMP exposes management data in the form of variables on the managed systems,
which describe the system conguration. These variables can then be queried (set to ReadOnly) and
sometimes set (set to ReadWrite) by managing applications.
Requires user role: ADMIN
Value space: <Off/ReadOnly/ReadWrite>
O: Disable the SNMP network service.
ReadOnly: Enable the SNMP network service for queries only.
ReadWrite: Enable the SNMP network ser vice for both queries and commands.
Enter the name of the Network Services SNMP Community. SNMP Community names are used to
authenticate SNMP requests. SNMP requests must have a password (case sensitive) in order to receive
a response from the SNMP Agent in the codec. The default password is "public". If you have the Cisco
TelePresence Management Suite (TMS) you must make sure the same SNMP Community is congured
there too. NOTE: The SNMP Community password is case sensitive.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration NetworkServices Telnet Mode
Telnet is a network protocol used on the Internet or Local Area Network (LAN) connections.
Requires user role: ADMIN
Value space: <Off/On >
O: The Telnet protocol is disabled. This is the factory setting.
On: The Telnet protocol is enabled.
Example: xConguration NetworkServices Telnet Mode: Off
xConguration NetworkServices CTMS Mode
This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence
Multipoint Switch (CTMS).
Video systems running sof tware TC5.0 or later are able to initiate or join non-encrypted multiparty conferences controlled by CTMS version 1.8 or later. Encrypted conferences are supported as from software
versions TC6.0 and CTMS 1.9.1. Encryption is addressed in the NetworkServices CTMS Encryption setting.
Requires user role: ADMIN
Value space: <Off/On >
O: Mulitparty conferencing via CTMS is prohibited.
On: Mulitparty conferencing via CTMS is allowed.
Example: xConguration NetworkServices CTMS Mode: On
xConguration NetworkServices CTMS Encryption
This setting indicates whether or not the video system supports encr yption when participating in a
multiparty meeting controlled by a Cisco TelePresence Multipoint Switch (CTMS).
CTMS allows three security settings for meetings: non-secure (not encr ypted), best eort (encr ypted if
all participants support encryption, otherwise not encrypted) and secure (always encrypted).
Requires user role: ADMIN
Value space: <Off/BestEffort>
O: The video system does not allow encr yption and therefore cannot participate in a secure CTMS
meeting (encrypted). When participating in a best eort CTMS meeting, the meeting will be downgraded to non-secure (not encrypted).
BestEort: The video system can negotiate encryption parameters with CTMS and participate in
a secure CTMS meeting (encrypted). Do not use this value if the CTMS version is older than 1.9.1.
Example: xConguration NetworkServices CTMS Encryption: Off
Phonebook conguration
xConguration Phonebook Server [1..1] ID
Enter a name for the external phone book.
Requires user role: ADMIN
Value space: <S: 0, 64>
Format: String with a maximum of 64 characters.
Example: xConguration Phonebook Server 1 ID: ""
xConguration Phonebook Server [1..1] Type
Select the phonebook server type.
Requires user role: ADMIN
Value space: <VC S/T M S/C a l lw a y/CUC M >
VCS: Select VCS if the phonebook is located on the Cisco TelePresence Video Communication Server.
TMS: Select TMS if the phonebook is located on the Cisco TelePresence Management Suite server.
Callway: Select Callway if the phonebook is to be provided by the WebEx TelePresence subscription
service (formerly called CallWay). Contact your WebEx TelePresence provider for more information.
CUCM: Select CUCM if the phonebook is located on the Cisco Unied Communications Manager.
Example: xConguration Phonebook Server 1 Typ e: TMS
xConguration Phonebook Server [1..1] URL
Enter the address (URL) to the external phone book ser ver.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: String with a maximum of 255 characters.
Example: xC on g ura tio n Pho nebook Server 1 UR L: "http://tm s.com pany.com/t ms/pu blic/
external/phonebook/phonebookservice.asmx"
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
Provisioning conguration
xConguration Provisioning Connectivity
This setting controls how the device discovers whether it should request an internal or external conguration from the provisioning server.
Requires user role: ADMIN
Value space: <Internal/External/Auto>
Internal: Request internal conguration.
External: Request external conguration.
Auto: Automatically discover using NAPTR queries whether internal or external congurations should
be requested. If the NAPTR responses have the "e" ag, external congurations will be requested.
Otherwise internal congurations will be requested.
Example: xConguration Provisioning Connectivity: Auto
xConguration Provisioning Mode
It is possible to congure a video system using a provisioning system (external manager). This allows
video conferencing network administrators to manage many video systems simultaneously.
With this setting you choose which type of provisioning system to use. Provisioning can also be switched
o. Contact your provisioning system provider/representative for more information.
Requires user role: ADMIN
Value space: <Off/TMS/VCS/CallWay/CUCM/Auto>
O: The video system will not be congured by a provisioning system.
TMS: The video system will be congured using TMS (Cisco TelePresence Management System).
VCS: Not applicable in this version.
Callway: The video system will be congured using the WebEx TelePresence subscription service
(formerly called Callway).
CUCM: The video system will be congured using CUCM (Cisco Unied Communications Manager).
Auto: The provisioning server will automatically be selected by the video system.
Example: xConguration Provisioning Mode: TMS
xConguration Provisioning Password
This is the password part of the credentials used to authenticate the video system with the provisioning server. This setting must be used when required by the provisioning server. If Provisioning Mode is
Callway (WebEx TelePresence), enter the activation code.
Requires user role: ADMIN
Value space: <S: 0, 64>
Format: String with a maximum of 64 characters.
Example: xConguration Provisioning Password: ""
xConguration Provisioning HttpMethod
Select the HTTP method to be used for the provisioning.
Requires user role: ADMIN
Value space: <GET/POST>
GET: Select GET when the provisioning server supports GET.
POST: Select POST when the provisioning server supports POST.
Example: xConguration Provisioning HttpMethod: POST
Enter the IP Address or DNS name of the external manager / provisioning system.
If an External Manager Address (and Path) is congured, the system will send a message to this address
when starting up. When receiving this message the external manager / provisioning system can return
congurations/commands to the unit as a result.
When using CUCM or TMS provisioning, the DHCP server can be set up to provide the external manager
address automatically (DHCP Option 242 for TMS, and DHCP Option 150 for CUCM). An address set in
the Provisioning ExternalManager Address setting will override the address provided by DHCP.
Requires user role: ADMIN
Value space: <S: 0, 64>
Format: A valid IP address format or DNS name; a compact string with a maximum of 64 characters.
This is the user name part of the credentials used to authenticate the video system with the provisioning server. This setting must be used when required by the provisioning server. If Provisioning Mode is
Callway (WebEx TelePresence), enter the video number.
Set the Path to the external manager / provisioning system. This setting is required when several management services reside on the same server, i.e. share the same External Manager address.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: String with a maximum of 255 characters.
Example: xCo n g u rat io n Prov ision i n g Exte r nalMana g er Path: "t m s/pu blic/exte r nal/
management/SystemManagementService.asmx"
xConguration Provisioning ExternalManager Domain
Enter the SIP domain for the VCS provisioning server.
Specify the rst port in the range of RTP ports. Also see the H323 Prole [1..1] PortAllocation setting.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: ADMIN
Value space: <1024..65502>
Range: Select a value from 1024 to 65502.
Example: xConguration RTP Ports Range Start: 2326
xConguration RTP Ports Range Stop
Specify the last RTP port in the range. Also see the H323 Prole [1..1] PortAllocation setting.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: ADMIN
Value space: <1056..65535>
Range: Select a value from 1056 to 65535.
Example: xConguration RTP Ports Range Stop: 2486
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
Security conguration
xConguration Security Audit Logging Mode
Determine where to record or transmit the audit logs. When using the External or ExternalSecure modes,
you also must enter the address and por t number for the audit ser ver in the Security Audit Server Address
and Security Audit Ser ver Por t settings.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: AUDIT
Value space: <Off/Internal/External/ExternalSecure>
O: No audit logging is performed.
Internal: The system records the audit logs to internal logs, and rotates logs when they are full.
External: The system sends the audit logs to an external audit server (syslog server). The audit
server must support TCP.
ExternalSecure: The system sends encrypted audit logs to an external audit server (syslog server)
that is veried by a certicate in the Audit CA list. The Audit CA list le must be uploaded to the
codec using the web interface. The common_name parameter of a certicate in the CA list must
match the IP address of the audit server.
Example: xConguration Security Audit Logging Mode: Off
xConguration Security Audit Server Address
Enter the IP-address of the audit server. Only valid IPv4 or IPv6 address formats are accepted. Host
names are not supported. This setting is only relevant when Security Audit Logging Mode is set to
External or ExternalSecure.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: AUDIT
Value space: <S: 0, 64>
Format: Valid IPv4 or IPv6 address formats.
Example: xConguration Security Audit Server Address: ""
xConguration Security Audit Server Port
Enter the port of the audit ser ver that the system shall send its audit logs to. The default port is 514.
This setting is only relevant when Security Audit Logging Mode is set to External or ExternalSecure.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: AUDIT
Value space: <0..65535>
Range: Select a value from 0 to 65535.
Example: xConguration Security Audit Server Port: 514
xConguration Security Audit OnError Action
Determine what happens when the connection to the audit server is lost. This setting is only relevant
when Security Audit Logging Mode is set to ExternalSecure.
NOTE: Restart the system for any change to this setting to take eect.
Requires user role: AUDIT
Value space: <Halt/Ign ore>
Halt: If a halt condition is detected the system is rebooted and only the auditor is allowed to operate the unit until the halt condition has passed. When the halt condition has passed the audit logs
are re-spooled to the audit server. Halt conditions are: A network breach (no physical link), no audit
server running (or wrong audit server address or port), TLS authentication failed (if in use), local
backup (re-spooling) log full.
Ignore: The system will continue its normal operation, and rotate internal logs when full. When the
connection is restored it will again send its audit logs to the audit server.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
SerialPort conguration
xConguration SerialPort Mode
Enable/disable the serial port (connection via Camera port with Y-cable).
Requires user role: ADMIN
Value space: <Off/On >
O: Disable the serial por t.
On: Enable the serial por t.
Example: xConguration SerialPort Mode: On
xConguration SerialPort BaudRate
Specif y the baud rate (data transmission rate, bits per second) for the serial port. The default value is 38400.
Other connection parameters for the serial port are: Data bits: 8; Parity: None; Stop bits: 1; Flow control:
None.
Requires user role: ADMIN
Value space: <9600/19200/38400/57600/115200>
Range: Select a baud rate from the baud rates listed (bps).
Determine if login shall be required when connecting to the serial port.
Requires user role: ADMIN
Value space: <Off/On >
O: The user can access the codec via the serial port without any login.
On: Login is required when connecting to the codec via the serial port.
Example: xConguration SerialPort LoginReq uired: On
SIP conguration
xConguration SIP ListenPort
Turn on or o the listening for incoming connections on the SIP TCP/UDP ports. If turned o the endpoint
must be registered with a SIP registrar to be reachable.
Requires user role: ADMIN
Value space: <On/Off>
On: Listening for incoming connections on the SIP TCP/UDP ports is turned on.
O: Listening for incoming connections on the SIP TCP/UDP por ts is turned o.
Example: xConguration SIP ListenPort: On
xConguration SIP Prole [1..1] URI
The SIP URI or number is used to address the system. This is the URI that is registered and used by
the SIP services to route inbound calls to the system. A Uniform Resource Identier (URI) is a compact
string of characters used to identify or name a resource.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: Compact string with a maximum of 255 characters.
Select the transport protocol to be used over the LAN.
Requires user role: ADMIN
Value space: <TCP/U DP/Tls/Auto>
TCP: The system will always use TCP as the default transport method.
UDP: The system will always use UDP as the default transport method.
Tls: The system will always use TLS as the default transport method. For TLS connections a SIP
CA-list can be uploaded to the video system. If no such CA-list is available on the system then
anonymous Die Hellman will be used.
Auto: The system will try to connect using transpor t protocols in the following order: TLS, TCP, UDP.
Example: xConguration SIP Prole 1 DefaultTransport: Auto
xConguration SIP Prole [1..1] TlsVerify
For TLS connections a SIP CA-list can be uploaded to the video system.
Requires user role: ADMIN
Value space: <Off/On >
O: Set to O to allow TLS connections without verif ying them. The TLS connections are allowed to
be set up without verifying the x.509 certicate received from the server against the local CA-list.
This should typically be selected if no SIP CA-list has been uploaded.
On: Set to On to verify TLS connections. Only TLS connections to servers, whose x.509 certicate
is validated against the CA-list, will be allowed.
Example: xConguration SIP Prole 1 TlsVerify: Off
xConguration SIP Prole [1..1] Outbound
The client initiated connections mechanism for rewall traversal, connection reuse and redundancy. The
current version supports http://tools.ietf.org/html/draft-ietf-sip-outbound-20.
Requires user role: ADMIN
Value space: <Off/On >
O: Connect to the single proxy congured rst in Proxy Address list.
On: Set up multiple outbound connections to servers in the Proxy Address list.
The Proxy Address is the manually congured address for the outbound proxy. It is possible to use a
fully qualied domain name, or an IP address. The default port is 5060 for TCP and UDP but another
one can be provided. If Outbound is enabled, multiple proxies can be addressed.
Requires user role: ADMIN
Value space: <S: 0, 255>
Format: Compact string with a maximum of 255 characters. An IP address that contains letters
(192.a.2.0) or unvalid IP addresses (192.0.1234.0) will be rejected.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration SIP Prole [1..1] Type
Enables SIP extensions and special behaviour for a vendor or provider.
Requires user role: ADMIN
Value space: <Standard/Alcatel/Avaya/Cisco/Microsoft/Nortel>
Standard: To be used when registering to standard SIP Proxy (tested with Cisco TelePresence VCS
and Broadsoft)
Alcatel: To be used when registering to Alcatel-Lucent OmniPCX Enterprise. NOTE: This mode is
not fully supported.
Avaya: To be used when registering to Avaya Communication Manager. NOTE: This mode is not
fully supported.
Cisco: To be used when registering to Cisco Unied Communication Manager.
Microsoft: To be used when registering to Microsoft LCS or OCS. NOTE: This mode is not fully supported.
Nortel: To be used when registering to Nortel MCS 5100 or MCS 5200 PBX. NOTE: This mode is
not fully supported.
Example: xConguration SIP Prole 1 Type: Standard
Standby conguration
xConguration Standby Control
Determine whether the system should go into standby mode or not.
Requires user role: ADMIN
Value space: <Off/On >
O: The system will not enter standby mode.
On: Enter standby mode when the Standby Delay has timed out. NOTE: Requires the Standby Delay
to be set to an appropriate value.
Example: xConguration Stand by Control: On
xConguration Standby Delay
Dene how long (in minutes) the system shall be in idle mode before it goes into standby mode. NOTE:
Requires the Standby Control to be enabled.
Requires user role: ADMIN
Value space: <1..480>
Range: Select a value from 1 to 480 minutes.
Example: xConguration Stand by Delay: 10
xConguration Standby BootAction
Dene the camera position after a restart of the codec.
Requires user role: ADMIN
Value space: <None/Pre set1/Pr eset 2/Pr es et3/Preset4/Pr es et5/Pre set6/Preset7/Preset8/
Preset9/Preset10/Preset11/Preset12/Preset13/Preset14/Preset15/RestoreCameraPosition/
DefaultC a m eraPosition >
None: No action.
Preset1 to Preset15: After a reboot the camera position will be set to the position dened by the
selected preset.
RestoreCameraPosition: After a reboot the camera position will be set to the position it had before
the last boot.
DefaultCameraPosition: After a reboot the camera position will be set to the factory default position.
Example: xConguration Stand by BootAction: DefaultCameraPosition
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Standby StandbyAction
Dene the camera position when going into standby mode.
Requires user role: ADMIN
Value space: <None/PrivacyPosition>
None: No action.
PrivacyPosition: Turns the camera to a sideways position for privacy.
Example: xConguration Stand by StandbyAction: PrivacyPosition
xConguration Standby WakeupAction
Dene the camera position when leaving standby mode.
Requires user role: ADMIN
Value space: <None/Pre set1/Pr eset 2/Pr es et3/Preset4/Pr es et5/Pre set6/Preset7/Preset8/
Preset9/Preset10/Preset11/Preset12/Preset13/Preset14/Preset15/RestoreCameraPosition/
DefaultC a m eraPosition >
None: No action.
Preset1 to Preset15: When leaving standby the camera position will be set to the position dened
by the selected preset.
RestoreCameraPosition: When leaving standby the camera position will be set to the position it had
before entering standby.
DefaultCameraPosition: When leaving standby the camera position will be set to the factory default
position.
Example: xConguration Stand by WakeupAction: RestoreCameraPosition
SystemUnit conguration
xConguration SystemUnit Name
Enter a System Name to dene a name of the system unit. If the H.323 Alias ID is congured on the
system then this ID will be used instead of the system name. The system name will be displayed:
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration SystemUnit ContactInfo Type
Choose which type of contact information to show in the status eld in the upper left corner of the main
display and Touch controller. The information can also be read with the command xStatus SystemUnit
ContactInfo.
Requires user role: ADMIN
Value space: <Auto/No n e/IP v4/IP v6/H323Id/E164Ali as/H320N u m b e r/SipUri/Sys temNa me/
DisplayNa me>
Auto: Show the address which another system can dial to reach this system. The address depends
on the default call protocol and system registration.
None: Do not show any contact information in the status eld.
IPv4: Show the IPv4 address as contact information.
IPv6: Show the IPv6 address as contact information.
H323Id: Show the H.323 ID as contact information (see the H323 Prole [1..1] H323Alias ID setting).
E164Alias: Show the H.323 E164 Alias as contact information (see the H323 Prole [1..1] H323Alias
E164 setting).
H320Number: Show the H.320 number as contact information (only applicable if connected to a
Cisco TelePresence ISDN Link gateway).
SipUri: Show the SIP URI as contact information (see the SIP Prole [1..1] URI setting).
SystemName: Show the system name as contact information (see the SystemUnit Name setting).
DisplayName: Show the display name as contact information (see the SIP Prole [1..1] DisplayName
setting).
Example: xConguration SystemUnit ContactInfo Type: Auto
xConguration SystemUnit CallLogging Mode
Set the call logging mode for calls that are received or placed by the system. The call logs may then be
viewed via the web interface or using the xHistory command.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable logging.
On: Enable logging.
Example: xConguration SystemUnit CallLogging Mode: On
xConguration SystemUnit IrSensor
Both the Codec C Series and PrecisionHD camera have IR sensors, and only one of them needs to be
enabled at the time. The IR sensor LED is located on the front of the codec and the camera and ickers
when an IR signal is received from the remote control.
Requires user role: ADMIN
Value space: <Au t o/Off/O n >
Auto: The system will automatically disable the IR sensor on the codec if the IR sensor at camera is
enabled. Other wise, the IR sensor on the codec will be enabled.
O: Disable the IR sensor on the codec.
On: Enable the IR sensor on the codec.
Example: xConguration SystemUnit IrSensor: Auto
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
Time conguration
xConguration Time Zone
Set the time zone where the system is located, using Windows time zone description format.
Requires user role: USER
Value space: <GMT-12:00 (International Date Line West)/GMT-11:00 (Midway Island,
Sa m o a)/GM T-10:00 (Haw a ii)/GMT-09:00 (Al a sk a)/GM T-08:00 (Pac i c Ti m e (US & Canad a);
Tijuana)/GMT-07:00 (Arizona)/GMT-07:00 (Mountain Time (US & Canada))/GMT-07:00
(Ch i h ua hua, La Paz, Maz atl a n)/GM T-06:00 (Cen tra l Amer ic a)/GM T- 06:00 (Saskat chew a n)/
GMT-06:00 (Guadalajara, Mexico City, Monterrey)/GMT-06:00 (Central Time (US &
Canada))/GMT-05:00 (Indiana (East))/GMT-05:00 (Bogota, Lima, Quito)/GMT-05:00
(Eastern Tim e (US & Canada))/GMT-04:30 (Caracas)/GMT-04:00 (La Paz)/GMT-04:00
(Sa nti ago)/GM T-04:00 (Atla n tic Ti m e (C a nad a))/GM T-03:30 (Ne w fo u n d land)/GM T-03:00
(Buenos Aires, Georgetown)/GMT-03:00 (Greenland)/GMT-03:00 (Brasilia)/GMT-02:00
(Mid-Atlantic)/GMT-01:00 (Cape Verde Is.)/GMT-01:00 (Azores)/GMT (Casablanca,
Monrovia)/GMT(CoordinatedUniversalTime)/GMT(GreenwichMeanTime:Dublin,
Typical resolutions used for dier ent optimal denition proles, call rates and frame rates
(Osaka, Sapporo, Tokyo)/GMT+09:00 (Seoul)/GMT+09:00 (Yakutsk)/GMT+09:30 (Darwin)/
GM T+09:30 (A d e l a i d e)/G M T+10:00 (G u a m, Por t Mo r e s b y)/G M T+10:00 (B r i s b a n e)/GM T +10:00
(V l a d ivosto k)/GM T+10:00 (H o b a r t)/GM T+10:00 (C a n ber r a , Me l bo u r ne, Syd n e y)/GM T +11:00
(Magadan, Solomon Is., New Caledonia)/GMT+12:00 (Fiji, Kamchatka, Marshall Is.)/
GMT+12:00 (Auckland, Welling ton)/GMT+13:00 (Nuku alofa)>
Range: Select a time zone from the list time zones. If using a command line interface; watch up for typos.
Example: xC on guration Ti m e Zone: "GMT (Gr e e nwic h Mean Ti m e : Du bli n, Ed i n burgh,
Lisbon, London)"
Call rate
1472
kbps
2560
kbps
4
Mbps
6
Mbps
xConguration Time TimeFormat
Set the time format.
Requires user role: USER
Value space: <24H/12H>
24H: Set the time format to 24 hours.
12H : Set the time format to 12 hours (AM/PM).
Example: xConguration Time TimeFormat: 24H
xConguration Time DateFormat
Set the date format.
Requires user role: USER
Value space: <DD _ MM _ YY/MM _ DD _ YY/YY _ MM _ DD>
DD _ M M_Y Y: The date January 30th 2010 will be displayed: 30.01.10
MM _ D D_Y Y: The date January 30th 2010 will be displayed: 01.30.10
YY_MM_DD: The date January 30th 2010 will be displayed: 10.01.30
Example: xConguration Time DateFormat: DD _ M M _ YY
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Select whether to display the list of contacts, the list of scheduled meetings, or a dial pad on the Touch
controller as default.
Requires user role: USER
Value space: <ContactList/MeetingList/Dialpad>
ContactList: The contact list (favorites, directory and history) will appear as default on the Touch
controller.
MeetingList: The list of scheduled meetings will appear as default on the Touch controller.
Dialpad: A dial pad will appear as default on the Touch controller.
Example: xConguration Video Input Source 1 Name: ""
xConguration Video Input Source [1] Connector
Select which video input connector to be active on video input source 1.
Requires user role: ADMIN
Value space: <HDMI>
HDMI: Select HDMI when you want to use the HDMI as input source 1.
Example: xConguration Video Input Source 1 Connector: HDMI
xConguration Video Input Source [2] Connector
Select which video input connector to be active on video input source 2.
Requires user role: ADMIN
Value space: <DVI>
DVI: Select DVI-I when you want to use the DVI-I 2 as input source 2.
Example: xConguration Video Input Source 2 Connector: DVI
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
xConguration Video Input Source [1..2] Type
Set which type of input source is connected to the video input.
Requires user role: ADMIN
Value space: <other/camera/PC/DVD/document _ ca mera>
Other: Select Other when some other type of equipment is connected to the selected video input.
Camera: Select Camera when you have a camera connected to the selected video input.
PC: Select PC when you have a PC connected to the selected video input.
DVD: Select DVD when you have a DVD player connected to the selected video input.
Document_Camera: Select Document_Camera when you have a document camera connected to
the selected video input.
Example: xConguration Video Input Source 1 Type: PC
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video Input Source [1..2] PresentationSelection
In general, any input source can be used as a presentation source; normally, the main camera (self view)
will not be used as a presentation source.
This setting is used to dene whether to display the presentation source on the local video system's
display automatically or not. To share the presentation with the far end always requires additional action
(tap Start Presenting on the Touch controller or the Presentation key on the remote control).
The default values for all input sources are Manual.
Requires user role: ADMIN
Value space: <Manual/Automatic/Hidden>
Manual: The content on the input source will not be presented on the local video system's display
before you select it. Use either the remote control or the Touch controller to choose which input
source to present.
Automatic: Any content on the input source will be presented on the local video system's display
automatically. If there is active content on more than one input source (which is set to Automatic)
the most recent one will be used.
Hidden: The input source is not expected to be used as a presentation source.
Example: xConguration Video Input Source 1 PresentationSelection: Manual
xConguration Video Input Source [1..2] CameraControl Mode
Select whether or not to enable camera control for the selected video input source when the video
input is active.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable camera control.
On: Enable camera control.
Example: xConguration Video Input Source 1 CameraControl Mode: On
xConguration Video Input Source [1..2] CameraControl CameraId
Indicates the ID of the camera. This value is xed in this product.
Value space: <1>
Range: Indicates the ID of the camera.
xConguration Video Input Source [1..2] OptimalDenition Prole
The Video Input Source Quality setting must be set to Motion for the optimal denition settings to take
any eect.
The optimal denition prole should reect the lighting conditions in your room and the quality of the
video input (camera); the better the lighting conditions and video input, the higher the prole. Then, in
good lighting conditions, the video encoder will provide better quality (higher resolution or frame rate)
for a given call rate.
Generally, we recommend using the Normal or Medium proles. However, when the lighting conditions
are good, the High prole can be set in order to increase the resolution for a given call rate.
Some typical resolutions used for dierent optimal denition proles, call rates and transmit frame rates
are shown in the table below. It is assumed that dual video is not used. The resolution must be supported
by both the calling and called systems.
Use the Video Input Source OptimalDenition Threshold60fps setting to decide when to use the 60
fps frame rate.
Typical resolutions used for different optimal definition profiles, call rates and frame rates
Frame
rate
30 fps
60 fps
.
Requires user role: ADMIN
Value space: <Norm al/M ed iu m/High>
Normal: Use this prole for a normally to poorly lit environment. Resolutions will be set rather
conservative.
Medium: Requires good and stable lighting conditions and a good quality video input. For some call
rates this leads to higher resolution.
High: Requires nearly optimal video conferencing lighting conditions and a good quality video input
in order to achieve a good overall experience. Rather high resolutions will be used.
Example: xConguration Video Input Source 1 Optim alDenition Prole: Normal
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video Input Source [1..2] OptimalDenition Threshold60fps
For each video input, this setting tells the system the lowest resolution where it should transmit 60fps.
So for all resolutions lower than this, the maximum transmitted framerate would be 30fps, while above
this resolution 60fps would also be possible, if the available bandwidth is adequate.
Requires user role: ADMIN
Value space: <512 _ 288/768 _ 448/1024 _ 576/1280 _ 720/1920 _ 1080/Ne ver >
512_28 8: Set the threshold to 512x288.
768 _448: Set the threshold to 768x448.
1024 _576: Set the threshold to 1024x576.
128 0 _72 0: Set the threshold to 1280x720.
192 0 _10 8 0: Set the threshold to 1920x1080.
Never: Do not set a threshold for transmitting 60fps.
When encoding and transmitting video there will be a trade-o between high resolution and high framerate. For some video sources it is more important to transmit high framerate than high resolution and
vice versa. The Quality setting species whether to give priority to high frame rate or to high resolution
for a given source.
Requires user role: ADMIN
Value space: <Motion/Sharpness>
Motion: Gives the highest possible framerate. Used when there is a need for higher frame rates, typically when a large number of participants are present or when there is a lot of motion in the picture.
Sharpness: Gives the highest possible resolution. Used when you want the highest quality of detailed
images and graphics.
Example: xConguration Video Input Source 1 Quality: Motion
xConguration Video MainVideoSource
Dene which video input source shall be used as the main video source. The video input source is
congured with the "Video Input Source [1..n] Connector" setting.
Requires user role: USER
Value space: <1/2>
Range: Select the source to be used as the main video source.
Example: xConguration Video MainVideoSource: 1
xConguration Video DefaultPresentationSource
Dene which video input source shall be used as the default presentation source when you press the
Presentation key on the remote control. If using a Touch controller this setting has no eect. The Video
Input Source n Connector setting denes which input connector to use for input source n.
Requires user role: USER
Value space: <1/2>
Range: Select the video source to be used as the presentation source.
Example: xConguration Video DefaultPresentationSource: 2
xConguration Video Input HDMI [1..1] RGBQuantizationRange
All devices with HDMI inputs should follow the rules for RGB video quantization range dened in CEA-861.
Unfortunately some devices do not follow the standard and this conguration may be used to override
the settings to get a perfect image with any source.
Requires user role: ADMIN
Value space: <Auto/F u ll/Limite d >
Auto: RGB quantization range is automatically selected based on the RGB Quantization Range bits
(Q0, Q1) in the AVI infoframe. If no AVI infoframe is available, RGB quantization range is selected
based on video format according to CEA-861-E.
Full: Full quantization range. The R, G, B quantization range includes all code values (0 - 255). This
is dened in CEA-861-E.
Limited: Limited Quantization Range. R, G, B quantization range that excludes some code values at
the extremes (16 - 235). This is dened in CEA-861-E.
Example: xConguration Video Input 1 HDMI 1 RGBQuantizationRange: Auto
xConguration Video Input DVI [2] RGBQuantizationRange
All devices with DVI inputs should follow the rules for RGB video quantization range dened in CEA-861.
Unfortunately some devices do not follow the standard and this conguration may be used to override
the settings to get a perfect image with any source. The default value is set to Full because most DVI
sources expects full quantization range.
Requires user role: ADMIN
Value space: <Auto/F u ll/Limite d >
Auto: RGB quantization range is automatically selected based on video format according to CEA-861-E.
CE video formats will use limited quantization range levels. IT video formats will use full quantization
range levels.
Full: Full quantization range. The R, G, B quantization range includes all code values (0 - 255). This
is dened in CEA-861-E.
Limited: Limited Quantization Range. R, G, B quantization range that excludes some code values at
the extremes (16 - 235). This is dened in CEA-861-E.
Example: xConguration Video Input 1 DVI 2 RGBQuantizationRa nge: Full
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video Input DVI [2] Type
The ocial DVI standard supports both digital and analog signals. In most cases the default AutoDetect
setting can detect whether the signal is analog RGB or digital. However, in some rare cases when DVI-I
cables are used (these cables can carry both the analog and digital signals) the auto detection fails. This
setting makes it possible to override the AutoDetect and select the correct DVI video input.
Requires user role: ADMIN
Value space: <AutoDetect/Digital/AnalogRGB>
AutoDetect: Set to AutoDetect to automatically detect if the signal is analog RGB or digital.
Digital: Set to Digital to force the DVI video input to Digital when using DVI-I cables with both analog
and digital pins and AutoDetect fails.
AnalogRGB: Set to AnalogRGB to force the DVI video input to AnalogRGB when using DVI-I cables
with both analog and digital pins and AutoDetect fails.
Example: xConguration Video Input DVI 2 Ty pe: AutoDetect
xConguration Video Layout Scaling
Dene how the system shall adjust the aspect ratio for images or frames when there is a dierence
between the image and the frame it is to be placed in.
Requires user role: ADMIN
Value space: <Off/On >
O: No adjustment of the aspect ratio.
On: Let the system automatically adjust aspect ratio.
Example: xConguration Video Layout Scaling: On
xConguration Video Layout ScaleToFrame
Dene what to do if the aspect ratio of a video input source doesn't match the aspect ratio of the
corresponding image frame in a composition. For example if you have a 4:3 input source (like XGA) to
be displayed on a 16:9 output (like HD720).
Requires user role: ADMIN
Value space: <Manual/MaintainAspectRatio/StretchToFit>
Manual: If the dierence in aspect ratio between the video input source and the target image frame
is less than the Video Layout ScaleToFrameThreshold setting (in percent), the image is stretched to
t. If not, the system will maintain the original aspect ratio.
MaintainAspectRatio: Maintain the aspect ratio of the input source, and ll in black in the rest of the
frame (letter boxing or pillar boxing).
StretchToFit: Stretch (horizontally or ver tically) the input source to t into the image frame. NOTE:
The general limitation is that you cannot upscale in one direction and at the same time downscale in
the other direction. In such situations the codec will apply letterboxing.
Example: xConguration Video Layout ScaleToFrame: MaintainAspectRatio
xConguration Video Layout ScaleToFrameThreshold
Only applicable if the Video Layout ScaleToFrame setting is set to manual. If the dierence in aspect
ratio between the video input source and the target image frame is less than the ScaleToFrameThreshold
setting (in percent), the image is stretched to t. If not, the system will maintain the original aspect ratio.
Requires user role: ADMIN
Value space: <0..100>
Range: Select a value from 0 to 100 percent.
Example: xConguration Video Layout ScaleToFrameThreshold: 5
xConguration Video Selfview
Determine if the main video source (self view) shall be displayed on screen.
This setting is obsoleted by the Video SelfviewDefault Mode setting as from TC6.0.
Requires user role: USER
Value space: <Off/On >
O: Do not display self view on screen.
On: Display self view on screen.
Example: xConguration Video Selfview: On
xConguration Video SelfviewPosition
Select where the small self view PiP (Picture-in-Picture) will appear on screen.
This setting is obsoleted by the Video SelfviewDefault PIPPosition setting as from TC6.0.
Requires user role: ADMIN
Value space: <UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/
LowerR ight>
UpperLeft: The self view PiP will appear in the upper left corner of the screen.
UpperCenter: The self view PiP will appear in the upper center of the screen.
UpperRight: The self view PiP will appear in the upper right corner of the screen.
CenterLeft: The self view PiP will appear on the left side of the screen, in center.
CenterRight: The self view PiP will appear on the right side of the screen, in center.
LowerLeft: The self view PiP will appear in the lower left corner of the screen.
LowerRight: The self view PiP will appear in the lower right corner of the screen.
Example: xConguration Video SelfviewPosition: LowerRight
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video SelfviewDefault Mode
Determine if the main video source (self view) shall be displayed on screen after a call. The position
and size of the self view window is determined by the Video SelfviewDefault PIPPosition and the Video
Selfview FullscreenMode settings respectively.
This setting obsoletes the Video Selfview setting as from TC6.0.
Requires user role: ADMIN
Value space: <Off/Current/On>
O: Self view is switched o when leaving a call.
Current: Self view is left as is, i.e. if it was on during the call, it remains on after the call; if it was
o during the call, it remains o after the call.
On: Self view is switched on when leaving a call.
Example: xConguration Video SelfviewDefault Mode: Current
xConguration Video SelfviewDefault FullscreenMode
Determine if the main video source (self view) shall be shown in full screen or as a small picture-inpicture (PiP) after a call. The setting only takes eect when self view is switched on (see the Video
SelfviewDefault Mode setting).
Requires user role: ADMIN
Value space: <Off/Current/On>
O: Self view will be shown as a PiP.
Current: The size of the self view picture will be kept unchanged when leaving a call, i.e. if it was
a PiP during the call, it remains a PiP after the call; if it was fullscreen during the call, it remains
fullscreen after the call.
On: The self view picture will be shown in fullscreen.
Example: xConguration Video SelfviewDefault FullscreenMode: Current
xConguration Video SelfviewDefault PIPPosition
Determine the position on screen of the small self view picture-in-picture (PiP) after a call. The setting
only takes eect when self view is switched on (see the Video SelfviewDefault Mode setting) and
fullscreen view is switched o (see the Video SelfviewDefault FullscreenMode setting).
This setting obsoletes the Video SelfviewPosition setting as from TC6.0.
Requires user role: ADMIN
Value space: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/
LowerLeft/LowerRight >
Current: The position of the self view PiP will be kept unchanged when leaving a call.
UpperLeft: The self view PiP will appear in the upper left corner of the screen.
UpperCenter: The self view PiP will appear in the upper center position.
UpperRight: The self view PiP will appear in the upper right corner of the screen.
CenterLeft: The self view PiP will appear in the center left position.
CentreRight: The self view PiP will appear in the center right position.
LowerLeft: The self view PiP will appear in the lower left corner of the screen.
LowerRight: The self view PiP will appear in the lower right corner of the screen.
Example: xConguration Video SelfviewDefault PIPPosition: Current
xConguration Video SelfviewDefault OnMonitorRole
Determine which monitor/output to display the main video source (self view) on after a call. The value
reects the monitor roles set for the dierent outputs in the Video Output HDMI MonitorRole settings.
The setting applies both when self view is displayed in full screen, and when it is displayed as picturein-picture (PiP), but only if the Video Monitors setting is set to Dual.
Requires user role: ADMIN
Value space: <First/Second/Current>
First: The self view picture will be shown on outputs with the Video Output HDMI MonitorRole set
to First.
Second: The self view picture will be shown on outputs with the Video Output HDMI MonitorRole
set to Second.
Current: When leaving the call, the self view picture will be kept on the same output as during the call.
Example: xConguration Video SelfviewDefault OnMonitorRole: Current
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video PIP ActiveSpeaker DefaultValue Position
Determine the position on screen of the active speaker picture-in-picture (PiP). The setting only takes
eect when using a video layout where the active speaker is a PiP, i.e. the Overlay layout, or possibly
a Custom layout (see the Video Layout LocalLayoutFamily setting). The setting takes eect from the
next call onwards; if changed during a call, it will have no eect on the current call.
Requires user role: ADMIN
Value space: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/
LowerLeft/LowerRight>
Current: The position of the active speaker PiP will be kept unchanged when leaving a call.
UpperLeft: The active speaker PiP will appear in the upper left corner of the screen.
UpperCenter: The active speaker PiP will appear in the upper center position.
UpperRight: The active speaker PiP will appear in the upper right corner of the screen.
CenterLeft: The active speaker PiP will appear in the center left position.
CentreRight: The active speaker PiP will appear in the center right position.
LowerLeft: The active speaker PiP will appear in the lower left corner of the screen.
LowerRight: The active speaker PiP will appear in the lower right corner of the screen.
Example: xConguration Video PIP ActiveSpeaker DefaultValue Position: Current
xConguration Video PIP Presentation DefaultValue Position
Determine the position on screen of the presentation picture-in-picture (PiP). The setting only takes
eect when the presentation is explicitly minimized to a PiP, for example using the remote control or
the Touch controller. The setting takes eect from the next call onwards; if changed during a call, it
will have no eect on the current call.
Requires user role: ADMIN
Value space: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/
LowerLeft/LowerRight >
Current: The position of the presentation PiP will be kept unchanged when leaving a call.
UpperLeft: The presentation PiP will appear in the upper left corner of the screen.
UpperCenter: The presentation PiP will appear in the upper center position.
UpperRight: The presentation PiP will appear in the upper right corner of the screen.
CenterLeft: The presentation PiP will appear in the center left position.
CentreRight: The presentation PiP will appear in the center right position.
LowerLeft: The presentation PiP will appear in the lower left corner of the screen.
LowerRight: The presentation PiP will appear in the lower right corner of the screen.
Example: xConguration Video PIP Presentation DefaultValue Position: Current
xConguration Video Layout LocalLayoutFamily
Select which video layout family to use locally.
Requires user role: ADMIN
Value space: <Auto/FullScreen/Equal/PresentationSmallSpeaker/
Auto: The default layout family, as given by the layout database, will be used as the local layout. For
more information about the layout database, see the xCommand Video Layout LoadDb command.
FullScreen: The FullScreen layout family will be used as the local layout. It means that the active
speaker or presentation will be shown in full screen. Using this value is not recommended as
from TC6.0.
Equal: The Equal layout family will be used as the local layout. All videos have equal size, as long
as there is space enough on the screen.
PresentationSmallSpeaker: The PresentationSmallSpeaker layout family will be used as the local
layout. Using this value is not recommended as from TC6.0.
PresentationLargeSpeaker: The PresentationLargeSpeaker layout family will be used as the local
layout. Using this value is not recommended as from TC6.0.
Prominent: The Prominent layout family will be used as the local layout. The active speaker, or the
presentation if present, will be a large picture, while the other participants will be small pictures.
Transitions between active speakers are voice switched.
Overlay: The Overlay layout family will be used as the local layout. The active speaker, or the
presentation if present, will be shown in full screen, while the other participants will be small
pictures-in-picture (PiP). Transitions between active speakers are voice switched.
Single: The active speaker, or the presentation if present, will be shown in full screen. The other
participants are not shown. Transitions between active speakers are voice switched.
Example: xConguration Video Layout LocalLayoutFam ily: Auto
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Auto: The default layout family, as given by the local layout database, will be used as the remote
layout. For more information about the layout database, see the command: xCommand Video
Layout LoadDb.
FullScreen: The FullScreen layout family will be used as the remote layout. It means that the
active speaker or presentation will be shown in full screen. Using this value is not recommended
as from TC6.0.
Equal: The Equal layout family will be used as the remote layout. All videos have equal size, as
long as there is space enough on the screen.
PresentationSmallSpeaker: The PresentationSmallSpeaker layout family will be used as the remote
layout. Using this value is not recommended as from TC6.0.
PresentationLargeSpeaker: The PresentationLargeSpeaker layout family will be used as the remote
layout. Using this value is not recommended as from TC6.0.
Prominent: The Prominent layout family will be used as the remote layout. The active speaker, or
the presentation if present, will be a large picture, while the other participants will be small pictures.
Transitions between active speakers are voice switched.
Overlay: The Overlay layout family will be used as the remote layout. The active speaker, or the
presentation if present, will be shown in full screen, while the other participants will be small
pictures-in-picture (PiP). Transitions between active speakers are voice switched.
Single: The active speaker, or the presentation if present, will be shown in full screen. The other
participants are not shown. Transitions between active speakers are voice switched.
Example: xConguration Video Layout RemoteLayoutFam ily: Auto
xConguration Video Monitors
Set the monitor layout mode.
Requires user role: ADMIN
Value space: <Single/Dual/DualPresentationOnly>
Single: The same layout is shown on all monitors.
Dual: All participants in the call is shown on the rst monitor, while the presentation (if any) is
shown on the second monitor. Self view can also be displayed on the second monitor, depending
on the Video SelfviewDefault OnMonitorRole setting.
DualPresentationOnly: All participants in the call will be shown on the rst monitor, while the
presentation (if any) will be shown on the second monitor.
Example: xConguration Video Monitors: Single
xConguration Video OSD Mode
The Video OSD (On Screen Display) Mode lets you dene if information and icons should be displayed
on screen.
Requires user role: ADMIN
Value space: <Off/On /D isa ble d >
O: Hide the on screen menus, icons and indicators.
On: Display the on screen menus, icons and indicators.
Disabled: When set to disabled, the C20 can use the additional resources usually used by the GUI
to do 1080p30 at the same time as sharing a presentation. The C20 must then be controlled by a
Cisco TelePresence Touch or an external control panel as the GUI will be disabled.
Example: xConguration Video OSD Mode: On
xConguration Video OSD MenuStartupMode
Congures the state of the OSD (On Screen Display) menu af ter a video system / codec boot. The
setting only applies when the video system is operated by a remote control and the on-screen menu.
Requires user role: ADMIN
Value space: <Closed/Hom e>
Closed: The OSD menu will NOT expand automatically. This setting is recommended for 3rd party
integrations that need full control of what is shown on the OSD.
Home: The OSD menu will show the home menu expanded.
Example: xConguration Video OSD MenyStartUpMode: Home
xConguration Video OSD VirtualKeyboard
Determine whether or not the virtual keyboard will automatically show on screen when text is to be
entered in an input eld. The setting only applies when the video system is operated by a remote
control and the on-screen menu.
Requires user role: ADMIN
Value space: <UserSelecta ble/AlwaysOn >
UserSelectable: The user has to press a sof tbutton to open or close the virtual keyboard.
AlwaysOn: The virtual keyboard is automatically shown on screen as long as text can be entered
in an input eld.
Example: xConguration Video OSD VirtualKeyboard: UserSelectable
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video OSD EncryptionIndicator
Dene for how long the encryption indicator (a padlock) will be shown on screen. The setting applies
to both encr ypted and non-encrypted calls, i.e. both to secure and non-secure conferences. The
icon for encrypted calls is a locked padlock, and the icon for non-encrypted calls is a crossed out
locked padlock.
Requires user role: ADMIN
Value space: <Auto/A lw ay sOn/Always Off>
Auto: If the Conference Encryption Mode setting is set to BestEort and the call is encrypted, the
encryption indicator is shown during the rst seconds of a call. If the Conference Encryption Mode
setting is set to BestEort and the call is non-encrypted, the crossed out encr yption indicator is
shown during the entire call. If the Conference Encryption Mode setting is NOT set to BestEort,
the encr yption indicator is not shown at all.
AlwaysOn: The encryption indicator is displayed on screen during the entire call. This applies to
both encr ypted and non-encrypted calls for all Conference Encryption Mode settings.
AlwaysO: The encr yption indicator is never displayed on screen. This applies to both encrypted
and non-encrypted calls for all Conference Encr yption Mode settings.
Example: xConguration Video OSD EncryptionIndicator: Auto
xConguration Video OSD MissedCallsNotication
Determine whether or not the OSD (On Screen Display) shall display a missed calls notication dialog
box if there have been incoming calls that have not been answered. The setting only applies when the
video system is operated by a remote control and the on-screen menu. When using a Touch controller
the notication dialog box will appear on the Touch display, and not on the OSD.
Requires user role: ADMIN
Value space: <Off/On >
O: The OSD will NOT show any indication that there have been any missed calls. This setting
is recommended for 3rd party integrations that need full control of what is shown on the OSD.
On: The OSD will show a notication of missed calls.
Example: xConguration Video OSD MissedCallsNotications: On
xConguration Video OSD AutoSelectPresentationSource
Determine if the presentation source should be automatically selected.
Requires user role: ADMIN
Value space: <Off/On >
O: Disable automatic selection of the presentation source.
On: Enable automatic selection of the presentation source.
Example: xConguration Video OSD AutoSelectPresentationSource: Off
xConguration Video OSD TodaysBookings
This setting can be used to display the system's bookings for today on the main OSD menu. This requires
that the system is bookable by an external booking system, like Cisco TelePresence Management
Suite (TMS).
Requires user role: ADMIN
Value space: <Off/On >
O: Do not display todays bookings.
On: Displays information about this systems bookings on screen.
Example: xConguration Video OSD TodaysBookings: Off
xConguration Video OSD MyContactsExpanded
Set how the local contacts will be displayed in the phone book dialog in the OSD (On Screen Display).
Requires user role: ADMIN
Value space: <Off/On >
O: The local contacts will be placed in a separate folder called MyContacts in the phonebook dialog.
On: The local contacts in the phone book will be shown in the top level of the phonebook dialog.
Example: xConguration Video OSD MyContactsEx panded: Off
xConguration Video OSD Output
The Video OSD (On Screen Display) Output lets you dene which monitor should display the on
screen menus, information and icons. By default the OSD is sent to the monitor connected to the
Video OSD Output 1. If you cannot see the OSD on screen, then you must re-congure the OSD
Output. You can do this by entering a key sequence on the remote control, from the web interface,
or by a command line interface.
Using the remote control: Press the Disconnect key followed by: * # * # 0 x # (where x is output 1 to 2).
Using the web interface: Open a web browser and enter the IP address of the codec. Open the
Advanced Conguration menu and navigate to Video OSD Output and select the video output.
Using a command line interface: Open a command line interface and connect to the codec (if in doubt
of how to do this, see the API Guide for the codec). Enter the command: xConguration Video OSD
Output [1..2] (select the OSD Output)
Requires user role: ADMIN
Value space: <1/2>
Range: Select 1 for HDMI output, or select 2 for DVI-I output.
Example: xConguration Video OSD Output: 1
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video OSD InputMethod InputLanguage
The codec can be enabled for Cyrillic input characters in the menus on screen. NOTE: Requires that
xConguration Video OSD inputMethod Cyrillic is set to On.
Requires user role: ADMIN
Value space: <Latin/Cyrillic>
Latin: Latin characters can be entered when using the remote control (default).
Cyrillic: Cyrillic characters can be entered using the remote control. NOTE: Requires a Cisco
TelePresence Remote Control with Cyrillic fonts.
Example: xConguration Video OSD InputMethod InputLanguage: Latin
xConguration Video OSD InputMethod Cyrillic
Set the Cyrillic mode for the menu input language in the menus on screen.
Requires user role: ADMIN
Value space: <Off/On >
O: Cyrillic mode is NOT available as a menu input language in the menus on screen.
On: Cyrillic mode is available as a menu input language in the menus on screen. This will enable
the setting Video OSD InputMethod InputLanguage.
Example: xConguration Video OSD InputMethod Cyrillic: Off
xConguration Video OSD LoginRequired
Determine if the system should require the user to login before accessing the On Screen Display
(OSD). If enabled, the user must enter his username and his PIN. After the user has logged in he can
only execute to the congurations changes and commands allowed by his Role.
Requires user role: ADMIN
Value space: <Off/On >
O: No login to the OSD is required.
On: The user must log in to access the On Screen Display (OSD).
Example: xConguration Video OSD LoginRequired: Off
xConguration Video AllowWebSnapshots
Allow or disallow snapshots being taken of the local input sources, remote sites and presentation channel. If allowed, the web interface Call Control page will show snapshots both when idle and in a call.
NOTE: This feature is disabled by default, and must be enabled from the On Screen Display (OSD),
from a directly connected Touch controller, or via the codec's serial por t (Camera port and Y-cable).
Requires user role: ADMIN
Value space: <Off/On >
O: Capturing web snapshots is not allowed.
On: Web snapshots can be captured and displayed on the web interface.
Example: xConguration Video AllowWe bSnapshots: Off
xConguration Video Output HDMI [1,2] RGBQuantizationRange
All devices with HDMI outputs should follow the rules for RGB video quantization range dened in
CEA-861. Unfortunately some devices do not follow the standard and this conguration may be used
to override the settings to get a perfect image with any display. The default value is set to Full because
most HDMI displays expects full quantization range.
Requires user role: ADMIN
Value space: <Auto/F u ll/Limite d >
Auto: RGB quantization range is automatically selected based on the RGB Quantization Range bits
(Q0, Q1) in the AVI infoframe. If no AVI infoframe is available, RGB quantization range is selected
based on video format according to CEA-861-E.
Full: Full quantization range. The R, G, B quantization range includes all code values (0 - 255).
This is dened in CEA-861-E.
Limited: Limited Quantization Range. R, G, B quantization range that excludes some code values
at the extremes (16 - 235). This is dened in CEA-861-E.
Example: xConguration Video Output HDMI 1 RGBQuantizationRange: Full
xConguration Video Output HDMI [1,2] CEC Mode
The HDMI outputs support Consumer Electronics Control (CEC). When set to on (default is o), and
the monitor connected to the HDMI output is CEC compatible and CEC is congured, the system will
use CEC to set the monitor in standby when the system enters standby. Likewise the system will wake
up the monitor when the system wakes up from standby. Please note that the dierent manufacturers uses dierent marketing names for CEC, for example Anynet+ (Samsung); Aquos Link (Sharp);
BRAVIA Sync (Sony); HDMI-CEC (Hitachi); Kuro Link (Pioneer); CE-Link and Regza Link (Toshiba);
RIHD (Onkyo); HDAVI Control, EZ-Sync, VIER A Link (Panasonic); EasyLink (Philips); and NetCommand
for HDMI (Mitsubishi).
Requires user role: ADMIN
Value space: <Off/On >
O: Disable CEC control.
On: Enable CEC control.
Example: xConguration Video Output HDMI 1 CEC Mode: Off
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
xConguration Video Output HDMI [1,2] MonitorRole
The HDMI monitor role describes what video stream will be shown on the monitor connected to the
video output HDMI connector. Applicable only if the "Video > Monitors" conguration is set to dual.
Requires user role: ADMIN
Value space: <First/Second/PresentationOnly>
First: Show main video stream.
Second: Show presentation video stream if active.
PresentationOnly: Show presentation video stream if active, and nothing else.
Example: xConguration Video Output HDMI 1 MonitorRole: First
xConguration Video Output HDMI [1,2] OverscanLevel
Some TVs or other monitors may not display the whole image sent out on the systems video output,
but cuts the outer parts of the image. In this case this setting can be used to let the system not use
the outer parts of video resolution. Both the video and the OSD menu will be scaled in this case.
Requires user role: ADMIN
Value space: <Medium/High/None>
Medium: The system will not use the outer 3% of the output resolution.
High: The system will not use the outer 6% of the output resolution
None: The system will use all of the output resolution.
Example: xConguration Video Output HDMI 1 OverscanLevel: None
xConguration Video Output HDMI [1,2] Resolution
Select the preferred resolution for the monitor connected to the video output HDMI connector. This
will force the resolution on the monitor.
Example: xConguration Video Output HDMI 1 Resolution: Auto
xConguration Video WallPaper
Select a background image (wallpaper) for the video screen when idle.
Requires user role: USER
Value space: <None/Custom/Growing/Summersky/Waves>
None: There is no background image on the screen, i.e. the background is black.
Custom: Use the custom wallpaper that is stored on the system as background image on the
screen. As default, there is no custom wallpaper stored and the background will be black. You
can upload a custom wallpaper to the system using the web interface. The maximum supported
resolution is 1920x1200.
Summersky, Growing, Waves: The chosen background image is shown on the screen.
Example: xConguration Video Wallpaper: Summersky
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xConguration
Experimental conguration
The Experimental settings are for testing only and should not be used unless agreed with Cisco.
These settings are not documented and WILL change in later releases.
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
Description of the xCommands commands
In this chapter, you can nd a complete list of all xCommand type commands with parameters.
We recommend you visit our web site regularly for updated versions of the manual.
Go to: http://www.cisco.com/go/quickset-docs
The Audio commands ............................................................................................................71
xCommand Audio Sound Play ............................................................................................................................71
xCommand Bookings List ..................................................................................................................................71
The Boot commands ............................................................................................................ 73
xCommand Call Hold ..........................................................................................................................................74
The Camera commands ....................................................................................................... 77
xCommand Camera PanTiltReset ..................................................................................................................... 77
xCommand Camera PositionActivateFromPreset ............................................................................................ 78
xCommand Camera PositionReset ................................................................................................................... 77
xCommand Camera PositionSet ....................................................................................................................... 77
xCommand Camera Preset Activate ................................................................................................................. 79
xCommand Camera Preset Edit ........................................................................................................................ 79
xCommand Camera Preset List ........................................................................................................................ 79
xCommand Camera Preset Remove ................................................................................................................. 79
xCommand Camera Preset Store ..................................................................................................................... 80
xCommand Camera Ramp ................................................................................................................................ 78
xCommand Camera TriggerAutofocus .............................................................................................................. 78
The Conference commands ................................................................................................. 80
xCommand Preset Store ................................................................................................................................... 93
The Security commands ....................................................................................................... 94
The Video commands ........................................................................................................... 99
xCommand Video Layout LoadDb .................................................................................................................... 99
xCommand Video Layout SetPresentationView ............................................................................................... 99
xCommand Video OSD Close ........................................................................................................................... 99
xCommand Video PictureLayoutSet ................................................................................................................. 99
xCommand Video PIP ActiveSpeaker Set ...................................................................................................... 100
xCommand Video PIP Presentation Set.......................................................................................................... 10 0
xCommand Video Selfview Set ...................................................................................................................... 100
The Experimental commands ..............................................................................................101
The Provisioning commands ................................................................................................ 94
List the stored bookings for the system. The list of booking details is received from the management
system. All parameters are optional, and can be used to limit the search result.
If no parameters are used, past, present and future bookings are all listed. To avoid listing bookings
from yesterday and before, use DayOset = 0.
Days: Number of days to retrieve bookings from.
DayOset: Which day to start the search from (today: 0, tomorrow: 1…).
Limit: Max number of bookings to list.
Oset: Oset number of bookings for this search.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The Boot commands
xCommand Boot
Reboot system.
Action: As a default the system restarts after a reboot. By selecting Shutdown, the system will not restar t.
Requires user role: USER
Parameters:
Action: <Restart/Shutdown>
Example:
xCom mand Boot
*r BootResult (status=OK):
** end
OK
CUIL reboot request, restarting
Connection closed by foreign host.
The Call commands
xCommand Call Accept
Accept an incoming call. If no CallId is specied, all incoming calls are accepted. The CallID is returned
when the xCommand Dial command is run. During the call you can run the xStatus Call command to
see the CallId.
Requires user role: USER
Parameters:
CallId: <0..65534>CallType(o): <Audio/Video>
Example:
xCom mand Call Accept CallId:19
OK
*r CallAcceptResult (status=OK):
** end
xCommand Call Reject
Reject incoming call. If no call id is specied, all incoming calls are rejected. The CallID is returned when the
xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role: USER
Parameters:
CallId: <0..65534>
Example:
xCom mand Call Reject CallId:20
OK
*r CallRejectResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Call Disconnect
Disconnect a call. The CallID is returned when the xCommand Dial command is run. During the call you
can run the xStatus Call command to see the CallId.
Requires user role: USER
Parameters:
CallId(r): <0..65534>
Example:
xCom mand Call Disconnect CallId:17
OK
*r DisconnectCallResult (status=OK):
** end
xCommand Call DisconnectAll
Disconnect all active calls.
Requires user role: USER
Example:
xCom mand Call DisconnectAll
OK
*r DisconnectAllResult (status=OK):
** end
xCommand Call Hold
Put a call on hold. The CallID is returned when the xCommand Dial command is run. During the call you
can run the xStatus Call command to see the CallId.
Requires user role: USER
Parameters:
CallId(r): <0..65534>
Example:
xCom mand Call Hold CallId:19
OK
*r CallHoldResult (status=OK):
** end
xCommand Call Join
Join all existing calls, active and on hold. For this command to work, you have to congure Multiway™ rst,
see xConguration NetworkSer vices MultiWay Address and xConguration Conference 1 Multipoint Mode.
Requires user role: USER
Example:
xCom mand Call Join
OK
*r CallJoinResult (status=OK):
** end
xCommand Call Resume
Resume a call that have been put on hold. The CallID is returned when the xCommand Dial command
is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role: USER
Parameters:
CallId(r): <0..65534>
Example:
xCom mand Call Resu me CallId:19
OK
*r CallResumeResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Call ExtendConference
Request to extend the conference for the call with the specied CallId.
For this command to apply, the following are required:
1) The result from the xStatus Conference Site <CallId> ConferenceExtended must be NotExtended:
*s Conference Site <CallId> ConferenceExtended: NotExtended
2) The following tag from the bookings list command must have a value > 0:
*r Bookings Booking <bookingNumber> MaximumMeetingExtension: "30"
Note: The command returns the result from the command itself, not the result from the extension request
to far end. A separate event returns the result from the extension request.
CallId: CallId for the call in question.
Requires user role: USER
Parameters:
CallId(r): <0..65534>
Example:
xCom mand Call ExtendConference CallId: 1
OK
*r CallExtendConferenceResult (status=OK)
** end
xCommand Call UnattendedTransfer
Transfers an ongoing call to another participant. The CallID is returned when the xCommand Dial command
is run. During the call you can run the xStatus Call command to see the CallId. Fully supported for SIP
calls only.
Requires user role: USER
Parameters:
CallId(r): <0..65534>Number(r): <S: 0, 255>
Example:
xCom mand Call UnattendedTransfer CallId: 2 Number: destination@exa mple.com
*r TransferUriResult (status=OK):
** end
The CallLog commands
xCommand CallLog Clear
Clear call logs stored in the system. If a logtag is given as argument, that specic call is deleted from
the logs. If no logtag is given the system deletes all call logs. The LogTag values for the calls are found
by issuing the xHistory CallLog Call command.
Requires user role: USER
Parameters:
Lo gTa g: <0..2147483 6 47>
Example:
xCom mand CallLog Clear
*r ClearResult (status=OK):
** end
xCommand CallLog Recent Delete
Delete the call log of recent calls. If a logtag is given as argument, that specic call is deleted from the
log. If no logtag is given the system deletes all call logs. The LogTag values for recent calls are found by
issuing the xHistory CallLog Recent command.
Requires user role: USER
Parameters:
Lo gTa g: <0..2147483 6 47>
Example:
xCom mand CallLog Recent Delete
*r DeleteResult (status=OK):
** end
xCommand CallLog Outgoing Delete
Delete the call log of outgoing calls. If a logtag is given as argument, that specic call is deleted from
the log. If no logtag is given the system deletes the complete outgoing calls log. The LogTag values for
outgoing calls are found by issuing the xHistor y CallLog Outgoing command.
Requires user role: USER
Parameters:
Lo gTa g: <0..2147483 6 47>
Example:
xCom mand CallLog Outgoing Delete LogTag:202
*r DeleteResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand CallLog Received Delete
Delete the call log of received calls. If a logtag is given as argument, that specic call is deleted from
the log. If no logtag is given the system deletes the complete received calls log. The LogTag values for
received calls are found by issuing the xHistor y CallLog Received command.
Requires user role: USER
Parameters:
Lo gTa g: <0..2147483 6 47>
Example:
xCom mand CallLog Received Delete LogTag:126
*r DeleteResult (status=OK):
** end
xCommand CallLog Missed Delete
Delete the call log of missed calls. If a logtag is given as argument, that specic call is deleted from the
log. If no logtag is given the system deletes the complete missed calls log. The LogTag values for missed
calls are found by issuing the xHistor y CallLog Missed command.
Requires user role: USER
Parameters:
Lo gTa g: <0..2147483 6 47>
Example:
xCom mand CallLog Missed Delete LogTag:119
*r DeleteResult (status=OK):
** end
The CamCtrlPip commands
xCommand CamCtrlPip
Show or hide the camera selfview in a small window (picture in picture).
Mode: Select whether the self-view picture in picture is on or o.
Duration: Set how long the self-view is shown for on screen.
Requires user role: USER
Parameters:
Mode(r): <O n/O<
Duration: <0..60<
Example:
xCom mand CamCtrlPip Mode: On
*r CamCtrlPipResult (status=OK):
** end
xCommand CallLog Missed Dismiss
Review the call log of dismissed calls. If a logtag is given as argument, that specic call is deleted from
the log. If no logtag is given the system deletes the complete missed calls log. The LogTag values for
missed calls are found by issuing the xHistory CallLog Missed command.
Requires user role: USER
Parameters:
Lo gTa g: <0..2147483 6 47>
Example:
xCom mand CallLog Missed Dim issed LogTag:119
*r DismissResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The Camera commands
xCommand Camera PanTiltReset
The camera is reset to its default values for pan and tilt. If the camera is daisy chained, the CameraId
is given by its place in the chain.
Requires user role: USER
Parameters:
CameraId(r): <1..1>
Example:
xCom mand Camera PanTiltReset Cam eraId:1
OK
*r PanTiltResetResult (status=OK):
** end
xCommand Camera PositionReset
Reset the camera position the the deafult position.
Requires user role: USER
Parameters:
CameraId(r): <1..1>
Example:
xCom mand Camera PositionReset CameraId:1
OK
*r CameraPositionResetResult (status=OK):
** end
xCommand Camera PositionSet
Position the camera by dening the pan, tilt, zoom and focus parameters. If the camera is placed in a
daisy chain you need to know the CameraId for the camera you want to address.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Camera Ramp
Move the camera in a specied direction. The camera moves at specied speed until a stop command
is issued. In a daisy chain, you need to know the CameraId for the camera you want to address. Be
aware that pan and tilt can be operated simultaneously, but no other combinations. In the latter case
only the rst operation specied is executed. For example, if you try to run both zoom and pan at the
same time, only zoom is executed.
NOTE: You must run a stop command to stop the camera, see the example below.
CameraId: Give the camera id.
Pan: Move the camera to the Left or Right, followed by Stop.
PanSpeed: Set the pan speeed.
Tilt: Move the camera Up or Down, followed by Stop.
TiltSpeed: Set the tilt speeed.
Zoom: Zoom the camera In or Out, followed by Stop.
ZoomSpeed: Set the zoom speeed.
Focus: Focus the camera Far or Near, followed by Stop.
xCom mand Camera Ra mp Ca meraId:1 Pan:left PanSpeed:1
OK
*r RampResult (status=OK):
** end
xCom mand Camera Ra mp Ca meraId:1 Pan:stop
OK
*r RampResult (status=OK):
** end
xCommand Camera TriggerAutofocus
Trigger the autofocus functionality. The camera must support autofocus functionality. If the camera is
daisy chained, the CameraId is given by its place in the chain.
Requires user role: USER
Parameters:
CameraId(r): <1..1>
Example:
xCom mand Camera TriggerAutofocus Ca meraId:1
OK
*r TriggerAutofocusResult (status=OK):
** end
xCommand Camera PositionActivateFromPreset
Selects pan, tilt, zoom and focus parameters for the given camera id from the selected preset.
CameraId: Give the camera id.
PresetId: Select preset 1 to 15.
Requires user role: USER
Parameters:
CameraId(r): <1..1>
PresetId (r): <1..15>
Example:
xCom mand Camera PositionActivateFromPreset CameraId:1 PresetID:1
OK
*r PositionActivateFromPresetResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Camera Preset Activate
Activate one of the stored camera preset.
Note: The xCommand Camera Preset commands applies to an individual camera. This is in contrast
to the xCommand Preset commands where a single preset covers ALL connected cameras plus the
Video Input switcher settings.
PresetId: The ID of the camera preset you want to activate.
Requires user role: USER
Parameters:
PresetId(r): <1..35>
Example:
xCom mand Camera Preset Activate PresetId: 1
OK
*r CameraPresetActivateResult (status=OK)
** end
xCommand Camera Preset Edit
Edit a stored camera preset. You can change the name of the camera preset and its position in the list
that is returned by the xCommand Camera Preset List command.
Note: The xCommand Camera Preset commands applies to an individual camera. This is in contrast
to the xCommand Preset commands where a single preset covers ALL connected cameras plus the
Video Input switcher settings.
PresetId: The ID of the camera preset you want to edit.
ListPosition: The position in the list returned by the xCommand Camera Preset List command.
Name: The name of the camera preset. It will be used in the list returned by the xCommand Camera
xCom mand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: ""
OK
*r CameraPresetEditResult (status=OK)
** end
xCommand Camera Preset List
List information about available camera presets.
Note: The xCommand Camera Preset commands are used to store camera positions for individual
cameras. This is in contrast to the xCommand Preset commands where a single preset stores/recalls
ALL connected cameras plus the Video Input switcher settings. This makes it more usable for integrations where one wants to store multiple camera positions individually per camera rather than a complete
camera position set.
PresetId: Filter on specied preset.
Requires user role: USER
Parameters:
PresetId: <1..35>
Example:
xCom mand Camera Preset List PresetId: 1
OK
*r CameraPresetListResult (status=OK)
** end
xCommand Camera Preset Remove
Remove a camera preset.
Note: The xCommand Camera Preset commands applies to an individual camera. This is in contrast
to the xCommand Preset commands where a single preset covers ALL connected cameras plus the
Video Input switcher settings.
PresetId: The ID of the camera preset you want to remove.
Requires user role: USER
Parameters:
PresetId(r): <1..35>
Example:
xCom mand Camera Preset Remove PresetId: 1
OK
*r CameraPresetRemoveResult (status=OK)
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Camera Preset Store
Store the current position of the chosen camera. The camera is identied by the CameraId parameter.
Note: The xCommand Camera Preset commands applies to an individual camera. This is in contrast
to the xCommand Preset commands where a single preset covers ALL connected cameras plus the
Video Input switcher settings. The xCommand Camera Preset commands are useful when you want
to handle multiple camera positions individually per camera, rather than working with complete sets of
camera positions.
PresetId: The ID of this camera preset. If not set explicitly, the codec will assign a preset ID automatically.
CameraId: Which camera to store the position of.
ListPosition: The new camera preset’s position in the list returned by the xCommand Camera Preset
List command.
Name: The name of the new camera preset. It will be used in the list returned by the xCommand Camera
xCom mand Camera Preset Store PresetId: 1 CameraId: 1 ListPosition: 1 Name “”
OK
*r CameraPresetStoreResult (status=OK)
** end
The Conference commands
xCommand Conference DoNotDisturb Activate
This command switches on the Do Not Disturb mode, and the Timeout parameter allows you to control
when it is switched o again. It only takes eect when xConguration Conference DoNotDisturb Mode
is set to Timed.
When Do Not Disturb is switched on, all incoming calls are rejected and registered as missed calls. The
calling side receives a busy signal.
Timeout: The number of minutes before Do Not Disturb is switched o. If not set, Do Not Disturb times
out after 1440 minutes (24 hours).
Requires user role: USER
Parameters:
Timeout: <0..1440>
Example:
xCom mand Conference DoNotDisturb Activate
*r ActivateResult:
** end
xCommand Conference DoNotDisturb Deactivate
This command switches o the Do Not Disturb mode. This command only takes eect when xConguration Conference DoNotDisturb Mode is set to Timed. When Do Not Disturb is switched o incoming
calls come through as normal.
Requires user role: USER
Example:
xCom mand Conference DoNotDisturb Deactivate
*r DeactivateResult:
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
xCommand Conference ActiveSpeaker Reset
Resets ActiveSpeaker. Normal voice switching is switched back on.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Conference ActiveSpeaker Set
For manually setting the active speaker in a conference. Overrides normal voice switching.
Target: Identies local or remote participant.
CallId: Identies callId for remote participant. Only relevant if Target is set to "remote".
Requires user role: USER
Parameters:
Target(r): <local/remote<
CallId: <0..65534<
Example:
Example 1 xCommand Conference ActiveSpeaker Set Target: local
*r ConferenceActiveSpeakerSetResult (status=OK):
** end
Example 2 xcom Conference ActiveSpeaker Set Target: remote Callid: 3
*r ConferenceActiveSpeakerSetResult (status=OK):
** end
The Dial commands
xCommand Dial
Dial out from the system. Returns information about the CallId and ConferenceId, which are required
for some other commands.
Number: Enter the number or address.
Protocol: Select the SIP, H323 or H320 protocol.
CallRate: Set a call rate.
CallType: Select the audio or video call type.
BookingId: Any identier that an external booking system (e.g. TMS, CTS-MAN) can use for its own
references to match placed calls with the booking systems internal identier for a meeting. This can be
any string, e.g. a GUID. The booking Id is supplied in call logs, call events etc for the call.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The DTMFSend commands
xCommand DTMFSend
Send DTMF tones to the far end.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the
xStatus Call command to see the CallId.
DTMFString: Enter the DTMF string.
Requires user role: USER
Parameters:
CallId: <0..65534>
DTMFString(r): <S: 0, 32>
Example:
xCom mand DTMFSend CallId:2 DTMFString:1234
*r DTMFSendResult (status=OK):
** end
The FacilityService commands
xCommand FacilityService Dial
Dial out from the system to a facility ser vice. A maximum of ve facility services can be dened; which
one of these ve to dial to is identied by the ServiceId (ref. xConguration Facility Service [ServiceId]
Type/Name/Number/CallType). The command returns information about the CallId and ConferenceId.
ServiceId: The identier of the facility service.
Requires user role: USER
Parameters:
ServiceId(r): <1..5>
Example:
xCom mand FacilityService Dial ServiceId: 1
OK
*r FacilityServiceDialResult (status=OK):
CallId: 2
ConferenceId: 1
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The FarEndControl commands
xCommand FarEndControl Camera Move
Move the far end camera (the remote camera). NOTE: The far end camera moves in the specied direction until the stop command (ref: xCommand FarEndControl Camera Stop) is issued
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the
xStatus Call command to see the CallId.
Value: Select the action for how to move the camera.
xCom mand FarEndControl Camera Move CallId:3 Value:left
*r FECCMoveResult (status=OK):
** end
xCommand FarEndControl Camera Stop
Stop the far end camera after the xCommand FarEndControl Camera Move has been issued.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the
xStatus Call command to see the CallId.
Requires user role: USER
Parameters:
CallId: <0..65534>
Example:
xCom mand FarEndControl Camera Stop CallId:3
*r FECCMoveResult (status=OK):
** end
xCommand FarEndControl Preset Activate
While in a call, this command is used to activate a preset on the far end codec. The preset covers the
far end codec’s camera positions and input video switcher settings.
The preset must be stored on the far end codec beforehand, either by using the xCommand Preset
Store command locally on the far end codec, or by using the xCommand FarEndControl Preset Store
command from a remote codec.
Note: The far end codec’s xConguration Conference FarEndControl Mode setting must be switched
On for the FarEndControl commands to work.
CallId: The CallId is required to identify the far end codec only when in a multipoint call. The CallId
is returned when issuing the xCommand Dial command. During the call you can run the xStatus Call
command to see the CallId.
PresetId: The PresetId must be retrieved from the far end codec since this is the ID of the preset that
is stored on that codec.
Requires user role: USER
Parameters:
CallId: <0..65534>
PresetId (r): <1..15>
Example:
xCom mand FarEndControl Preset Activate CallId:3 PresetId:1
*r FECCPresetActivateResult (status=OK):
** end
xCommand FarEndControl Preset Store
While in a call, this command is used to store a preset on the far end codec. The preset covers the far
end codec’s camera positions and input video switcher settings.
Note: The far end codec’s xConguration Conference FarEndControl Mode setting must be switched
On for the FarEndControl commands to work.
CallId: The CallId is required to identify the far end codec only when in a multipoint call. The CallId
is returned when issuing the xCommand Dial command. During the call you can run the xStatus Call
command to see the CallId.
PresetId: The PresetId must be retrieved from the far end codec since this is the ID of the preset that
is stored on that codec.
Requires user role: ADMIN
Parameters:
CallId: <0..65534>
PresetId(r): <0..15>
Example:
xCom mand FarEndControl Preset Store CallId:3 PresetId:1
*r FECCPresetStoreResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand FarEndControl Source Select
Select which video input source to use as the main source on the far end system.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the
xStatus Call command to see the CallId.
SourceId: Select a video input source on the far end.
Requires user role: USER
Parameters:
CallId: <0..65534>
SourceId(r): <0..15>
Example:
xCom mand FarEndControl Source Select CallId:3 SourceId:1
*r FECCSelectSourceResult (status=OK):
** end
The HttpFeedback commands
xCommand HttpFeedback Register
Register the system to a HTTP(S) server to return XML feedback over HTTP(S) to specic URLs.
FeedbackSlot: You can have from 1 to 4 slots for feedback.
ServerUrl: Dene the URL for the HTTP(S) server.
Expression[1..15]: What par ts of the Status and Conguration XML documents to monitor are specied
by XPath expressions. You can have from 1 to 15 XPath expressions.
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.
Display a message on screen, for a specied duration of time (in seconds). NOTE: If Duration is not set,
the command must be followed by xCommand Message Alert Clear.
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.
Title: Enter a message title.
Text: Enter the message to be displayed.
Duration: Set how long (in seconds) the message is to be displayed on the screen. If set to 0 (zero) the
message does not disappear until a xCommand Message Alert Clear message has been sent.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Message TextLine Display
Display a text line on screen. Optionally you can place the text line at a specied location and for a
specied 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.
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.
xCom mand Message TextLine Display Text: "The message to be displayed." X:500
Y:2000 Duration: 20
OK
*r MessageTextLineDisplayResult (status=OK):
** end
xCommand Message TextLine Clear
Clears the text line which was dened by the xCommand Message TextLine Display command.
Requires user role: ADMIN
Example:
xCom mand Message TextLine Clear
OK
*r MessageTextLineClearResult (status=OK):
** end
xCommand Message Prompt Display
Display a small window on screen with a title, text and up to ve options for response from the user.
The message is displayed on screen until the user gives a response, or until the system receives the
following command xCommand Message Prompt Clear.
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.
Title: Enter the title of the message.
Text: Enter the message.
FeedbackId: To identify the feedback enter a FeedbackId.
Option.1 to Option.5: Enter the text to appear on the feedback options.
xCom mand Message Pro mpt Display Title: "Meeting extension" Text: "The
meeting is about to end. Do you want to extend the meeting?" Option.1:
"No" Option.2: "Yes, extend with 5 minutes" Option.3: "Yes, extend with 10
mi nutes"
OK
*r MessagePromptDisplayResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Message Prompt Clear
Remove the window displayed using the xCommand Message Alert Display command.
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.
FeedbackId: The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt
Display command.
Requires user role: ADMIN
Parameters:
FeedbackId: <S: 0, 255>
Example:
xCom mand Message Pro mpt Clear
OK
*r MessagePromptClearResult (status=OK):
** end
xCommand 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.
FeedbackId: The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt
Display command.
OptionId: The OptionId corresponds to the OptionIds given as possible responses in the xCommand
Message Prompt Display command.
Requires user role: ADMIN
Parameters:
FeedbackId: <S: 0, 255>
Op t ionI d (r): <1.. 5>
Example:
xCom mand Message Pro mpt Response OptionId: 1
OK
*r MessagePromptResponseResult (status=OK):
** end
xCommand Message Echo
Issuing the command makes the API raise a message-echo event. The command has no other impact
on the codec. Usage can be to poll the codec from a control system or any external device/system to
check for connectivity. To monitor the feedback use the xFeedback command. You can read more about
the xFeedback command in the general API introduction section.
Text: Enter the text to be echoed.
Requires user role: ADMIN
Parameters:
Text: <S: 0, 255>
Example:
xCom mand Message Echo Text:" MyEchoListner99"
*** end
* e Message Echo Text: "MyEchoListner99"
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The Phonebook commands
xCommand Phonebook Folder Add
Add a folder to the local phonebook, where phonebook entries can be stored. Returns the FolderId
(localGroupId-3), which is a unique Id for the folder.
Name(r): The name of the folder.
ParentFolderId: A unique identier for the parent folder, which was created when a previous xCommand
Phonebook Folder Add command was issued.
Requires user role: ADMIN
Parameters:
Name(r): <S: 0, 255>
ParentFolderId: <S: 0, 255>
Example:
xCom mand Phonebook Folder Add Name: "New York Ofce"
OK
*r PhonebookFolderAdd Result (status=OK):
Name: localGroupId-3
** end
xCommand Phonebook Folder Modify
Modify an existing phonebook folder.
FolderId: A unique identier for the folder, which was created when the xCommand Phonebook Folder
Add command was issued.
Name(r): The name of the contact.
ParentFolderId: A unique identier for the parent folder, which was created when the xCommand
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Phonebook Contact Add
Add new contact to the local phonebook. Stored internally in the system. Returns the ContactId (Name:
localContactId-1), which is a unique Id of the contact.
Name: The name of the contact.
FolderId: A unique identier for the folder, which was created when the xCommand Phonebook Folder
Add command was issued.
ImageURL: The URL to an image.
Title: The title of the contact.
Number: The phone number or address of the contact.
Protocol: Select Auto, SIP, H323 or H320 protocol.
CallRate: Set a call rate.
CallType: Select a call type (audio or video).
Device: Select the device type.
xCom mand Phonebook Contact Add Name: "John Doe" Number:12345
OK
*r PhonebookContactAddResult (status=OK):
Name: localContactId-1
** end
xCommand Phonebook Contact Modify
Modify the contact details of an existing contact in the local phonebook.
ContactId: A unique identier for the contact, which was created when the xCommand Phonebook
Contact Add command was issued.
Name: The name of the contact.
FolderId: A unique identier for the folder, which was created when the xCommand Phonebook Folder
Add command was issued.
ImageURL: The URL to an image.
Title: The title of the contact.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Phonebook ContactMethod Add
Add details about the call setup to an existing contact in the local phonebook. Returns the ContactMethodId
(Name: 1), which is a unique Id of the contact method.
ContactId: A unique identier for the contact, which was created when the xCommand Phonebook
Contact Add command was issued.
Device: Set which type of device to call to.
Number(r): The phone number or address of the contact.
Protocol: Select Auto, SIP, H323 or H320 protocol.
CallRate: Set a call rate.
CallType: Select a call type (audio or video).
xCom mand Phonebook ContactMethod Add ContactId:localContactId-2 Number:54321
Protocol:H323
OK
*r PhonebookContactMethod AddResult (status=OK):
Name: 1
** end
xCommand Phonebook ContactMethod Modify
Modify details about the call setup for an existing contact in the local phonebook.
ContactId: A unique identier for the contact. It was created when the xCommand Phonebook Contact
Add command was issued.
ContactMethodId: A unique identier for the contact method. It was created when the xCommand
Phonebook ContactMethod Add command was issued.
Device: Set which type of device to call to.
Number: The phone number or address of the contact.
Protocol: Select Auto, SIP, H323 or H320 protocol.
CallRate: Set a call rate.
CallType: Select a call type (audio or video).
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Phonebook ContactMethod Delete
Delete details about the call setup to an existing contact in the local phonebook.
ContactId: A unique identier for the contact, which was created when the xCommand Phonebook
Contact Add command was issued.
ContactMethodId: A unique identier for the contact method, which was created when the xCommand
The search command lets you search in both the local and corporate phone books. A search gives
a ResultSet. More examples can be found on the Developer Zone web page. Go to: http://developer.
tandberg.com/web/guest/howtos/cseries-api/phonebook.
PhonebookId: The value of the ID tag for which phonebook server to use. See xConguration Phonebook
Server. Not necessary to use.
PhonebookType: Which phone book to search in. Either the local phone book or the corporate phonebook.
SearchString: Search for entries containing specied string (not begins with). If no FolderId is specied,
the search yields search results from ALL folders/phonebook directories. The SearchString parameter
is optional for software version TC2.0 and later.
SearchField: Currently not in use.
Oset: Get records starting with this oset in a search. Default 0. Used together with Limit to support
paging.
FolderId: Search only in the specied folder. FolderId (string) is listed in the ResultSet of a search result
containing folders.
Limit: Limit the number of records in the result set to this number. E.g. Limit: 10 only gives a ResultSet
of 10 entries (Contacts + Folders) although the total number of hits may be greater. Any limit higher
than 1000 is treated as 1000.
Recursive: Set if the phonebook should search recursive. The result from an empty search return both the
directories and the content in the directories. NOTE: This command is only valid for the local directory.
Open a media stream from the selected presentation source.
PresentationSource: Select the video input source to be used for presentation.
SendingMode: Select whether the presentation is shown locally or locally and remotely.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The Preset commands
xCommand Preset Store
Store the connector selections for all video input sources and the current position for all cameras.
Note that information about all video input sources and all camera positions are included in the same
preset. The system may hold 15 predened video input presets. These presets are available for far end
control, i.e. they are referred in the PresetId parameter of the xCommand FarEndControl Preset Activate
command. In contrast, the xCommand Camera Preset commands applies to individual cameras only.
Those presets are not available for far end control.
PresetId: The ID of this preset.
Type: Currently it makes no dierence if you select Camera or All. However, this may change in the
future (other audio or video settings may be included in a preset). If you want to ensure that a preset
only aects camera positions we recommend that you select Camera.
Description: Enter a description of the camera preset.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The Provisioning commands
xCommand Provisioning StartUpgrade
The codec software can be upgraded from the provisioning server. When starting the upgrade the software is automatically downloaded and installed. The codec reboots to complete the software upgrade.
Requires user role: ADMIN
Example:
xCom mand Provisioning StartUpgrade
*r StartUpgradeResult (status=OK):
** end
xCommand Provisioning CUCM CAPF OperationStart
Starts a pending CAPF (Cer ticate Authority Proxy Function) operation towards the CUCM. When the
CUCM administrator initiates an operation that the endpoint should perform (like installing, updating or
deleting certicates), this command can be used to start the CAPF operation.
AuthString: Set the authentication string required for the CAPF operation.
Requires user role: USER
Parameters:
AuthString(o): >S: 4, 10>
Example:
xCom mand Provisioning CUCM CAPF OperationStart AuthString: 123456
*r CAPFStartResult (status=OK):
** end
The Security commands
xCommand Security FIPSMode Activate
Activate FIPS (140-2) mode. NOTE: Activating FIPS mode implies a reset to factory defaults.
While in FIPS mode, software upgrade is disabled and the following limitations apply: All calls are
encrypted, unencrypted communication protocols like Telnet and HTTP cannot be used. IEEE802.1x
and SNMP are disabled. The SIP Prole Type setting cannot be Microsof t. The root user is not available
(root settings cannot be changed).
To exit FIPS mode, perform a factory reset.
Conrm: <Yes>
Requires user role: ADMIN
Parameters:
Conrm(r): <Yes>
Example:
xCom mand Security FIPSMode Activate Conrm: "Yes"
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The Standby commands
xCommand Standby Activate
Set the system in standby mode, which turns o the video outputs and put the camera into sleep mode.
Requires user role: USER
Example:
xCom mand Stand by Activate
*r ActivateResult (status=OK):
** end
xCommand Standby Deactivate
Bring the system out of standby mode.
Requires user role: USER
Example:
xCom mand Stand by Deactivate
*r DeactivateResult (status=OK):
** end
xCommand Standby ResetTimer
Set a nonpermanent standby delay (in minutes). If the system is in standby mode when the reset timer is
set, the system is brought out of standby mode. When left idle for the given delay the system goes into
standby mode. Setting the reset timer does not aect the Standby Delay in the Advanced conguration
menu (or by xConguration Standby Delay). Next time this delay is the valid standby delay.
Requires user role: USER
Parameters:
Delay(r): <1..480>
Example:
xCom mand Stand by ResetTimer Delay:10
*r ResetResult (status=OK):
** end
The SystemUnit commands
xCommand SystemUnit OptionKey Add
Add an option key to support additional features.
Requires user role: ADMIN
Parameters:
Key(r): <S: 16, 24>
Example:
xCom ma nd Syste m Un it O pt ionK ey Add Key:******************
*r OptionKeyResult (status=OK):
** end
xCommand SystemUnit OptionKey RemoveAll
Removes all Option keys.
Requires user role: ADMIN
Parameters:
Conrm(r): <Yes>
Example:
xCom mand SystemUnit OptionKey RemoveAll Conr m: Yes
*r OptionKeyResult (status=OK):
** end
xCommand SystemUnit ReleaseKey Add
Add the sof tware release key. Used to enable new software (applicable for main software releases).
Requires user role: ADMIN
Parameters:
Key(r): <S: 16, 24>
Example:
xCom ma nd Syste m Un it Rele aseKey Ad d Key:******************
*r ReleaseKeyResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand SystemUnit ReleaseKey RemoveAll
Removes all Release keys.
Requires user role: ADMIN
Parameters:
Conrm(r): <Yes>
Example:
xCom mand SystemUnit ReleaseKey Remove All Conrm: Yes
*r ReleaseKeyResult (status=OK):
** end
xCommand SystemUnit AdminPassword Set
Set an administrator password to restrict access the codec. After a restart of the codec this password
also applies to the web interface.
Requires user role: ADMIN
Parameters:
Password(r): <S: 0, 64>
Example:
xCom mand SystemUnit AdminPassword Set Password:***********
*r AdminPasswordSetResult (status=OK):
** end
xCommand SystemUnit Diagnostics Run
This command runs all self-diagnostics commands on the system. Returns information on whether the
admin password is set.
Requires user role: ADMIN
Example:
xCom mand SystemUnit Diagnostics Run
*r DiagnosticsResult (status=OK):
** end
xCommand SystemUnit MenuPassword Set
Set a menu password to restrict access to Administrator Settings menu. If you have a remote control the
password can also be set from the on screen menu. If you have a Cisco TelePresence Touch controller
the menu password is set from the command line interface.
Requires user role: ADMIN
Parameters:
Password(r): <S: 0, 255>
Example:
xCom ma nd Syste m Un it M enuPas sw or d Set Password:***********
*r MenuPasswordSetResult (status=OK):
** end
xCommand SystemUnit MenuPassword Validate
Validate that the supplied password is correct.
Requires user role: ADMIN
Parameters:
Password(r): <S: 0, 255>
Example:
xCom ma nd Syste m Un it M enuPas sw or d Va lidate Password:***********
*r MenuPasswordValidateResult (status=OK):
** end
xCommand SystemUnit DateTime Set
Set the date and time for the system, if not available from NTP (Network Time Protocol).
Requires user role: ADMIN
Parameters:
Year: <2008..2037>
Mo n t h : < 1. .12 >
Day : <1. . 31>
Hour: <0..23>
Minute: <0..59>
Second: <0..59>
Example:
xCom mand SystemUnit DateTime Set Year:2009 Month:7 Day:3 Hour:12 Minute:0
Se co n d:0
*r DateTimeSetResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand SystemUnit DateTime Get
Read the time and date from the system.
Requires user role: USER
Example:
xCom mand SystemUnit DateTime get
*r DateTimeGetResult (status=OK):
Year: 2009
Month: 7
Day: 3
Hour: 12
Minute: 0
Second: 0
** end
xCommand SystemUnit FactoryReset
Reset the codec to factory default settings. The call logs are deleted and all system parameters are
reset to default values. All les that have been uploaded to the codec are deleted. The Release key and
Option key are not aected.
As a default the system restar ts after the factory reset, but other behavior can be forced by selecting
a dierent TrailingAction.
TrailingAction: Select Shutdown or NoAction to override the default behavior (Restart).
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
The Video commands
xCommand Video PictureLayoutSet
Select the screen layout mode.
Target: Select if the target is the local layout or the remote layout.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run
the xStatus Call command to see the CallId.
LayoutFamily: Select a layout family.
CustomLayoutName: Enter a name for the layout.
xCom mand Video PictureLayoutSet Target: Local LayoutFa mily: equal
*r SetPictureLayoutResult (status=OK):
** end
xCommand Video Layout SetPresentationView
Set the presentation view mode.
View: Select Default when you want the presentation to be viewed with the default settings for the
codec. Select Maximized when you want the presentation to be displayed in full screen. Select Minimized
when you want the presentation to be displayed in a small picture on screen.
Requires user role: ADMIN
Parameters:
View(r): <Default/Maximized/Minimized>
Example:
xCom mand Video Layout SetPresentationView View:Default
Loads and starts using the specied video layout database. The default video layout database is
initially provided by the system. The custom database is generated by the Cisco TC Console tool and
is made available to the codec from within the TC Console tool. The TC Console software is found
at the Developer Zone web page. Go to: http://developer.tandberg.com/web/guest/tools/integrators/
audio-console.
Custom: The system uses the custom video layout database which generated by the Cisco TC Console tool.
CustomAutoModes: The system uses the auto mode part of the custom video layout database.
Default: The system use the default video layout database which is provided by the system.
Requires user role: ADMIN
Parameters:
Type(r): <Custom/CustomAutoModes/Default>
Example:
xCom mand Video Layout LoadDb Type: Default
*r VideoLayoutLoadDbResult (status=OK):
** end
xCommand Video OSD Close
Closes all menus on the on-screen display.
Element: The on –screen menu.
Requires user role: ADMIN
Parameters:
Element(r): <Menu<
Example:
xCom mand Video OSD Close Element: Menu
*OsdCloseElementResult (status=OK):
** end
D1486 9. 05 Codec C20 API Reference Guide TC6.0 Februar y 2013.
Cisco TelePresence System Codec C20API Reference Guide
Contents
Introduction
About the API
xConguration
Appendices
xCommand
xStatus
xCommand
xCommand Video PIP ActiveSpeaker Set
Sets position for the active speakers PiP (picture in picture).
Position: Predened positions
CenterLeft: The ActiveSpeaker PiP appears on the left side of the screen, in center.
CenterRight: The ActiveSpeaker PiP appears on the right side of the screen, in center.
LowerLeft: The ActiveSpeaker PiP appears in the lower left corner of the screen.
LowerRight: The ActiveSpeaker PiP appears in the lower right corner of the screen.
UpperCenter: The ActiveSpeaker PiP appears on top of the screen, in center.
UpperLeft: The ActiveSpeaker PiP appears in the upper left corner of the screen.
UpperRight: The ActiveSpeaker PiP appears in the upper right corner of the screen.
xCom mand Video PIP ActiveSpeaker Set Position: UpperRight
*r ActiveSpeakerPipSetResult (status=OK):
** end
xCommand Video PIP Presentation Set
Sets position for the presentation PiP (picture in picture).
Position: Predened positions
CenterLeft: The presentation PiP appears on the left side of the screen, in center.
CenterRight: The presentation PiP appears on the right side of the screen, in center.
LowerLeft: The presentation PiP appears in the lower left corner of the screen.
LowerRight: The presentation PiP appears in the lower right corner of the screen.
UpperCenter: The presentation PiP appears on top of the screen, in center.
UpperLeft: The presentation PiP appears in the upper left corner of the screen.
UpperRight: The presentation PiP appears in the upper right corner of the screen.
xCom mand Video PIP Presentation Set Position: LowerLeft
*r PresentationPipSetResult (status=OK):
** end
xCommand Video Selfview Set
Sets self-view on/o and species its size and position. If the parameter is not specied, current
value is used.
Mode: Self view on/o
FullscreenMode: Self-view in fullscreen or pip.
PIPPosition: Predened PIP positions.
FullscreenMode: Choose between displaying the self-view in full screen or not.
PIPPosition: Select the position for the self-view image.
CenterLeft: The self-view PiP appears on the left side of the screen, in center.
CenterRight: The self-view PiP appears on the right side of the screen, in center.
LowerLeft: The self-view PiP appears in the lower left corner of the screen.
LowerRight: The self-view PiP appears in the lower right corner of the screen.
UpperCenter: The self-view PiP appears on top of the screen, in center.
UpperLeft: The self-view PiP appears in the upper left corner of the screen.
UpperRight: The self-view PiP appears in the upper right corner of the screen.
OnMonitorRole: Displays self-view on monitors with this role.