Cisco TelePresence SX20 Codec Reference Manual

Download

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Software version TC6.2 JULY 2013

Application Programmer Interface (API) Reference Guide

Cisco TelePresence SX20 Codec

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Contents

What’s in this guide?

TA - ToC - Hidden

The top menu bar and the entries in the table of

text anchor

contents are all hyperlinks, just click on them to go to the topic.

We recommend you visit our web site regularly for updated versions of the user documentation.

Go to: http://www.cisco.com/go/quickset-docs

Table of Contents

Introduction ..........................................................................3

About this guide ......................................................................4

User documentation .............................................................4

What’s new in this version ...................................................... 5

Software release notes ........................................................ 5

Software download .............................................................. 5

New features and improvements ......................................... 5

xConfiguration changes .......................................................6

xCommand changes ............................................................ 7

xStatus changes ................................................................... 7

About the API ........................................................................8

API fundamentals ....................................................................9

Connecting to the API ..........................................................9

Password .............................................................................9

RS-232/serial connection ....................................................9

Tel n et .................................................................................... 9

SSH ......................................................................................9

HTTP/HTTPS ........................................................................9

API output .............................................................................10

The output modes ..............................................................10

Using the command line ....................................................... 11

API commands ................................................................... 11

Other commands ............................................................... 11

Command line shortcuts .................................................... 11

Searching ........................................................................... 12

Value types and formats .................................................... 12

Commands ...........................................................................13

Configurations ...................................................................... 14

Status .................................................................................... 15

Events ................................................................................... 16

Call history ............................................................................ 17

Feedback mechanism...........................................................18

Feedback expressions .......................................................18

Terminal connections .........................................................19

Using HTTP ...........................................................................20

Getting status and configurations ...................................... 20

Sending commands and configurations.............................20

Using HTTP POST ..............................................................20

Feedback from codec over HTTP ........................................ 21

Registering for feedback .................................................... 21

Translating from terminal mode to XML.............................. 22

Dos and don’ts ......................................................................23

xConfiguration commands ..................................................24

Description of the xConfiguration commands ......................25

xCommand commands ....................................................... 74

Description of the xCommand commands ........................... 75

xStatus commands ........................................................... 113

Description of the xStatus commands ............................... 114

Appendices....................................................................... 178

Startup script ...................................................................... 179

Adding a startup script ..................................................... 179

Cisco TelePresence Remote Control .................................. 18 0

Remote control key map ..................................................... 181

The SystemTools commands ..............................................182

About disconnect cause types ........................................... 184

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Introduction

Chapter 1

Introduction

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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 following product:

• Cisco TelePresence SX20 Codec

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 guide for the SX20 Codec

• Regulatory compliance and safety information guides

• Legal and license information for the TC software

To download the user documentation go to:

http://www.cisco.com/go/quickset-docs

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

What’s new in this version

This section provides an overview of the new and changed advanced settings and new features in the TC6.2 software version.

Software release notes

For a complete overview of new features and changes, we recommend reading the Software Release Notes (TC6). Go to:

► http://w ww.cisco.com/en/US/products/ps11424/prod_ release_notes_list.html

Software download

For software download go to:

► http://www.cisco.com/cisco/software/navigator.html

New features and improvements

Cisco Unified Communication Manager (CUCM) redundancy support

The TelePresence endpoints have CUCM redundancy support with failover and fallback. The TelePresence endpoint will automatically register to the next CUCM in the cluster if the connection to the active CUCM is lost.

If the TelePresence endpoint loses its connection to the primary CUCM, the call is preserved, but no additional features like content sharing, putting participants on hold etc. will be available. The next call will be handled by the secondary CUCM and all call features are available again. When the primary CUCM is back online, the endpoint will automatically register with the primary CUCM.

More details can be found in the Administering TC endpoints on CUCM guide for TC6.2.

Improved provisioning from CUCM

Several TelePresence endpoint parameters are added to CUCM and can be provisioned to the endpoint.

More details can be found in the Administering TC endpoints on CUCM guide for TC6.2.

Support for CUCM provisioning of the endpoint password when using the encrypted security profile

TelePresence endpoints can be fully and securely provisioned from CUCM. When the TelePresence endpoint is set up with an encrypted security profile in CUCM, the endpoint will read the admin password from the CUCM. The password can not be empty, and the user name must be admin.

More details can be found in the Administering TC endpoints on CUCM guide for TC6.2.

Support for auto discovery of the CUCM

The TelePresence endpoints have support for auto discovery of the CUCM through DHCP Option 150. If the network provides the CUCM address through DHCP Option 150, the endpoint will automatically register to the CUCM after a factory reset.

More details can be found in the Administering TC endpoints on CUCM guide for TC6.2.

Support for IPv4, IPv6 and dual stack

The video system is able to operate on IPv4, IPv6 or both at the same time (dual stack). This is configured using the xConfiguration Network IPStack setting. Which IP version to use for calls is configured using the xConfiguration Conference CallProtocolIPStack setting.

G.729 audio codec support in H.323 calls

Support for the G.729AB audio codec is added in H.323 calls in order to provide better IP phone interoperability. G.729 has been supported in SIP calls as from software version TC6.1.

Lync 2013 support for point-to-point calls

You can set up video calls between TelePresence systems and Lync 2013 users. HD quality at full frame rate (720p30) is suppor ted in both directions. This feature is disabled by default. It must be enabled using the xConfiguration Conference LyncCompatibility Mode setting. It also requires version X8 of the VCS (Video Communication Server).

You can see the Lync 2013 users in the TelePresence system’s directory (phone book), provided that TMS (TelePresence Management System) version 13.x or later is used.

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Interactive Connectivity Establishment (ICE) support

TelePresence systems can use the ICE protocol (RFC 5245) to find the best media path through the network. ICE separates signalling and media, and is a NAT traversal solution that finds the shortest route for audio and video.

This feature is disabled by default. It must be enabled using the xConfiguration SIP Profile Ice settings. Both endpoints in the call must support ICE, and a valid TURN (Traversal Using Relay NAT) server must be defined.

ICE is not supported when registered to the current version of CUCM.

Check the TC6 software release notes for further details.

Active control: Providing end users conference control with TelePresence Server

Active Control gives more control and improved experience for the end user during conferences hosted on a Cisco TelePresence Server. Using your Cisco Touch controller, you can interact with the server to control the local experience of the meeting. You will see the par ticipant list with indicators that show who is the active speaker and who is sharing content, you can change your local video layout, disconnect participants, etc.

This feature is disabled by default. It must be enabled using the xConfiguration Experimental Conference ActiveControl Mode setting.

Active control requires a Cisco TelePresence Server 3.1 or later, and the server must be behind a Conductor (version XC2.2 or later), i.e. not registered directly to VCS or CUCM. CUCM must be version 9.1.2 or later, and VCS must be version X7 or later. The feature is only supported for SIP calls. H.323 interworking scenarios are not supported.

Check the TC6 software release notes for further details.

Extended Binary Floor Control Protocol (BFCP) port range

When using SIP as a call protocol, UDP ports 5070 to 5077 are used for the BFCP connection (presentation channel). If a firewall is blocking ports in this range, the presentation channel will not be established and the presentation will be sent in the main video channel.

In earlier software releases, only port 5070 was used. The range is extended to support ICE.

Overriding manual positioning of the PrecisionHD 1080p12x camera

If the camera position is adjusted by hand, the camera will automatically return to the position it had before. This feature is disabled by default. It must be enabled using the xConfiguration Camera Camera[n] MotorMoveDetection setting.

Web interface enhancements

• A System recovery page is introduced. The page provides access to the following recovery alternatives: software image swapping and factory reset. Easy access to configuration and log file back up is also provided.

• A VU meter (volume meter) is available on the Peripherals page. The VU meter shows the signal level for the microphone(s).

xConfiguration changes

New configurations

xConfiguration Cameras Camera [1..1] MotorMoveDetection: <Of f/O n>

xConfiguration Conference CallProtocolIPStack: <IPv4/IPv6>

xConfiguration Conference LyncCompatibility: <Off/On>

xConfiguration Network IPv4 Assignment: <Static/DHCP>

Replacing xConfiguration Network Assignment

xConfiguration SIP Profile Ice Mode: <Off/On>

xConfiguration SIP Profile Ice DefaultCandidate: <Host/Rflx/ Relay>

xConfiguration SIP Profile Turn Server: <S: 0, 255>

xConfiguration SIP Profile Turn UserName: <S: 0, 128>

xConfiguration SIP Profile Turn Password: <S: 0, 128>

xConfiguration Video Input Source 3 Name: <S: 0, 50>

xConfiguration Video Input Source 3 Type: <other/camera/ PC/DVD/document_camera>

xConfiguration Video Input Source 3 Connector: <USB>

xConfiguration Video Input Source 3 PresentationSelection: <Manual/Automatic/Hidden>

xConfiguration Video Input Source 3 CameraControl Mode: <Of f/O n>

xConfiguration Video Input Source 3 CameraControl CameraId: <1>

xConfiguration Video Input Source 3 OptimalDefinition Profile: <Normal/Medium/High>

xConfiguration Video Input Source 3 OptimalDefinition Threshold60fps: <512_288/768_448/1024_576/1280_720/1 920_1080/Never>

xConfiguration Video Input Source 3 Quality: <Motion/ Sharpness>

xConfiguration Video OSD WallPaperSelection: <Off/On>

xConfiguration Video OSD LanguageSelection: <Off/On>

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Configurations that are removed

xConfiguration Network Assignment

Replaced by xConfiguration Network IPv4 Assignment

Configurations that are modified

xConfiguration Network IPStack

OLD: <IPv4/IPv6> NEW: <Dual/IPv4/IPv6>

xConfiguration Video MainVideoSource

OLD: <1/ 2> NEW: <1/2 / 3>

xCommand changes

Commands that are modified

xCommand Message FarendMessage

OLD: CallId was required NEW: CallId is optional

xCommand Phonebook Search

ADDED: ContactType: <Any/Folder/Contact>

xStatus changes

New status

xStatus Conference Site Hold

xStatus Conference Site Preserved

xStatus ICE Configured

xStatus ICE Defaultcandidate

xStatus ICE Turn IP

xStatus ICE Turn Hostname

xStatus ICE Turn Username

xStatus ICE Call Result

xStatus ICE Call Local Candidate

xStatus ICE Call Local IP

xStatus ICE Call Remote Candidate

xStatus ICE Call Remote IP

xStatus SIP Profile Turn ServerAddress

xStatus SIP Profile 1 DirectoryURI Primary URI

xStatus SIP Profile 1 DirectoryURI Alias URI

xStatus Video Layout Mode

xStatus Video Input Source [1..n] MediaChannelId

xStatus Video Input Source 3 Resolution Height

xStatus Video Input Source 3 Resolution Width

xStatus Video Input Source 3 Resolution RefreshRate

xStatus Video Input Source 3 Resolution FormatType

xStatus Video Input Source 3 Resolution FormatStatus

xStatus Video Input USB 3 Connected

xStatus Video Input USB 3 SignalState

Status that is modified

xStatus Call Status

OLD: <Idle/Dialling/Ringing/Connecting/Connected/

Disconnecting/OnHold>

NEW: <Idle/Dialling/Ringing/Connecting/Connected/

Disconnecting/OnHold/EarlyMedia/Preserved/ RemotePreserved>

xStatus H320 Gateway Status

OLD: <OK/OKWithWarning/Error/Inactive> NEW: <OK/OKWithWarning/Error/Inactive/Warning>

xStatus SystemUnit Diagnostics Message Type

OLD: <ValidAdminPassword/CamerasDetected/

NEW: <ValidAdminPassword/CamerasDetected/

H320GatewayStatus/ISDNLinkCompatibility/ SIPProfileRegistration/SIPListenPortAndOutboundMode/ TLSVerifyRequiredCerts/DefaultCallProtocolRegistered/ NetSpeedAutoNegotiated/HasValidReleaseKey/ EthernetDuplexMatches/IPv4Assignment/ IPv6Assignment/SIPProfileType/ CallProtocolIPStackPlatformCompatability/ CameraStatus/CameraPairing/CameraSoftwareVersion/ SelectedVideoInputSourceConnected/OSDVideoOutput/ VideoFromInternalCamera/H323GatekeeperStatus>

xStatus MediaChannels Call IncomingVideoChannel Video Protocol

OLD: <Off/Raw/H261/H263/H263p/H263pp/H264/MP4V/

JPEG>

NEW: <Off/Raw/H261/H263/H263p/H263pp/H264/MP4V/

JPEG/HEVC>

xStatus MediaChannels Call OutgoingVideoChannel Video Protocol

OLD: <Off/Raw/H261/H263/H263p/H263pp/H264/MP4V/

JPEG>

NEW: <Off/Raw/H261/H263/H263p/H263pp/H264/MP4V/

JPEG/HEVC>

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Chapter 2

About the API

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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 different 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

• Configurations

• Status

• Events

These four groups are hierarchically organized, which makes it easier to find related functionality. You can find the complete lists of all commands, configurations 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 different methods, as some of those may require additional configuration changes before being enabled.

The following commands can be set from the System configuration menu in the web interface or on the on-screendiplay, or from the command line interface. All of the examples are for the command line interface.

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 configurations

There are two different configurations 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 take effect.

xConfiguration SerialPort BaudRate: <9600/19200/38400/57600/115200>

xConfiguration SerialPort LoginReq uired: <Off/On>

Connecting

For the SX20 codec you need a USB to RS-232 adapter to connect to the USB port.

Note:

• For security reasons the password prompting is turned on by default, but it can be turned off 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.

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 configuration

To enable Telnet service, configure 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 effect.

xConfiguration 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 configuration

In order to enable or disable the HT TP and HTTPS services, configure the following settings on the codec. Changing these settings requires a reboot of the device.

xConfiguration NetworkServices HTTP Mode: <Off/On>

xConfiguration NetworkServices HTTPS Mode: <Off/On>

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 configuration. The password can be changed by issuing the following command:

xCom mand SystemUnit AdminPassword Set Password: <password>

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 find the API documents under the menu section System Configuration > API > XML API. The HTTP POST and GET methods are used to execute commands and get feedback from the codec. This is described in

”Using HTTP” on page 20 in this document.

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

API output

The xPreferences is used to set preferences for the RS-232, Telnet and SSH sessions.

The output modes

• Terminal: Line based output for use with line based control systems

• XML: XML output for use with control systems that understand XML.

The default output mode is terminal. To change this you have to define your preferences for each session individually. Examples in this guide are in terminal mode.

To set ouput mode to XML, issue the command:

xPreferences outputmode xml

To revert to terminal mode, issue the command:

xPreferences outputmode terminal

Example: Layout command in terminal mode

xCom mand Video Layout AssignCall CallId: 2 LayoutId: 1

Example: Layout command in XML mode

</AssignC all >

</Layout>

</Vid eo>

</Command>

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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

xConfiguration

Configurations are system settings, such as system name and network settings. These are persistent across boots. Refer to ”Configurations” on page 14.

xCommand

Commands instruct the codec to execute actions, such as to dial a number or to search the phone book. Refer to ”Commands” on page 13.

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. Refer to ”Status” on page 15.

xFeedback

The Feedback commands are used to specify what parts of the configuration and status hierarchies to monitor. Feedback is only issued on the Telnet or SSH session for which it is specified. If you are connecting to the codec with multiple sessions, you have to define feedback individually for each session. Refer to ”Feedback mechanism” on page 18.

- User Commands -

help

xstatus

bye

xPreferences

The xPreferences command is used to set preferences for

the RS-232, Telnet and SSH sessions. Refer to ”API output” on page 10.

Echo <on/off>

If echo is set to On the key inputs are displayed when

entering text in a command line interface.

If echo is set to Off 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. Refer to ”Events” on page 16.

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. Refer to ”Feedback mechanism” on page 18.

xconfiguration

xevent

log

xfee d back

xpreferences

echo

xgetxm l

xcommand

whoami

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.

Refer to ”The SystemTools commands” on page 182.

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 T R L-a > : Jump to the beginning of the line.

• <C T R L-e > : Jump to the end of the line.

• <C T R L-r > : Incremental command history search.

• <C T R L-w > : Erase the current line.

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Searching

You can use // to search for elements anywhere in the status or configuration 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 firmware releases.

Value types and formats

The system supports the following value types (Example 3):

• Integer values: <x..y> Defines the valid range for an integer input. x = min value, y = max value.

• Literal values: <X/Y/../Z> Defines the possible values for a given configuration.

• String values: <S: x, y> Defines that the valid input for this configuration is a string with minimum length of x and maximum length of y characters. Strings can have rules that further specify their format and length.

Input values that contain spaces need to be quoted

Any values for configurations and commands containing spaces must be enclosed in quotes. Quotes are not necessary for values without spaces.

Examples:

Correct: xCommand dial num ber: “my number contains spaces” Correct: xCommand dial num ber: 12345

Incorrect: xCommand dial number: my num ber contains spaces

Case sensitivity

All commands are case-insensitive. All of the following commands will work.

XCOMMAND DIAL NUMBER: foo@bar.org

xcom mand dial nu mber: foo@bar.org

xCom mand Dial Number: foo@bar.org

Example 1: List all configurations that include a word that starts with DVI:

xConfiguration //dvi

*c xConfiguration Video Input DVI 2 RGBQuantizationRange: Full

*c xConfiguration Video Input DVI 2 Type: AutoDetect

** end

Example 2: Get the resolution width of all connected sources for both inputs and outputs:

x S t a t u s // v i d // r e s // w i d

*s Video Input Source 1 Resolution Width: 0

*s Video Input Source 2 Resolution Width: 0

*s Video Output HDMI 1 Resolution Width: 1280

*s Video Output HDMI 2 Resolution Width: 1680

** end

Example 3: List the value types and formats

xConfiguration ??

*? xConfiguration Audio Volume: <0..100>

*? xConfiguration Audio SoundsAnd Alerts RingVolume: <0..100>

*? xConfiguration Audio SoundsAnd Alerts RingTone: <Marbles/IceCrystals/Polaris/Alert/

Discreet/Fantasy/Jazz/Nordic/Echo/R hyth m ic>.

*? xConfiguration Video OSD InputMethod Cyrillic: <Off/On>

*? xConfiguration Video OSD LoginRequired: <Off/On>

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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 prefix xCommand followed by a command path. Writing xCommand ? on the command line will list all the top level commands.

To view the complete list of commands and their parameters, write xCommand ?? on the command line.

Command arguments are key-value pairs. The (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 prefix. The command to be

executed is Dial.

• The example contains one argument, Number: 123. Number is the key and 123 is its value. The key/value pair is separated with ‘:’.

xCommand ?

– User Commands –

Audio

Bookings

Boot

Call

CallLog

CamCtrlPip

xCommand ??

xCom mand Call DisconnectAll

xCom mand Call Accept

CallId: <0..65534>

CallType: <Audio/Video>

xCom mand Phonebook Folder Delete

FolderId(r): <S: 0, 255>

xCommand Phonebook Search

PhonebookId: <S: 0, 255>

PhonebookType: <Cor porate/Local>

SearchString: <S: 0, 255>

SearchField: <Name/Num ber>

Offset: <0..65534>

FolderId: <S: 0, 255>

Limit: <0..65534>

Recursive: <False/True>

Camera

Conference

Dial

DTMFSend

Experimental

FacilityService

FarEndControl

HttpFeedback

Key

Message

Phone book

Presentation

Preset

Provisioning

Secu rity

Standby

Syste m Unit

Video

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Configurations

Configurations are system settings that are persistent across boots. Like commands, also configurations are structured in a hierarchy.

Writing xConfiguration ? on the command line lists all the top level configurations.

Writing xConfiguration ?? lists all configurations and their value spaces.

Writing xConfiguration lists all configurations and their current values. To list out only parts of the configuration, write xConfiguration followed by one or more parts of the configuration paths.

Example: Set the H323 Alias ID

Write in:

xConfiguration H323 Profile 1 H323Alias ID:

“changed@company.com”

Example: Get the H323 Alias ID

Write in:

xConfiguration H323 Profile 1 H323Alias ID

Result:

*c xConfiguration H323 Profile 1 H323Alias ID:

“changed@company.com”

**end

xConfiguration ?

– User Configurations –

Audio

Cameras

Conference

Experimental

FacilityService

xConfiguration ??

*? xConfiguration Audio Volume: <0..100>

*? xConfiguration Audio SoundsAnd Alerts RingVolume: <0..100>

*? xConfiguration Audio SoundsAndAlerts RingTone: <Marbles/IceCrystals/Polaris/Alert/Discreet/Fantasy/Jazz/

Nord ic/Echo/Rhythmic>

*? xConfiguration Audio SoundsAnd Alerts KeyTones Mode: <Off/On>

*? xConfiguration Audio Microphones Mute Enabled: <True/InCallOnly>

*? xConfiguration Audio Input HDMI [1..1] Mode: <Off/On>

*? xConfiguration Video OSD AutoSelectPresentationSource: <Off/On>

*? xConfiguration Video OSD TodaysBookings: <Off/On>

*? xConfiguration Video OSD MyContactsExpanded: <Off/On>

*? xConfiguration Video OSD Output: <1/2>

*? xConfiguration Video OSD InputMethod InputLanguage: <Latin/Cyrillic>

*? xConfiguration Video OSD InputMethod Cyrillic: <Off/On>

*? xConfiguration Video OSD LoginRequired: <Off/On>

H323

Network

NetworkServices

Phone book

Provisioning

RTP

Secu rity

SerialPort

SIP

Standby

Syste m Unit

Time

UserInterface

Video

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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

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>

Example 1: Query all ongoing Call information:

xStatus Call

*s Call 3 Status: Connected

*s Call 3 Direction: Outgoing

*s Call 3 Protocol: “sip”

*s Call 3 RemoteNumber: “firstname.lastname@

company.com”

*s Call 3 CallbackNum ber: “sip:firstname.

lastname@company.com”

*s Call 3 DisplayName: “firstname.lastname@

company.com”

*s Call 3 TransmitCallRate: 768

*s Call 3 ReceiveCallRate: 768

*s Call 3 FacilityServiceId: 0

*s Call 3 Encryption Ty pe: “None”

*s Call 3 PlacedOnHold: False

*s Call 3 Duration: 9

** end

H323

Ht t pF e e d b a c k[1..4]

MediaChannels

Network

NetworkServices

Pres et[1..15]

Provisioning

Example 2: Query the protocol for a call:

xStatus Call Protocol

*s Call 3 Protocol: “sip”

Secu rity

SIP

Standby

SystemUnit

Time

Video

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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 call’s disconnection.

*e CallDisconnect CallId: x CauseValue: 0

CauseString: “” CauseType: LocalDisconnect OrigCallDirection: “outgoing”

** end

Example 3: Call Successful

Call Succesful is an event reported when a call is connected successfully, that is when all channels are up and established.

*e CallSuccessful CallId: 132 Protocol: “h223”

Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” Encry ptionOut: “Off”

** end

Example 4: FECC Action request

FECC Action request is an event reported when far end is

sending FECC commands.

*e FeccActionInd Id: 132 Req: 1 Pan: 1 PanRight:

1 Tilt: 0 TiltUp: 0 Zoom: 0 ZoomIn: 0 Focus: 0

FocusIn: 0 Timeout: 300 VideoSrc: 0 m: 0

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Call history

The xHistory command returns the call logs.

Example with xHistory CallLogs

xhistory

*h xHistory CallLogs Call 1 CallId: 13

*h xHistory CallLogs Call 1 Protocol: “h323”

*h xHistory CallLogs Call 1 Direction: Outgoing

*h xHistory CallLogs Call 1 CallType: Video

*h xHistory CallLogs Call 1 RemoteNu mber: “h323:firstname.lastname.office@company.com”

*h xHistory CallLogs Call 1 CallbackNum ber: “h323:firstname.lastname.office@company.com”

*h xHistory CallLogs Call 1 DisplayName: “firstname.lastname@company.com”

*h xHistory CallLogs Call 1 CallRate: 768

*h xHistory CallLogs Call 1 DisconnectCause: “”

*h xHistory CallLogs Call 1 DisconnectCauseTy pe: LocalDisconnect

*h xHistory CallLogs Call 1 DisconnectCauseCode: 16

*h xHistory CallLogs Call 1 DisconnectCauseOrigin: Q850

*h xHistory CallLogs Call 1 StartTime: “2012/03/01 11:04:14”

*h xHistory CallLogs Call 1 Duration: 184

*h xHistory CallLogs Call 1 Encryption: ““Aes-128”

*h xHistory CallLogs Call 1 BookingId: “”

...

*h xHistory CallLogs Recent 6 CounterMissed: 2

*h xHistory CallLogs Recent 6 Counter: 2

...

*h xHistory CallLogs Outgoing 29 Counter: 1

...

*h xHistory CallLogs Received 40 Counter: 6

...

*h xHistory CallLogs Missed 50 Counter: 2

*h xHistory CallLogs Missed 50 NewCounter: 0

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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 notification system to report the changes in the state of the codec.

The API supports notifications on the following:

• Configuration changes

• Status changes

• Event notifications

These notifications 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 differs slightly from what is presented in this section. Refer to

”Feedback from codec over HTTP” on page 21.

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:

Document API command Path

Status xStatus /Status

Configuration xConfiguration /Configuration

Event xEvent /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 /Configuration, as configuration 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

matches the nodes you want feedback on.

Example 1: Microphones Mute status.

Terminal query

xStatus Audio Microphones Mute

*s Audio Microphones Mute: Off

** end

Equivalent feedback expression

xFeedback register /Status/Audio/Microphones/Mute

Example 2: All video input connectors.

Terminal query

xConfiguration Video Input Source Connector

*c xConfiguration Video Input Source 1 Connector:

HDMI

*c xConfiguration Video Input Source 2 Connector:

DVI

** end

Equivalent feedback expression

xFeedback register /Configuration/Video/Input/

Source/Connector

Example 3: Video input connector for source 2.

Terminal query

xConfiguration Video Input Source 2 Connector

*c xConfiguration Video Input Source 2 Connector:

DVI

** end

Equivalent feedback expression

xFeedback register /Configuration/Video/Input/

Source[@item=’2’]/Connector

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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 querying the system using the xConfiguration and xStatus commands. E.g., if you issue the command

xStatus Standby Active

*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.

on the command line the result is:

Example: Managing feedback subscriptions

A: Register feedback expressions.

Write in: Result:

Write in:

MainVideoSource

Result:

B: List out currently registered expressions.

Write in: Result:

C: Deregister feedback expressions.

Write in: Result:

xFeedback register /Status/Audio

** end

xFeedback register /Event/CallDisconnect

** end

xFeedback register /Configuration/Video/

** end

xFeedback list

/Config uration/Vid eo/Ma inVideoSou rce

/Event/CallDisconnect

/St a tus/A u d io

** end

xFeedback deregister /Event/CallDisconnect

** end

xFeedback deregister /Status/Audio

** end

D: List the new feedback expressions.

Write in: Result:

xFeedback list

/Config uration/Vid eo/Ma inVideoSou rce

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Using HTTP

The codec supports sending commands and configurations over HT TP and HTTPS. It is also possible to retrieve configurations and statuses this way. This interface exposes the same API as the command line, but in XML format.

URL cheat sheet

The following table contains the main URLs used when accessing the API over HTTP.

Method URL Description

GET http://<ip-address>/status.xml Complete status document

GET http://<ip-address>/configuration.xml Complete configuration document

GET http://<ip-address>/command.xml Complete command document

GET http://<ip-address>/valuespace.xml Complete valuespace document

GET http://<ip-address>/getxml?location=<path> Retrieve document based on a path

POST http://<ip-address>/putxml Configurations and commands in HTTP body

GET, P OST http://<ip-address>/formputxml?xmldoc=<xml> Configurations and commands www-urlencoded

Getting status and configurations

Example 1: Get all status entries on the codec.

http://<ip-address>/getxml?location=/Status

Example 2: Get just the audio statuses of the codec.

http://<ip-ad dress>/getx m l?location=/Status/Audio

Example 3: Get all configurations of the codec.

http://<ip-add ress>/getxml?location=/Config uration

Example 4: Get all video configurations of the codec.

http://<ip-ad dress>/getx m l?location=/ Configuration/Video

Sending commands and configurations

Using HTTP GET

It is possible to use HTTP GET when sending commands or configurations to the codec. This makes it easy to test commands using your browser.

Example 1: Setting the camera position.

http://<ip-add ress>/formputxml?xmldoc= <Command><Camera><PositionSet command=”True”> <CameraId>1</CameraId><Pan>200</Pan> <Tilt>200</Tilt> </Posit io nSet ></Ca m era></Com m a nd>

Example 2: Changing the system name.

http://<ip-add ress>/formputxml?xmldoc= <Configuration> <SystemUnit> <Name>newName</Name></SystemUnit></Configuration>

Example 3: Changing multiple configurations in one go.

http://<ip-add ress>/formputxml?xmldoc= <Config u ration><Aud io><Volu me>80</Volu me> </Audio><Video><OSD><TodaysBookings>On </TodaysBookings></OSD></video><Configuration>

Using HTTP POST

When sending configurations and commands to the codec,

it is important that the HTTP 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 Content-Type: text/xml Connection: close

<SystemUnit> <Name>newName</Name> </Syst e mUnit>

</Configuration>

Example 2: Setting the camera position.

Request

POST /putxml HTTP/1.1 Co nt e nt-Ty pe: t ext/x m l Connection: close

</Command>

Response

HTTP/1.1 200 OK Date: <date> Server: WSGISer ver/0.1 Python/2.5.4 Cache-Control: no-cache Co nt e nt-Ty pe: t ext/x m l Content-Leng th: 91

Connection: close <?xml version=”1.0”?> <Command> <Ca m eraPosition SetR es ult item =”1” status=”OK”/> </Command>

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Feedback from codec over HTTP

To get notifications from the codec, you need to register HTTP feedback expressions. The codec will then use HTTP POST to send feedback messages to the supplied IP-address. This means that you have to have a HTTP server 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>

HttpFeedback Register arguments:

FeedbackSlot: The codec can register up to 4 slots of servers

requesting HTTP feedback. Set the registering to one of them.

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. Refer to ”Feedback mechanism” on

page 18.

Example: Registering feedback on configuration changes, disconnect events and call status changes.

<S er v erUrl > h t t p://127.0.0.1/ myhttpp ostscripturl</ServerUrl>

<Expression item=”1”>/Configuration</ Expression>

<Expression item=”2”>/Event/ CallDisconnect</Expression>

<Expression item=”3”>/Status/Call</ Expression>

</Register>

</HttpFeed back>

</Command>

Feedback output

When the codec notifies the registered HTTP server about changes, the body contains the same XML as when polling. There is however one small difference. The root-node contains an Identification node with children that specify the codec from which the notification originated. This means that you can handle multiple codecs with a single HTTP server URI.

Example: Audio volume changed.

<Configuration xmlns=”http://www.company.com/XML/

CUIL/2.0”>

<SystemNa me>integrator</SystemNam e>

19 2.16 8.1.10 0 </IPA d d r ess>

<ProductType>Cisco Codec</ProductType>

<ProductID>Cisco Codec C90</ProductID>

</Identification>

</Au d io>

</Configuration>

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Translating from terminal mode to XML

Translating commands

The XML commands maintain the same structure as the terminal commands, but they use a parent-child relationship to describe the hierarchy. You can see this structure in the examples below.

Example 1: Setting up a call.

Terminal

xCom mand Dial Number: “12345” Protocol: H323

XML

</Dia l>

</Command>

Example 2: Assigning video layout to a call.

Terminal

xCom mand Video Layout AssignCall CallId: 2 LayoutId: 1

XML

</AssignC all >

</Layout>

</Vid eo>

</Command>

Translating configurations

Translating from xConfiguration to XML is similar to commands, but with the addition of a special attribute

item=”NN” for specifying the index in arrays.

Example: Configuring connector for input source 2.

Terminal

xConfiguration Video Input Source 2

Connector: HDMI

XML

<Input>

</Source>

</In put >

</Vid eo>

</Configuration>

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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-screendisplay.

DO use complete commands

You should always use complete commands when programming, i.e. always use xConfiguration 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 use the experimental section in production

Under the listing of commands, status and configurations, you can find subsections that start with Experimental.

• xCommand Experimental

• xStatus Experimental

• xConfiguration Experimental

These sections give access to features that we are still working on and have yet to release for official 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 firmware these sections may be hidden or removed.

DO NOT subscribe to unnecessary feedback

Subscribing to too much feedback may congest the control application. Although the amount of feedback may seem fine in the current version, the amount of feedback may grow in future releases.

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-screendisplay in is using the exact same API as you have access to through the command interface.

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Chapter 3

xConfiguration commands

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Description of the xConfiguration commands

In this chapter, you can find a complete list of the xConfiguration commands. The examples show either the default value or an example of a value.

We recommend you visit our web site regularly for updated versions of the manual. Go to: http://www.cisco.com/go/quickset-docs

Audio configuration .............................................................................................................................. 29

xConfiguration Audio Input HDMI [1] Mode.................................................................................................29

xConfiguration Audio Microphones Mute Enabled .....................................................................................29

xConfiguration Audio SoundsAndAlerts KeyTones Mode ..........................................................................29

xConfiguration Audio SoundsAndAlerts RingTone .....................................................................................29

xConfiguration Audio SoundsAndAlerts RingVolume ................................................................................29

xConfiguration Audio Volume .....................................................................................................................29

Cameras configuration ......................................................................................................................... 30

xConfiguration Cameras Camera [1..1] Backlight .......................................................................................30

xConfiguration Cameras Camera [1..1] Brightness Level ...........................................................................30

xConfiguration Cameras Camera [1..1] Brightness Mode ...........................................................................30

xConfiguration Cameras Camera [1..1] DHCP ............................................................................................32

xConfiguration Cameras Camera [1..1] Flip ................................................................................................30

xConfiguration Cameras Camera [1..1] Focus Mode ..................................................................................30

xConfiguration Cameras Camera [1..1] Gamma Level ................................................................................31

xConfiguration Cameras Camera [1..1] Gamma Mode ...............................................................................31

xConfiguration Cameras Camera [1..1] IrSensor ........................................................................................31

xConfiguration Cameras Camera [1..1] Mirror ............................................................................................31

xConfiguration Cameras Camera [1..1] MotorMoveDetection ....................................................................31

xConfiguration Cameras Camera [1..1] Whitebalance Level.......................................................................32

xConfiguration Cameras Camera [1..1] Whitebalance Mode ......................................................................31

xConfiguration Cameras PowerLine Frequency .........................................................................................30

Conference configuration ..................................................................................................................... 32

xConfiguration Conference [1..1] AutoAnswer Delay ..................................................................................33

xConfiguration Conference [1..1] AutoAnswer Mode .................................................................................32

xConfiguration Conference [1..1] AutoAnswer Mute ...................................................................................33

xConfiguration Conference [1..1] CallProtocolIPStack ................................................................................32

xConfiguration Conference [1..1] DefaultCall Protocol................................................................................34

xConfiguration Conference [1..1] DefaultCall Rate ......................................................................................34

xConfiguration Conference [1..1] DoNotDisturb DefaultTimeout ................................................................33

xConfiguration Conference [1..1] DoNotDisturb Mode ...............................................................................33

xConfiguration Conference [1..1] Encryption Mode ....................................................................................34

xConfiguration Conference [1..1] FarEndControl Mode ..............................................................................33

xConfiguration Conference [1..1] FarEndControl SignalCapability..............................................................34

xConfiguration Conference [1..1] IncomingMultisiteCall Mode ...................................................................36

xConfiguration Conference [1..1] LyncCompatibility ...................................................................................32

xConfiguration Conference [1..1] MaxReceiveCallRate ..............................................................................34

xConfiguration Conference [1..1] MaxTotalReceiveCallRate .......................................................................35

xConfiguration Conference [1..1] MaxTotalTransmitCallRate ......................................................................35

xConfiguration Conference [1..1] MaxTransmitCallRate ..............................................................................34

xConfiguration Conference [1..1] MicUnmuteOnDisconnect Mode ............................................................33

xConfiguration Conference [1..1] Multipoint Mode .....................................................................................36

xConfiguration Conference [1..1] PacketLossResilience Mode ..................................................................35

xConfiguration Conference [1..1] Presentation OnPlacedOnHold ..............................................................36

xConfiguration Conference [1..1] Presentation Policy ................................................................................35

xConfiguration Conference [1..1] Presentation RelayQuality ......................................................................36

xConfiguration Conference [1..1] VideoBandwidth MainChannel Weight ...................................................35

xConfiguration Conference [1..1] VideoBandwidth Mode ...........................................................................35

xConfiguration Conference [1..1] VideoBandwidth PresentationChannel Weight ......................................35

FacilityService configuration ................................................................................................................ 37

xConfiguration FacilityService Service [1..5] CallType ...............................................................................37

xConfiguration FacilityService Service [1..5] Name ...................................................................................37

xConfiguration FacilityService Service [1..5] Number ................................................................................37

xConfiguration FacilityService Service [1..5] Type .....................................................................................37

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

H323 configuration ............................................................................................................................... 38

xConfiguration H323 NAT Address ............................................................................................................38

xConfiguration H323 NAT Mode ................................................................................................................38

xConfiguration H323 Profile [1..1] Authentication LoginName ....................................................................38

xConfiguration H323 Profile [1..1] Authentication Mode .............................................................................38

xConfiguration H323 Profile [1..1] Authentication Password ......................................................................38

xConfiguration H323 Profile [1..1] CallSetup Mode.....................................................................................39

xConfiguration H323 Profile [1..1] Gatekeeper Address .............................................................................39

xConfiguration H323 Profile [1..1] Gatekeeper Discovery...........................................................................39

xConfiguration H323 Profile [1..1] H323Alias E164 .....................................................................................39

xConfiguration H323 Profile [1..1] H323Alias ID .......................................................................................... 39

xConfiguration H323 Profile [1..1] PortAllocation ........................................................................................39

Network configuration .......................................................................................................................... 40

xConfiguration Network [1..1] DHCP RequestTFTPServerAddress ............................................................41

xConfiguration Network [1..1] DNS Domain Name ......................................................................................41

xConfiguration Network [1..1] DNS Server [1..3] Address ........................................................................... 41

xConfiguration Network [1..1] IEEE8021X AnonymousIdentity ....................................................................44

xConfiguration Network [1..1] IEEE8021X Eap Md5 ....................................................................................44

xConfiguration Network [1..1] IEEE8021X Eap Peap ...................................................................................45

xConfiguration Network [1..1] IEEE8021X Eap Tls .......................................................................................44

xConfiguration Network [1..1] IEEE8021X Eap Ttls ......................................................................................44

xConfiguration Network [1..1] IEEE8021X Identity .......................................................................................44

xConfiguration Network [1..1] IEEE8021X Mode .........................................................................................43

xConfiguration Network [1..1] IEEE8021X Password ...................................................................................44

xConfiguration Network [1..1] IEEE8021X TlsVerify .....................................................................................43

xConfiguration Network [1..1] IEEE8021X UseClientCertificate ..................................................................44

xConfiguration Network [1..1] IPStack .........................................................................................................40

xConfiguration Network [1..1] IPv4 Address ...............................................................................................40

xConfiguration Network [1..1] IPv4 Assignment ..........................................................................................40

xConfiguration Network [1..1] IPv4 Gateway ...............................................................................................40

xConfiguration Network [1..1] IPv4 SubnetMask .........................................................................................40

xConfiguration Network [1..1] IPv6 Address ............................................................................................... 41

xConfiguration Network [1..1] IPv6 Assignment ..........................................................................................40

xConfiguration Network [1..1] IPv6 DHCPOptions ......................................................................................41

xConfiguration Network [1..1] IPv6 Gateway ...............................................................................................41

xConfiguration Network [1..1] MTU .............................................................................................................45

xConfiguration Network [1..1] QoS Diffserv Audio ...................................................................................... 42

xConfiguration Network [1..1] QoS Diffserv Data ........................................................................................ 42

xConfiguration Network [1..1] QoS Diffserv ICMPv6 ..................................................................................43

xConfiguration Network [1..1] QoS Diffserv NTP ........................................................................................43

xConfiguration Network [1..1] QoS Diffserv Signalling ................................................................................43

xConfiguration Network [1..1] QoS Diffserv Video ......................................................................................42

xConfiguration Network [1..1] QoS Mode ...................................................................................................42

xConfiguration Network [1..1] RemoteAccess Allow ...................................................................................45

xConfiguration Network [1..1] Speed ..........................................................................................................45

xConfiguration Network [1..1] TrafficControl Mode .....................................................................................45

xConfiguration Network [1..1] VLAN Voice Mode .......................................................................................45

xConfiguration Network [1..1] VLAN Voice VlanId.......................................................................................45

NetworkServices configuration ............................................................................................................ 46

xConfiguration NetworkServices CTMS Encryption ..................................................................................49

xConfiguration NetworkServices CTMS Mode ..........................................................................................49

xConfiguration NetworkServices H323 Mode ...........................................................................................46

xConfiguration NetworkServices HTTP Mode ...........................................................................................46

xConfiguration NetworkServices HTTPS Mode .........................................................................................46

xConfiguration NetworkServices HTTPS OCSP Mode .............................................................................. 47

xConfiguration NetworkServices HTTPS OCSP URL ................................................................................ 47

xConfiguration NetworkServices HTTPS VerifyClientCertificate ............................................................... 47

xConfiguration NetworkServices HTTPS VerifyServerCertificate .............................................................47

xConfiguration NetworkServices MultiWay Address .................................................................................46

xConfiguration NetworkServices MultiWay Protocol .................................................................................46

xConfiguration NetworkServices NTP Address .........................................................................................47

xConfiguration NetworkServices NTP Mode .............................................................................................47

xConfiguration NetworkServices SIP Mode ...............................................................................................48

xConfiguration NetworkServices SNMP CommunityName .......................................................................48

xConfiguration NetworkServices SNMP Host [1..3] Address .....................................................................48

xConfiguration NetworkServices SNMP Mode ..........................................................................................48

xConfiguration NetworkServices SNMP SystemContact ..........................................................................48

xConfiguration NetworkServices SNMP SystemLocation .........................................................................48

xConfiguration NetworkServices SSH AllowPublicKey ..............................................................................49

xConfiguration NetworkServices SSH Mode .............................................................................................48

xConfiguration NetworkServices Telnet Mode ..........................................................................................49

xConfiguration NetworkServices XMLAPI Mode .......................................................................................46

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Phonebook configuration ...................................................................................................................... 50

xConfiguration Phonebook Server [1..1] ID .................................................................................................50

xConfiguration Phonebook Server [1..1] Type ............................................................................................50

xConfiguration Phonebook Server [1..1] URL .............................................................................................50

Provisioning configuration .................................................................................................................... 50

xConfiguration Provisioning Connectivity...................................................................................................50

xConfiguration Provisioning ExternalManager Address ............................................................................. 51

xConfiguration Provisioning ExternalManager Domain ..............................................................................52

xConfiguration Provisioning ExternalManager Path ................................................................................... 51

xConfiguration Provisioning ExternalManager Protocol .............................................................................51

xConfiguration Provisioning HttpMethod ...................................................................................................51

xConfiguration Provisioning LoginName ....................................................................................................51

xConfiguration Provisioning Mode .............................................................................................................50

xConfiguration Provisioning Password .......................................................................................................51

RTP configuration ................................................................................................................................. 52

xConfiguration RTP Ports Range Start .......................................................................................................52

xConfiguration RTP Ports Range Stop .......................................................................................................52

Security configuration ........................................................................................................................... 53

xConfiguration Security Audit Logging Mode ............................................................................................53

xConfiguration Security Audit OnError Action ............................................................................................53

xConfiguration Security Audit Server Address ..........................................................................................53

xConfiguration Security Audit Server Port .................................................................................................53

xConfiguration Security Session InactivityTimeout ....................................................................................53

xConfiguration Security Session ShowLastLogon .....................................................................................53

SerialPort configuration ........................................................................................................................ 54

xConfiguration SerialPort BaudRate ...........................................................................................................54

xConfiguration SerialPort LoginRequired ...................................................................................................54

xConfiguration SerialPort Mode .................................................................................................................54

SIP configuration .................................................................................................................................. 54

xConfiguration SIP ListenPort ....................................................................................................................57

xConfiguration SIP Profile [1..1] Authentication [1..1] LoginName ...............................................................55

xConfiguration SIP Profile [1..1] Authentication [1..1] Password ..................................................................55

xConfiguration SIP Profile [1..1] DefaultTransport .......................................................................................55

xConfiguration SIP Profile [1..1] DisplayName ............................................................................................55

xConfiguration SIP Profile [1..1] Ice .............................................................................................................54

xConfiguration SIP Profile [1..1] IceDefaultCandidate .................................................................................54

xConfiguration SIP Profile [1..1] Line ...........................................................................................................57

xConfiguration SIP Profile [1..1] Mailbox .....................................................................................................56

xConfiguration SIP Profile [1..1] Outbound ..................................................................................................56

xConfiguration SIP Profile [1..1] Proxy [1..4] Address ..................................................................................56

xConfiguration SIP Profile [1..1] Proxy [1..4] Discovery ............................................................................... 56

xConfiguration SIP Profile [1..1] TlsVerify ....................................................................................................56

xConfiguration SIP Profile [1..1] Turn Password ..........................................................................................55

xConfiguration SIP Profile [1..1] Turn Server ...............................................................................................54

xConfiguration SIP Profile [1..1] Turn UserName ........................................................................................55

xConfiguration SIP Profile [1..1] Type ..........................................................................................................56

xConfiguration SIP Profile [1..1] URI ............................................................................................................55

Standby configuration ........................................................................................................................... 57

xConfiguration Standby BootAction ........................................................................................................... 57

xConfiguration Standby Control .................................................................................................................57

xConfiguration Standby Delay ....................................................................................................................57

xConfiguration Standby StandbyAction .....................................................................................................58

xConfiguration Standby WakeupAction ......................................................................................................58

SystemUnit configuration...................................................................................................................... 58

xConfiguration SystemUnit CallLogging Mode ..........................................................................................59

xConfiguration SystemUnit ContactInfo Type ............................................................................................59

xConfiguration SystemUnit IrSensor ..........................................................................................................59

xConfiguration SystemUnit MenuLanguage ...............................................................................................58

xConfiguration SystemUnit Name ..............................................................................................................58

Time configuration ................................................................................................................................ 60

xConfiguration Time DateFormat ...............................................................................................................60

xConfiguration Time TimeFormat ...............................................................................................................60

xConfiguration Time Zone ..........................................................................................................................60

UserInterface configuration .................................................................................................................. 61

xConfiguration UserInterface TouchPanel DefaultPanel ............................................................................61

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Video configuration............................................................................................................................... 61

xConfiguration Video AllowWebSnapshots ................................................................................................71

xConfiguration Video CamCtrlPip CallSetup Duration ...............................................................................67

xConfiguration Video CamCtrlPip CallSetup Mode ....................................................................................67

xConfiguration Video DefaultPresentationSource ......................................................................................64

xConfiguration Video Input DVI [2] RGBQuantizationRange .......................................................................64

xConfiguration Video Input DVI [2] Type .....................................................................................................64

xConfiguration Video Input HDMI [1..1] RGBQuantizationRange .................................................................64

xConfiguration Video Input Source [1..3] CameraControl CameraId ..........................................................62

xConfiguration Video Input Source [1..3] CameraControl Mode ................................................................62

xConfiguration Video Input Source [1..3] Name .........................................................................................61

xConfiguration Video Input Source [1..3] OptimalDefinition Profile ............................................................63

xConfiguration Video Input Source [1..3] OptimalDefinition Threshold60fps .............................................63

xConfiguration Video Input Source [1..3] PresentationSelection ..............................................................62

xConfiguration Video Input Source [1..3] Quality ........................................................................................63

xConfiguration Video Input Source [1..3] Type ...........................................................................................62

xConfiguration Video Input Source [1] Connector ......................................................................................61

xConfiguration Video Input Source [2] Connector ......................................................................................61

xConfiguration Video Input Source [3] Connector......................................................................................61

xConfiguration Video Layout LocalLayoutFamily .......................................................................................68

xConfiguration Video Layout RemoteLayoutFamily ....................................................................................68

xConfiguration Video Layout ScaleToFrame ..............................................................................................65

xConfiguration Video Layout ScaleToFrameThreshold ..............................................................................65

xConfiguration Video Layout Scaling .........................................................................................................64

xConfiguration Video MainVideoSource ....................................................................................................63

xConfiguration Video Monitors ...................................................................................................................68

xConfiguration Video OSD AutoSelectPresentationSource .......................................................................70

xConfiguration Video OSD EncryptionIndicator .........................................................................................69

xConfiguration Video OSD InputMethod Cyrillic ........................................................................................71

xConfiguration Video OSD InputMethod InputLanguage ...........................................................................70

xConfiguration Video OSD LanguageSelection .........................................................................................69

xConfiguration Video OSD LoginRequired ................................................................................................. 71

xConfiguration Video OSD MenuStartupMode ..........................................................................................69

xConfiguration Video OSD MissedCallsNotification ...................................................................................70

xConfiguration Video OSD Mode ...............................................................................................................69

xConfiguration Video OSD MyContactsExpanded .....................................................................................70

xConfiguration Video OSD Output .............................................................................................................70

xConfiguration Video OSD TodaysBookings .............................................................................................. 70

xConfiguration Video OSD VirtualKeyboard ...............................................................................................69

xConfiguration Video OSD WallPaperSelection .........................................................................................69

xConfiguration Video Output HDMI [1,2] CEC Mode .................................................................................. 71

xConfiguration Video Output HDMI [1,2] MonitorRole ................................................................................72

xConfiguration Video Output HDMI [1,2] OverscanLevel ............................................................................72

xConfiguration Video Output HDMI [1,2] Resolution ...................................................................................72

xConfiguration Video Output HDMI [1,2] RGBQuantizationRange ..............................................................71

xConfiguration Video PIP ActiveSpeaker DefaultValue Position ................................................................67

xConfiguration Video PIP Presentation DefaultValue Position ...................................................................67

xConfiguration Video Selfview ...................................................................................................................65

xConfiguration Video SelfviewControl AutoResizing .................................................................................65

xConfiguration Video SelfviewDefault FullscreenMode .............................................................................66

xConfiguration Video SelfviewDefault Mode ..............................................................................................66

xConfiguration Video SelfviewDefault OnMonitorRole ...............................................................................66

xConfiguration Video SelfviewDefault PIPPosition .....................................................................................66

xConfiguration Video SelfviewPosition ......................................................................................................65

xConfiguration Video WallPaper .................................................................................................................72

Experimental configuration ................................................................................................................... 73

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Audio configuration

xConfiguration Audio Input HDMI [1] Mode

If you are connecting a Cisco camera with an integrated microphone to the codec’s HDMI 1 input, you can enable/disable audio input on the port; if you are using any other camera, the audio input will be disabled regardless of this setting.

If you are going to use the integrated microphone, this set ting must be On (default value). Whenever you are connecting a Cisco Table Microphone 20 to any of the codec’s external

microphone inputs, the integrated microphone will be disabled regardless of this setting.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable audio on the HDMI input. On: Enable audio on the HDMI input.

Example:

xConfiguration 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>

Example:

xConfiguration Audio Input HDMI 1 Mode: On

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.

xConfiguration Audio Microphones Mute Ena bled: True

xConfiguration Audio SoundsAndAlerts RingTone

Select the ring tone for incoming calls.

Requires user role: USER

Value space: <Marbles/IceCrystals/Polaris/Alert/Discreet/Fantasy/Jazz/Nordic/Echo/Rhythmic>

Ran ge: Select a tone from the list of ring tones.

Example:

xConfiguration Audio SoundsAnd Alerts RingTone: Jazz

xConfiguration Audio SoundsAndAlerts RingVolume

Sets the ring volume for an incoming call.

Requires user role: USER

Value space: <0..100>

Ran ge: The value goes in steps of 5 from 0 to 100 (from -34.5 dB to 15 dB). Volume 0 = Off.

Example:

xConfiguration Audio SoundsAnd Alerts RingVolume: 50

xConfiguration Audio Volume

Adjust the speaker volume.

Requires user role: USER

Value space: <0..100>

Ran ge: 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 off.

Example:

xConfiguration Audio Volume: 70

xConfiguration Audio SoundsAndAlerts KeyTones Mode

The system can be configured to make a keyboard click sound effect (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/O n>

Off: 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:

xConfiguration Audio SoundsAnd Alerts KeyTones Mode: Off

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Cameras configuration

xConfiguration Cameras PowerLine Frequency

Applies to cameras supporting PowerLine frequency anti-flickering, i.e. PrecisionHD 1080p cameras.

Requires user role: ADMIN

Value space: <50Hz/60Hz>

50Hz: Set to 50 Hz. 60Hz: Set to 60 Hz.

Example:

xConfiguration Cameras Camera [1..1] Backlight

This configuration turns backlight compensation on or off. 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/O n>

Example:

xConfiguration Cameras Camera [1..1] Brightness Mode

Set the camera brightness mode.

Requires user role: ADMIN

Value space: <Auto/Manual>

Example:

xConfiguration Ca meras PowerLine Frequency: 50Hz

Off: Turn off the camera backlight compensation. On: Turn on the camera backlight compensation.

xConfiguration Ca meras Camera 1 Backlight: Off

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.

xConfiguration Ca meras Camera 1 Brightness Mode: Auto

xConfiguration 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>

Ran ge: Select a value from 1 to 31.

Example:

xConfiguration Ca meras Camera 1 Brightness Level: 1

xConfiguration Cameras Camera [1..1] Flip

With Flip mode (vertical flip) you can flip the image upside down.

Requires user role: ADMIN

Value space: <Auto/Off/On>

Auto: When the camera is placed upside down the image is automatically flipped upside down. This setting will only take effect for a camera that automatically detects which way it is mounted.

Off: Display the video on screen the normal way. On: When enabled the video on screen is flipped. This setting is used when a camera is mounted

upside down, but cannot automatically detect which way it is mounted.

Example:

xConfiguration Ca meras Camera 1 Flip: Off

xConfiguration 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 off to prevent continuous focus adjustments of the camera.

Manual: Turn the autofocus off and adjust the camera focus manually.

Example:

xConfiguration Ca meras Camera 1 Focus Mode: Auto

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration 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 specify explicitly which

gamma table to use by setting the Gamma Level.

Example:

xConfiguration Ca meras Camera 1 Gamm a Mode: Auto

xConfiguration 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 difficult 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>

Ran ge: Select a value from 0 to 7.

Example:

xConfiguration Ca meras Camera 1 Gamm a Level: 0

xConfiguration Cameras Camera [1..1] IrSensor

The IR sensor LED is located in the front of the camera and flickers 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/O n>

Off: Disable the IR sensor on the camera. On: Enable the IR sensor on the camera.

Example:

xConfiguration Ca meras Camera 1 IrSensor: On

xConfiguration Cameras Camera [1..1] Mirror

With Mirror mode (horizontal flip) you can mirror the image on screen.

Requires user role: ADMIN

Value space: <Auto/Off/On>

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.

Off: 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:

xConfiguration Ca meras Camera 1 Mirror: Off

xConfiguration Cameras Camera [1..1] MotorMoveDetection

This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. If adjusting the camera position by hand you can configure whether the camera should keep its new

position or return to the preset or position it had before.

Requires user role: ADMIN

Value space: <Off/O n>

Off: When the camera position is adjusted manually the camera will keep this position until adjusted again. WARNING: If moving the camera by hand, the camera will not register the new pan and tilt values since there is no position feedback. This will result in wrong pan and tilt values when recalling the camera presets subsequently.

On: When the camera position is adjusted manually, or the camera detects that the motors have moved, it will first re-initialize (i.e. go to default position) then return to the preset/position it had before the camera was adjusted.

Example:

xConfiguration Ca meras Camera 1 MotorMoveDetection: Off

xConfiguration 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:

xConfiguration Ca meras Camera 1 Whitebalance Mode: Auto

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration 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>

Ran ge: Select a value from 1 to 16.

Example:

xConfiguration Ca meras Camera 1 Whitebalance Level: 1

xConfiguration 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 L AN. When set, the command enables suppor t 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/O n>

Off: 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:

xConfiguration Ca meras Camera 1 DHCP: Off

Conference configuration

xConfiguration Conference [1..1] CallProtocolIPStack

Select if the call protocol (SIP, H323) should use the IPv4 or IPv6 address when the system has IP connectivity on both protocol versions at the same time, e.g. when the network interface (Network IPStack) is set to Dual.

Requires user role: ADMIN

Value space: <IPv4/IPv6>

IPv4: When set to IPv4, the call protocol (SIP, H323) will use IPv4. IPv6: When set to IPv6, the call protocol (SIP, H323) will use IPv6.

Example:

xConfiguration Conference [1..1] LyncCompatibility

The TelePresence endpoints, running TC6.2 software, or later are Lync 2013 ready. NOTE: Requires version X8 of the VCS (Video Communication Server). You can make calls to Lync

2013 from your TelePresence endpoint and vice versa and the call will have support for audio and video.

NOTE: To make Lync 2013 contacts available in the phonebook on the endpoint the TMS (TelePresence Management System) version 13.x, or later, must be configured.

Requires user role: ADMIN

Value space: <Off/O n>

Example:

xConfiguration Conference 1 CallProtocolIPStack: IPv4

Off: When set to Off, Lync 2013 compatibility on the endpoint is disabled. This is the default value. On: When set to Off, Lync 2013 compatibility on the endpoint is enabled.

xConfiguration Conference 1 LyncCompatibility: Off

xConfiguration Conference [1..1] AutoAnswer Mode

Set the auto answer mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: 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:

xConfiguration Conference 1 AutoAnswer Mode: Off

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration 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/O n>

Off: The incoming call will not be muted. On: The incoming call will be muted when automatically answered.

Example:

xConfiguration Conference 1 AutoAnswer Mute: Off

xConfiguration Conference [1..1] AutoAnswer Delay

Define 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.

Requires user role: ADMIN

Value space: <0..50>

Ran ge: Select a value from 0 to 50 seconds.

Example:

xConfiguration Conference 1 AutoAnswer Delay: 0

xConfiguration Conference [1..1] MicUnmuteOnDisconnect Mode

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/O n>

Off: 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:

xConfiguration Conference 1 MicUnmuteOnDisconnect Mode: On

xConfiguration Conference [1..1] DoNotDisturb Mode

Determine if there should be an alert on incoming calls.

Requires user role: USER

Value space: <Off/On/Timed>

Off: 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 off (xCommand Conference DoNotDisturb Activate and xCommand Conference DoNotDisturb Deactivate).

Example:

xConfiguration Conference 1 DoNotDisturb Mode: Off

xConfiguration Conference [1..1] DoNotDisturb DefaultTimeout

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>

Ran ge: Select the number of minutes (between 0 and 1440, i.e. 24 hours) before the Do Not Disturb session times out automatically.

Example:

xConfiguration Conference 1 DoNotDisturb DefaultTimeOut: 60

xConfiguration Conference [1..1] FarEndControl Mode

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/O n>

Off: 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:

xConfiguration Conference 1 FarEndControl Mode: On

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Conference [1..1] FarEndControl SignalCapability

Set the far end control (H.224) signal capability mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the far end control signal capability. On: Enable the far end control signal capability.

Example:

xConfiguration Conference 1 FarEndControl SignalCapability: On

xConfiguration Conference [1..1] Encryption Mode

Set the conference encryption mode. A padlock with the text "Encryption On" or "Encryption Off" displays on screen for a few seconds when the conference starts.

Requires user role: ADMIN

Value space: <Off/On/BestEffort>

Off: The system will not use encryption. On: The system will only allow calls that are encrypted. BestEffort: 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

encrypted. If not, the call will proceed without encryption. > In MultiSite calls: In order to have encrypted MultiSite conferences, all sites must support

encryption. If not, the conference will be unencrypted.

Example:

xConfiguration Conference 1 Encryption Mode: BestEffort

xConfiguration Conference [1..1] DefaultCall Protocol

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

TelePresence ISDN Link gateway).

Example:

xConfiguration Conference 1 DefaultCall Protocol: H323

xConfiguration Conference [1..1] DefaultCall Rate

Set the Default Call Rate to be used when placing calls from the system.

Requires user role: ADMIN

Value space: <64..6000>

Ran ge: Select a value between 64 and 6000 kbps.

Example:

xConfiguration Conference 1 DefaultCall Rate: 768

xConfiguration Conference [1..1] MaxTransmitCallRate

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.

Requires user role: ADMIN

Value space: <64..6000>

Ran ge: Select a value between 64 and 6000 kbps.

Example:

xConfiguration Conference 1 Ma xTransm itCallRate: 6000

xConfiguration Conference [1..1] MaxReceiveCallRate

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.

Requires user role: ADMIN

Value space: <64..6000>

Ran ge: Select a value between 64 and 6000 kbps.

Example:

xConfiguration Conference 1 MaxReceiveCallRate: 6000

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Conference [1..1] MaxTotalTransmitCallRate

This configuration 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 defined in the Conference MaxTransmitCallRate setting.

Requires user role: ADMIN

Value space: <64..10000>

Ran ge: Select a value between 64 and 10000.

Example:

xConfiguration Conference 1 Ma xTotalTransm itCallRate: 9000

xConfiguration Conference [1..1] MaxTotalReceiveCallRate

This configuration 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 defined in the Conference MaxReceiveCallRate setting.

Requires user role: ADMIN

Value space: <64..10000>

Ran ge: Select a value between 64 and 10000.

Example:

xConfiguration Conference 1 MaxTotalReceiveCallRate: 9000

xConfiguration Conference [1..1] VideoBandwidth Mode

Set the conference video bandwidth mode.

Requires user role: ADMIN

Value space: <Dynamic/Static>

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.

Example:

xConfiguration Conference 1 VideoBandwidth Mode: Dyna mic

xConfiguration Conference [1..1] VideoBandwidth MainChannel Weight

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>

Ran ge: 1 to 10.

Example:

xConfiguration Conference 1 VideoBandwidth MainChannel Weight: 5

xConfiguration Conference [1..1] VideoBandwidth PresentationChannel Weight

Requires user role: ADMIN

Value space: <1..10>

Ran ge: 1 to 10.

Example:

xConfiguration Conference 1 VideoBandwidth PresentationChannel Weight: 5

xConfiguration Conference [1..1] PacketLossResilience Mode

Set the packetloss resilience mode. This configuration will only take effect for calls initiated after the configuration is set.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the packetloss resilience. On: Enable the packetloss resilience.

Example:

xConfiguration Conference 1 PacketLossResilience Mode: On

xConfiguration Conference [1..1] Presentation Policy

Control how the presentation service is to be performed.

Requires user role: ADMIN

Value space: <LocalRemote/LocalOnly>

LocalRemote: The presentation will be shown locally and sent to remote side. LocalOnly: The presentation will only be shown locally.

Example:

xConfiguration Conference 1 Presentation Policy: LocalRemote

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Conference [1..1] Presentation RelayQuality

This configuration applies to video systems that are using the built-in MultiSite feature (optional) to host a multipoint video conference. When a remote user shares a presentation, the video system (codec) will transcode the presentation and send it to the other participants in the multipoint conference. The RelayQuality setting specifies whether to give priority to high frame rate or to high resolution for the presentation source.

Requires user role: ADMIN

Value space: <Motion/Sharpness>

Motion: Gives the highest possible frame rate. Used when there is a need for higher frame rates, typically 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:

xConfiguration Conference 1 Presentation RelayQuality: Sharpness

xConfiguration Conference [1..1] Presentation OnPlacedOnHold

Define whether or not to continue sharing a presentation after 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.

Example:

xConfiguration Conference 1 Presentation OnPlacedOnHold: NoAction

xConfiguration Conference [1..1] Multipoint Mode

Define how the video system handles multiparty video conferences. If registered to a Cisco TelePresence Video Communication Ser ver (VCS), the video system can

either use its own built-in MultiSite feature, or it can rely on the MultiWay network solution. MultiWay requires that the video network includes a multipoint control unit (MCU).

If registered to a Cisco Unified Communications Manager (CUCM) version 8.6.2 or newer, the video system can use either the CUCM conference bridge, or the video system's own built-in MultiSite feature. Which one to use is set-up by CUCM.

Both Multiway and the CUCM conference bridge allows you to set up conferences with many participants. The MultiSite feature allows up to four participants (yourself included) plus one additional audio call.

Note that the MultiSite feature is optional and may not be available on all video systems.

Requires user role: ADMIN

Value space: <Auto/Off/MulitSite/MultiWay/CUCMMediaResourceGroupList>

Auto: If a MultiWay address is specified in the NetworkServices MultiWay Address setting, MultiWay takes priority over MultiSite. If neither MultiWay nor MultiSite is available, the Multipoint Mode is set to Off automatically.

Off: Multiparty conferences are not allowed. MultiSite: Multiparty conferences are set up using MultiSite. If MultiSite is chosen when the

MultiSite feature is not available, the Multipoint Mode will be set to Off. MultiWay: Multiparty conferences are set up using MultiWay. The Multipoint Mode will be set to Off

automatically if the MultiWay service is unavailable, for example if a server address is not specified in the NetworkServices MultiWay Address setting.

CUCMMediaResourceGroupList: Multiparty conferences (ad hoc conferences) are hosted by the CUCM configured conference bridge. This setting is provisioned by CUCM in a CUCM environment and should never be set manually by the user.

Example:

xConfiguration Conference 1 Multipoint Mode: Auto

xConfiguration Conference [1..1] IncomingMultisiteCall Mode

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 notified 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 notified about the incoming call. However, the call will appear as a missed call in the call histor y list.

Example:

xConfiguration Conference 1 IncomingMultisiteCall Mode: Allow

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

FacilityService configuration

xConfiguration FacilityService Service [1..5] Type

Up to five different facility services can be supported simultaneously. With this set ting you can select what kind of services they are.

A facility service is not available unless both the FacilityService Ser vice 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 services. Emergency: Select this option for emergency services. Security: Select this option for security services. Catering: Select this option for catering ser vices. Transportation: Select this option for transportation services.

Example:

xConfiguration FacilityService Service [1..5] Name

Set the name of each facility service. Up to five different facility services are supported. A facility service is not available unless both the FacilityService Ser vice 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 onscreen menu.

Requires user role: ADMIN

Value space: <S: 0, 255>

Example:

xConfiguration FacilityService Service 1 Ty pe: Helpdesk

Format: String with a maximum of 255 characters.

xConfiguration FacilityService Service 1 Na me: ""

xConfiguration FacilityService Service [1..5] Number

Set the number for each facilit y service. Up to five different facility services are supported. A facility service is not available unless both the FacilityService Ser vice 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:

xConfiguration FacilityService Service 1 Nu mber: ""

xConfiguration FacilityService Service [1..5] CallType

Set the call type for each facility service. Up to five different facilit y services are supported. A facility service is not available unless both the FacilityService Ser vice 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:

xConfiguration FacilityService Service 1 CallType: Video

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

H323 configuration

xConfiguration H323 NAT Mode

The firewall traversal technology creates a secure path through the firewall barrier, and enables proper exchange of audio/video data when connected to an external video conferencing system (when the IP traffic goes through a NAT router). NOTE: NAT does not work in conjunction with gatekeepers.

Requires user role: ADMIN

Value space: <Auto/Off/On>

Auto: The system will determine if the H323 NAT Address or the real IP address should be used in signaling. This makes it possible to place calls to endpoints on the L AN as well as endpoints on the WAN. If the H323 NAT Address is wrong or not set, the real IP address will be used.

Off: The system will signal the real IP address. On: The system will signal the configured H323 NAT Address instead of its real 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". If the H323 NAT Address is wrong or not set, H.323 calls cannot be set up.

Example:

xConfiguration 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. Note that NAT cannot be used when registered to a gatekeeper.

In the router, the following ports must be routed to the system's IP address: * Port 1720 * Port 5555-6555 * Port 2326-2487

Requires user role: ADMIN

Value space: <S: 0, 64>

Example:

xConfiguration H323 NAT Mode: Off

Format: A valid IPv4 address or IPv6 address.

xConfiguration H323 NAT Address: ""

xConfiguration H323 Profile [1..1] Authentication Mode

Set the authenticatin mode for the H.323 profile.

Requires user role: ADMIN

Value space: <Off/O n>

Off: If the H.323 Gatekeeper Authentication Mode is set to Off 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 defined on both the codec and the Gatekeeper.

Example:

xConfiguration H323 Profile 1 Authentication Mode: Off

xConfiguration H323 Profile [1..1] Authentication LoginName

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.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration H323 Profile 1 Authentication LoginName: ""

xConfiguration H323 Profile [1..1] Authentication Password

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration H323 Profile 1 Authentication Password: ""

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration H323 Profile [1..1] CallSetup Mode

The H.323 Call Setup Mode defines 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 Profile Gatekeeper Address and H323 Profile Gatekeeper Discovery settings must also be configured.

Example:

xConfiguration H323 Profile 1 CallSetup Mode: Gatekeeper

xConfiguration H323 Profile [1..1] Gatekeeper Discovery

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 specific Gatekeeper identified by the Gatekeeper's IP address. Auto: The system will automatically tr y to register to any available Gatekeeper. If a Gatekeeper

responds to the request sent from the codec within 30 seconds this specific 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 specified manually.

Example:

xConfiguration H323 Profile 1 Gatekeeper Discovery: Manual

xConfiguration H323 Profile [1..1] Gatekeeper Address

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: A valid IPv4 address, IPv6 address or DNS name.

Example:

xConfiguration H323 Profile 1 Gatekeeper Address: "192.0.2.0"

xConfiguration H323 Profile [1..1] H323Alias E164

The H.323 Alias E.164 defines 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 #.

Example:

xConfiguration H323 Profile 1 H323Alias E164: "90550092"

xConfiguration H323 Profile [1..1] H323Alias ID

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: "firstname.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:

xConfiguration H323 Profile 1 H323Alias ID: "firstname.lastname@company.com"

xConfiguration H323 Profile [1..1] PortAllocation

The H.323 Port Allocation setting affects the H.245 port numbers used for H.323 call signalling.

Requires user role: ADMIN

Value space: <Dynamic/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 ports for subsequent calls, as some firewalls 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 predefined range [5555-6555].

Example:

xConfiguration H323 Profile 1 PortAllocation: Dynamic

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Network configuration

xConfiguration Network [1..1] IPStack

Select if the system should use IPv4, IPv6 or Dual on the network interface. Dual means that the system will be able to operate on both IP versions at the same time. This means that the system can have both an IPv4 and an IPv6 address at the same time.

NOTE: Restart the system after changing this setting.

Requires user role: ADMIN

Value space: <Dual/IPv4/IPv6>

Dual: When set to Dual, the network interface can operate on both IP versions at the same time, and can have both an IPv4 and an IPv6 address at the same time.

IPv4: When set to IPv4, the system will use IPv4 on the network interface. IPv6: When set to IPv6, the system will use IPv6 on the network interface.

Example:

xConfiguration Network [1..1] IPv4 Assignment

Define 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>

Example:

xConfiguration Network [1..1] IPv4 Address

Enter the static IPv4 network address for the system. This set ting is only applicable when Network Assignment is set to Static.

Requires user role: ADMIN

Value space: <S: 0, 64>

Example:

xConfiguration Network 1 IPStack: IPv4

Static: The addresses must be configured manually using the Network IPv4 Address, Network IPv4 Gateway and Network IPv4 SubnetMask set tings (static addresses).

DHCP: The system addresses are automatically assigned by the DHCP server.

xConfiguration Network 1 IPv4 Assignment: DHCP

Format: A valid IPv4 address.

xConfiguration Network 1 IPv4 Address: "192.0.2.2"

xConfiguration Network [1..1] IPv4 Gateway

Define the IPv4 network gateway. This setting is only applicable when the Network Assignment is set to Static.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: A valid IPv4 address.

Example:

xConfiguration Network 1 IPv4 Gateway: "192.0.2.1"

xConfiguration Network [1..1] IPv4 SubnetMask

Define the IPv4 network subnet mask. This setting is only applicable when the Network Assignment is set to Static.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: The valid IPv4 address format.

Example:

xConfiguration Network 1 IPv4 SubnetMask: "255.255.255.0"

xConfiguration Network [1..1] IPv6 Assignment

Define 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 configured 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 RFC 3315 for a detailed description. The Network IPv6 DHCPOptions setting will be ignored.

Autoconf: Enable IPv6 stateless autoconfiguration of the IPv6 network interface. See RFC 4862 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.

Example:

xConfiguration Network 1 IPv6 Assignment: Autoconf

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Network [1..1] IPv6 Address

Enter the static IPv6 network address for the system. This setting is only applicable when the Network IPv6 Assignment is set to Static.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: A valid IPv6 address.

Example:

xConfiguration Network 1 IPv6 Address: "2001:0DB8:0000:0000:0000:0000:0000:000

xConfiguration Network [1..1] IPv6 Gateway

Define the IPv6 network gateway address. This setting is only applicable when the Network IPv6 Assignment is set to Static.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: A valid IPv6 address.

Example:

xConfiguration Network 1 IPv6 Gateway: "2001:0DB8:0000:0000:0000:0000:0000:000

xConfiguration Network [1..1] IPv6 DHCPOptions

Retrieve a set of DHCP options, for example NTP and DNS server addresses, from a DHCPv6 server.

Requires user role: ADMIN

Value space: <Off/O n>

Off: 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:

xConfiguration Network 1 IPv6 DHCPOptions: On

xConfiguration Network [1..1] DHCP RequestTFTPServerAddress

This setting is used only for video systems that are registered to a Cisco Unified Communications Manager (CUCM).

The setting determines whether the endpoint should ask the DHCP server for DHCP option 150, so that it can discover the address of the TFTP ser ver (provisioning server) automatically.

If this setting is Off or the DHCP server does not support option 150, the TFTP server address must be set manually using the Provisioning ExternalManager Address setting.

Note: If the Network VLAN Voice Mode setting is Auto and the Cisco Discovery Protocol (CDP) assigns an ID to the voice VLAN, then a request for option 150 will always be sent. That is, the Network DHCP RequestTFTFServerAddress setting will be ignored.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The video system will not send a request for DHCP option 150 and the address of the TFTP server must be set manually. See the note above for any exception to this rule.

On: The video system will send a request for option 150 to the DHCP server so that it can automatically discover the address of the TFTP server.

Example:

xConfiguration Network 1 DHCP RequestTFTPServerAddress: On

xConfiguration Network [1..1] DNS Domain Name

DNS Domain Name is the default domain name suffix which is added to unqualified 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:

xConfiguration Network 1 DNS Domain Name: ""

xConfiguration Network [1..1] DNS Server [1..3] Address

Define the network addresses for DNS servers. Up to 3 addresses may be specified. If the network addresses are unknown, contact your administrator or Internet Service Provider.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: A valid IPv4 address or IPv6 address.

Example:

xConfiguration Network 1 DNS Server 1 Add ress: ""

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration 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. Diffserv (Differentiated Services) is a computer networking architecture that specifies a simple, scalable and coarsegrained mechanism for classifying, managing network traffic and providing QoS priorities on modern IP networks.

Requires user role: ADMIN

Value space: <Off/Diffserv>

Off: No QoS method is used. Diffserv: When you set the QoS Mode to Diffserv, the Network QoS Diffserv Audio, Network

QoS Diffserv Video, Network QoS Diffserv Data, Network QoS Dif fser v Signalling, Network QoS Diffserv ICMPv6 and Network QoS Diffserv NTP settings are used to prioritize packets.

Example:

xConfiguration Network 1 QoS Mode: Diffserv

xConfiguration Network [1..1] QoS Diffserv Audio

Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Define 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..63>

Ran ge: Select a value between 0 to 63 - the higher the number, the higher the priority. The default value is 0 (best effort).

Example:

xConfiguration Network 1 QoS Diffserv Audio: 0

xConfiguration Network [1..1] QoS Diffserv Video

Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Define 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..63>

Ran ge: Select a value between 0 to 63 - the higher the number, the higher the priority. The default value is 0 (best effort).

Example:

xConfiguration Network 1 QoS Diffserv Video: 0

xConfiguration Network [1..1] QoS Diffserv Data

Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Define 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 effor t. 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..63>

Ran ge: Select a value between 0 to 63 - the higher the number, the higher the priority. The default value is 0 (best effort).

Example:

xConfiguration Network 1 QoS Diffserv Data: 0

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Network [1..1] QoS Diffserv Signalling

Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Define which priority Signalling packets that are deemed critical (time-sensitive) for the real-time

operation 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..63>

Ran ge: Select a value between 0 to 63 - the higher the number, the higher the priority. The default value is 0 (best effort).

Example:

xConfiguration Network 1 QoS Diffserv Signalling: 0

xConfiguration Network [1..1] QoS Diffserv ICMPv6

Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Define 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 priority. The

recommended value for ICMPv6 is 0, which means best effort. 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..63>

Ran ge: Select a value between 0 to 63 - the higher the number, the higher the priority. The default value is 0 (best effort).

Example:

xConfiguration Network 1 QoS Diffserv ICMPv6: 0

xConfiguration Network [1..1] QoS Diffserv NTP

Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Define 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 effor t. 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..63>

Ran ge: Select a value between 0 to 63 - the higher the number, the higher the priority. The default value is 0 (best effort).

Example:

xConfiguration Network 1 QoS Diffserv NTP: 0

xConfiguration Network [1..1] IEEE8021X Mode

The system can be connected to an IEEE 802.1X LAN network, with a port-based network access control that is used to provide authenticated network access for Ethernet networks.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The 802.1X authentication is disabled (default). On: The 802.1X authentication is enabled.

Example:

xConfiguration Network 1 IEEE8021X Mode: Off

xConfiguration Network [1..1] IEEE8021X TlsVerify

Verification of the server-side certificate of an IEEE802.1x connection against the certificates in the local CA-list when TLS is used. The CA-list must be uploaded to the video system. This can be done from the web interface.

This setting takes effect only when Network [1..1] IEEE8021X Eap Tls is enabled (On).

Requires user role: ADMIN

Value space: <Off/O n>

Off: When set to Off, TLS connections are allowed without verifying the server-side X.509 certificate 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 certificate will be validated against the local CA-list for all TLS connections. Only servers with a valid certificate will be allowed.

Example:

xConfiguration xConfiguration Network 1 IEEE8021X TlsVerify: Off

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Network [1..1] IEEE8021X UseClientCertificate

Authentication using a private key/certificate pair during an IEEE802.1x connection. The authentication X.509 certificate must be uploaded to the video system. This can be done from the web interface.

Requires user role: ADMIN

Value space: <Off/O n>

Off: When set to Off 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:

xConfiguration Network 1 IEEE8021X UseClientCertificate: Off

xConfiguration Network [1..1] IEEE8021X Identity

The 802.1X Identity is the user name needed for 802.1X authentication.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: String with a maximum of 64 characters.

Example:

xConfiguration Network 1 IEEE8021X Identity: ""

xConfiguration Network [1..1] IEEE8021X Password

The 802.1X Password is the password needed for 802.1X authentication.

Requires user role: ADMIN

Value space: <S: 0, 32>

Format: String with a maximum of 32 characters.

Example:

xConfiguration Network 1 IEEE8021X Password: ""

xConfiguration Network [1..1] IEEE8021X AnonymousIdentity

The 802.1X Anonymous ID string is to be used as unencrypted identity with EAP (Extensible Authentication Protocol) types that support different tunneled identity, like EAP-PEAP and EAPTTLS. If set, the anonymous ID will be used for the initial (unencrypted) EAP Identity Request.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: String with a maximum of 64 characters.

Example:

xConfiguration Network 1 IEEE8021X AnonymousIdentity: ""

xConfiguration Network [1..1] IEEE8021X Eap Md5

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/O n>

Off: The EAP-MD5 protocol is disabled. On: The EAP-MD5 protocol is enabled (default).

Example:

xConfiguration Network 1 IEEE8021X Eap Md5: On

xConfiguration Network [1..1] IEEE8021X Eap Ttls

Set the TTLS (Tunneled Transport Layer Security) mode. Authenticates LAN clients without the need for client certificates. Developed by Funk Software and Certicom. Usually supported by Agere Systems, Proxim and Avaya.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The EAP-TTLS protocol is disabled. On: The EAP-TTLS protocol is enabled (default).

Example:

xConfiguration Network 1 IEEE8021X Eap Ttls: On

xConfiguration 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, defined in RFC 5216, is considered one of the most secure EAP standards. LAN clients are authenticated using client certificates.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The EAP-TLS protocol is disabled. On: The EAP-TLS protocol is enabled (default).

Example:

xConfiguration Network 1 IEEE8021X Eap Tls: On

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Network [1..1] IEEE8021X Eap Peap

Set the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The EAP-PEAP protocol is disabled. On: The EAP-PEAP protocol is enabled (default).

Example:

xConfiguration Network 1 IEEE8021X Eap Peap: On

xConfiguration Network [1..1] MTU

Set the Ethernet MTU (Maximum Transmission Unit).

Requires user role: ADMIN

Value space: <576 . .15 00>

Ran ge: Select a value from 576 to 1500 bytes.

Example:

xConfiguration Network 1 MTU: 1500

xConfiguration 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 effect.

Requires user role: ADMIN

Value space: <Auto/10h alf/10f ull/100h alf/100 ful l/100 0fu ll>

Auto: Autonegotiate link speed. 10h alf: Force link to 10 Mbps half-duplex. 10full: Force link to 10 Mbps full-duplex. 100 hal f: Force link to 100 Mbps half-duplex. 100full: Force link to 100 Mbps full-duplex. 1000full: Force link to 1 Gbps full-duplex.

Example:

xConfiguration Network 1 Speed: Auto

xConfiguration Network [1..1] TrafficControl Mode

Set the network traffic control mode to decide how to control the video packets transmission speed.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Transmit video packets at link speed. On: Transmit video packets at maximum 20 Mbps. Can be used to smooth out bursts in the

outgoing network traffic.

Example:

xConfiguration Network 1 TrafficControl: On

xConfiguration Network [1..1] RemoteAccess Allow

Filter IP addresses for access to ssh/telnet/HTTP/HTTPS.

Requires user role: ADMIN

Value space: <S: 0, 255>

Format: String with a maximum of 255 characters, comma separated IP adresses or IP range.

Example:

xCon fig u r at ion Net wor k 1 R e m ote A c c e s s A l l o w: "19 2.16 8.1.2 31, 192.168.1.182 "

xConfiguration 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 Unified 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.

Off: VL AN is not enabled.

Example:

xConfiguration Network 1 VLAN Voice Mode: Off

xConfiguration Network [1..1] VLAN Voice VlanId

Set the VL AN voice ID. This setting will only take effect if VLAN Voice Mode is set to Manual.

Requires user role: ADMIN

Value space: <1..40 94>

Ran ge: Select a value from 1 to 4094.

Example:

xConfiguration Network 1 VLAN Voice VlanId: 1

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

NetworkServices configuration

xConfiguration 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/O n>

Off: The XML API is disabled. On: The XML API is enabled (default).

Example:

xConfiguration NetworkServices MultiWay Address

The MultiWay address must be equal to the Conference Factor y Alias, as configured 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: 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>

Example:

xConfiguration NetworkServices MultiWay Protocol

Determine the protocol to be used for MultiWay calls.

Requires user role: ADMIN

Value space: <Auto/H323/Sip>

Example:

xConfiguration NetworkServices XMLAPI Mode: On

Format: String with a maximum of 255 characters (a valid dial URI).

xConfiguration NetworkServ ices MultiWay Add ress: "h323:multiway@company.com"

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.

xConfiguration NetworkServices MultiWay Protocol: Auto

xConfiguration 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/O n>

Off: Disable the possibility to place and receive H.323 calls. On: Enable the possibility to place and receive H.323 calls (default).

Example:

xConfiguration NetworkServices H323 Mode: On

xConfiguration 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 effect.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The HTTP protocol is disabled. On: The HTTP protocol is enabled.

Example:

xConfiguration NetworkServices HTTP Mode: On

xConfiguration 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 effect.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The HTTPS protocol is disabled. On: The HTTPS protocol is enabled.

Example:

xConfiguration NetworkServices HTTPS Mode: On

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration NetworkServices HTTPS VerifyServerCertificate

When the video system connects to an external HT TPS server (like a phone book server or an external manager), this server will present a certificate to the video system to identify itself.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Do not verify server certificates. On: Requires the system to verify that the ser ver cer tificate is signed by a trusted Certificate

Authority (CA). This requires that a list of trusted CAs are uploaded to the system in advance.

Example:

xConfiguration NetworkServices HTTPS VerifyServerCertificate: Off

xConfiguration NetworkServices HTTPS VerifyClientCertificate

When the video system connects to a HTTPS client (like a web browser), the client can be asked to present a certificate to the video system to identify itself.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Do not verify client certificates. On: Requires the client to present a cer tificate that is signed by a trusted Certificate Authority

(CA). This requires that a list of trusted CAs are uploaded to the system in advance.

Example:

xConfiguration NetworkServices HTTPS VerifyClientCertificate: Off

xConfiguration NetworkServices HTTPS OCSP Mode

Define the support for OCSP (Online Certificate Status Protocol) responder services. The OCSP feature allows users to enable OCSP instead of certificate revocation lists (CRLs) to check the certificate status.

For any outgoing HTTPS connection, the OCSP responder is queried of the status. If the corresponding certificate has been revoked, then the HTTPS connection will not be used.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable OCSP support. On: Enable OCSP support.

Example:

xConfiguration NetworkServices HTTPS OCSP Mode: Off

xConfiguration NetworkServices HTTPS OCSP URL

Specify the URL of the OCSP responder (server) that will be used to check the cer tificate status.

Requires user role: ADMIN

Value space: <S: 0, 255>

Format: String with a maximum of 255 characters.

Example:

c o m :8 1"

xConfiguration NetworkServices HTTPS OCSP URL: "http://ocspserver.company.

xConfiguration 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 ever y 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 ser ver is used, or the DHCP server does not provide the system with a NTP server address, the system will use the static defined NTP server address specified by the us e r.

Off: The system will not use an NTP server. Manual: The system will always use the static defined NTP server address specified by the user.

Example:

xConfiguration NetworkServices NTP Mode: Manual

xConfiguration NetworkServices NTP Address

Enter the NTP Address to define 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.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: A valid IPv4 address, IPv6 address or DNS name.

Example:

xConfiguration NetworkServices NTP Address: "1.ntp.tandberg.com"

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration NetworkServices SIP Mode

Determine whether the system should be able to place and receive SIP calls or not.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the possibility to place and receive SIP calls. On: Enable the possibility to place and receive SIP calls (default).

Example:

xConfiguration NetworkServices SIP Mode: On

xConfiguration 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 configuration. 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>

Off: Disable the SNMP network service. ReadOnly: Enable the SNMP network service for queries only. ReadWrite: Enable the SNMP network service for both queries and commands.

Example:

xConfiguration NetworkServices SNMP Mode: ReadWrite

xConfiguration NetworkServices SNMP Host [1..3] Address

Enter the address of up to three SNMP Managers. The system's SNMP Agent (in the codec) responds to requests from SNMP Managers (a PC

program etc.), for example about system location and system contact. SNMP traps are not supported.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: A valid IPv4 address, IPv6 address or DNS name.

Example:

xConfiguration NetworkServices SNMP Host 1 Address: ""

xConfiguration NetworkServices SNMP CommunityName

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 configured there too. NOTE: The SNMP Community password is case sensitive.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration NetworkServices SNMP Com munityName: "public"

xConfiguration NetworkServices SNMP SystemContact

Enter the name of the Network Services SNMP System Contact.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration NetworkServices SNMP SystemContact: ""

xConfiguration NetworkServices SNMP SystemLocation

Enter the name of the Network Services SNMP System Location.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration NetworkServices SNMP SystemLocation: ""

xConfiguration NetworkServices SSH Mode

SSH (or Secure Shell) protocol can provide secure encrypted communication between the codec and your local computer.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The SSH protocol is disabled. On: The SSH protocol is enabled.

Example:

xConfiguration NetworkServices SSH Mode: On

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration NetworkServices SSH AllowPublicKey

Secure Shell (SSH) public key authentication can be used to access the codec.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The SSH public key is not allowed. On: The SSH public key is allowed.

Example:

xConfiguration NetworkServices SSH AllowPublicKey: On

xConfiguration 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/O n>

Off: The Telnet protocol is disabled. This is the factory setting. On: The Telnet protocol is enabled.

Example:

xConfiguration NetworkServices Telnet Mode: Off

xConfiguration 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/O n>

Off: Mulitparty conferencing via CTMS is prohibited. On: Mulitpar ty conferencing via CTMS is allowed.

Example:

xConfiguration NetworkServices CTMS Mode: On

xConfiguration NetworkServices CTMS Encryption

This setting indicates whether or not the video system supports encryption when participating in a multiparty meeting controlled by a Cisco TelePresence Multipoint Switch (CTMS).

CTMS allows three security settings for meetings: non-secure (not encrypted), best effort (encrypted if all participants support encryption, otherwise not encrypted) and secure (always encrypted).

Requires user role: ADMIN

Value space: <Off/BestEffort>

Off: The video system does not allow encryption and therefore cannot participate in a secure CTMS meeting (encrypted). When participating in a best effort CTMS meeting, the meeting will be downgraded to non-secure (not encrypted).

BestEffort: 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:

xConfiguration NetworkServices CTMS Encryption: Off

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Phonebook configuration

xConfiguration 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:

xConfiguration Phonebook Server [1..1] Type

Select the phonebook server type.

Requires user role: ADMIN

Value space: <VCS/TMS/Callway/CUCM>

Example:

xConfiguration 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>

Example:

external/phonebook/phonebookservice.asmx"

xConfiguration Phonebook Server 1 ID: ""

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 Unified Communications Manager.

xConfiguration Phonebook Server 1 Ty pe: TMS

Format: String with a maximum of 255 characters.

xConfiguration Phonebook Server 1 UR L: "http://tms.company.com/tms/public/

Provisioning configuration

xConfiguration Provisioning Connectivity

This setting controls how the device discovers whether it should request an internal or external configuration from the provisioning server.

Requires user role: ADMIN

Value space: <Internal/External/Auto>

Internal: Request internal configuration. External: Request external configuration. Auto: Automatically discover using NAPTR queries whether internal or external configurations

should be requested. If the NAPTR responses have the "e" flag, external configurations will be requested. Otherwise internal configurations will be requested.

Example:

xConfiguration Provisioning Mode

It is possible to configure 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 off. Contact your provisioning system provider/representative for more information.

Requires user role: ADMIN

Value space: <Off/TMS/VCS/CallWay/CUCM/Auto>

Example:

xConfiguration Provisioning Connectivity: Auto

Off: The video system will not be configured by a provisioning system. TMS: The video system will be configured using TMS (Cisco TelePresence Management System). VCS: Not applicable in this version. Callway: The video system will be configured using the WebEx TelePresence subscription service

(formerly called Callway). CUCM: The video system will be configured using CUCM (Cisco Unified Communications

Manager). Auto: The provisioning server will automatically be selected by the video system.

xConfiguration Provisioning Mode: TMS

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Provisioning LoginName

This is the user name part of the credentials used to authenticate the video system with the provisioning ser ver. This setting must be used when required by the provisioning server. If Provisioning Mode is Callway (WebEx TelePresence), enter the video number.

Requires user role: ADMIN

Value space: <S: 0, 80>

Format: String with a maximum of 80 characters.

Example:

xConfiguration Provisioning LoginName: ""

xConfiguration Provisioning Password

This is the password part of the credentials used to authenticate the video system with the provisioning ser ver. 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:

xConfiguration Provisioning Password: ""

xConfiguration Provisioning HttpMethod

Select the HTTP method to be used for the provisioning.

Requires user role: ADMIN

Value space: <GE T/P O S T>

GE T: Select GET when the provisioning ser ver supports GET. PO S T: Select POST when the provisioning server supports POST.

Example:

xConfiguration Provisioning HttpMethod: POST

xConfiguration Provisioning ExternalManager Address

Enter the IP Address or DNS name of the external manager / provisioning system. If an External Manager Address (and Path) is configured, the system will send a message to this

address when starting up. When receiving this message the external manager / provisioning system can return configurations/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 D H C P.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: A valid IPv4 address, IPv6 address or DNS name.

Example:

xConfiguration Provisioning ExternalManager Address: ""

xConfiguration Provisioning ExternalManager Protocol

Determine whether to use secure management or not.

Requires user role: ADMIN

Value space: <HTTP/HTTPS>

HTTP: Set to HTTP to disable secure management. Requires HTTP to be enabled in the NetworkServices HTTP Mode setting.

HTTPS: Set to HTTPS to enable secure management. Requires HTTPS to be enabled in the NetworkServices HTTPS Mode setting.

Example:

xConfiguration Provisioning ExternalManager Protocol: HTTP

xConfiguration Provisioning ExternalManager Path

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:

management/SystemManagementService.asmx"

xConfiguration Provisioning ExternalManager Path: "tms/public/external/

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Provisioning ExternalManager Domain

Enter the SIP domain for the VCS provisioning server.

Requires user role: ADMIN

Value space: <S: 0, 64>

Format: String with a maximum of 64 characters.

Example:

xConfiguration Provisioning ExternalManager Domain: "any.domain.com"

RTP configuration

xConfiguration RTP Ports Range Start

Specify the first port in the range of RTP ports. Also see the H323 Profile [1..1] PortAllocation setting.

NOTE: Restart the system for any change to this setting to take effect.

Requires user role: ADMIN

Value space: <1024..65502>

Ran ge: Select a value from 1024 to 65502.

Example:

xConfiguration RTP Ports Range Stop

Specify the last RTP por t in the range. Also see the H323 Profile [1..1] PortAllocation setting. NOTE: Restart the system for any change to this setting to take effect.

Requires user role: ADMIN

Value space: <1056..65535>

Example:

xConfiguration RTP Ports Range Start: 2326

Ran ge: Select a value from 1056 to 65535.

xConfiguration RTP Ports Range Stop: 2486

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Security configuration

xConfiguration 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 port number for the audit server in the Security Audit Server Address and Security Audit Ser ver Port settings.

NOTE: Restart the system for any change to this setting to take effect.

Requires user role: AUDIT

Value space: <Off/Internal/External/ExternalSecure>

Off: No audit logging is per formed. 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 verified by a certificate in the Audit CA list. The Audit CA list file must be uploaded to the codec using the web interface. The common_name parameter of a cer tificate in the CA list must match the IP address of the audit server.

Example:

xConfiguration 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 effect.

Requires user role: AUDIT

Value space: <S: 0, 64>

Example:

xConfiguration 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 effect.

Requires user role: AUDIT

Value space: <0..65535>

Example:

xConfiguration Security Audit Logging Mode: Off

Format: A valid IPv4 address or IPv6 address.

xConfiguration Security Audit Server Address: ""

Ran ge: Select a value from 0 to 65535.

xConfiguration Security Audit Server Port: 514

xConfiguration 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 effect.

Requires user role: AUDIT

Value space: <Halt/Ignore>

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.

Example:

xConfiguration Security Audit OnError Action: Ignore

xConfiguration Security Session ShowLastLogon

When logging in to the system using SSH or Telnet you will see the UserId, time and date of the last session that did a successful login.

Requires user role: ADMIN

Value space: <Off/O n>

On: Show information about the last session. Off: Do not show information about the last session.

Example:

xConfiguration Security Session ShowLastLogon: Off

xConfiguration Security Session InactivityTimeout

Determine how long the system will accept inactivity from the user before he is automatically logged out.

Requires user role: ADMIN

Value space: <0..10000>

Ran ge: Select a value between 1 and 10000 seconds; or select 0 when inactivity should not enforce automatic logout.

Example:

xConfiguration Security Session InactivityTimeout: 0

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

SerialPort configuration

xConfiguration SerialPort Mode

Enable/disable the serial port (connection via USB and RS-232 adapter).

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the serial port. On: Enable the serial port.

Example:

xConfiguration SerialPort BaudRate

Specify 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>

Example:

xConfiguration SerialPort LoginRequired

Determine if login shall be required when connecting to the serial port.

Requires user role: ADMIN

Value space: <Off/O n>

Example:

xConfiguration SerialPort Mode: On

Ran ge: Select a baud rate from the baud rates listed (bps).

xConfiguration SerialPort BaudRate: 38400

Off: 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.

xConfiguration SerialPort LoginRequired: On

SIP configuration

xConfiguration SIP Profile [1..1] Ice

ICE (Interactive Connectivity Establishment, RFC 5245) is a NAT traversal solution that the endpoints can use to discover the optimized media path. Thus the shortest route for audio and video is always secured between the endpoints.

NOTE: ICE is not suppor ted when registered to CUCM (Cisco Unified Communication Manager).

Requires user role: ADMIN

Value space: <Off/O n>

Off: Set to Off to disable ICE. On: Set to On, to enable ICE.

Example:

xConfiguration SIP Profile [1..1] IceDefaultCandidate

This is the default IP address that the endpoint will receive media on until ICE has reached a conclusion about which media route to use (up to the first 5 seconds of a call.

Requires user role: ADMIN

Value space: <Off/O n>

Example:

xConfiguration SIP Profile [1..1] Turn Server

This is the address of the TURN (Traversal Using Relay NAT) server that the endpoints will use. It is used as a media relay fallback and it is also used to discover the endpoint’s own public IP address.

Requires user role: ADMIN

Value space: <S: 0, 255>

Example:

xConfiguration SIP Profile 1 Ice: Off

Host: The endpoint will receive media on its own IP address. Rflx: The endpoint will receive media on its public IP address as seen by the TURN server. Relay: The endpoint will receive media on the IP address and port allocated on the TURN server,

and is used as a fallback until ICE has concluded.

xConfiguration SIP Profile 1 IceDefaultCandidate: Host

Format: The preferred format is DNS SRV record (e.g. _turn._udp.<domain>), or it can be a valid IPv4 or IPv6 address.

xConfiguration SIP Profile 1 Turn Server: " _ turn. _ udp.example.com"

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration SIP Profile [1..1] Turn UserName

The user name needed for accessing the TURN server.

Requires user role: ADMIN

Value space: <S: 0, 128>

Format: String with a maximum of 128 characters.

Example:

xConfiguration SIP Profile 1 Turn UserName: ""

xConfiguration SIP Profile [1..1] Turn Password

The password needed for accessing the TURN server.

Requires user role: ADMIN

Value space: <S: 0, 128>

Format: String with a maximum of 128 characters.

Example:

xConfiguration SIP Profile 1 Turn Password: ""

xConfiguration SIP Profile [1..1] URI

The SIP URI (Uniform Resource Identifier) is the address that is used to identify the video system. The URI is registered and used by the SIP services to route inbound calls to the system. The SIP URI syntax is defined in RFC 3261.

Requires user role: ADMIN

Value space: <S: 0, 255>

Format: String with maximum 255 characters and compliant with the SIP URI syntax.

Example:

xConfiguration SIP Profile 1 URI: "sip:firstname.lastname@company.com"

xConfiguration SIP Profile [1..1] DisplayName

When configured the incoming call will report the DisplayName instead of the SIP URI.

Requires user role: ADMIN

Value space: <S: 0, 255>

Format: String with a maximum of 255 characters.

Example:

xConfiguration SIP Profile 1 DisplayName: ""

xConfiguration SIP Profile [1..1] Authentication [1..1] LoginName

This is the user name part of the credentials used to authenticate towards the SIP proxy.

Requires user role: ADMIN

Value space: <S: 0, 128>

Format: String with a maximum of 128 characters.

Example:

xConfiguration SIP Profile 1 Authentication 1 LoginName: ""

xConfiguration SIP Profile [1..1] Authentication [1..1] Password

This is the password part of the credentials used to authenticate towards the SIP proxy.

Requires user role: ADMIN

Value space: <S: 0, 128>

Format: String with a maximum of 128 characters.

Example:

xConfiguration SIP Profile 1 Authentication 1 Password: ""

xConfiguration SIP Profile [1..1] DefaultTransport

Select the transport protocol to be used over the LAN.

Requires user role: ADMIN

Value space: <TC P/UDP/Tl s/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 transpor t 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 Diffie Hellman will be used.

Auto: The system will try to connect using transport protocols in the following order: TLS, TCP, U D P.

Example:

xConfiguration SIP Profile 1 DefaultTransport: Auto

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration SIP Profile [1..1] TlsVerify

For TLS connections a SIP CA-list can be uploaded to the video system. This can be done from the web interface.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Set to Off to allow TLS connections without verifying them. The TLS connections are allowed to be set up without verifying the x.509 certificate received from the ser ver against the local CAlist. This should t ypically 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 certificate is validated against the CA-list, will be allowed.

Example:

xConfiguration SIP Profile 1 TlsVerify: Off

xConfiguration SIP Profile [1..1] Outbound

Turn on or off the client initiated connections mechanism for firewall traversal, connection reuse and redundancy. The current version suppor ts RFC 5626.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Connect to the single proxy configured first in Proxy Address list. On: Set up multiple outbound connections to servers in the Proxy Address list.

Example:

xConfiguration SIP Profile 1 Outbound: Off

xConfiguration SIP Profile [1..1] Proxy [1..4] Address

The Proxy Address is the manually configured address for the outbound proxy. It is possible to use a fully qualified domain name, or an IP address. The default port is 5060 for TCP and UDP but another one can be provided. If SIP Profile Outbound is enabled, multiple proxies can be addressed.

Requires user role: ADMIN

Value space: <S: 0, 255>

Format: A valid IPv4 address, IPv6 address or DNS name.

Example:

xConfiguration SIP Profile 1 Proxy 1 Address: ""

xConfiguration SIP Profile [1..1] Proxy [1..4] Discovery

Select if the SIP Proxy address is to be obtained manually or by using Dynamic Host Configuration Protocol (DHCP).

Requires user role: ADMIN

Value space: <Auto/Manual>

Auto: When Auto is selected, the SIP Proxy address is obtained using Dynamic Host Configuration Protocol (DHCP).

Manual: When Manual is selected, the manually configured SIP Proxy address will be used.

Example:

xConfiguration SIP Profile 1 Proxy 1 Discovery: Manual

xConfiguration SIP Profile [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 Unified 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:

xConfiguration SIP Profile 1 Type: Standard

xConfiguration SIP Profile [1..1] Mailbox

When registered to a Cisco Unified Communications Manager (CUCM) you may be offered the option of having a private voice mailbox. Enter the number (address) of the mailbox in this setting, or leave the string empty if you do not have a voice mailbox.

Requires user role: ADMIN

Value space: <S: 0, 255>>

Format: String with a maximum of 255 characters.

Example:

xConfiguration SIP Profile 1 Mailbox: "12345678"

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration SIP Profile [1..1] Line

When registered to a Cisco Unified Communications Manager (CUCM) the endpoint may be par t of a shared line. This means that several devices share the same directory number. The different devices sharing the same number receive status from the other appearances on the line as defined in RFC 4235.

Note that shared lines are set up by CUCM, not by the endpoint. Therefore do not change this setting manually; CUCM pushes this information to the endpoint when required.

Requires user role: ADMIN

Value space: <Private/Shared>

Sha red: The system is par t of a shared line and is therefore sharing its directory number with other devices.

Private: This system is not part of a shared line (default).

Example:

xConfiguration SIP Profile 1 Line: Private

xConfiguration SIP ListenPort

Turn on or off the listening for incoming connections on the SIP TCP/UDP ports. If turned off, the endpoint will only be reachable through the SIP registrar (CUCM or VCS). It is recommended to leave this setting at its default value.

Requires user role: ADMIN

Value space: <On/Off>

On: Listening for incoming connections on the SIP TCP/UDP ports is turned on. Off: Listening for incoming connections on the SIP TCP/UDP ports is turned of f.

Example:

xConfiguration SIP ListenPort: On

Standby configuration

xConfiguration Standby Control

Determine whether the system should go into standby mode or not.

Requires user role: ADMIN

Value space: <Off/O n>

Off: 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:

xConfiguration Standby Delay

Define 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>

Example:

xConfiguration Standby BootAction

Define the camera position after a restart of the codec.

Requires user role: ADMIN

Value space: <None/Preset1/Preset2/Preset3/Preset4/Preset5/Preset6/Preset7/Preset8/

Preset9/Preset10/Preset11/Preset12/Preset13/Preset14/Preset15/RestoreCameraPosition/ DefaultCameraPosition>

Example:

xConfiguration Standby Control: On

Ran ge: Select a value from 1 to 480 minutes.

xConfiguration Standby Delay: 10

None: No action. Preset1 to Preset15: After a reboot the camera position will be set to the position defined 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.

xConfiguration Standby BootAction: DefaultCa meraPosition

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Standby StandbyAction

Define 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:

xConfiguration Standby StandbyAction: PrivacyPosition

xConfiguration Standby WakeupAction

Define the camera position when leaving standby mode.

Requires user role: ADMIN

Value space: <None/Preset1/Preset2/Preset3/Preset4/Preset5/Preset6/Preset7/Preset8/

Preset9/Preset10/Preset11/Preset12/Preset13/Preset14/Preset15/RestoreCameraPosition/ DefaultCameraPosition>

None: No action. Preset1 to Preset15: When leaving standby the camera position will be set to the position defined

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:

xConfiguration Standby WakeupAction: RestoreCameraPosition

SystemUnit configuration

xConfiguration SystemUnit Name

Enter a System Name to define a name of the system unit. If the H.323 Alias ID is configured on the system then this ID will be used instead of the system name. The system name will be displayed:

1) When the codec is acting as an SNMP Agent.

2) Towards a DHCP server.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration SystemUnit MenuLanguage

Select the language to be used in the menus on screen or on the Touch controller.

Requires user role: USER

Value space: <English/ChineseSimplified/ChineseTraditional/Czech/Danish/Dutch/Finnish/French/

German/Hungarian/Italian/Japanese/Korean/Norwegian/Polish/PortugueseBrazilian/Russian/ Spanish/SpanishLatin/Swedish/Turkish>

Example:

xConfiguration SystemUnit Name: "Meeting Room"

xConfiguration SystemUnit MenuLanguage: English

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration SystemUnit ContactInfo Type

Choose which type of contact information to show in the status field 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/None/IPv4/IPv6/H323Id/E164Alias/H320Number/SipUri/SystemName/

DisplayName>

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 field. 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 Profile [1..1] H323Alias ID

setting). E164Alias: Show the H.323 E164 Alias as contact information (see the H323 Profile [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 Profile [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 Profile [1..1] DisplayName

setting).

Example:

xConfiguration SystemUnit ContactInfo Type: Auto

xConfiguration 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/O n>

Off: Disable logging. On: Enable logging.

Example:

xConfiguration SystemUnit CallLogging Mode: On

xConfiguration 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 flickers when an IR signal is received from the remote control.

Requires user role: ADMIN

Value space: <Auto/Off/On>

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.

Off: Disable the IR sensor on the codec. On: Enable the IR sensor on the codec.

Example:

xConfiguration SystemUnit IrSensor: Auto

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Time configuration

xConfiguration 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, Samoa)/GMT-

10:00 (Hawaii)/GMT-09:00 (Alaska)/GMT-08:00 (Pacific Time (US & Canada); Tijuana)/GMT-07:00 (Arizona)/GMT-07:00 (Mountain Time (US & Canada))/GMT-07:00 (Chihuahua, La Paz, Mazatlan)/ GMT-06:00 (Central America)/GMT-06:00 (Saskatchewan)/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 Time (US & Canada))/GMT-04:30 (Caracas)/GMT-04:00 (La Paz)/GMT-04:00 (Santiago)/GMT-04:00 (Atlantic Time (Canada))/GMT-03:30 (Newfoundland)/ GMT-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 (Coordinated Universal Time)/GMT (Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London)/ GMT+01:00 (West Central Africa)/GMT+01:00 (Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna)/ GMT+01:00 (Brussels, Copenhagen, Madrid, Paris)/GMT+01:00 (Sarajevo, Skopje, Warsaw, Zagreb)/ GMT+01:00 (Belgrade, Bratislava, Budapest, Ljubljana, Prague)/GMT+02:00 (Harare, Pretoria)/ GMT+02:00 (Jerusalem)/GMT+02:00 (Athens, Istanbul, Minsk)/GMT+02:00 (Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius)/GMT+02:00 (Cairo)/GMT+02:00 (Bucharest)/GMT+03:00 (Nairobi)/GMT+03:00 (Kuwait, Riyadh)/GMT+03:00 (Moscow, St. Petersburg, Volgograd)/GMT+03:00 (Baghdad)/ GMT+03:30 (Tehran)/GMT+04:00 (Abu Dhabi, Muscat)/GMT+04:00 (Baku, Tbilisi, Yerevan)/ GMT+04:30 (Kabul)/GMT+05:00 (Islamabad, Karachi, Tashkent)/GMT+05:00 (Ekaterinburg)/ GMT+05:30 (Chennai, Kolkata, Mumbai, New Delhi)/GMT+05:45 (Kathmandu)/GMT+06:00 (Sri Jayawardenepura)/GMT+06:00 (Astana, Dhaka)/GMT+06:00 (Almaty, Novosibirsk)/GMT+06:30 (Rangoon)/GMT+07:00 (Bangkok, Hanoi, Jakarta)/GMT+07:00 (Krasnoyarsk)/GMT+08:00 (Perth)/ GMT+08:00 (Taipei)/GMT+08:00 (Kuala Lumpur, Singapore)/GMT+08:00 (Beijing, Chongqing, Hong Kong, Urumqi)/GMT+08:00 (Irkutsk, Ulaan Bataar)/GMT+09:00 (Osaka, Sapporo, Tokyo)/GMT+09:00 (Seoul)/GMT+09:00 (Yakutsk)/GMT+09:30 (Darwin)/GMT+09:30 (Adelaide)/GMT+10:00 (Guam, Port Moresby)/GMT+10:00 (Brisbane)/GMT+10:00 (Vladivostok)/GMT+10:00 (Hobart)/GMT+10:00 (Canberra, Melbourne, Sydney)/GMT+11:00 (Magadan, Solomon Is., New Caledonia)/GMT+12:00 (Fiji, Kamchatka, Marshall Is.)/GMT+12:00 (Auckland, Wellington)/GMT+13:00 (Nuku alofa)>

Ran ge: Select a time zone from the list time zones. If using a command line interface; watch up for typos.

Example:

Lisbon, London)"

xConfiguration Time Zone: "GMT (Greenwich Mean Time : Dublin, Edinburgh,

xConfiguration 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:

xConfiguration Time Ti meFormat: 24H

xConfiguration 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 Januar y 30th 2010 will be displayed: 30.01.10 MM _ D D _Y Y: The date Januar y 30th 2010 will be displayed: 01.30.10 YY_MM_DD: The date January 30th 2010 will be displayed: 10.01.30

Example:

xConfiguration Ti me DateFormat: DD _ MM _ YY

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

UserInterface configuration

xConfiguration UserInterface TouchPanel DefaultPanel

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 histor y) 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:

xConfiguration UserInterface TouchPanel DefaultPanel: ContactList

Video configuration

xConfiguration Video Input Source [1..3] Name

Enter a name for the video input source.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration 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>

Example:

xConfiguration 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>

Example:

xConfiguration Video Input Source 1 Name: ""

HDM I: Select HDMI when you want to use the HDMI as input source 1.

xConfiguration Video Input Source 1 Connector: HDMI

DVI: Select DVI-I when you want to use the DVI-I 2 as input source 2.

xConfiguration Video Input Source 2 Connector: DVI

xConfiguration Video Input Source [3] Connector

Select which video input connector to be active on video input source 3.

Requires user role: ADMIN

Value space: <USB>

USB: Select USB when you want to use the USB as input source 3.

Example:

xConfiguration Video Input Source 3 Connector: USB

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Input Source [1..3] Type

Set which type of input source is connected to the video input.

Requires user role: ADMIN

Value space: <other/camera/PC/DVD/document_camera>

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:

xConfiguration Video Input Source 1 Ty pe: PC

xConfiguration Video Input Source [1..3] 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 define 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:

xConfiguration Video Input Source 1 PresentationSelection: Manual

xConfiguration Video Input Source [1..3] 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/O n>

Off: Disable camera control. On: Enable camera control.

Example:

xConfiguration Video Input Source 1 Ca meraControl Mode: On

xConfiguration Video Input Source [1..3] CameraControl CameraId

Indicates the ID of the camera. This value is fixed in this product.

Value space: <1>

Ran ge: Indicates the ID of the camera.

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Input Source [1..3] OptimalDefinition Profile

The Video Input Source Quality setting must be set to Motion for the optimal definition settings to take any effect.

The optimal definition profile should reflect 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 profile. 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 profiles. However, when the lighting conditions are good, the High profile can be set in order to increase the resolution for a given call rate.

Some typical resolutions used for different optimal definition profiles, 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 suppor ted by both the calling and called systems.

Use the Video Input Source OptimalDefinition 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: <Normal/Medium/High>

Normal: Use this profile 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.

Hig h: 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:

Optimal

Definition

Profile

Normal 512 × 28 8 1024 × 576 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080

Medium 640 × 360 1280 × 720 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080

High 768 × 448 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080 1920 × 1080

Normal 256 × 144 512 × 28 8 768 × 448 1024 × 576 1280 × 720 1280 × 720 1920 × 1080

Medium 256 × 144 768 × 448 1024 × 576 1024 × 576 1280 × 720 1920 × 1080 1920 × 1080

High 512 × 288 1024 × 576 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080

xConfiguration Video Input Source 1 OptimalDefinition Profile: Medium

256 kbps 768 k bps 1152 k b p s 1472 k b p s 2560 kbps 4 Mbps 6 Mbps

Call rate

xConfiguration Video Input Source [1..3] OptimalDefinition 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_108 0/Never>

512_ 2 8 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. 1920_1080: Set the threshold to 1920x1080. Never: Do not set a threshold for transmitting 60fps.

Example:

1280 _ 720

xConfiguration Video Input Source 1 OptimalDefinition Threshold60fps:

xConfiguration Video Input Source [1..3] Quality

When encoding and transmitting video there will be a trade-off 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 specifies 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 par ticipants 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:

xConfiguration Video Input Source 1 Quality: Motion

xConfiguration Video MainVideoSource

Define which video input source shall be used as the main video source. The video input source is configured with the "Video Input Source [1..n] Connector" setting.

Requires user role: USER

Value space: <1/2/ 3>

Ran ge: Select the source to be used as the main video source.

Example:

xConfiguration Video MainVideoSource: 1

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video DefaultPresentationSource

Define 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 effect. The Video Input Source n Connector setting defines which input connector to use for input source n.

Requires user role: USER

Value space: <1/2>

Ran ge: Select the video source to be used as the presentation source.

Example:

xConfiguration Video DefaultPresentationSource: 2

xConfiguration Video Input HDMI [1..1] RGBQuantizationRange

All devices with HDMI inputs should follow the rules for RGB video quantization range defined in CEA-861. Unfortunately some devices do not follow the standard and this configuration may be used to override the settings to get a perfect image with any source.

Requires user role: ADMIN

Value space: <Auto/Full/Limited>

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 defined 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 defined in CEA-861-E.

Example:

xConfiguration Video Input 1 HDMI 1 RGBQuantizationRange: Auto

xConfiguration Video Input DVI [2] RGBQuantizationRange

All devices with DVI inputs should follow the rules for RGB video quantization range defined in CEA-

861. Unfortunately some devices do not follow the standard and this configuration 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/Full/Limited>

Auto: RGB quantization range is automatically selected based on video format according to CEA861-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 defined 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 defined in CEA-861-E.

Example:

xConfiguration Video Input 1 DVI 2 RGBQuantizationRange: Full

xConfiguration Video Input DVI [2] Type

The official 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/AnalogYPbPr>

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. AnalogYPbPr: Set to AnalogYPbPr to force the DVI video input to AnalogYPbPr, as the component

(YPbPr) signal cannot be auto detected.

Example:

xConfiguration Video Input DVI 2 Type: AutoDetect

xConfiguration Video Layout Scaling

Define how the system shall adjust the aspect ratio for images or frames when there is a difference between the image and the frame it is to be placed in.

Requires user role: ADMIN

Value space: <Off/O n>

Off: No adjustment of the aspect ratio. On: Let the system automatically adjust aspect ratio.

Example:

xConfiguration Video Layout Scaling: On

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Layout ScaleToFrame

Define 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 difference 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 fit. If not, the system will maintain the original aspect ratio.

MaintainAspectRatio: Maintain the aspect ratio of the input source, and fill in black in the rest of the frame (letter boxing or pillar boxing).

St retc hTo Fit : Stretch (horizontally or vertically) the input source to fit 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:

xConfiguration Video Layout ScaleToFrame: MaintainAspectRatio

xConfiguration Video Layout ScaleToFrameThreshold

Only applicable if the Video Layout ScaleToFrame setting is set to manual. If the difference 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 fit. If not, the system will maintain the original aspect ratio.

Requires user role: ADMIN

Value space: <0..100>

Ran ge: Select a value from 0 to 100 percent.

Example:

xConfiguration Video Layout ScaleToFrameThreshold: 5

xConfiguration 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/O n>

Off: Do not display self view on screen. On: Display self view on screen.

Example:

xConfiguration Video Selfview: On

xConfiguration 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/LowerRight>

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:

xConfiguration Video SelfviewPosition: LowerRight

xConfiguration Video SelfviewControl AutoResizing

The size of the self view frame can be configured to automatically change according to the following rules. The size is reduced from full screen to PiP (picture-in-picture) when there is a change in a frame that overlaps with the self view frame. The size is increased from PiP to full screen when nothing else is displayed on the monitor. The last rule does not apply to monitors with MonitorRole set to First.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Self view will not be automatically resized. On: Self view is automatically resized as described above.

Example:

xConfiguration Video SelfviewControl AutoResizing: On

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration 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>

Off: Self view is switched off 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 off

during the call, it remains off after the call. On: Self view is switched on when leaving a call.

Example:

xConfiguration Video SelfviewDefault Mode: Current

xConfiguration 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 effect when self view is switched on (see the Video SelfviewDefault Mode setting).

Requires user role: ADMIN

Value space: <Off/Current/On>

Off: 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:

xConfiguration Video SelfviewDefault FullscreenMode: Current

xConfiguration Video SelfviewDefault PIPPosition

Determine the position on screen of the small self view picture-in-picture (PiP) after a call. The setting only takes effect when self view is switched on (see the Video SelfviewDefault Mode setting) and fullscreen view is switched off (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:

xConfiguration Video SelfviewDefault PIPPosition: Current

xConfiguration Video SelfviewDefault OnMonitorRole

Determine which monitor/output to display the main video source (self view) on after a call. The value reflects the monitor roles set for the different 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 picture-in-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:

xConfiguration Video SelfviewDefault OnMonitorRole: Current

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video CamCtrlPip CallSetup Mode

This setting is used to switch on self view for a short while when setting up a call. The Video CamCtrlPip CallSetup Duration setting determines for how long it remains on. This applies when self view in general is switched off.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Self view is not shown automatically during call setup. On: Self view is shown automatically during call setup.

Example:

xConfiguration Video Ca mCtrlPip CallSetup Mode: Off

xConfiguration Video CamCtrlPip CallSetup Duration

This setting only has an effect when the Video CamCtrlPip CallSetup Mode setting is switched On. In this case, the number of seconds set here determines for how long self view is shown before it is automatically switched off.

Requires user role: ADMIN

Value space: <1..60 >

Ran ge: Choose for how long self view remains on. The valid range is between 1 and 60 seconds.

Example:

xConfiguration Video Ca mCtrlPip CallSetup Duration: 10

xConfiguration Video PIP ActiveSpeaker DefaultValue Position

Determine the position on screen of the active speaker picture-in-picture (PiP). The setting only takes effect 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 effect from the next call onwards; if changed during a call, it will have no ef fect 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:

xConfiguration Video PIP ActiveSpeaker DefaultValue Position: Current

xConfiguration Video PIP Presentation DefaultValue Position

Determine the position on screen of the presentation picture-in-picture (PiP). The setting only takes effect when the presentation is explicitly minimized to a PiP, for example using the remote control or the Touch controller. The setting takes effect from the next call onwards; if changed during a call, it will have no ef fect 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 lef t corner of the screen. LowerRight: The presentation PiP will appear in the lower right corner of the screen.

Example:

xConfiguration Video PIP Presentation DefaultValue Position: Current

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Layout LocalLayoutFamily

Select which video layout family to use locally.

Requires user role: ADMIN

Value space: <Auto/FullScreen/Equal/PresentationSmallSpeaker/PresentationLargeSpeaker/

Prominent/Overlay/Single>

Auto: The default layout family, as given in the layout database provided by the system, will be used as the local layout.

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.

Sin gle: 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:

xConfiguration Video Layout LocalLayoutFa mily: Auto

xConfiguration Video Layout RemoteLayoutFamily

Select which video layout family to be used for the remote participants.

Requires user role: ADMIN

Value space: <Auto/FullScreen/Equal/PresentationSmallSpeaker/PresentationLargeSpeaker/

Prominent/Overlay/Single>

Auto: The default layout family, as given by the local layout database, will be used as the remote layout.

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. It is recommended not to use this value 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.

Sin gle: 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:

xConfiguration Video Layout Re moteLayoutFa mily: Auto

xConfiguration Video Monitors

Set the monitor layout mode.

Requires user role: ADMIN

Value space: <Single/Dual/DualPresentationOnly>

Sin gle: The same layout is shown on all monitors. Dual: The layout is distributed on two monitors. DualPresentationOnly: All par ticipants in the call will be shown on the first monitor, while the

presentation (if any) will be shown on the second monitor.

Example:

xConfiguration Video Monitors: Single

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video OSD Mode

The Video OSD (On Screen Display) Mode lets you define if information and icons should be displayed on screen.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Hide the on screen menus, icons and indicators. On: Display the on screen menus, icons and indicators.

Example:

xConfiguration Video OSD Mode: On

xConfiguration Video OSD WallPaperSelection

Applies to the on screen menu (OSD). The wall paper selection menu can be hidden outside the administrator set tings menu and visible inside, or it can be visible both inside and outside the administrator settings menu. The administrator settings menu can be password protected.

Requires user role: ADMIN

Value space: <Off/O n>

Example:

xConfiguration Video OSD WallPaperSelection: On

xConfiguration Video OSD LanguageSelection

Applies to the on screen menu (OSD). The language selection menu can be hidden outside the administrator set tings menu and visible inside, or it can be visible both inside and outside the administrator settings menu. The administrator settings menu can be password protected.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The language selection menu is hidden outside the administrator settings menu and visible inside. To change the language, navigate to: Home > Settings > Administrator Settings. If required log in with your username and password. Then navigate to Language.

On: The language selection menu is visible both inside and outside the administrator settings menu. To change the language, navigate to: Home > Settings > Language. Or navigate to Home > Settings > Administrator Settings. If required log in with your username and password. Then navigate to Language.

Example:

xConfiguration Video OSD LanguageSelection: On

xConfiguration Video OSD MenuStartupMode

Configures 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/Home>

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:

xConfiguration Video OSD MenyStartUpMode: Home

xConfiguration Video OSD VirtualKeyboard

Determine whether or not the virtual keyboard will automatically show on screen when text is to be entered in an input field. 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: <UserSelectable/AlwaysOn>

UserSelectable: The user has to press a softbutton to open or close the vir tual keyboard. AlwaysOn: The virtual keyboard is automatically shown on screen as long as text can be entered in

an input field.

Example:

xConfiguration Video OSD VirtualKeyboard: UserSelecta ble

xConfiguration Video OSD EncryptionIndicator

Define for how long the encryption indicator (a padlock) will be shown on screen. The setting applies to both encr ypted and non-encr ypted calls, i.e. both to secure and non-secure conferences. The icon for encr ypted 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/AlwaysOn/AlwaysOff>

Auto: If the Conference Encryption Mode setting is set to BestEffort and the call is encrypted, the encryption indicator is shown during the first seconds of a call. If the Conference Encryption Mode setting is set to BestEffort and the call is non-encrypted, the crossed out encryption indicator is shown during the entire call. If the Conference Encr yption Mode setting is NOT set to BestEffort, 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.

AlwaysOff: The encryption indicator is never displayed on screen. This applies to both encrypted and non-encrypted calls for all Conference Encryption Mode settings.

Example:

xConfiguration Video OSD Encry ptionIndicator: Auto

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video OSD MissedCallsNotification

Determine whether or not the OSD (On Screen Display) shall display a missed calls notification 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 notification dialog box will appear on the Touch display, and not on the OSD.

Requires user role: ADMIN

Value space: <Off/O n>

Off: 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 notification of missed calls.

Example:

xConfiguration Video OSD MissedCallsNotifications: On

xConfiguration Video OSD AutoSelectPresentationSource

Determine if the presentation source should be automatically selected.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable automatic selection of the presentation source. On: Enable automatic selection of the presentation source.

Example:

xConfiguration Video OSD AutoSelectPresentationSource: Off

xConfiguration 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/O n>

Off: Do not display todays bookings. On: Displays information about this systems bookings on screen.

Example:

xConfiguration Video OSD TodaysBookings: Off

xConfiguration 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/O n>

Off: 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:

xConfiguration Video OSD MyContactsExpanded: Off

xConfiguration Video OSD Output

The Video OSD (On Screen Display) Output lets you define 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-configure the OSD Output. You can do this by entering a key sequence on the remote control, from the web inter face, 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 Configuration 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: xConfiguration Video OSD Output [1..2] (select the OSD Output)

Requires user role: ADMIN

Value space: <1/2>

Ran ge: Select 1 for HDMI output, or select 2 for DVI-I output.

Example:

xConfiguration Video OSD Output: 1

xConfiguration Video OSD InputMethod InputLanguage

The codec can be enabled for Cyrillic input characters in the menus on screen. NOTE: Requires that xConfiguration 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:

xConfiguration Video OSD InputMethod InputLanguage: Latin

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration 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/O n>

Off: 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:

xConfiguration Video OSD InputMethod Cyrillic: Off

xConfiguration 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 configurations changes and commands allowed by his Role.

Requires user role: ADMIN

Value space: <Off/O n>

Off: No login to the OSD is required. On: The user must log in to access the On Screen Display (OSD).

Example:

xConfiguration Video OSD LoginReq uired: Off

xConfiguration 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 port (USB port and RS-232 adapter).

Requires user role: ADMIN

Value space: <Off/O n>

Off: Capturing web snapshots is not allowed. On: Web snapshots can be captured and displayed on the web interface.

Example:

xConfiguration Video AllowWebSnapshots: Off

xConfiguration Video Output HDMI [1,2] RGBQuantizationRange

All devices with HDMI outputs should follow the rules for RGB video quantization range defined in CEA-861. Unfortunately some devices do not follow the standard and this configuration 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/Full/Limited>

Full: Full quantization range. The R, G, B quantization range includes all code values (0 - 255). This is defined 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 defined in CEA-861-E.

Example:

xConfiguration Video Output HDMI 1 RGBQuantizationRange: Full

xConfiguration Video Output HDMI [1,2] CEC Mode

The HDMI outputs support Consumer Electronics Control (CEC). When set to on (default is off), and the monitor connected to the HDMI output is CEC compatible and CEC is configured, 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 different manufacturers uses different 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, VIERA Link (Panasonic); EasyLink (Philips); and NetCommand for HDMI (Mitsubishi).

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable CEC control. On: Enable CEC control.

Example:

xConfiguration Video Output HDMI 1 CEC Mode: Off

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Output HDMI [1,2] MonitorRole

The HDMI monitor role describes which video stream will be shown on the monitor connected to the video output HDMI connector.

Requires user role: ADMIN

Value space: <First/Second/PresentationOnly>

First/Second: Define the role of the monitor in a multi-monitor setup. In a single-monitor setup, there is no difference between First and Second.

PresentationOnly: Show presentation video stream if active, and nothing else.

Example:

xConfiguration Video Output HDMI 1 MonitorRole: First

xConfiguration 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. Hig h: The system will not use the outer 6% of the output resolution None: The system will use all of the output resolution.

Example:

xConfiguration Video Output HDMI 1 OverscanLevel: None

xConfiguration 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.

Requires user role: ADMIN

Value space: <Auto/1024_768_60/1280_1024_60/1280_720_60/1920_1080_60/1280_768_60/13

60_768_60/1366_768_60>

Auto: The system will automatically try to set the optimal resolution based on negotiation with the connected monitor.

Ran ge: 1024x768@60p, 1280x1024@60p, 1280x720@60p, 1920x1080@60p, 1280x768@60p, 1360x768@60p, 1366x768@60p

Example:

xConfiguration Video Output HDMI 1 Resolution: Auto

xConfiguration 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:

xConfiguration Video Wallpaper: Sum mersky

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Experimental configuration

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.

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Chapter 4

xCommand commands

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Description of the xCommand commands

In this chapter, you can find 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

Audio commands .................................................................................................................................. 78

xCommand Audio Microphones Mute ........................................................................................................78

xCommand Audio Microphones Unmute ...................................................................................................78

xCommand Audio Sound Play .................................................................................................................... 78

xCommand Audio Sound Stop ................................................................................................................... 78

Bookings commands ............................................................................................................................ 79

xCommand Bookings Clear ........................................................................................................................80

xCommand Bookings List ...........................................................................................................................79

Boot commands .................................................................................................................................... 80

xCommand Boot .........................................................................................................................................80

Call commands ..................................................................................................................................... 81

xCommand Call Accept ..............................................................................................................................81

xCommand Call Disconnect .......................................................................................................................81

xCommand Call DisconnectAll ...................................................................................................................81

xCommand Call ExtendConference ...........................................................................................................82

xCommand Call Hold ..................................................................................................................................81

xCommand Call HoldAll ..............................................................................................................................83

xCommand Call Ignore ...............................................................................................................................83

xCommand Call Join ..................................................................................................................................82

xCommand Call Modify ..............................................................................................................................83

xCommand Call Reject ............................................................................................................................... 81

xCommand Call Resume ............................................................................................................................82

xCommand Call UnattendedTransfer .........................................................................................................82

xCommand CallLog Missed Dismiss ..........................................................................................................84

xCommand CallLog Outgoing Delete .........................................................................................................84

xCommand CallLog Received Delete .........................................................................................................84

xCommand CallLog Recent Delete ............................................................................................................83

CamCtrlPip commands ......................................................................................................................... 85

xCommand CamCtrlPip ..............................................................................................................................85

Camera commands ............................................................................................................................... 85

xCommand Camera PanTiltReset ...............................................................................................................85

xCommand Camera PositionActivateFromPreset ......................................................................................87

xCommand Camera PositionReset ............................................................................................................85

xCommand Camera PositionSet ................................................................................................................86

xCommand Camera Preset Activate ..........................................................................................................87

xCommand Camera Preset Edit .................................................................................................................87

xCommand Camera Preset List .................................................................................................................88

xCommand Camera Preset Remove ..........................................................................................................88

xCommand Camera Preset Store ..............................................................................................................88

xCommand Camera Ramp .........................................................................................................................86

xCommand Camera TriggerAutofocus .......................................................................................................87

Conference commands ........................................................................................................................ 89

xCommand Conference ActiveSpeaker Reset...........................................................................................89

xCommand Conference ActiveSpeaker Set ..............................................................................................89

xCommand Conference DoNotDisturb Activate ........................................................................................89

xCommand Conference DoNotDisturb Deactivate ....................................................................................89

CallLog commands ............................................................................................................................... 83

xCommand CallLog Clear...........................................................................................................................83

xCommand CallLog Missed Delete ............................................................................................................84

Dial commands ..................................................................................................................................... 90

xCommand Dial ..........................................................................................................................................90

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

DTMFSend commands..........................................................................................................................90

xCommand DTMFSend ..............................................................................................................................90

FacilityService commands .................................................................................................................... 91

xCommand FacilityService Dial ..................................................................................................................91

FarEndControl commands .................................................................................................................... 91

xCommand FarEndControl Camera Move..................................................................................................91

xCommand FarEndControl Camera Stop ...................................................................................................91

xCommand FarEndControl Preset Activate ................................................................................................92

xCommand FarEndControl Preset Store ....................................................................................................92

xCommand FarEndControl Source Select .................................................................................................92

HttpFeedback commands ..................................................................................................................... 93

xCommand HttpFeedback Deregister ........................................................................................................93

xCommand HttpFeedback Register ...........................................................................................................93

Key commands ..................................................................................................................................... 93

xCommand Key Click..................................................................................................................................93

xCommand Key Press ................................................................................................................................93

xCommand Key Release ............................................................................................................................94

Message commands ............................................................................................................................. 94

xCommand Message Alert Clear ...............................................................................................................94

xCommand Message Alert Display ............................................................................................................94

xCommand Message Echo ........................................................................................................................96

xCommand Message FarendMessage ......................................................................................................96

xCommand Message Prompt Clear ...........................................................................................................96

xCommand Message Prompt Display ........................................................................................................95

xCommand Message Prompt Response....................................................................................................96

xCommand Message TextLine Clear .........................................................................................................95

xCommand Message TextLine Display ......................................................................................................95

Phonebook commands ......................................................................................................................... 97

xCommand Phonebook Contact Add .........................................................................................................98

xCommand Phonebook Contact Delete .....................................................................................................99

xCommand Phonebook ContactMethod Add ............................................................................................99

xCommand Phonebook ContactMethod Delete ......................................................................................100

xCommand Phonebook ContactMethod Modify ......................................................................................100

xCommand Phonebook Contact Modify ....................................................................................................98

xCommand Phonebook Folder Add ...........................................................................................................97

xCommand Phonebook Folder Delete .......................................................................................................97

xCommand Phonebook Folder Modify .......................................................................................................97

xCommand Phonebook Search ...............................................................................................................101

Presentation commands ..................................................................................................................... 102

xCommand Presentation Start ................................................................................................................. 102

xCommand Presentation Stop .................................................................................................................102

Preset commands ............................................................................................................................... 102

xCommand Preset Activate ......................................................................................................................102

xCommand Preset Clear ..........................................................................................................................103

xCommand Preset Store ..........................................................................................................................102

Provisioning commands ...................................................................................................................... 103

xCommand Provisioning CompleteUpgrade ............................................................................................103

xCommand Provisioning CUCM CAPF OperationStart ............................................................................104

xCommand Provisioning CUCM CTL Delete ............................................................................................104

xCommand Provisioning PostponeUpgrade ............................................................................................103

xCommand Provisioning StartUpgrade ....................................................................................................103

Security commands ............................................................................................................................ 104

xCommand Security FIPSMode Activate .................................................................................................104

Standby commands ............................................................................................................................ 105

xCommand Standby Activate ...................................................................................................................105

xCommand Standby Deactivate ...............................................................................................................105

xCommand Standby ResetTimer ..............................................................................................................105

SystemUnit commands ....................................................................................................................... 10 5

xCommand SystemUnit AdminPassword Set ..........................................................................................106

xCommand SystemUnit ConfigurationProfile CancelChange ..................................................................108

xCommand SystemUnit ConfigurationProfile Change .............................................................................108

xCommand SystemUnit ConfigurationProfile List ....................................................................................108

xCommand SystemUnit ConfigurationProfile Remove ............................................................................108

xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs ...........................................108

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand SystemUnit DateTime Get .....................................................................................................107

xCommand SystemUnit DateTime Set .....................................................................................................107

xCommand SystemUnit Diagnostics Run .................................................................................................106

xCommand SystemUnit FactoryReset .....................................................................................................107

xCommand SystemUnit MenuPassword Set ...........................................................................................106

xCommand SystemUnit MenuPassword Validate ....................................................................................106

xCommand SystemUnit Notifications RemoveAll ....................................................................................108

xCommand SystemUnit OptionKey Add...................................................................................................105

xCommand SystemUnit OptionKey RemoveAll ........................................................................................105

xCommand SystemUnit ReleaseKey Add ................................................................................................105

xCommand SystemUnit ReleaseKey List .................................................................................................109

xCommand SystemUnit ReleaseKey RemoveAll ......................................................................................106

xCommand SystemUnit SoftwareUpgrade ..............................................................................................107

Video commands ................................................................................................................................ 109

xCommand Video Layout SetPresentationView .......................................................................................109

xCommand Video OSD Close .................................................................................................................. 110

xCommand Video PictureLayoutSet ........................................................................................................109

xCommand Video PIP ActiveSpeaker Set ................................................................................................ 11 0

xCommand Video PIP Presentation Set ................................................................................................... 11 0

xCommand Video PIP Presentation Set ................................................................................................... 111

xCommand Video PreviewFilmstrip Set ................................................................................................... 111

xCommand Video Selfview Set ................................................................................................................ 111

Experimental commands ..................................................................................................................... 112

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Audio commands

xCommand Audio Microphones Mute

Mute all microphones.

Requires user role: USER

Example:

xCom mand Audio Microphones Mute

*r AudioMicrophonesMuteResult (status=OK):

** end

xCommand Audio Microphones Unmute

Unmute microphones.

Requires user role: USER

Example:

xCom mand Audio Microphones Un mute

*r AudioMicrophonesUnmuteResult (status=OK):

** end

xCommand Audio Sound Play

Play a specified audio sound.

Requires user role: USER

Parameters:

Sound(r): <Busy/CallWaiting/Dial/KeyTone/Ringing/SpecialInfo/TelephoneCall/VideoCall> Loop: <On/Off>

Example:

xCom mand Audio Sound Play Sound: Ringing

*r AudioSoundPlayResult (status=OK):

** end

xCommand Audio Sound Stop

Stop playing audio sound.

Requires user role: USER

Example:

xCom mand Audio Sound Stop

*r AudioSoundStopResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Bookings commands

xCommand Bookings List

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 DayOffset = 0.

Days: Number of days to retrieve bookings from. DayOffset: Which day to start the search from (today: 0, tomorrow: 1…). Limit: Max number of bookings to list. Offset: Offset number of bookings for this search.

Requires user role: USER

Parameters:

Days: <1..365> DayOffset: <0..365> Limit: <1..65534> Offset: <0..65534>

Example:

Example 1 (One booking in list)

xCom mand Bookings List

*r Bookings ResultInfo TotalRows: 1

*r Bookings LastUpdated: "2011-09-02T11:19:01Z"

*r Bookings Booking 1 Id: "273"

*r Bookings Booking 1 Title: "Sales meeting"

*r Bookings Booking 1 Agenda: "Describe this com ma nd"

*r Bookings Booking 1 Privacy: Public

*r Bookings Booking 1 Organizer FirstName: "Ola"

*r Bookings Booking 1 Organizer LastNa me: "Normann"

*r Bookings Booking 1 Organizer Email: "ola.norma nn@domain.com"

*r Bookings Booking 1 Time StartTime: "2011-09-02T13:00:00Z"

*r Bookings Booking 1 Time StartTimeBuffer: 600

*r Bookings Booking 1 Time EndTime: "2011-09-02T13:30:00Z"

*r Bookings Booking 1 Time EndTimeBuffer: 0

*r Bookings Booking 1 Maximum MeetingExtension: 30

*r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed

*r Bookings Booking 1 BookingStatus: OK

*r Bookings Booking 1 BookingStatusMessage: ""

*r Bookings Booking 1 Web ex Ena bled: True

*r Bookings Booking 1 Web ex Url: "http://webex.url"

*r Bookings Booking 1 Web ex MeetingNumber: "webexNum ber@cisco.co m"

*r Bookings Booking 1 Web ex Password: ""

*r Bookings Booking 1 Web ex HostKey: ""

*r Bookings Booking 1 Web ex DialInNu mbers DialInNum ber 1 Ty pe: TollFree

*r Bookings Booking 1 Web ex DialInNu mbers DialInNum ber 1 Nu mber: "+1 987 65 4 321"

*r Bookings Booking 1 Web ex DialInNu mbers DialInNum ber 2 Ty pe: Toll

*r Bookings Booking 1 Web ex DialInNu mbers DialInNum ber 2 Nu mber: "+1 987 654322"

*r Bookings Booking 1 InteropBridge Nu m ber: ""

*r Bookings Booking 1 InteropBridge ConferenceId: ""

*r Bookings Booking 1 ManualCallIn Num ber: ""

*r Bookings Booking 1 ManualCallIn ConferenceId: ""

*r Bookings Booking 1 ManualCallIn ConferencePassword: ""

*r Bookings Booking 1 Encryption: BestEffort

*r Bookings Booking 1 Role: Slave

*r Bookings Booking 1 Recording: Disabled

*r Bookings Booking 1 DialInfo Calls Call 1 Num ber: "91123456;conferenceid =21 0017 056 9"

*r Bookings Booking 1 DialInfo Calls Call 1 Protocol: SIP

*r Bookings Booking 1 DialInfo Calls Call 1 CallRate: 3000

*r Bookings Booking 1 DialInfo Calls Call 1 CallType: Video

*r Bookings Booking 1 DialInfo ConnectMode: OBTP

** end

Example 2 (When no bookings have been received, or after all bookings have been removed by the com mand xCom mand Bookings Clear)

xCom mand Bookings List

*r Bookings Error: "No bookings found."

*r Bookings ResultInfo TotalRows: 0

*r Bookings LastUpdated: Never

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Bookings Clear

Clear the current stored list of bookings.

Requires user role: USER

Example:

xCom mand Bookings Clear

** end

Boot commands

xCommand Boot

Reboot system. Action: As a default the system restarts after a reboot. By selecting Shutdown, the system will not

restart.

Requires user role: USER

Parameters:

Action: <Restart/Shutdown>

Example:

xCommand Boot

*r BootResult (status=OK):

** end

CUIL reboot request, restarting

Connection closed by foreign host.

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Call commands

xCommand Call Accept

Accept an incoming call. If no CallId is specified, 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): <Au di o/ Video>

Example:

xCom mand Call Accept CallId:19

*r CallAcceptResult (status=OK):

** end

xCommand Call Reject

Reject incoming call. If no call id is specified, 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

*r CallRejectResult (status=OK):

** end

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:

xCommand Call Disconnect CallId:17

*r DisconnectCallResult (status=OK):

** end

xCommand Call DisconnectAll

Disconnect all active calls.

Requires user role: USER

Example:

xCom mand Call Discon nectAll

*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> Reason(o): <Conference/Transfer/Other>

Example:

xCom mand Call Hold CallId:19

*r CallHoldResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Call Join

Join all existing calls, active and on hold. For this command to work, you have to configure Multiway™ first, see xConfiguration NetworkServices MultiWay Address and xConfiguration Conference 1 Multipoint Mode.

Requires user role: USER

Parameters:

CallId(r): <0..65534>

Example:

xCom mand Call Join

*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

*r CallResumeResult (status=OK):

** end

xCommand Call ExtendConference

Request to extend the conference for the call with the specified 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:

xCommand Call ExtendConference CallId: 1

*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 suppor ted 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 Num ber: destination@exam ple. com

*r TransferUriResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Call HoldAll

Puts all ongoing calls on hold.

Requires user role: USER

Parameters:

Reason(0): <Conference/Transfer/Other>

Example:

xCom mand Call HoldAll

xCommand Call Ignore

Turns off the ringtone for the incoming call. The call can still be answered.

Requires user role: USER

Parameters:

CallId(r): <0..65534>

Example:

xCom mand Call Ignore CallId: 22

*r IgnoreResult (status=OK):

** end

xCommand Call Modify

Modifies the call type of the current call, to either an audio call or a video call. Not in use in this software version.

Requires user role: USER

Parameters:

CallId(r): <0..65534> CallType(r): <Audio/Video>

Example:

xCom mand Call Modify CallType: Audio CallId: 16

*r CallModifyResult (status=Error):

Reason: Callesc alation not enable d

** end

CallLog commands

xCommand CallLog Clear

Clear call logs stored in the system. If a logtag is given as argument, that specific 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..214748 3 647>

Example:

xCommand 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 specific 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 xHistor y CallLog Recent command.

Requires user role: USER

Parameters:

Lo gTa g: <0..214748 3 647>

Example:

xCom mand CallLog Recent Delete

*r DeleteResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand CallLog Outgoing Delete

Delete the call log of outgoing calls. If a logtag is given as argument, that specific 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 xHistory CallLog Outgoing command.

Requires user role: USER

Parameters:

Lo gTa g: <0..214748 3 647>

Example:

xCom mand CallLog Outgoing Delete LogTag:202

*r DeleteResult (status=OK):

** end

xCommand CallLog Received Delete

Delete the call log of received calls. If a logtag is given as argument, that specific 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 xHistory CallLog Received command.

Requires user role: USER

Parameters:

Lo gTa g: <0..214748 3 647>

Example:

xCom mand CallLog Received Delete LogTag:126

*r DeleteResult (status=OK):

** end

xCommand CallLog Missed Dismiss

Review the call log of dismissed calls. If a logtag is given as argument, that specific 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..214748 3 647>

Example:

xCom mand CallLog Missed Dimissed LogTag:119

*r DismissResult (status=OK):

** end

xCommand CallLog Missed Delete

Delete the call log of missed calls. If a logtag is given as argument, that specific 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..214748 3 647>

Example:

xCom mand CallLog Missed Delete LogTag:119

*r DeleteResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

CamCtrlPip commands

xCommand CamCtrlPip

Show or hide the camera self-view in a small window (picture in picture). Mode: Select whether the self-view picture in picture is on or off. Duration: Set how long the self-view is shown for on screen.

Requires user role: USER

Parameters:

Mode(r): <On/O ff> Duration: <0..60>

Example:

xCom mand CamCtrlPip Mode: On

*r CamCtrlPipResult (status=OK):

** end

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 CameraId:1

*r PanTiltResetResult (status=OK):

** end

xCommand Camera PositionReset

Reset the camera position the the default position.

Requires user role: USER

Parameters:

CameraId(r): <1..1>

Example:

xCom mand Camera PositionReset CameraId:1

*r CameraPositionResetResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Camera PositionSet

Position the camera by defining 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.

Requires user role: USER

Parameters:

CameraId(r): <1..1> Pan: <-65535..65535> Tilt: <-65535..65535> Zoom: <0..65535> Focus: <0..65535>

Example:

xCom mand Camera PositionSet CameraId:1 Pan:200 Tilt:300

*r CameraPositionSetResult (status=OK):

** end

xCommand Camera Ramp

Move the camera in a specified direction. The camera moves at specified 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 first operation specified 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 speed. Tilt: Move the camera Up or Down, followed by Stop. TiltSpeed: Set the tilt speed. Zoom: Zoom the camera In or Out, followed by Stop. ZoomSpeed: Set the zoom speed. Focus: Focus the camera Far or Near, followed by Stop.

Requires user role: USER

Parameters:

CameraId(r): <1..1> Pan: <Left/Right/Stop> Pa nSp eed: <1..15> Tilt: <Down/Up/Stop> Ti ltS peed: <1..15> Zoom: <In/Out/Stop> Zoom Spee d: <1..15> Focus: <Far/Near/Stop>

Example:

xCom mand Camera Ra mp CameraId:1 Pan:left PanSpeed:1

*r RampResult (status=OK):

** end

xCom mand Camera Ra mp CameraId:1 Pan:stop

*r RampResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Camera TriggerAutofocus

Trigger the auto-focus functionalit y. The camera must support auto-focus 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:

xCommand Ca mera TriggerAutofocus CameraId:1

*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

*r PositionActivateFromPresetResult (status=OK):

** end

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

*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.

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

Preset List command.

Requires user role: ADMIN

Parameters:

PresetId(r): <1..35> ListPosition: <1..35> Name: <S: 0, 255>

Example:

xCom mand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: ""

*r CameraPresetEditResult (status=OK)

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

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 specified preset.

Requires user role: USER

Parameters:

PresetId: <1..35>

Example:

xCom mand Camera Preset List PresetId: 1

*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 Re move PresetId: 1

*r CameraPresetRemoveResult (status=OK)

** end

xCommand Camera Preset Store

Store the current position of the chosen camera. The camera is identified 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 Preset List command.

Requires user role: ADMIN

Parameters:

PresetId: <1..35> CameraId (r): <1..1> ListPosition: <1..35> Name: <S: 0, 255>

Example:

xCom mand Camera Preset Store PresetId: 1 CameraId: 1 ListPosition: 1 Name “”

*r CameraPresetStoreResult (status=OK)

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

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 off again. It only takes effect when xConfiguration 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 off. If not set, Do Not Disturb times out after 1440 minutes (24 hours).

Requires user role: USER

Parameters:

Timeout: <0..1440>

Example:

xCommand Conference DoNotDisturb Activate

*r ActivateResult:

** end

xCommand Conference DoNotDisturb Deactivate

This command switches off the Do Not Disturb mode. This command only takes effect when xConfiguration Conference DoNotDisturb Mode is set to Timed. When Do Not Disturb is switched off incoming calls come through as normal.

Requires user role: USER

Example:

xCommand Conference DoNotDisturb Deactivate

*r DeactivateResult:

** end

xCommand Conference ActiveSpeaker Set

For manually setting the active speaker in a conference. Overrides normal voice switching. Target: Identifies local or remote participant. CallId: Identifies 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:

Exa m ple 1

xCom mand Conference ActiveSpeaker Set Target: local

*r ConferenceActiveSpeakerSetResult (status=OK):

** end

Example 2

xCom mand Conference ActiveSpeaker Set Target: remote CallID: 3

*r ConferenceActiveSpeakerSetResult (status=OK):

** end

xCommand Conference ActiveSpeaker Reset

Resets ActiveSpeaker. Normal voice switching is switched back on.

Requires user role: USER

Example:

xCommand Conference ActiveSpeaker Reset

*r ConferenceActiveSpeakerResetResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

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 identifier 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 identifier 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.

Requires user role: USER

Parameters:

Number(r): <S: 0, 255> Protocol: <H320/H323/Sip> CallRate: <64..6000> CallType: <Audio/Video> BookingId: <S: 0, 255> Appearance(o): <1..999999999>

Example:

xCom mand Dial Numb er:543210 Protocol:h323

*r DialResult (status=OK):

CallId: 2

ConferenceId: 1

** end

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:

xCommand DTMFSend CallId:2 DTMFString:1234

*r DTMFSendResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

FacilityService commands

xCommand FacilityService Dial

Dial out from the system to a facility ser vice. A maximum of five facility services can be defined; which one of these five to dial to is identified by the ServiceId (ref. xConfiguration Facility Service [ServiceId] Type/Name/Number/CallType). The command returns information about the CallId and ConferenceId.

ServiceId: The identifier of the facility service.

Requires user role: USER

Parameters:

ServiceId(r): <1..5>

Example:

xCom mand FacilityService Dial Ser viceId: 1

*r FacilityServiceDialResult (status=OK):

CallId: 2

ConferenceId: 1

** end

FarEndControl commands

xCommand FarEndControl Camera Move

Move the far end camera (the remote camera). NOTE: The far end camera moves in the specified 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.

Requires user role: USER

Parameters:

CallId: <0..65534> Value(r): <Left/Right/Up/Down/ZoomIn/ZoomOut>

Example:

xCommand 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:

xCommand FarEndControl Camera Stop CallId:3

*r FECCMoveResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

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 xConfiguration 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:

xCommand 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 xConfiguration Conference FarEndControl Mode setting must be switched On for the FarEndControl commands to work.

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:

xCommand FarEndControl Preset Store CallId:3 PresetId:1

*r FECCPresetStoreResult (status=OK):

** end

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

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

HttpFeedback commands

xCommand HttpFeedback Register

Register the system to a HTTP(S) server to return XML feedback over HTTP(S) to specific URLs. FeedbackSlot: You can have from 1 to 4 slots for feedback. ServerUrl: Define the URL for the HTTP(S) server. Expression[1..15]: What parts of the Status and Configuration XML documents to monitor are

specified by XPath expressions. You can have from 1 to 15 XPath expressions.

Requires user role: USER

Parameters:

FeedbackSlot: <1..4> ServerUrl(r): <S: 1, 2048> Expression[1..15]: <S: 1, 255>

Example:

xCom mand HttpFeedback Register FeedbackSlot:1 ServerUrl:10.47.19.41 Expression[1]:Status/Video Expression[2]:Status/Audio Expression[3]:Status/ Call Expression[4]:Status/Conference

*r FeedbackRegisterResult (status=OK):

FeedbackSlot: 1

** end

xCommand HttpFeedback Deregister

Deregister XML feedback over HTTP(S).

Requires user role: USER

Parameters:

FeedbackSlot(r): <1..4>

Example:

xCommand HttpFeedback Deregister FeedbackSlot:1

*r FeedbackDeregisterResult (status=OK):

FeedbackSlot: 1

** end

Key commands

xCommand Key Click

Emulates a remote control key press, followed by a key release.

Requires user role: ADMIN

Parameters:

Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/ Left/Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/ SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut>

Example:

xCom mand Key Click Key:Down

*r KeyClickResult (status=OK):

** end

xCommand Key Press

Emulates a remote control key press without releasing it. The Key Press command must be followed by a Key Release command to emulate releasing the key.

Requires user role: ADMIN

Parameters:

Example:

xCom mand Key Press Key:Home

*r KeyPressResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Key Release

Emulates a remote control key release. The Key Release command is issued after a Key Press command.

Requires user role: ADMIN

Parameters:

Example:

xCom mand Key Release Key:Home

*r KeyReleaseResult (status=OK):

** end

Message commands

xCommand Message Alert Display

Display a message on screen, for a specified 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. The and HTML tags will result in line breaks as

normal; any other tags will appear as plain text. 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.

Requires user role: ADMIN

Parameters:

Title: <S: 0, 255> Text(r): <S: 0, 255> Duration: <0..3600>

Example:

xCom mand Message Alert Display Title: "Message" Text: "The meeting will end in 5 minutes." Duration: 20

*r MessageAlertDisplayResult (status=OK):

** end

xCommand Message Alert Clear

Remove the message which was displayed using the xCommand Message Alert Display command. This is required when the Duration parameter is not set.

Requires user role: ADMIN

Example:

xCom mand Message Alert Clear

*r MessageAlertClearResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Message TextLine Display

Display a text line on screen. Optionally you can place the text line at a specified location and for a specified duration of time (in seconds). NOTE: If Duration is not set, the command must be followed by xCommand Message TextLine Clear.

Text: Enter the text line to be displayed. The and HTML tags will result in line breaks as normal; any other tags will appear as plain text.

X: Enter the X-coordinate (horizontal) on screen. X=0 is in the upper left corner. Y: Enter the Y-coordinate (vertical) on screen. Y=0 is in the upper left corner. Duration: Set how long (in seconds) the text line is to be displayed on the screen. If set to 0 (zero)

the text line is displayed until a xCommand Message TextLine Clear command has been sent.

Requires user role: ADMIN

Parameters:

Text(r): <S: 0, 140> X: <1..10000> Y: <1..10000> Duration: <0..3600>

Example:

xCom mand Message TextLine Display Text: "The message to be displayed." X:500 Y:2000 D uration: 20

*r MessageTextLineDisplayResult (status=OK):

** end

xCommand Message TextLine Clear

Clears the text line which was defined by the xCommand Message TextLine Display command.

Requires user role: ADMIN

Example:

xCom mand Message TextLine Clear

*r MessageTextLineClearResult (status=OK):

** end

xCommand Message Prompt Display

Display a small window on screen with a title, text and up to five 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 text line to be displayed. The and HTML tags will result in line breaks as

normal; any other tags will appear as plain text. FeedbackId: To identify the feedback enter a FeedbackId. Option.1 to Option.5: Enter the text to appear on the feedback options.

Requires user role: ADMIN

Parameters:

Title: <S: 0, 255> Text(r): <S: 0, 255> FeedbackId: <S: 0, 255> Option.1: <S: 0, 255> Option.2: <S: 0, 255> Option.3: <S: 0, 255> Option.4: <S: 0, 255> Option.5: <S: 0, 255>

Example:

xCom mand Message Prompt 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"

*r MessagePromptDisplayResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

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 Prompt Clear

*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 Prompt Response OptionId: 1

*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"

xCommand Message FarendMessage

This command is used to send generic messages to the participants in a conference. Not in use in this software version.

CallId: The remote participant to whom the message needs to be sent. Type: Type of the message. Text: Enter the text line to be displayed.

Requires user role: ADMIN

Parameters:

CallId(o): <0..65534> Type(r): <S: 0, 255> Text(r): <S: 1, 1450> Loc alEcho(o): <On/Off >

Example:

xCom mand Message Farend Message CallId: 3 Type: 3 Text: Hello

*r FarendMessageResult (status=Error):

Reason: Generic Message mode not enabled

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Phonebook commands

xCommand Phonebook Folder Add

Phonebook entries can be stored in folders. Use this command to add a folder to the local phonebook. The command returns the FolderId, which is a unique string that identifies the folder; typically the format is “localGroupId-n”.

Name(r): The name of the folder. ParentFolderId: The unique identifier for the parent folder. The identifier will be returned by an

xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the parent folder.

Requires user role: ADMIN

Parameters:

Name(r): <S: 0, 255> ParentFolderId: <S: 0, 255>

Example:

xCom mand Phonebook Folder Add Na me: "New York Office"

*r PhonebookFolderAddResult (status=OK):

Name: localGroupId-3

** end

xCommand Phonebook Folder Modify

Modify an existing phonebook folder. FolderId: The unique identifier for the folder. The identifier will be returned by an xCommand

Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder.

Name(r): The name of the contact. ParentFolderId: The unique identifier for the parent folder. The identifier will be returned by an

xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the parent folder.

Requires user role: ADMIN

Parameters:

FolderId(r): <S: 0, 255> Name: <S: 0, 255> ParentFolderId: <S: 0, 255>

Example:

xCom mand Phonebook Folder Modify FolderId:localGroupId-3 Name: "New York Head Office"

*r PhonebookFolderModifyResult (status=OK):

** end

xCommand Phonebook Folder Delete

Delete an existing folder from the local phonebook. FolderId: The unique identifier for the folder. The identifier will be returned by an xCommand

Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder.

Requires user role: ADMIN

Parameters:

FolderId(r): <S: 0, 255>

Example:

xCom mand Phonebook Folder Delete FolderId:localGroupId-3

*r PhonebookFolderDeleteResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Phonebook Contact Add

Add a new contact to the local phonebook. The command returns the ContactId, which is a unique string that identifies the contact; typically the format is “localContactId-n”.

You can add several contact methods to a contact using the xCommand Phonebook ContactMethod Add command. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in the API, on the web interface and when using the remote control.

Name: The name of the contact. FolderId: The unique identifier for the folder that you want to store the contact in. The identifier

will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder.

ImageURL: Currently not in use. 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.

Requires user role: ADMIN

Parameters:

Name(r): <S: 0, 255> FolderId: <S: 0, 255> ImageURL: <S: 0, 255> Title: <S: 0, 255> Number: <S: 0, 255> Protocol: <Auto/H320/H323/SIP> CallRate: <0..6000> CallType: <Audio/Video> Device: <Mobile/Other/Telephone/Video>

Example:

xCom mand Phonebook Contact Add Name: "John Doe" Num ber:12345

*r PhonebookContactAdd Result (status=OK):

Name: localContactId-1

** end

xCommand Phonebook Contact Modify

Modify contact details of an existing contact in the local phonebook. The following parameters can be changed using this command: Name, FolderId, ImageURL and Title. You must use the xCommand Phonebook ContactMethod Modify command to change the other parameters: Number, Protocol, CallRate, CallType and Device.

ContactId: The unique identifier for the contact you want to modif y. The identifier will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Contact Add command was issued to make the contact.

Name: The name of the contact. FolderId: A unique identifier for the folder. The identifier will be returned by an xCommand

Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued.

ImageURL: Currently not in use. Title: The title of the contact.

Requires user role: ADMIN

Parameters:

ContactId(r): <S: 0, 255> Name: <S: 0, 255> FolderId: <S: 0, 255> ImageURL: <S: 0, 255> Title: <S: 0, 255>

Example:

xCom mand Phonebook Contact Modify ContactId:localContactId-1 Name: "John Doe - office"

*r PhonebookContactModifyResult (status=OK):

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Phonebook Contact Delete

Delete an existing contact from the local phonebook. ContactId: The unique identifier for the contact. The identifier will be returned by an xCommand

Phonebook Search command. It was also returned when the xCommand Phonebook Contact Add command was issued to make the contact.

Requires user role: ADMIN

Parameters:

ContactId(r): <S: 0, 255>

Example:

xCommand Phonebook Contact Delete ContactId:localContactId-1

*r PhonebookContactDeleteResult (status=OK):

** end

xCommand Phonebook ContactMethod Add

Add contact details for an existing contact in the local phonebook. The command returns the ContactMethodId, which is a unique string that identifies the contact method; typically the format is “n”.

You can add several contact methods to a contact. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact method may have been created when issuing the xCommand Phonebook Contact Add command to make the contact. All contact methods are available in the API, on the web interface and when using the remote control.

ContactId: The unique identifier for the contact that you want to add a contact method to. The identifier will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Contact Add command was issued to make the contact.

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).

Requires user role: ADMIN

Parameters:

ContactId(r): <S: 0, 255> Device: <Mobile/Other/Telephone/Video> Number(r): <S: 0, 255> Protocol: <Auto/H320/H323/SIP> CallRate: <0..6000> CallType: <Audio/Video>

Example:

xCommand Phonebook ContactMethod Add ContactId:localContactId-2 Number:54321 Protocol:H323

*r PhonebookContactMethodAddResult (status=OK):

Na m e: 1

** end

Cisco TelePresence SX20 Codec API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Phonebook ContactMethod Modify

Modify details about the contact method for an existing contact in the local phonebook. ContactId: The unique identifier for the contact. The identifier will be returned by an xCommand

Phonebook Search command. It was also returned when the xCommand Phonebook Contact Add command was issued to make the contact.

ContactMethodId: The unique identifier for the contact method you want to modify. The identifier will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook ContactMethod Add or xCommand Phonebook Contact Add commands were issued to make the contact method.

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).

Requires user role: ADMIN

Parameters:

ContactId(r): <S: 0, 255> ContactMethodId(r): <S: 0, 255> Device: <Mobile/Other/Telephone/Video> Number: <S: 0, 255> Protocol: <Auto, H320/H323/SIP> CallRate: <0..6000> CallType: <Audio/Video>

Example:

xCom mand Phonebook ContactMethod Modify ContactMethodId:117 ContactId:localContactId-10 Number:"newnumber@cisco.com"

xCommand Phonebook ContactMethod Delete

Delete a contact method from an existing contact in the local phonebook. ContactId: The unique identifier for the contact you want to change. The identifier will be returned

by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Contact Add command was issued to make the contact.

ContactMethodId: The unique identifier for the contact method you want to delete. The identifier will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook ContactMethod Add command was issued to make the contact method.

Requires user role: ADMIN

Parameters:

ContactId(r): <S: 0, 255> ContactMethodId(r): <S: 0, 255>

Example:

xCommand Phonebook ContactMethod Delete ContactId:localContactId-2 ContactMethodId:1

*r PhonebookContactMethodDeleteResult (status=OK):

** end

Cisco TelePresence SX20 Codec Reference Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Introduction

About this guide

User documentation

Software release notes

Software download

New features and improvements

xConfiguration changes

xCommand changes

xStatus changes

About the API

API fundamentals

Connecting to the API

RS-232/serial connection

Telnet

HTTP/HTTPS

Password

API output

The output modes

Using the command line

API commands

Other commands

Command line shortcuts

Searching

Value types and formats

Commands

Configurations

Status

Events

Call history

Feedback mechanism

Feedback expressions

Terminal connections

Using HTTP

Getting status and configurations

Sending commands and configurations

Using HTTP POST

Feedback from codec over HTTP

Registering for feedback

Translating from terminal mode to XML

Dos and don’ts

xConfiguration commands

Description of the xConfiguration commands

Audio configuration

xConfiguration Audio Input HDMI [1] Mode

xConfiguration Audio Microphones Mute Enabled

xConfiguration Audio SoundsAndAlerts RingTone

xConfiguration Audio SoundsAndAlerts RingVolume

xConfiguration Audio Volume

xConfiguration Audio SoundsAndAlerts KeyTones Mode

Cameras configuration

xConfiguration Cameras PowerLine Frequency

xConfiguration Cameras Camera [1..1] Backlight

xConfiguration Cameras Camera [1..1] Brightness Mode

xConfiguration Cameras Camera [1..1] Brightness Level

xConfiguration Cameras Camera [1..1] Flip

xConfiguration Cameras Camera [1..1] Focus Mode

xConfiguration Cameras Camera [1..1] Gamma Mode

xConfiguration Cameras Camera [1..1] Gamma Level

xConfiguration Cameras Camera [1..1] IrSensor

xConfiguration Cameras Camera [1..1] Mirror

xConfiguration Cameras Camera [1..1] MotorMoveDetection

xConfiguration Cameras Camera [1..1] Whitebalance Mode

xConfiguration Cameras Camera [1..1] Whitebalance Level

xConfiguration Cameras Camera [1..1] DHCP

Conference configuration

xConfiguration Conference [1..1] CallProtocolIPStack

xConfiguration Conference [1..1] LyncCompatibility

xConfiguration Conference [1..1] AutoAnswer Mode

xConfiguration Conference [1..1] AutoAnswer Mute

xConfiguration Conference [1..1] AutoAnswer Delay

xConfiguration Conference [1..1] MicUnmuteOnDisconnect Mode

xConfiguration Conference [1..1] DoNotDisturb Mode

xConfiguration Conference [1..1] DoNotDisturb DefaultTimeout

xConfiguration Conference [1..1] FarEndControl Mode

xConfiguration Conference [1..1] FarEndControl SignalCapability

xConfiguration Conference [1..1] Encryption Mode