Cisco TelePresence SX80 Reference Manual

Download

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Software version TC7.3 OCTOBER 2015

Application Programmer Interface (API)

Reference Guide

Cisco TelePresence SX80

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Contents

What’s in this guide?

The top menu bar and the entries in the table

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

TA - ToC - Hidden

We recommend you visit our web site

text anchor

regularly for updated versions of the user documentation.

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

Table of Contents

Introduction ..........................................................................4

About this guide ...................................................................... 5

User documentation .............................................................5

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

Software release notes ........................................................ 6

New features and improvements ......................................... 6

System configuration changes .............................................7

System command changes..................................................8

System status changes ........................................................9

About the API ...................................................................... 10

API fundamentals .................................................................. 11

Connecting to the API ........................................................ 11

Password ........................................................................... 11

RS-232/serial connection .................................................. 11

Tel n et .................................................................................. 11

SSH .................................................................................... 11

HTTP/HTTPS ...................................................................... 11

Ethernet port ...................................................................... 11

API output .............................................................................12

The output modes .............................................................. 12

Using the command line ....................................................... 13

API commands ...................................................................13

Other commands ...............................................................13

Command line shortcuts ....................................................13

Searching ........................................................................... 14

Value types and formats .................................................... 14

Commands ........................................................................... 15

Configurations ......................................................................16

Status .................................................................................... 17

Events ................................................................................... 18

Feedback mechanism...........................................................19

Feedback expressions ....................................................... 19

Terminal connections .........................................................20

Using HTTP ........................................................................... 21

Getting status and configurations ...................................... 21

Sending commands and configurations.............................21

Using HTTP POST .............................................................. 21

Feedback from codec over HTTP ........................................ 22

Registering for feedback ....................................................22

Translating from terminal mode to XML..............................23

Dos and don’ts ...................................................................... 24

xConfiguration commands ..................................................25

Description of the xConfiguration commands ......................26

Audio configuration ............................................................ 31

Cameras configuration .......................................................36

Conference configuration ..................................................40

FacilityService configuration ..............................................44

GPIO configuration .............................................................45

H323 configuration .............................................................45

Logging configuration ........................................................48

Network configuration ........................................................48

NetworkServices configuration ..........................................55

Peripherals configuration ...................................................59

Phonebook configuration ...................................................60

Provisioning configuration ..................................................60

RTP configuration ............................................................... 62

Security configuration ........................................................ 63

SerialPort configuration ...................................................... 64

SIP configuration ................................................................65

Standby configuration ........................................................69

SystemUnit configuration ...................................................70

Time configuration .............................................................. 71

UserInterface configuration ................................................73

Video configuration ............................................................ 74

Experimental configuration ................................................ 82

xCommand commands .......................................................83

Description of the xCommand commands ...........................84

Audio commands ...............................................................88

Bookings commands .......................................................... 97

Boot commands .................................................................99

Call commands ..................................................................99

CallHistory commands ..................................................... 101

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Contents

CamCtrlPip commands .................................................... 103

Camera commands ..........................................................103

Cameras commands ........................................................ 107

Conference commands ....................................................108

Dial commands.................................................................109

DTMFSend commands ..................................................... 110

FacilityService commands ............................................... 110

FarEndControl commands ................................................111

GPIO commands .............................................................. 112

HttpFeedback commands ................................................ 11 3

Key commands ................................................................. 113

Logging commands ......................................................... 114

Message commands ........................................................ 114

Peripherals commands .....................................................117

Phonebook commands .................................................... 119

Presentation commands ..................................................123

Preset commands ............................................................124

Provisioning commands ................................................... 125

Security commands .........................................................126

Standby commands ......................................................... 127

SystemUnit commands ....................................................128

UserInterface commands .................................................130

UserManagement commands .......................................... 131

Video commands ............................................................. 132

Experimental commands ................................................. 141

xStatus commands ........................................................... 142

Description of the xStatus commands ...............................143

Audio status ...................................................................... 151

Call status .........................................................................154

Camera status .................................................................. 157

Cameras status ................................................................160

Conference status ............................................................ 161

Diagnostics status ............................................................168

GPIO status ......................................................................17 2

H320 status ...................................................................... 173

H323 status ...................................................................... 174

HttpFeedback status ........................................................17 5

ICE status .........................................................................17 5

Logging status ..................................................................178

MediaChannels status ...................................................... 178

Network status ................................................................. 191

NetworkServices status ................................................... 195

Peripherals status.............................................................196

Preset status .................................................................... 197

Provisioning status ...........................................................198

Security status .................................................................204

SIP status .........................................................................206

Standby status .................................................................208

SystemUnit status ............................................................209

Time status ....................................................................... 215

UserInterface status ......................................................... 215

Video status......................................................................216

Experimental status ..........................................................225

Appendices.......................................................................226

About startup scripts .......................................................... 227

The SystemTools commands ..............................................228

About disconnect cause types ...........................................230

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Introduction

Chapter 1

Introduction

Cisco TelePresence SX80 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 SX80

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)

• Quick reference guides for the TelePresence systems

• Administrator guides for the TelePresence systems

• Camera user guide for the PrecisionHD cameras

• API reference guides

• TC Console user guide

• Regulatory compliance and safety information guides

• Licensing information for the TC software

To download the user documentation go to:

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Introduction

What’s new in this version

This section provides an overview of the new and

changed system settings and new features in the TC7.3 software version.

Software release notes

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

http://www.cisco.com/c/en/us/support/collabo-

ration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

Software download

For software download go to:

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

New features and improvements

Local preview of presentation in a call

This allows the user to preview the presentation locally

before sharing it with far end. The feature has previously been available for EX systems, and is now available across the portfolio.

Multiple presentation outside a call

When the system is not in a call, it can simultaneously display multiple external sources on the connected screens, for example from two laptops.

Feature updates

Several feature improvements have been added to better align with C series functionality. There is now support for:

• H323 / SIP dual registration

• MultiWay

• Additional audio call

Snap to Whiteboard feature

It is possible to configure a set up for a whiteboard scenario when using the SpeakerTrack 60.

When the system detects a person speaking close to a

whiteboard, the camera will go to a pre-defined preset covering the whiteboard area as defined by the administra-

tor or installer.

There is a setup wizard for the Snap to Whiteboard feature

in the administrator settings on the Touch 10.

TC7.3.0-TC7.3.2: Users are notified when snapshots

are taken

Both the on screen display and web interface have warnings when the snapshots feature is enabled. A notification pops up on the on screen display, when a snapshot is taken. On the web interface the administrator is warned that this notice will show up when the feature is enabled.

The system also logs when snapshots are taken, and which

IP address the request was initiated from.

It is possible to allow and disallow snapshots remotely, but not to observe the room without the users being notified.

TC7.3.3 and later: Remote Monitoring option key

Due to security reasons, taking snapshots of local and far end video streams from the call control page on the system’s web interface now requires an option key to be installed on the endpoint.

The remote monitoring option key can only be added to

systems that are upgraded to TC7.3.3 and above. Remote monitoring is enabled once the option key is added, and the system rebooted. Once this feature is enabled, the only way to disable it is to remove the option key.

This feature does not display warning messages or indica-

tors on the local system that someone is monitoring the room. Please provide adequate notice to users of the system that the system administrator may monitor and control the camera and screen.

TC7.3.4 and later: Setting an administrator password

The

xCommand SystemUnit AdminPassword Set

will now change the password of the authenticated user (granted it has administrator rights).

In previous software versions, this command changed the password for the default user account (admin).

command

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Introduction

System configuration changes

New configurations

Cameras Camera [n] AssignedSerialNumber

Cameras Preset TriggerAutofocus

Cameras SpeakerTrack ConnectorDetection Mode

Cameras SpeakerTrack ConnectorDetection CameraLeft

Cameras SpeakerTrack ConnectorDetection CameraRight

Cameras SpeakerTrack Whiteboard Mode

Conference [1..1] DefaultCall Protocol

H323 Profile [1..1] Encryption KeySize

NetworkServices CDP Mode

NetworkServices MultiWay Address

NetworkServices MultiWay Protocol

NetworkServices UPnP Mode ( T C7. 3 . 4)

NetworkServices UPnP Timeout ( T C 7. 3 . 4)

Configurations that are removed

H323 Profile [1..1] Encryption MinKeySize

Video AllowWebSnapshots (TC7.3.3)

Configurations that are modified

Audio Input HDMI [n] VideoAssociation VideoInputSource

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

Audio Input Line [n] VideoAssociation VideoInputSource

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

Audio Input Microphone [n] VideoAssociation

VideoInputSource

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

Cameras SpeakerTrack TrackingMode (TC7.3.3)

OLD: <Default/Fast> NEW: <Default/Conservative>

Conference [1..1] Multipoint Mode

OLD: <Auto/Off/MultiSite/

CUCMMediaResourceGroupList>

NEW: <Auto/Off/MultiSite/MultiWay/

CUCMMediaResourceGroupList>

FacilityService Service [1..5] Name

OLD: <S: 0, 255> NEW: <S: 0, 1024>

FacilityService Service [1..5] Number

OLD: <S: 0, 255> NEW: <S: 0, 1024>

Phonebook Server [1..1] Type

OLD: <VCS/TMS/Callway/CUCM> NEW: <VCS/TMS/CUCM>

Provisioning Mode

OLD: <Off/TMS/VCS/CallWay/CUCM/Auto/Edge> NEW: <Off/TMS/VCS/CUCM/Auto/Edge>

Video AllowWebSnapshots (removed in TC7.3.3)

OLD: <Off/On>, default Off NEW: <Off/On/LocalDeviceOnly>, default

LocalDeviceOnly

Video Output Connector [n] MonitorRole (T C 7. 3 . 4 )

OLD: <Auto/First/Second/Third/PresentationOnly> NEW: <Auto/First/Second/Third/PresentationOnly/

Recorder>

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Introduction

System command changes

New commands

Camera Preset Snapshot Get

Camera Preset Snapshot Remove

Camera Preset Snapshot Store

Cameras SpeakerTrack Whiteboard ActivatePosition

Cameras SpeakerTrack Whiteboard AlignPosition

Cameras SpeakerTrack Whiteboard SetDistance

Cameras SpeakerTrack Whiteboard StorePosition

SystemUnit OptionKey List (TC7.3.3)

SystemUnit OptionKey Remove (TC7.3.3)

Video Matrix Assign

Video Matrix Reset

Video Matrix Swap

Video Matrix Unassign

Commands that are modified

Audio LocalOutput Add (TC7.3.3)

NEW: VolumeControlled: <On/Off>

Audio LocalOutput Update (TC7.3.3)

NEW: VolumeControlled: <On/Off>

CallHistory Get

OLD: Filter: <All/Missed/AnsweredElsewhere/Forwarded/

Placed/NoAnswer/Received/UnacknowledgedMissed>

NEW: Filter: <All/Missed/AnsweredElsewhere/

Forwarded/Placed/NoAnswer/Received/Rejected/ UnacknowledgedMissed>

CallHistory Recents

OLD: Filter: <All/Missed/AnsweredElsewhere/Forwarded/

Placed/NoAnswer/Received/UnacknowledgedMissed>

NEW: Filter: <All/Missed/AnsweredElsewhere/

Forwarded/Placed/NoAnswer/Received/Rejected/ UnacknowledgedMissed>

Camera Preset Store

NEW: TakeSnapshot <False/True>

Presentation Start

NEW: Instance: <New/1/2/3/4/5/6> NEW: OutputId: <1 – 4>

Presentation Stop

NEW: Instance: <New/1/2/3/4/5/6>

UserInterface ScreenShot Get

OLD: ScreenShotId: 0 – 35 NEW: ScreenShotId: 0 – 50

UserInterface ScreenShot Remove

OLD: ScreenShotId: 0 – 255 NEW: ScreenShotId: 0 – 50

UserInterface ScreenShot Request

OLD: ScreenShotId: 0 – 35 NEW: ScreenShotId: 0 – 50

UserInterface ScreenShot Store

OLD: ScreenShotId: 0 – 255 NEW: ScreenShotId: 0 – 50

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Introduction

System status changes

New statuses

Audio Output LocalOutput [n] VolumeControlled (T C7. 3 . 4)

Call [n] AttendedTransferFrom

Cameras SpeakerTrack Whiteboard [n] Camera [n] Defined

Cameras SpeakerTrack Whiteboard [n] Camera [n] Pan

Cameras SpeakerTrack Whiteboard [n] Camera [n] Tilt

Cameras SpeakerTrack Whiteboard [n] Camera [n] Zoom

Cameras SpeakerTrack Whiteboard [n] Distance

Conference ActiveSpeaker Manual SiteId

Conference Presentation Instance [n] LocalSendingMode

Conference Presentation Instance [n] LocalSource

MediaChannels Call [n] IncomingAudioChannel [n] Transport RTCP Local Protocol

MediaChannels Call [n] IncomingAudioChannel [n] Transport RTCP Remote Protocol

MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Local Protocol

MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Remote Protocol

MediaChannels Call [n] IncomingVideoChannel [n] Transport RTCP Local Protocol

MediaChannels Call [n] IncomingVideoChannel [n] Transport RTCP Remote Protocol

MediaChannels Call [n] IncomingVideoChannel [n] Transport RTP Local Protocol

MediaChannels Call [n] IncomingVideoChannel [n] Transport RTP Remote Protocol

MediaChannels Call [n] OutgoingAudioChannel [n] Transport RTCP Local Protocol

MediaChannels Call [n] OutgoingAudioChannel [n] Transport RTCP Remote Protocol

MediaChannels Call [n] OutgoingAudioChannel [n] Transport RTP Local Protocol

MediaChannels Call [n] OutgoingAudioChannel [n] Transport RTP Remote Protocol

MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTCP Local Protocol

MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTCP Remote Protocol

MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTP Local Protocol

MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTP Remote Protocol

SystemUnit Software OptionKeys RemoteMonitoring (TC7.3.3)

Video Layout Prediction Site [n] Family [n] OutputRole [n] Frame [n] ParticipantId

Video Layout Prediction Site [n] Family [n] OutputRole [n] Frame [n] VideoSourceInstance

Video Output HDMI [n] ConnectedDevice CEC [n] DeviceType

Video Output HDMI [n] ConnectedDevice CEC [n] PowerControl

Video Output HDMI [n] ConnectedDevice CEC [n] PowerStatus

Statuses that are modified

SystemUnit Diagnostics Message [n] Type

OLD: <CUCMVendorConfigurationFile/

CallProtocolDualStackConfig/ CallProtocolIPStackPlatformCompatibility/ CallProtocolVcsProvisioningCompatibility/ CameraPairing/CameraSoftwareVersion/CameraStatus/ CamerasDetected/DefaultCallProtocolRegistered/ EthernetDuplexMatches/H320GatewayStatus/ H323GatekeeperStatus/HasValidReleaseKey/ IPv4Assignment/IPv6Assignment/IPv6Mtu/ ISDNLinkCompatibility/ISDNLinkIpStack/ NTPStatus/NetSpeedAutoNegotiated/ OSDVideoOutput/ProvisioningStatus/SIPEncryption/

SIPListenPortAndOutboundMode/SIPProfileRegistration/ SIPProfileType/SelectedVideoInputSourceConnected/ SipIceAndAnatConflict/TLSVerifyRequiredCerts/

TouchPanelConnection/TurnBandwidth/

UdpPortRangeViolation/ValidAdminPassword/

VideoFromInternalCamera/VideoInputStability>

NEW: <CUCMVendorConfigurationFile/

TouchPanelConnection/TurnBandwidth/

UdpPortRangeViolation/ValidPasswords/

VideoFromInternalCamera/VideoInputStability>

NEW (TC7. 3. 4 ) : <CUCMVendorConfigurationFile/

TouchPanelConnection/TurnBandwidth/

UdpPortRangeViolation/ValidPasswords/ VideoFromInternalCamera/VideoInputStability/ TemperatureCheck>

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Chapter 2

About the API

Cisco TelePresence SX80 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

ch a pte r.

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 is

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

uration menu in the web interface or on the on-screen-diplay, or from the command line interface. All of the examples are

for the command line interface.

Password

Initially, no password is set for the default admin user. We

strongly recommend that you set a password for this user, and any other users possessing an ADMIN role, to restrict access to system configuration. The password can be changed by issuing the following command:

xCommand SystemUnit AdminPassword Set Password:

RS-232/serial connection

This is one of the most used connections to our products for

integrators, as it can be used regardless of an IP address, DNS or network configuration.

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 LoginRequired: <Off/On>

Connecting

Connect a standard 9-pin serial cable <115200, N, 8, 1> to the COM port on the SX80 codec.

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 11 520 0 . The codec can give very much feedback. We therefore recommend keeping the connection at this speed.

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 HTTP and HT TPS services, configure the following settings on the codec. Changing these settings requires a reboot of the device.

xConfiguration NetworkServices HTTP Mode:

xConfiguration NetworkServices HTTPS Mode:

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 21 in this document.

Ethernet port

You can connect a non-Cisco controller directly to an SX80

codec. Connect your device to the network port 2 or 3 with an Ethernet cable. This way the device gets a local IP address from the SX80, and is not part of the corporate network.

This method can also be used to connect to the codec with

SSH. In this case you can use the IP address 169.254.1.1.

Note: Only one non-Cisco device can be connected to the

network ports at a time.

Cisco TelePresence SX80 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

xCommand Video Layout AssignCall CallId: 2 LayoutId: 1

Example: Layout command in XML mode

Cisco TelePresence SX80 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 top level 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 16.

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

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

xFeedback

The Feedback commands are used to specify what parts of

the configuration and status hierarchies to monitor. Feedback is only issued on the RS-232, 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 19.

- User Commands -

help xcommand xconfiguration xevent xfeedback xgetxml xdocument xpreferences xstatus bye echo log systemtools OK

xPreferences

The xPreferences command is used to set preferences for

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

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

Other commands

Systemtools

The systemtools commands are a set of command line tools

for administrative control and diagnostics. The commands can be used for advanced troubleshooting together with Cisco technical support. Systemtools are not a part of the programming API. Refer to ”The SystemTools commands”

on page 228.

Log

The log command is used to enable advanced logs. It is only

used for debugging the system.

Command line shortcuts

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

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 SX80 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 number: “my number contains spaces” Correct: xCommand dial number: 12345

Incorrect: xCommand dial number: my number contains spaces

Case sensitivity

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

work.

XCOMMAND DIAL NUMBER: foo@bar.org xcommand dial number: foo@bar.org xCommand Dial Number: foo@bar.org

Exa m ple 1: List all configurations that include words that starts with OUT and HDMI:

xc o n fi g u r ati on //o ut// hd m i *c xConfiguration Audio Output HDMI 1 Level: 0 *c xConfiguration Audio Output HDMI 1 Mode: On *c xConfiguration Audio Output HDMI 2 Level: 0 *c xConfiguration Audio Output HDMI 2 Mode: Off ** end

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

x S ta tu s //v id //r es // wi d *s Video Input Source 1 Resolution Width: 1920 *s Video Input Source 2 Resolution Width: 0 *s Video Input Source 3 Resolution Width: 0 *s Video Input Source 4 Resolution Width: 0 *s Video Output Connector 1 Resolution Width: 1920 *s Video Output Connector 2 Resolution Width: 1280 *s Video Output Connector 3 Resolution Width: 1280 ** end

Example 3: Value types and formats

xconfiguration ?? *? xConfiguration Audio DefaultVolume: <0..100> *? xConfiguration Audio Input HDMI[1] Level: <-24..0> *? xConfiguration Audio Input HDMI[1] Mode: <Off/On> *? xConfiguration Audio Input HDMI[1] VideoAssociation MuteOnInactiveVideo: <Off/On> *? xConfiguration Audio Input HDMI[1] VideoAssociation VideoInputSource: <1, 2, 3, 4, 5> *? xConfiguration Audio Input HDMI[2] Level: <-24..0> *? xConfiguration Audio Input HDMI[2] Mode: <Off/On> *? xConfiguration Audio Input HDMI[2] VideoAssociation MuteOnInactiveVideo: <Off/On> *? xConfiguration Audio Input HDMI[2] VideoAssociation VideoInputSource: <1, 2, 3, 4, 5>

. . .

*? xConfiguration Video SelfviewDefault Mode: <Off/Current/On> *? xConfiguration Video SelfviewDefault OnMonitorRole: <First/Second/Current/Third> *? xConfiguration Video SelfviewDefault PIPPosition: <Current/UpperLeft/UpperCenter/

UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight> *? xConfiguration Video Wallpaper: <None/Custom> DEPRECATED

Cisco TelePresence SX80 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 Conference Key Security Bookings Dial Logging SStringSend Boot DTMFSend Message Standby Call Experimental Peripherals SystemUnit CallHistory FacilityService Phonebook TStringSend CamCtrlPip FarEndControl Presentation UserInterface Camera GPIO Preset UserManagement Cameras HttpFeedback Provisioning Video

xCommand ?? xCommand Audio Equalizer List EqualizerId: <1..8> xCommand Audio Equalizer Update EqualizerId(r): <1..8> FilterType(r): <highpass/highshelf/lowpass/lowshelf/none/peaking> Frequency(r): <S: 0, 32> Gain(r): <S: 0, 32> Q(r): <S: 0, 32>

Section(r): <1..6> . . .

xCommand Video PreviewFilmstrip Set

Position(r): <LowerCenter/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight>

xCommand Video Selfview Set

FullscreenMode: <On/Off>

Mod e: <On/Off>

OnMonitorRole: <First/Fourth/Second/Third>

PIPPosition: <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight>

Cisco TelePresence SX80 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 H323 Provisioning SystemUnit

Cameras Logging RTP Time

Conference Network Security UserInterface

Experimental NetworkServices SerialPort Video

FacilityService Peripherals SIP

GPIO Phonebook Standby

xConfiguration ??

*? xConfiguration Audio DefaultVolume: <0..100> *? xConfiguration Audio Input HDMI[1] Level: <-24..0> *? xConfiguration Audio Input HDMI[1] Mode: <Off/On> *? xConfiguration Audio Input HDMI[1] VideoAssociation MuteOnInactiveVideo: <Off/On> *? xConfiguration Audio Input HDMI[1] VideoAssociation VideoInputSource: <1, 2, 3, 4, 5> *? xConfiguration Audio Input HDMI[2] Level: <-24..0> *? xConfiguration Audio Input HDMI[2] Mode: <Off/On>

*? xConfiguration Audio Input HDMI[2] VideoAssociation MuteOnInactiveVideo: <Off/On> . . .

*? xConfiguration Video PIP Presentation DefaultValue Position: <Current/UpperLeft/UpperCenter/UpperRight/

CenterLeft/CenterRight/LowerLeft/LowerRight> *? xConfiguration Video SelfviewDefault FullscreenMode: <Off/Current/On> *? xConfiguration Video SelfviewDefault Mode: <Off/Current/On> *? xConfiguration Video SelfviewDefault OnMonitorRole: <First/Second/Current/Third> *? xConfiguration Video SelfviewDefault PIPPosition: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/

CenterRight/LowerLeft/LowerRight> *? xConfiguration Video Wallpaper: <None/Custom> DEPRECATED

Cisco TelePresence SX80 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 GPIO Network Standby

Call H320 NetworkServices SystemUnit

Camera H323 Peripherals Time

Cameras HttpFeedback Preset UserInterface

Conference ICE Provisioning Video

Diagnostics Logging Security

Experimental MediaChannels SIP

Addressing status information with xStatus

To read the status from the system type xStatus followed by a path (address expression):

xStatus <address expression>

Example 1: Query all ongoing Call information:

xStatus Call *s Call 2 Status: Connected *s Call 2 AnswerState: Answered *s Call 2 CallPriority: None *s Call 2 CallType: Video *s Call 2 CallbackNumber: “sip:name@company.com” *s Call 2 DeviceType: Endpoint *s Call 2 Direction: Outgoing *s Call 2 DisplayName: “Display Name” *s Call 2 Duration: 15 *s Call 2 Encryption Type: “None” *s Call 2 FacilityServiceId: 0 *s Call 2 ModifyState: Idle *s Call 2 PlacedOnHold: False *s Call 2 Protocol: “sip” *s Call 2 ReceiveCallRate: 6000 *s Call 2 RemoteNumber: “name@company.com” *s Call 2 TransmitCallRate: 4000 ** end

Example 2: Query the protocol for a call:

xStatus Call Protocol

*s Call 2 Protocol: “sip”

Cisco TelePresence SX80 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 outgo-

ing 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” EncryptionOut: “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

Example 5: TString message received

TString message received is an event reported when far end

has sent a TString message.

*e TString CallId: 132 Message: “ee” ** end

Example 6: SString message received

SString message received is an event reported when far end has sent a SString message.

*e SString String: “ee” Id: 132 ** end

Cisco TelePresence SX80 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. See

”Feedback from codec over HTTP” on page 22 for more

information.

WARNING: A codec may give very much feedback,

especially when calls are connected and disconnected. Therefore, you should only subscribe to the feedback that you need.

Never register for all status feedback by issuing

xFeedback register /Status. This may give the control application too much data to handle, which may lead to sluggish or unpredictable behavior.

Feedback expressions

The expression used when registering for feedback is a variant of the XPath language. This language describes a way to select nodes from an XML document. TC software contains three main feedback documents:

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.

Exa m ple 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: Name of all video input connectors.

Terminal query

xConfiguration Video Input Connector Name *c xConfiguration Video Input Connector 1 Name:

“NameA” *c xConfiguration Video Input Connector 2 Name:

“NameB” *c xConfiguration Video Input Connector 3 Name:

“NameC” *c xConfiguration Video Input Connector 4 Name:

“NameD” *c xConfiguration Video Input Connector 5 Name:

“NameE” ** end

Equivalent feedback expression

xFeedback register /Configuration/Video/Input/

Connector/Name

Example 3: Name of video input connector 3.

Terminal query

xConfiguration Video Input Connector 3 Name *c xConfiguration Video Input Connector 3 Name:

“NameC” ** end

Equivalent feedback expression

xFeedback register /Configuration/Video/Input/

Connector[@item=’3’]/Name

Cisco TelePresence SX80 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

/Configuration/Video/MainVideoSource /Event/CallDisconnect /Status/Audio ** end OK

xFeedback deregister /Event/CallDisconnect

** end OK

xFeedback deregister /Status/Audio

** end OK

D: List the new feedback expressions.

Write in: Result:

xFeedback list

/Configuration/Video/MainVideoSource ** end OK

Cisco TelePresence SX80 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 HTTP 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 HT TP body

GE T, POS T 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-address>/getxml?location=/Status/Audio

Example 3: Get all configurations of the codec.

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

Example 4: Get all video configurations of the codec.

http://<ip-address>/getxml?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.

Exa m ple 1: Setting the camera position.

http://<ip-address>/formputxml?xmldoc= <Command><Camera><PositionSet command=”True”> <CameraId>1</CameraId><Pan>200</Pan> <Tilt>200</Tilt></PositionSet></Camera></Command>

Example 2: Changing the system name.

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

Example 3: Changing multiple configurations in one go.

http://<ip-address>/formputxml?xmldoc= <Configuration><Audio><DefaultVolume>80</ DefaultVolume></Audio><UserInterface><Wallpaper>C ustom</Wallpaper></UserInterface></Configuration>

Using HTTP POST

When sending configurations and commands to the codec, it is impor tant 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.

Exa m ple 1: Changing the system name.

Request

POST /putxml HTTP/1.1

Content-Type: text/xml Connection: close

<SystemUnit> <Name>newName</Name> </SystemUnit>

</Configuration>

Example 2: Setting the camera position.

Request

POST /putxml HTTP/1.1

Content-Type: text/xml Connection: close

</Command>

Response

HTTP/1.1 200 OK Date: <date>

Server: WSGIServer/0.1 Python/2.5.4

Cache-Control: no-cache Content-Type: text/xml Content-Length: 91

Connection: close <?xml version=”1.0”?> <Command> <Ca meraPositionSetResult item=”1” status=”OK”/> </Command>

Cisco TelePresence SX80 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:

xCommand HttpFeedback Register FeedbackSlot: <1..4> ServerUrl(r): <S: 1, 2048> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255>

HttpFeedback Register arguments:

FeedbackSlot: The codec can register up to 4 slots of servers requesting HTTP feedback. Set the registering to one of 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. See the ”Feedback mechanism” on

page 19 section for more information about the expression

formats.

Example: Registering feedback on configuration changes,

disconnect events and call status changes.

<HttpFeedback> <Register command=”True”> <FeedbackSlot>1</FeedbackSlot> <S e r ve rUrl>http://127.0.0.1/

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

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

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

Expression> </Register> </HttpFeedback>

</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”> <Identification> <SystemName>integrator</SystemName> <MACAddress>00:00:de:ad:be:ef</MACAddress> <IPAddress>192.168.1.100</IPAd d ress> <ProductType>Cisco Codec</ProductType> <ProductID>Cisco Codec C90</ProductID> <S W Version>TC6.0.0.199465</SW Versio n > <HWBoard>101401-5 [08]</HWBoard> <SerialNumber>PH0000000</SerialNumber> </Identification> <Audio item=”1”> <Volume item=”1”>60</Volume> </Audio>

</Configuration>

Cisco TelePresence SX80 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

xCommand Dial Number: “12345” Protocol: H323

XML

</Command>

Example 2: Assigning video layout to a call.

Terminal

xCommand Video Layout AssignCall CallId: 2 LayoutId: 1

XML

</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 the input source type for video input connector 2.

Terminal

xConfiguration Video Input Connector 2 InputSourceType: camera

XML

<Video> <Input> <Connector item=”2”> <InputSourceType>camera</InputSourceType> </Connector> </Input> </Video>

</Configuration>

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

About the API

Dos and don’ts

Here are some best practices 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 compatibil-

ity in your integrations. Program against the codec, not the on-screen-display.

DO use complete commands

You should always use complete commands when program-

ming, 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.

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Chapter 3

xConfiguration commands

Cisco TelePresence SX80 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/sx-docs

Audio configuration ...............................................................................................................................31

xConfiguration Audio Input HDMI [1..3] Mode ............................................................................................ 31

xConfiguration Audio Input HDMI [1..3] Level ............................................................................................. 31

xConfiguration Audio Input HDMI [1..3] VideoAssociation VideoInputSource ............................................ 31

xConfiguration Audio Input HDMI [1..3] VideoAssociation MuteOnInactiveVideo ......................................31

xConfiguration Audio Input Line [1..4] Equalizer ID ..................................................................................... 31

xConfiguration Audio Input Line [1..4] Equalizer Mode ............................................................................... 31

xConfiguration Audio Input Line [1..4] VideoAssociation VideoInputSource ..............................................32

xConfiguration Audio Input Line [1..4] VideoAssociation MuteOnInactiveVideo ........................................32

xConfiguration Audio Input Line [1..4] Channel ..........................................................................................32

xConfiguration Audio Input Line [1..4] Level ...............................................................................................32

xConfiguration Audio Input Line [1..4] Mode ..............................................................................................32

xConfiguration Audio Input Microphone [1..8] EchoControl Mode .............................................................32

xConfiguration Audio Input Microphone [1..8] EchoControl NoiseReduction ............................................ 33

xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation ........................................... 33

xConfiguration Audio Input Microphone [1..8] Equalizer ID ....................................................................... 33

xConfiguration Audio Input Microphone [1..8] Equalizer Mode ................................................................. 33

xConfiguration Audio Input Microphone [1..8] VideoAssociation MuteOnInactiveVideo ........................... 33

xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource ................................ 33

xConfiguration Audio Input Microphone [1..8] Level .................................................................................. 33

xConfiguration Audio Input Microphone [1..8] Mode ................................................................................. 33

xConfiguration Audio Input Microphone [1..8] Type ...................................................................................34

xConfiguration Audio Output HDMI [1..2] Level ..........................................................................................34

xConfiguration Audio Output HDMI [1..2] Mode .........................................................................................34

xConfiguration Audio Output Line [1..6] Channel .......................................................................................34

xConfiguration Audio Output Line [1..6] Equalizer ID ..................................................................................34

xConfiguration Audio Output Line [1..6] Equalizer Mode ............................................................................34

xConfiguration Audio Output Line [1..6] Level ............................................................................................34

xConfiguration Audio Output Line [1..6] Mode ...........................................................................................34

xConfiguration Audio Microphones Mute Enabled .....................................................................................35

xConfiguration Audio SoundsAndAlerts KeyTones Mode ..........................................................................35

xConfiguration Audio SoundsAndAlerts RingTone .....................................................................................35

xConfiguration Audio SoundsAndAlerts RingVolume ................................................................................35

xConfiguration Audio DefaultVolume .........................................................................................................35

Cameras configuration ......................................................................................................................... 36

xConfiguration Cameras PowerLine Frequency ....................................................................................... 36

xConfiguration Cameras Preset TriggerAutofocus .................................................................................... 36

xConfiguration Cameras SpeakerTrack Mode .......................................................................................... 36

xConfiguration Cameras SpeakerTrack TrackingMode ............................................................................. 36

xConfiguration Cameras SpeakerTrack ConnectorDetection Mode ..........................................................37

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraLeft ................................................37

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight ..............................................37

xConfiguration Cameras SpeakerTrack Whiteboard Mode ........................................................................ 37

xConfiguration Cameras Camera [1..7] AssignedSerialNumber ................................................................37

xConfiguration Cameras Camera [1..7] Backlight ...................................................................................... 38

xConfiguration Cameras Camera [1..7] Brightness Mode ......................................................................... 38

xConfiguration Cameras Camera [1..7] Brightness Level .......................................................................... 38

xConfiguration Cameras Camera [1..7] Flip ............................................................................................... 38

xConfiguration Cameras Camera [1..7] Focus Mode................................................................................. 38

xConfiguration Cameras Camera [1..7] Gamma Mode .............................................................................. 38

xConfiguration Cameras Camera [1..7] Gamma Level .............................................................................. 39

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Cameras Camera [1..7] IrSensor ....................................................................................... 39

xConfiguration Cameras Camera [1..7] Mirror ........................................................................................... 39

xConfiguration Cameras Camera [1..7] MotorMoveDetection ................................................................... 39

xConfiguration Cameras Camera [1..7] Whitebalance Mode .................................................................... 39

xConfiguration Cameras Camera [1..7] Whitebalance Level ..................................................................... 39

xConfiguration Cameras Camera [1..7] DHCP ........................................................................................... 39

Conference configuration ..................................................................................................................... 40

xConfiguration Conference [1..1] ActiveControl Mode .............................................................................. 40

xConfiguration Conference [1..1] CallProtocolIPStack............................................................................... 40

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

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

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

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

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

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

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

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

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

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

xConfiguration Conference [1..1] MaxTransmitCallRate ..............................................................................41

xConfiguration Conference [1..1] MaxReceiveCallRate ..............................................................................42

xConfiguration Conference [1..1] MaxTotalTransmitCallRate ......................................................................42

xConfiguration Conference [1..1] MaxTotalReceiveCallRate .......................................................................42

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

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

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

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

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

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

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

FacilityService configuration ................................................................................................................ 44

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

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

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

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

GPIO configuration ............................................................................................................................... 45

xConfiguration GPIO Pin [1..4] Mode ..........................................................................................................45

H323 configuration ............................................................................................................................... 45

xConfiguration H323 NAT Mode ................................................................................................................45

xConfiguration H323 NAT Address ............................................................................................................45

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

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

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

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

xConfiguration H323 Profile [1..1] Encryption KeySize ............................................................................. 46

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

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

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

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

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

Logging configuration .......................................................................................................................... 48

xConfiguration Logging Mode ................................................................................................................... 48

Network configuration .......................................................................................................................... 48

xConfiguration Network [1..1] IPStack ....................................................................................................... 48

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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

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

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

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

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

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

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

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

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

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

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

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

xConfiguration Network [1..1] MTU ............................................................................................................ 53

xConfiguration Network [1..1] Speed ......................................................................................................... 53

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

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

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

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

NetworkServices configuration ............................................................................................................ 55

xConfiguration NetworkServices CDP Mode .............................................................................................55

xConfiguration NetworkServices H323 Mode ...........................................................................................55

xConfiguration NetworkServices HTTP Mode ...........................................................................................55

xConfiguration NetworkServices SIP Mode ...............................................................................................55

xConfiguration NetworkServices Telnet Mode ..........................................................................................55

xConfiguration NetworkServices WelcomeText.........................................................................................55

xConfiguration NetworkServices XMLAPI Mode .......................................................................................55

xConfiguration NetworkServices MultiWay Address ................................................................................ 56

xConfiguration NetworkServices MultiWay Protocol ................................................................................ 56

xConfiguration NetworkServices HTTPS Mode ........................................................................................ 56

xConfiguration NetworkServices HTTPS VerifyServerCertificate ............................................................ 56

xConfiguration NetworkServices HTTPS VerifyClientCertificate .............................................................. 56

xConfiguration NetworkServices HTTPS OCSP Mode ............................................................................. 56

xConfiguration NetworkServices HTTPS OCSP URL ................................................................................ 57

xConfiguration NetworkServices Medianet Metadata ...............................................................................57

xConfiguration NetworkServices NTP Mode .............................................................................................57

xConfiguration NetworkServices NTP Address .........................................................................................57

xConfiguration NetworkServices SNMP Mode ..........................................................................................57

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

xConfiguration NetworkServices SNMP CommunityName ...................................................................... 58

xConfiguration NetworkServices SNMP SystemContact ......................................................................... 58

xConfiguration NetworkServices SNMP SystemLocation ........................................................................ 58

xConfiguration NetworkServices SSH Mode ............................................................................................ 58

xConfiguration NetworkServices SSH AllowPublicKey ............................................................................. 58

xConfiguration NetworkServices CTMS Mode ......................................................................................... 58

xConfiguration NetworkServices CTMS Encryption ................................................................................. 58

xConfiguration NetworkServices UPnP Mode .......................................................................................... 59

xConfiguration NetworkServices UPnP Timeout ...................................................................................... 59

Peripherals configuration ..................................................................................................................... 59

xConfiguration Peripherals Pairing CiscoTouchPanels RemotePairing ..................................................... 59

xConfiguration Peripherals Profile TouchPanels ....................................................................................... 59

Phonebook configuration .....................................................................................................................60

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

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

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

Provisioning configuration ....................................................................................................................60

xConfiguration Provisioning Connectivity ................................................................................................. 60

xConfiguration Provisioning Mode ............................................................................................................ 60

xConfiguration Provisioning LoginName .................................................................................................... 61

xConfiguration Provisioning Password ....................................................................................................... 61

xConfiguration Provisioning HttpMethod ................................................................................................... 61

xConfiguration Provisioning ExternalManager Address ............................................................................. 61

xConfiguration Provisioning ExternalManager AlternateAddress .............................................................. 61

xConfiguration Provisioning ExternalManager Protocol ............................................................................. 61

xConfiguration Provisioning ExternalManager Path ...................................................................................62

xConfiguration Provisioning ExternalManager Domain ..............................................................................62

RTP configuration ................................................................................................................................. 62

xConfiguration RTP Ports Range Start .......................................................................................................62

xConfiguration RTP Ports Range Stop .......................................................................................................62

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Security configuration .......................................................................................................................... 63

xConfiguration Security Audit Logging Mode ........................................................................................... 63

xConfiguration Security Audit OnError Action ........................................................................................... 63

xConfiguration Security Audit Server Address ......................................................................................... 63

xConfiguration Security Audit Server Port ................................................................................................ 63

xConfiguration Security Audit Server PortAssignment ............................................................................. 63

xConfiguration Security Session ShowLastLogon .....................................................................................64

xConfiguration Security Session InactivityTimeout ....................................................................................64

SerialPort configuration ........................................................................................................................ 64

xConfiguration SerialPort Mode .................................................................................................................64

xConfiguration SerialPort BaudRate ...........................................................................................................64

xConfiguration SerialPort LoginRequired ...................................................................................................64

SIP configuration .................................................................................................................................. 65

xConfiguration SIP ANAT ...........................................................................................................................65

xConfiguration SIP AuthenticateTransferror ...............................................................................................65

xConfiguration SIP ListenPort ....................................................................................................................65

xConfiguration SIP PreferredIPMedia ........................................................................................................65

xConfiguration SIP PreferredIPSignaling ....................................................................................................65

xConfiguration SIP OCSP Mode ................................................................................................................65

xConfiguration SIP OCSP DefaultResponder .............................................................................................65

xConfiguration SIP Profile [1..1] Ice Mode ..................................................................................................65

xConfiguration SIP Profile [1..1] Ice DefaultCandidate ............................................................................... 66

xConfiguration SIP Profile [1..1] Turn DiscoverMode ................................................................................. 66

xConfiguration SIP Profile [1..1] Turn BandwidthProbe .............................................................................. 66

xConfiguration SIP Profile [1..1] Turn DropRflx .......................................................................................... 66

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Standby configuration .......................................................................................................................... 69

xConfiguration Standby Control ................................................................................................................ 69

xConfiguration Standby Delay ................................................................................................................... 69

xConfiguration Standby BootAction .......................................................................................................... 69

xConfiguration Standby StandbyAction .................................................................................................... 69

xConfiguration Standby WakeupAction .................................................................................................... 69

SystemUnit configuration ..................................................................................................................... 70

xConfiguration SystemUnit Name ..............................................................................................................70

xConfiguration SystemUnit MenuLanguage ..............................................................................................70

xConfiguration SystemUnit CallLogging Mode ..........................................................................................70

xConfiguration SystemUnit ContactInfo Type ............................................................................................70

xConfiguration SystemUnit IrSensor ..........................................................................................................70

Time configuration .................................................................................................................................71

xConfiguration Time TimeFormat ...............................................................................................................71

xConfiguration Time DateFormat ...............................................................................................................71

xConfiguration Time Zone .......................................................................................................................... 71

xConfiguration Time OlsonZone ................................................................................................................ 71

UserInterface configuration .................................................................................................................. 73

xConfiguration UserInterface Language ....................................................................................................73

xConfiguration UserInterface OSD EncryptionIndicator .............................................................................73

xConfiguration UserInterface OSD LanguageSelection.............................................................................73

xConfiguration UserInterface OSD LoginRequired ....................................................................................73

xConfiguration UserInterface OSD Output .................................................................................................73

xConfiguration UserInterface Wallpaper ....................................................................................................73

xConfiguration UserInterface TouchPanel DefaultPanel ............................................................................74

xConfiguration UserInterface UserPreferences ......................................................................................... 74

Video configuration .............................................................................................................................. 74

xConfiguration Video AllowWebSnapshots ...............................................................................................74

xConfiguration Video CamCtrlPip CallSetup Mode....................................................................................74

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video CamCtrlPip CallSetup Duration ...............................................................................74

xConfiguration Video DefaultPresentationSource......................................................................................75

xConfiguration Video Input Connector [1..5] Name ....................................................................................75

xConfiguration Video Input Connector [1..5] InputSourceType ..................................................................75

xConfiguration Video Input Connector [1..5] Visibility ................................................................................75

xConfiguration Video Input Connector [1..5] CameraControl Mode ..........................................................75

xConfiguration Video Input Connector [1..5] CameraControl CameraId ....................................................75

xConfiguration Video Input Connector [1..5] Quality ..................................................................................75

xConfiguration Video Input Connector [1..5] OptimalDefinition Profile ......................................................76

xConfiguration Video Input Connector [1..5] OptimalDefinition Threshold60fps .......................................76

xConfiguration Video Input Connector [1..4] PresentationSelection ..........................................................76

xConfiguration Video Input Connector [1..4] RGBQuantizationRange ........................................................77

xConfiguration Video Input Connector [4] DviType ....................................................................................77

xConfiguration Video Input Connector [5] SignalType ...............................................................................77

xConfiguration Video Layout DisableDisconnectedLocalOutputs .............................................................77

xConfiguration Video Layout LocalLayoutFamily .......................................................................................77

xConfiguration Video Layout PresentationDefault View ............................................................................78

xConfiguration Video Layout RemoteLayoutFamily ...................................................................................78

xConfiguration Video Layout Scaling .........................................................................................................78

xConfiguration Video Layout ScaleToFrame ..............................................................................................78

xConfiguration Video Layout ScaleToFrameThreshold ..............................................................................78

xConfiguration Video PIP ActiveSpeaker DefaultValue Position ................................................................79

xConfiguration Video PIP Presentation DefaultValue Position ...................................................................79

xConfiguration Video SelfviewDefault Mode .............................................................................................79

xConfiguration Video SelfviewDefault FullscreenMode .............................................................................79

xConfiguration Video SelfviewDefault PIPPosition.................................................................................... 80

xConfiguration Video SelfviewDefault OnMonitorRole.............................................................................. 80

xConfiguration Video Monitors .................................................................................................................. 80

xConfiguration Video OSD LanguageSelection ........................................................................................ 80

xConfiguration Video OSD EncryptionIndicator ........................................................................................ 80

xConfiguration Video OSD Output ............................................................................................................ 80

xConfiguration Video OSD LoginRequired ................................................................................................ 80

xConfiguration Video Output Connector [1..2] CEC Mode .........................................................................81

xConfiguration Video Output Connector [1..3] Location HorizontalOffset .................................................81

xConfiguration Video Output Connector [1..3] Location VerticalOffset .....................................................81

xConfiguration Video Output Connector [1..3] RGBQuantizatonRange......................................................81

xConfiguration Video Output Connector [1..3] Resolution .........................................................................82

xConfiguration Video Output Connector [1..3] MonitorRole .......................................................................82

xConfiguration Video WallPaper ................................................................................................................82

Experimental configuration ................................................................................................................... 82

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Audio configuration

xConfiguration Audio Input HDMI [1..3] Mode

Determine if the audio channels on the HDMI input shall be enabled. The HDMI input has two audio channels.

As default, Audio is disabled on HDMI [1..2] and enabled on HDMI [3].

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 Input HDMI [1..3] Level

Define the audio level of the HDMI input connector, in steps of 1 dB.

Requires user role: ADMIN

Value space: <-24. .0>

Example:

xConfiguration Audio Input HDMI [1..3] VideoAssociation VideoInputSource

It is possible to associate an audio source with a video source, and further to determine whether to play or mute audio depending on whether the video source is presented or not. By default, audio is not muted.

Use the Audio Input HDMI [n] VideoAssociation VideoInputSource setting to define which video source to associate the audio source with. Use the Audio Input HDMI [n] VideoAssociation MuteOnInactiveVideo setting to define whether to play or mute audio when not presenting the video source.

Requires user role: ADMIN

Value space: <1/2/3/4/5>

Example:

xConfiguration Audio Input HDMI 1 Mode: On

Ran ge: Select a value between -24 and 0, in steps of 1 dB.

xConfiguration Audio Input HDMI 2 Level: 0

Ran ge: Select one of the video input sources.

xConfiguration Audio Input HDMI 3 VideoAssociation VideoInputSource: 1

xConfiguration Audio Input HDMI [1..3] VideoAssociation MuteOnInactiveVideo

Requires user role: ADMIN

Value space: <Off/O n>

Off: The audio source is not associated with a video source. The audio will be played locally and to far end regardless of whether the video source is presented.

On: The audio source is associated with a video source. The audio will be played (locally and to far end) when the associated video source is presented. The audio will be muted when the video source is not presented.

Example:

xConfiguration Audio Input HDMI 3 VideoAssociation MuteOnInactiveVideo: Off

xConfiguration Audio Input Line [1..4] Equalizer ID

Select the audio input line equalizer ID.

Requires user role: ADMIN

Value space: <1..8>

Ran ge: Select EqualizerID 1 to 8.

Example:

xConfiguration Audio Input Line 1 Equalizer ID: 1

xConfiguration Audio Input Line [1..4] Equalizer Mode

Set the audio input line equalizer mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: No equalizer. On: Enable the equalizer for the audio input line.

Example:

xConfiguration Audio Input Line 1 Equalizer Mode: Off

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Audio Input Line [1..4] VideoAssociation VideoInputSource

Use the Audio Input Line [n] VideoAssociation VideoInputSource setting to define which video source to associate the audio source with. Use the Audio Input Line [n] VideoAssociation MuteOnInactiveVideo setting to define whether to play or mute audio when not presenting the video source.

Requires user role: ADMIN

Value space: <1/2/3/4/5>

Ran ge: Select one of the video input sources.

Example:

xConfiguration Audio Input Line 1 VideoAssociation VideoInputSource: 1

xConfiguration Audio Input Line [1..4] VideoAssociation MuteOnInactiveVideo

Requires user role: ADMIN

Value space: <Off/O n>

Off: The audio source is not associated with a video source. The audio will be played locally and to far end regardless of whether the video source is presented.

Example:

xConfiguration Audio Input Line 1 VideoAssociation MuteOnInactiveVideo: Off

xConfiguration Audio Input Line [1..4] Channel

Define whether the Audio Line input is a mono signal or part of a multichannel signal.

Requires user role: ADMIN

Value space: <Right/Left/Mono>

Right: The Audio Line input signal is the right channel of a stereo signal. Left: The Audio Line input signal is the left channel of a stereo signal. Mono: The Audio Line input signal is a mono signal.

Example:

xConfiguration Audio Input 1 Channel: Left

xConfiguration Audio Input Line [1..4] Level

Define the level of the audio source on the line input connector. See the Audio Level table in the Physical Interface Guide for the codec for a complete overview of

the values represented in dB.

Requires user role: ADMIN

Value space: <0..24>

Ran ge: Select a value between 0 to 24, in steps of 1 dB.

Example:

xConfiguration Audio Input Line 1 Level: 10

xConfiguration Audio Input Line [1..4] Mode

Set the audio input line mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the Audio Line input. On: Enable the Audio Line input.

Example:

xConfiguration Audio Input Line 1 Mode: On

xConfiguration Audio Input Microphone [1..8] EchoControl Mode

The echo canceller continuously adjusts itself to the audio characteristics of the room and compensate for any changes it detects in the audio environment. If the changes in the audio conditions are

very significant the echo canceller may take a second or two to re-adjust.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Echo Control should be switched Off if external echo cancellation or playback equipment is used.

On: Echo Control is normally set to On to prevent the far end from hearing their own audio. Once selected, echo cancellation is active at all times.

Example:

xConfiguration Audio Input Microphone 1 EchoControl Mode: On

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Audio Input Microphone [1..8] EchoControl NoiseReduction

The system has a built-in noise reduction which reduces constant background noise (for example noise from air-conditioning systems, cooling fans etc.). In addition, a high pass filter (Humfilter) reduces very low frequency noise. Requires the Echo Control Mode to be enabled for the microphone.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Turn off the Noise Reduction. On: The Noise Reduction should be enabled in the presence of low frequency noise.

Example:

xConfiguration Audio Input Microphone 1 EchoControl NoiseReduction: On

xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation

The system has built-in signal processing to reduce the effect of room reverberation. Requires the Echo Control Mode to be enabled for the microphone.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Turn off the dereverberation. On: Turn on the dereverberation.

Example:

xConfiguration Audio Input Microphone 1 EchoControl Dereverberation: On

xConfiguration Audio Input Microphone [1..8] Equalizer ID

Select the audio input microphone equalizer ID.

Requires user role: ADMIN

Value space: <1..8>

Ran ge: Select Equalizer ID 1 to 8.

Example:

xConfiguration Audio Input Microphone 1 Equalizer ID: 1

xConfiguration Audio Input Microphone [1..8] VideoAssociation MuteOnInactiveVideo

Enable association of a video source to a microphone audio input.

Requires user role: ADMIN

Value space: <Off/O n>

Off: No video source is associated. On: A video source is associated, and the audio will be muted if the associated video source is not

displayed.

Example:

MuteOnInactiveVideo: On

xConfiguration Audio Input Microphone 1 VideoAssociation

xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource

Select the associated video input source.

Requires user role: ADMIN

Value space: <1/2/3/4/5>

Ran ge: Select one of the video input sources.

Example:

xConfiguration Audio Input Microphone 1 VideoAssociation VideoInputSource:

xConfiguration Audio Input Microphone [1..8] Level

Define the audio level of the Microphone input connector. See the Audio Level table in the Physical Interface Guide for the codec for a complete overview of

the values represented in dB.

Requires user role: ADMIN

Value space: <0..70>

Ran ge: Select a value between 0 and 70, in steps of 1 dB.

Example:

xConfiguration Audio Input Microphone 1 Level: 58

xConfiguration Audio Input Microphone [1..8] Equalizer Mode

Set the audio input microphone equalizer mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: No equalizer. On: Enable the equalizer for the audio input microphone.

Example:

xConfiguration Audio Input Microphone 1 Equalizer Mode: Off

xConfiguration Audio Input Microphone [1..8] Mode

Set the audio input microphone mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the microphone connector. On: Enable the microphone connector.

Example:

xConfiguration Audio Input Microphone 1 Mode: On

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Audio Input Microphone [1..8] Type

The microphone connectors are intended for electret type microphones. The microphone connector can be set to line or microphone mode.

Requires user role: ADMIN

Value space: <Microphone/Line>

Microphone: Select Microphone when you have 48 V Phantom voltage and the pre-amplification

is On.

Line: Select Line when you have a standard balanced line input. The phantom voltage and pre-amplification is Off.

Example:

xConfiguration Audio Input Microphone 1 Type: Line

xConfiguration Audio Output HDMI [1..2] Level

Define the output level of the HDMI output connector, in steps of 1 dB.

Requires user role: ADMIN

Value space: <-24. .0>

Ran ge: Select a value between -24 and 0, in steps of 1 dB.

Example:

xConfiguration Audio Output HDMI 1 Level: 0

xConfiguration Audio Output HDMI [1..2] Mode

Determine if the audio channel on the HDMI output connector shall be enabled.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the audio channel on the HDMI output. On: Enable the audio channel on the HDMI output.

Example:

xConfiguration Audio Output HDMI 1 Mode: On

xConfiguration Audio Output Line [1..6] Channel

Define whether the Audio Line output is a mono signal or part of a multichannel signal.

Requires user role: ADMIN

Value space: <Right/Left/Mono>

Right: The Audio Line output signal is the right channel of a stereo signal. Left: The Audio Line output signal is the left channel of a stereo signal. Mono: The Audio Line output signal is a mono signal.

Example:

xConfiguration Audio Output Line 1 Channel: left

xConfiguration Audio Output Line [1..6] Equalizer ID

Select the audio output line equalizer ID.

Requires user role: ADMIN

Value space: <1..8>

Ran ge: Select EqualizerID 1 to 8.

Example:

xConfiguration Audio Output Line 1 Equalizer ID: 1

xConfiguration Audio Output Line [1..6] Equalizer Mode

Set the audio output line equalizer mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: No equalizer. On: Enable the equalizer for the audio output line.

Example:

xConfiguration Audio Output Line 1 Equalizer Mode: Off

xConfiguration Audio Output Line [1..6] Level

Define the audio level on the line output connector. See the Audio Level table in the Physical Interface Guide for the codec for a complete overview of

the menu values represented in dB.

Requires user role: ADMIN

Value space: <-24. .0>

Ran ge: Select a value between -24 and 0, in steps of 1 dB.

Example:

xConfiguration Audio Output Line 1 Level: -10

xConfiguration Audio Output Line [1..6] Mode

Set the audio output line mode.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the Audio Line output. On: Enable the Audio Line output.

Example:

xConfiguration Audio Output Line 1 Mode: On

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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>

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 ser vice/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.

Example:

xConfiguration Audio Microphones Mute Enabled: True

xConfiguration Audio SoundsAndAlerts KeyTones Mode

The system can be configured to make a keyboard click sound effect (key tone) when typing text or numbers on the 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 key tones when you type.

Example:

xConfiguration Audio SoundsAndAlerts KeyTones Mode: Off

xConfiguration Audio SoundsAndAlerts RingTone

This setting defines which ringtone to use for incoming calls. You need to enter the exact name of the ringtone. You can find the available ringtones the following ways.

Web interface: On the Configuration > Personalization page. Touch controller: On the Ringtone & Sound panel of the Settings menu. This panel is either in the

open part of the Settings menu, or included in the password protected Administrator menu. The UserInterface UserPreference setting defines which panels will be in the password protected area.

Requires user role: USER

Value space: <S: 1, 100>

Format: String with a maximum of 100 characters.

Example:

xConfiguration Audio SoundsAndAlerts RingTone: "Sunrise"

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 SoundsAndAlerts RingVolume: 50

xConfiguration Audio DefaultVolume

Set the default speaker volume. The volume returns to this value when you switch on or restart the video system. You can also run the following API command to return to the default value: xCommand Audio Volume SetToDefault. Run the xCommand Audio Volume commands or use the

Touch controller to change the volume while the video system is running.

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 DefaultVolume: 50

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Cameras configuration

xConfiguration Cameras PowerLine Frequency

If your camera supports power line frequency anti-flickering, the camera is able to compensate for any flicker noise from the electrical power supply. You should set this camera configuration based on your power line frequency. If your camera supports auto detection of line frequency, you can select the Auto option in the configuration.

All Cisco Precision cameras support both anti-flickering and auto detection of line frequency. Auto is the default value, so you should change this setting if you have a camera that does not support auto detection.

Requires user role: ADMIN

Value space: <Auto/50Hz/60Hz>

Auto: Allow the camera to detect the power frequency automatically. 50Hz: Use this value when the power line frequency is 50 Hz. 60Hz: Use this value when the power line frequency is 60 Hz.

Example:

xConfiguration Cameras Preset TriggerAutofocus

The current position (pan and tilt), zoom and focus are stored with a preset. Use this setting to determine if the camera should refocus or use the focus value that is stored with the preset.

Requires user role: ADMIN

Value space: <Auto/Off/On>

Example:

xConfiguration Cameras PowerLine Frequency: Auto

Auto: Whether the camera refocuses or not when selecting a preset, depends on the camera type. Off: The focus value that is stored with the preset will be used. The camera will not refocus when

selecting a preset. On: The camera will refocus when selecting a preset. The focus value that is stored with the

preset may be overridden.

xConfiguration Cameras Preset TriggerAutofocus: Auto

xConfiguration Cameras SpeakerTrack Mode

This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera. The SpeakerTrack 60 camera assembly consists of two cameras and uses an audio tracking

technique that finds and captures a close-up of the active speaker. When a change of speaker is detected, the system can switch automatically between the two cameras to always show the best camera view. Refer to the Cameras SpeakerTrack TrackingMode setting for different switching

modes.

Requires user role: USER

Value space: <Auto/Off>

Auto: Speaker tracking is switched on. The cameras in the camera assembly behave as one integrated unit that finds the active speaker and dynamically chooses the best camera view.

Off: The cameras operate as two individual cameras. Speaker tracking is not used.

Example:

xConfiguration Cameras SpeakerTrack Mode: Auto

xConfiguration Cameras SpeakerTrack TrackingMode

This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera, and when

Cameras SpeakerTrack Mode is set to Auto. The speaker tracking algorithm can react to changes in two modes, one faster than the other. The

mode determines when the camera view will change to a new speaker. In software versions TC7.3.0 and TC7.3.1 the Default value is the most conservative mode; the fastest mode is Default in TC7.3.2 and later.

Requires user role: USER

Value space: TC7.3.0 and TC7.3.1: <Default/Fast>; TC7.3.2 and later: <Conservative/Default>

Default: Normal tracking mode. Conservative: The camera view will change to a new speaker later than in Normal mode. Fast: The camera view will change to a new speaker faster than in Normal mode.

Example:

xConfiguration Cameras SpeakerTrack TrackingMode: Default

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Cameras SpeakerTrack ConnectorDetection Mode

This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to the codec (video system).

Determine whether to automatically detect or manually configure which video input each individual camera is connected to. You should choose manual configuration in situations where the codec does not receive EDID information from the cameras. Typically, this will be when you use HDMI repeaters that do not pass on EDID information.

Requires user role: USER

Value space: <Auto/Manual>

Auto: Automatically detect which video inputs the cameras are connected to. Manual: Manually define which video inputs the cameras are connected to. Use the Cameras

SpeakerTrack ConnectorDetection CameraLeft and Cameras SpeakerTrack ConnectorDetection CameraRight settings.

Example:

xConfiguration Cameras SpeakerTrack ConnectorDetection Mode: Auto

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraLeft

This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to the codec (video system). Furthermore, Cameras SpeakerTrack ConnectorDetection Mode must be set to Manual.

Enter the number of the video input that SpeakerTrack 60's left camera is connected to. For example, set to 1 if the left camera is connected to video input 1.

Requires user role: USER

Value space: <1..5>

Format: Select a valid video input number.

Example:

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraLeft: 1

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight

This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to the codec (video system). Furthermore, Cameras SpeakerTrack ConnectorDetection Mode must be set to Manual.

Enter the number of the video input that SpeakerTrack 60's right camera is connected to. For example, set to 2 if the right camera is connected to video input 2.

Requires user role: USER

Value space: <1..5>

Format: Select a valid video input number.

Example:

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight: 2

xConfiguration Cameras SpeakerTrack Whiteboard Mode

This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to the codec.

Determine whether to enable the Snap to Whiteboard feature or not. The Snap to Whiteboard feature relies on a speaker track camera. When a presenter is standing

next to the whiteboard, the camera will capture both the presenter and the whiteboard if the Snap

to Whiteboard feature is enabled. If the feature is disabled, only the presenter will be captured. The Snap to Whiteboard feature is set up from the Touch controller.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The Snap to Whiteboard feature is disabled. On: The Snap to Whiteboard feature is enabled.

Example:

xConfiguration Cameras SpeakerTrack Whiteboard Mode: Off

xConfiguration Cameras Camera [1..7] AssignedSerialNumber

The camera ID is the number n in Camera [n]. By default, the camera ID is assigned automatically

to a camera. If EDID information is not passed on from the camera to the codec, the camera ID is

not persistent after a reboot. This means that a camera may get a new camera ID when the codec

(video system) is restarted. You should use the Cameras Camera AssignedSerialNumber setting to cater for configurations

where the codec does not receive EDID information from multiple cameras. This setting allows you

to manually assign a camera ID to a camera by associating the camera ID with the camera's serial

number. The setting is persistent until the codec is factory reset. Typical situations where the codec does not receive EDID information are: when you connect a

Cisco TelePresence 60 camera using 3G-SDI; when you connect a Cisco TelePresence 40 (Cisco

PrecisionHD 1080p4xS2) camera; when you use an HDMI repeater that does not pass on EDID

information. The default value is an empty string.

Requires user role: USER

Value space: <S: 0, 20>

Format: The camera's serial number. String with a maximum of 20 characters.

Example:

xConfiguration Cameras Camera 1 AssignedSerialNumber: "FTT0123456F"

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Cameras Camera [1..7] 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>

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

Example:

xConfiguration Cameras Camera 1 Backlight: Off

xConfiguration Cameras Camera [1..7] Brightness Mode

Set the camera brightness mode.

Requires user role: ADMIN

Value space: <Auto/Manual>

Auto: The camera brightness is automatically set by the system. Manual: Enable manual control of the camera brightness. The brightness level is set using the

Cameras Camera Brightness Level setting.

Example:

xConfiguration Cameras Camera 1 Brightness Mode: Auto

xConfiguration Cameras Camera [1..7] Brightness Level

Set the brightness level. Requires the Camera Brightness Mode to be set to Manual.

Requires user role: ADMIN

Value space: <1..31>

Ran ge: Select a value between 1 and 31.

Example:

xConfiguration Cameras Camera 1 Brightness Level: 20

xConfiguration Cameras Camera [1..7] Flip

With Flip mode (vertical flip) you can flip the image upside down. Flipping applies both to the self-

view and the video that is transmitted to the far end.

Requires user role: USER

Value space: <Auto/Off/On>

Auto: If the camera detects that it is mounted upside down, the image is automatically flipped. If the camera cannot auto-detect whether it is mounted upside down or not, the image is not changed.

Off: Display the image on screen the normal way. On: Display the image flipped upside down. This setting is used when a camera is mounted upside

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

Example:

xConfiguration Cameras Camera 1 Flip: Auto

xConfiguration Cameras Camera [1..7] 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 Cameras Camera 1 Focus Mode: Auto

xConfiguration Cameras Camera [1..7] Gamma Mode

This setting enables gamma corrections, and applies only to cameras which support gamma mode.

Gamma describes the nonlinear relationship between image pixels and monitor brightness.

Requires user role: ADMIN

Value space: <Auto/Manual>

Auto: Auto is the default and the recommended setting. Manual: In manual mode the gamma value is changed with the gamma level setting, ref: Cameras

Camera [1..n] Gamma Level.

Example:

xConfiguration Cameras Camera 1 Gamma Mode: Auto

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Cameras Camera [1..7] 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. Requires the Gamma Mode to be set to Manual.

Requires user role: ADMIN

Value space: <0..7>

Ran ge: Select a value between 0 and 7.

Example:

xConfiguration Cameras Camera 1 Gamma Level: 0

xConfiguration Cameras Camera [1..7] IrSensor

Not applicable in this version.

xConfiguration Cameras Camera [1..7] Mirror

With Mirror mode (horizontal flip) you can mirror the image on screen. Mirroring applies both to the self-view and the video that is transmitted to the far end.

Requires user role: ADMIN

Value space: <Auto/Off/On>

Auto: If the camera detects that it is mounted upside down, the image is automatically mirrored.

If the camera cannot auto-detect whether it is mounted upside down or not, the image is not

changed.

Off: Display the image as other people see you. On: Display the image as you see yourself in a mirror.

Example:

xConfiguration Cameras Camera 1 Mirror: Auto

xConfiguration Cameras Camera [1..7] 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 Cameras Camera 1 MotorMoveDetection: Off

xConfiguration Cameras Camera [1..7] Whitebalance Mode

Set the camera white balance mode.

Requires user role: ADMIN

Value space: <Auto/Manual>

Auto: The camera will continuously adjust the white balance depending on the camera view. Manual: Enables manual control of the camera white balance. The white balance level is set using

the Cameras Camera Whitebalance Level setting.

Example:

xConfiguration Cameras Camera 1 Whitebalance Mode: Auto

xConfiguration Cameras Camera [1..7] Whitebalance Level

Set the white balance level. Requires the Camera Whitebalance Mode to be set to manual.

Requires user role: ADMIN

Value space: <1..16>

Ran ge: Select a value between 1 and 16.

Example:

xConfiguration Cameras Camera 1 Whitebalance Level: 1

xConfiguration Cameras Camera [1..7] DHCP

Not applicable for this product.

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Conference configuration

xConfiguration Conference [1..1] ActiveControl Mode

Active control is a feature that allows conference participants to administer a conference on Cisco TelePresence Server using the video system's interfaces. Each user can see the participant list, change video layout, disconnect participants, etc. from the interface. The active control feature is enabled by default, provided that it is supported by the infrastructure (Cisco Unified Communications Manager (CUCM) version 9.1.2 or newer, Cisco TelePresence Video Communication Server (VCS) version X8.1 or newer). Change this setting if you want to disable the active control features.

Requires user role: ADMIN

Value space: <Auto/Off>

Auto: Active control is enabled when supported by the infrastructure. Off: Active control is disabled.

Example:

xConfiguration Conference [1..1] CallProtocolIPStack

Select if the system should enable IPv4, IPv6, or dual IP stack on the call protocol (SIP, H323).

Requires user role: ADMIN

Value space: <Dual/IPv4/IPv6>

Example:

xConfiguration Conference [1..1] AutoAnswer Mode

Set the auto answer mode. Use the Conference AutoAnswer Delay setting if you want the system to wait a number of seconds before answering the call, and use the Conference AutoAnswer Mute setting if you want your microphone to be muted when the call is answered.

Requires user role: ADMIN

Value space: <Off/O n>

Example:

xConfiguration Conference ActiveControl Mode: Auto

Dual: Enables both IPv4 and IPv6 for the call protocol. IPv4: When set to IPv4, the call protocol will use IPv4. IPv6: When set to IPv6, the call protocol will use IPv6.

xConfiguration Conference 1 CallProtocolIPStack: Dual

Off: You must answer incomming calls manually by tapping Answer on the Touch controller. On: The system automatically answers incoming calls, except if you are already in a call. You must

always answer or decline incoming calls manually when you are already engaged in a call.

xConfiguration Conference 1 AutoAnswer Mode: Off

xConfiguration Conference [1..1] AutoAnswer Mute

Determine if the microphone shall be muted when an incoming call is automatically answered.

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. Requires that AutoAnswer Mode is switched on.

Requires user role: ADMIN

Value space: <0..50>

Ran ge: Select a value between 0 and 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 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 (Touch controller). 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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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

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 capabilit y. On: Enable the far end control signal capability.

Example:

xConfiguration Conference 1 FarEndControl SignalCapability: On

xConfiguration Conference [1..1] Encryption Mode

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

NOTE: If the Encryption Option Key is not installed on the video system, the encryption mode is alw ays Of f.

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 suppor ts encr yption (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: <Auto/H323/Sip/H320>

Auto: Enables auto-selection of the call protocol based on which protocols are available. If multiple protocols are available, the order of priority is: 1) SIP; 2) H323; 3) H320. If the system cannot register, or the call protocol is not enabled, the auto-selection chooses H323.

H323: All calls are set up as H.323 calls. Sip: All calls are set up as SIP calls. H320: All 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: Auto

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

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 MaxTransmitCallRate: 6000

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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

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 MaxTotalTransmitCallRate: 10000

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

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

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

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 PresentationChannel Weight: 5

Cisco TelePresence SX80 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 Server (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 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 built-in MultiSite allows up to five participants (yourself included) plus one additional audio call.

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

Requires user role: ADMIN

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

Auto: The multipoint method available will be choosen automatically; if none are available the Multipoint Mode will automatically be set to Off. If both MultiWay and MultiSite are available, the MultiWay service takes priority over the built-in MultiSite.

Off: Multiparty conferences are not allowed. MultiSite: Multiparty conferences are set up using the built-in MultiSite feature. If MultiSite is

chosen when the MultiSite feature is not available, the Multipoint Mode will automatically be set to Off.

MultiWay: Multiparty conferences are set up using the MultiWay service. If MultiWay is chosen when the MultiWay service is not available, the Multipoint Mode will automatically be set to Off. This may occur when the NetworkServices MultiWay Address setting is empty or not properly set.

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 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 history list.

Example:

xConfiguration Conference 1 IncomingMultisiteCall Mode: Allow

Cisco TelePresence SX80 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 setting you can select what kind of services they are. A facility service is not available unless both the FacilityService Service Name and the FacilityService Service Number settings are properly set. Only FacilityService Service 1 with Type Helpdesk is available on the Touch controller; the other options are available for system integrators using the API (Application Programming Interface) command set.

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 services. Transportation: Select this option for transportation services.

Example:

xConfiguration FacilityService Service [1..5] Name

Enter the name of the facility ser vice. Up to five different facility services are supported. A facility ser vice is not available unless both the FacilityService Service Name and the Facilit yService Service Number settings are properly set. Only FacilityService Service 1 is available on the Touch controller. The name will show on the facility service call button, which appears when you tap the question mark icon in the top bar. The other services are available for system integrators using the API (Application Programming Interface) command set.

Requires user role: ADMIN

Value space: <S: 0, 1024>

Example:

xConfiguration FacilityService Service 1 Type: Helpdesk

Format: String with a maximum of 1024 characters.

xConfiguration FacilityService Service 1 Name: ""

xConfiguration FacilityService Service [1..5] Number

Enter the number (URI or phone number) of the facility service. Up to five different facility services are supported. A facility service is not available unless both the FacilityService Service Name and

the FacilitySer vice Service Number set tings are properly set. Only FacilityService Service 1 is available on the Touch controller; the other options are available for system integrators using the API

(Application Programming Interface) command set.

Requires user role: ADMIN

Value space: <S: 0, 1024>

Format: String with a maximum of 1024 characters.

Example:

xConfiguration FacilityService Service 1 Number: ""

xConfiguration FacilityService Service [1..5] CallType

Set the call type for 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; the other options are available for system integrators using the API (Application

Programming Interface) command set.

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 SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

GPIO configuration

xConfiguration GPIO Pin [1..4] Mode

The four GPIO pins are configured individually. The state can be retrieved by "xStatus GPIO Pin

[1..4] State". The default pin state is High (+12 V). When activated as output, they are set to 0 V. To

activate them as input, they must be pulled down to 0 V.

Requires user role: ADMIN

Value space: <InputNoAction/OutputManualState/OutputInCall/OutputMicrophonesMuted/

OutputPresentationOn/OutputAllCallsEncrypted/OutputStandbyActive/InputMuteMicrophones>

InputNoAction: The pin state can be set, but no operation is performed. OutputManualState: The pin state can be set by "xCommand GPIO ManualState Set PinX: <High/

Low>" (to +12 V or 0 V, respectively).

OutputInCall: The pin is activated when in call, deactivated when not in call. OutputMicrophonesMuted: The pin is activated when microphones are muted, deactivated when

not muted. OutputPresentationOn: The pin is activated when presentation is active, deactivated when presen-

tation is not active. OutputAllCallsEncrypted: The pin is activated when all calls are encr ypted, deactivated when one

or more calls are not encrypted. OutputStandbyActive: The pin is activated when the system is in standby mode, deactivated when

no longer in standby. InputMuteMicrophones: When the pin is activated (0 V), the microphones will be muted. When

deactivated (+12 V), the microphones are unmuted.

Example:

xConfiguration GPIO Pin 1 Mode: InputNoAction

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 LAN 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 suppor t. 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: ""

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration H323 Profile [1..1] Authentication Mode

Set the authentication 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. 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. 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: ""

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] Encryption KeySize

Define the minimum or maximum key size for the Diffie-Hellman key exchange method, which is

used when establishing the Advanced Encryption Standard (AES) encryption key.

Requires user role: ADMIN

Value space: <Min1024bit/Max1024bit/Min2048bit>

Min1024b i t: The minimum size is 1024 bit. Ma x1024 bi t: The maximum size is 1024 bit. Min2048bit: The minimum size is 2048 bit.

Example:

xConfiguration H323 Profile 1 Encryption MinKeySize: Max1024bit

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration H323 Profile [1..1] Gatekeeper Address

Enter the IP address of the Gatekeeper. 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 signaling.

Requires user role: ADMIN

Value space: <Dynamic/Static>

Dynamic: The system will allocate which por ts 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. 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 por ts are given within a static predefined range [5555-6555].

Example:

xConfiguration H323 Profile 1 PortAllocation: Dynamic

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Logging configuration

xConfiguration Logging Mode

Not applicable in this version.

Network configuration

xConfiguration Network [1..1] IPStack

Select if the system should use IPv4, IPv6, or dual IP stack, on the network interface. NOTE: After changing this setting you may have to wait up to 30 seconds before it takes effect.

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 setting is only applicable when Network Assignment is set to Static.

Requires user role: ADMIN

Value space: <S: 0, 64>

Example:

xConfiguration Network 1 IPStack: Dual

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

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

xConfiguration Network 1 IPv4 Assignment: DHCP

Format: A valid IPv4 address.

xConfiguration Network 1 IPv4 Address: "192.0.2.2"

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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 Net work 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 set ting determines which method to use.

Example:

xConfiguration Network 1 IPv6 Assignment: Autoconf

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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 server (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.

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] 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 Diffser v, the Network QoS Dif fserv Audio, Network

QoS Diffserv Video, Network QoS Diffserv Data, Network QoS Dif fserv 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

This setting will only take effect if Network QoS Mode is set to Diffser v.

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] 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 Address: ""

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Network [1..1] QoS Diffserv Video

This setting will only take effect if Network QoS Mode is set to Diffser v. 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

This setting will only take effect if Network QoS Mode is set to Diffser v. 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 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 Data: 0

xConfiguration Network [1..1] QoS Diffserv Signalling

This setting will only take effect if Network QoS Mode is set to Diffser v.

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

This setting will only take effect if Network QoS Mode is set to Diffser v.

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Network [1..1] QoS Diffserv NTP

This setting will only take effect if Network QoS Mode is set to Diffser v. 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 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 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 cer tificates 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 ser vers with a valid certificate will be allowed.

Example:

xConfiguration Network 1 IEEE8021X TlsVerify: Off

xConfiguration Network [1..1] IEEE8021X UseClientCertificate

Authentication using a private key/certificate pair during an IEEE802.1x connection. The authen-

tication 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 per form 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 unencr ypted identity with EAP (Extensible Authentication Protocol) types that support different tunneled identity, like EAP-PEAP and

EAP-TTLS. 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: ""

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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

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

Ran ge: Select a value between 576 and 1500 bytes.

Example:

xConfiguration Network 1 MTU: 1500

xConfiguration Network [1..1] Speed

Set the Ethernet link speed.

Requires user role: ADMIN

Value space: <Auto/10 half/10full/100hal f/100f ull/100 0f ull>

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

Example:

xConfiguration Network 1 Speed: Auto

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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

ing network traffic.

Example:

xConfiguration Network 1 TrafficControl: On

xConfiguration Network [1..1] RemoteAccess Allow

Define which IP addresses (IPv4/IPv6) are allowed for remote access to the codec from SSH/ Telnet/HTTP/HTTPS. Multiple IP addresses are separated by a white space.

A network mask (IP range) is specified by <ip address>/N, where N is 1-32 for IPv4, and N is 1-128 for IPv6. The /N is a common indication of a network mask where the first N bits are set. Thus

192.168.0.0/24 would match any address starting with 192.168.0, since these are the first 24 bits in the address.

Requires user role: ADMIN

Value space: <S: 0, 255>

Format: String with a maximum of 255 characters.

Example:

2001:0db8:0000:0000:0000:ff00:0042:8329 2001:db8:abcd:0012::0/64"

xConfiguration Network 1 RemoteAccess Allow: "10.11.2.3 192.168.0.0/24

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 have Cisco UCM (Cisco Unified Communications Manager) as provisioning infrastructure. Note that Auto mode will NOT work if the NetworkSer vices CDP Mode setting is Off.

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

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 between 1 and 4094.

Example:

xConfiguration Network 1 VLAN Voice VlanId: 1

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

NetworkServices configuration

xConfiguration NetworkServices CDP Mode

Enable or disable the CDP (Cisco Discovery Protocol) daemon. Enabling CDP will make the endpoint report certain statistics and device identifiers to a CDP-enabled switch. If CDP is disabled, the Network VLAN Voice Mode: Auto setting will not work.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The CDP daemon is disabled. On: The CDP daemon is enabled.

Example:

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>

Example:

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.

Requires user role: ADMIN

Value space: <Off/O n>

Example:

xConfiguration NetworkServices CDP Mode: On

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

xConfiguration NetworkServices H323 Mode: On

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

xConfiguration NetworkServices HTTP Mode: On

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

Choose which information the user should see when logging on to the codec through Telnet/SSH.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The welcome text is: Login successful On: The welcome text is: Welcome to <system name>; Software version; Software release date;

Example:

xConfiguration NetworkServices WelcomeText: On

xConfiguration NetworkServices XMLAPI Mode

Enable or disable the video system's XML API. For securit y 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 XMLAPI Mode: On

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration NetworkServices MultiWay Address

The MultiWay address must be equal to the Conference Factory 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>

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

Example:

xConfiguration NetworkServices MultiWay Address: "h323:multiway@company.com"

xConfiguration NetworkServices MultiWay Protocol

Determine the protocol to be used for MultiWay calls.

Requires user role: ADMIN

Value space: <Auto/H323/Sip>

Auto: The system will select the protocol for MultiWay calls. H323: The H323 protocol will be used for MultiWay calls. Sip: The SIP protocol will be used for MultiWay calls.

Example:

xConfiguration NetworkServices MultiWay Protocol: Auto

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.

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

xConfiguration NetworkServices HTTPS VerifyServerCertificate

When the video system connects to an external HTTPS 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 server certificate 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 certificate 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 Cer tificate 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 corre-

sponding certificate has been revoked, then the HT TPS 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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration NetworkServices HTTPS OCSP URL

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

Requires user role: ADMIN

Value space: <S: 0, 255>

Format: String with a maximum of 255 characters.

Example:

com:81"

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

xConfiguration NetworkServices Medianet Metadata

Switch On or Off the capability to tag media flows with metadata related to the Cisco Medianet deployment.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Media flows will not be tagged with such metadata. On: Media flows will be tagged with such metadata.

Example:

xConfiguration NetworkServices Medianet Metadata: Off

xConfiguration NetworkServices NTP Mode

The Network Time Protocol (NTP) is used to synchronize the system's time and date to a reference

time ser ver. The time server will be queried regularly for time updates.

Requires user role: ADMIN

Value space: <Auto/Manual/Off>

Auto: The system will use an NTP server for time reference. As default, the server address will be obtained from the network’s DHCP server. If a DHCP server is not used, or if the DHCP server does not provide an NTP server address, the NTP ser ver address that is specified in the

NetworkServices NTP Address setting will be used.

Manual: The system will use the NTP server that is specified in the NetworkServices NTP Address setting for time reference.

Off: The system will not use an NTP server. The Network Services NTP Address setting will be

ignored.

Example:

xConfiguration NetworkServices NTP Mode: Auto

xConfiguration NetworkServices NTP Address

The address of the NTP server that will be used when NetworkServices NTP Mode is set to Manual, and when NetworkServices NTP Mode is 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: "0.tandberg.pool.ntp.org"

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 at tention. 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: ReadOnly

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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 CommunityName: "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

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 CTMS Mode

This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence Multipoint Switch (CTMS).

Video systems are able to initiate or join non-encrypted multipar ty conferences controlled by CTMS

version 1.8 or later. Encrypted conferences are supported as from sof tware versions CTMS 1.9.1.

Encryption is addressed in the NetworkServices CTMS Encryption setting.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Multiparty conferencing via CTMS is prohibited. On: Multiparty 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 par ticipate 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 SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration NetworkServices UPnP Mode

Fully disable UPnP (Universal Plug and Play), or enable UPnP for a short time period af ter the video system has been switched on or restarted.

The default operation is that UPnP is enabled when you switch on or restart the video system. Then

UPnP is automatically disabled after the timeout period that is defined in the NetworkServices UPnP

Timeout setting.

When UPnP is enabled, the video system advertises its presence on the network. The advertisement permits a Touch controller to discover video systems automatically, and you do not need to manually enter the video system's IP address in order to pair the Touch controller.

Requires user role: ADMIN

Value space: <Off/O n>

Off: UPnP is disabled. The video system does not advertise its presence, and you have to enter the video system's IP address manually in order to pair a Touch controller to the video system.

On: UPnP is enabled. The video system advertises its presence until the timeout period expires.

Example:

xConfiguration NetworkServices UPnP Mode: On

xConfiguration NetworkServices UPnP Timeout

Define for how many seconds UPnP shall stay enabled after the video system is switched on or restar ted. The NetworkServices UPnP Mode setting must be On for this setting to take any effect.

Requires user role: ADMIN

Value space: <0..3600>

Ran ge: Select a value between 0 and 3600 seconds.

Example:

xConfiguration NetworkServices UPnP Timeout: 600

Peripherals configuration

xConfiguration Peripherals Pairing CiscoTouchPanels RemotePairing

In order to use Cisco Touch 10 (touch panel) as user interface for the video system, Touch 10 must

be either directly connected to the video system or paired to the video system via LAN. The latter is

referred to as remote pairing.

Remote pairing is allowed by default; you must switch this setting Off if you want to prevent remote

pairing.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Remote pairing of Touch 10 is not allowed. On: Remote pairing of Touch 10 is allowed.

Example:

xConfiguration Peripherals Profile TouchPanels

Set the number of touch panels that are expected to be connected to the video system. This infor-

mation is used by the video system’s diagnostics service. If the number of connected touch panels does not match this setting, the diagnostics service will report it as an inconsistency. Note that only one Cisco Touch controller is supported in this version.

Requires user role: ADMIN

Value space: <No tSet /Min imu m1/0/1/ 2/3/4/ 5>

Example:

xConfiguration Peripherals Pairing CiscoTouchPanels RemotePairing: On

NotSet: No touch panel check is performed. Minimum1: At least one touch panel should be connected to the video system. 0-5: This number of Touch controllers should be connected to the video system.

xConfiguration Peripherals Profile TouchPanels: NotSet

Cisco TelePresence SX80 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 server.

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: Not applicable. Removed as from TC7.3.3. CUCM: Select CUCM if the phonebook is located on the Cisco Unified Communications Manager.

xConfiguration Phonebook Server 1 Type: TMS

Format: String with a maximum of 255 characters.

xConfiguration Phonebook Server 1 URL: "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/Edge>

Example:

xConfiguration Provisioning Connectivity: Auto

Off: The video system will not be configured by a provisioning system. Auto: The provisioning server will automatically be selected by the video system. TMS: The video system will be configured using TMS (Cisco TelePresence Management System).

VCS: The video system will be configured using VCS (Cisco TelePresence Video Communication

Server).

Callway: Not applicable. Removed as from TC7.3.3.

CUCM: The video system will be configured using CUCM (Cisco Unified Communications

Manager).

Edge: The system will connect to CUCM via the Collaboration Edge infrastructure.

xConfiguration Provisioning Mode: Auto

Cisco TelePresence SX80 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 provi-

sioning server. This setting must be used when required by the provisioning server.

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

sioning server. This setting must be used when required by the provisioning server.

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 server supports GET. POST: Select POST when the provisioning server suppor ts 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 AlternateAddress

Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager

(CUCM) and an alternate CUCM is available for redundancy. Enter the address of the alternate

CUCM. If the main CUCM is not available, the endpoint will be provisioned by the alternate CUCM.

When the main CUCM is available again, the endpoint will be provisioned by this CUCM.

Requires user role: ADMIN

Value space: <S: 0, 64>

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

Example:

xConfiguration Provisioning ExternalManager AlternateAddress: ""

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 HT TP Mode setting.

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

Example:

xConfiguration Provisioning ExternalManager Protocol: HTTP

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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/

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 por ts. As default, the system is using the UDP ports in the range 2326 to 2487 for RTP and RTCP media

data. Each media channel is using two adjacent ports for RTP and RTCP. The default number of

ports required in the UDP port range is based on the number of simultaneous calls that the endpoint

is capable of.

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

Requires user role: ADMIN

Value space: <1024..6543 8>

Ran ge: Select a value between 1024 and 65438.

Example:

xConfiguration RTP Ports Range Stop

Specify the last RTP port in the range. As default, the system is using the UDP ports in the range 2326 to 2487 for RTP and RTCP media

data. Each media channel is using two adjacent ports for RTP and RTCP. The default number of

ports required in the UDP port range is based on the number of simultaneous calls that the endpoint

is capable of.

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

Requires user role: ADMIN

Value space: <1120..65535>

Example:

xConfiguration RTP Ports Range Start: 2326

Ran ge: Select a value between 1120 and 65535.

xConfiguration RTP Ports Range Stop: 2486

Cisco TelePresence SX80 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. The audit logs are sent to a syslog server. When using the External/ExternalSecure modes and setting the port assignment to manual in the

Security Audit Server PortAssignment setting, you must also enter the address and port number for the audit server in the Security Audit Server Address and Security Audit Server Port settings.

Requires user role: AUDIT

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

Off: No audit logging is performed. Internal: The system records the audit logs to internal logs, and rotates logs when they are full. External: The system sends the audit logs to an external syslog server. The syslog ser ver must

su p p o r t U D P. ExternalSecure: The system sends encrypted audit logs to an external 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 certificate in the CA list must match the IP address of the syslog server, and the secure TCP server must be set up to listen for secure (TLS) TCP Syslog messages.

Example:

xConfiguration Security Audit OnError Action

Determine what happens when the connection to the syslog server is lost. This setting is only relevant when Security Audit Logging Mode is set to ExternalSecure.

Requires user role: AUDIT

Value space: <Halt/Ignore>

Example:

xConfiguration Security Audit Logging Mode: Off

Halt: If a halt condition is detected the system codec 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 syslog server. Halt conditions are: A network breach (no physical link), no syslog server running (or incorrect address or port to the syslog ser ver), 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 syslog server.

xConfiguration Security Audit OnError Action: Ignore

xConfiguration Security Audit Server Address

The audit logs are sent to a syslog server. Enter the IP address of the syslog 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.

Requires user role: AUDIT

Value space: <S: 0, 64>

Format: A valid IPv4 address or IPv6 address

Example:

xConfiguration Security Audit Server Address: ""

xConfiguration Security Audit Server Port

The audit logs are sent to a syslog server. Enter the port of the syslog ser ver that the system shall send its audit logs to. This setting is only relevant when Security Audit PortAssignment is set to

Manual.

Requires user role: AUDIT

Value space: <0..65535>

Ran ge: Select a value between 0 to 65535.

Example:

xConfiguration Security Audit Server Port: 514

xConfiguration Security Audit Server PortAssignment

The audit logs are sent to a syslog server. You can define how the port number of the external syslog server will be assigned. This setting is only relevant when Security Audit Logging Mode is set to External or ExternalSecure. To see which port number is used you can check the Security Audit Server Port status. Navigate to Configuration > System status on the web interface or; if on a command line interface, run the command xStatus Security Audit Server Port.

Requires user role: AUDIT

Value space: <Auto/Manual>

Auto: Will use UDP port number 514 when the Security Audit Logging Mode is set to External. Will

use TCP port number 6514 when the Security Audit Logging Mode is set to ExternalSecure. Manual: Will use the port value defined in the Security Audit Server Port setting.

Example:

xConfiguration Security Audit Server PortAssignment: Auto

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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

SerialPort configuration

xConfiguration SerialPort Mode

Enable/disable the serial port (COM port).

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable the serial por t. 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 115200.

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

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

SIP configuration

xConfiguration SIP ANAT

ANAT (Alternative Network Address Types) enables media negotiation for multiple addresses and address types, as specified in RFC 4091.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable ANAT. On: Enable ANAT.

Example:

xConfiguration SIP AuthenticateTransferror

Not applicable in this version.

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

Example:

xConfiguration SIP PreferredIPMedia

Define the preferred IP version for sending and receiving media (audio, video, data). Only applicable when both Network IPStack and Conference CallProtocolIPStack are set to Dual, and the network does not have a mechanism for choosing the preferred IP version.

Requires user role: ADMIN

Value space: <IPv4/IPv6>

Example:

xConfiguration SIP ANAT: Off

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

xConfiguration SIP ListenPort: On

IPv4: The preferred IP version for media is IPv4. IPv6: The preferred IP version for media is IPv6.

xConfiguration SIP PreferredIPMedia: IPv4

xConfiguration SIP PreferredIPSignaling

Define the preferred IP version for signaling (audio, video, data). Only applicable when both Network IPStack and Conference CallProtocolIPStack are set to Dual, and the network does not have a mechanism for choosing the preferred IP version. It also determines the priority of the A/AA AA lookups in DNS, so that the preferred IP version is used for registration.

Requires user role: ADMIN

Value space: <IPv4/IPv6>

IPv4: The preferred IP version for signaling is IPv4. IPv6: The preferred IP version for signaling is IPv6.

Example:

xConfiguration SIP PreferredIPSignaling: IPv4

xConfiguration SIP OCSP Mode

Not applicable in this version.

xConfiguration SIP OCSP DefaultResponder

Not applicable in this version.

xConfiguration SIP Profile [1..1] Ice Mode

ICE (Interactive Connectivity Establishment, RFC 5245) is a NAT traversal solution that the endpoints can use to discover the optimized media path. Thus the shor test route for audio and video is always secured between the endpoints. NOTE: ICE is not supported when registered to CUCM (Cisco

Unified Communication Manager).

Requires user role: ADMIN

Value space: <Auto/Off/On>

Auto: When set to Auto, ICE will be enabled if a turn server is provided, otherwise ICE will be

disabled.

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

Example:

xConfiguration SIP Profile 1 Ice Mode: Auto

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration SIP Profile [1..1] Ice DefaultCandidate

This is the default IP address that the endpoint will receive media on until ICE has reached a conclu-

sion about which media route to use (up to the first 5 seconds of a call.

Requires user role: ADMIN

Value space: <Host/Rflx/Relay>

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.

Example:

xConfiguration SIP Profile 1 Ice DefaultCandidate: Host

xConfiguration SIP Profile [1..1] Turn DiscoverMode

Set the discover mode to enable/disable the application to search for available Turn servers in DNS. Before making calls, the system will test if port allocation is possible.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Set to Off to disable discovery mode. On: When set to On, the system will search for available Turn servers in DNS, and before making

calls the system will test if port allocation is possible.

Example:

xConfiguration SIP Profile Turn DiscoverMode: On

xConfiguration SIP Profile [1..1] Turn BandwidthProbe

Not applicable in this version.

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>

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

Example:

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

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] Turn DropRflx

DropRflx will make the endpoint force media through the Turn relay, unless the remote endpoint is on the same network.

Requires user role: ADMIN

Value space: <Off/O n>

Off: Disable DropRflx. On: The system will force media through the Turn relay when the remote endpoint is on another

network.

Example:

xConfiguration SIP Profile Turn DropRflx: Off

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"

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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: <TCP/UDP/T ls/Au to>

TCP: The system will always use TCP as the default transport method. UDP: The system will always use UDP as the default transport method. Tls: The system will always use TLS as the default transport method. For TLS connections a SIP

CA-list can be uploaded to the video system. If no such CA-list is available on the system then anonymous 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

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 server against the local CA-list. This should typically be selected if no SIP CA-list has been uploaded.

On: Set to On to verify TLS connections. Only TLS connections to servers, whose x.509 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 supports 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 ser vers in the Proxy Address list. A random proxy is

selected from the list for each SIP outbound request.

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. 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: If SIP Profile Outbound is enabled, use a fully qualified domain name. If SIP Profile Outbound is disabled, you can also use a valid IPv4 address or IPv6 address.

Example:

xConfiguration SIP Profile 1 Proxy 1 Address: ""

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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 behavior for a vendor or provider.

Requires user role: ADMIN

Value space: <Standard/Cisco>

Standard: Use this when registering to standard SIP Proxy (tested with Cisco TelePresence VCS and Broadsoft)

Cisco: Use this when registering to Cisco Unified Communication Manager.

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 empt y 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"

xConfiguration SIP Profile [1..1] Line

When registered to a Cisco Unified Communications Manager (CUCM) the endpoint may be part 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 part 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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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. 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. 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 between 1 and 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: DefaultCameraPosition

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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

SystemUnit configuration

xConfiguration SystemUnit Name

Define the system name. The system name will be sent as the hostname in a DHCP request and when the codec is acting as an SNMP Agent.Define the system name. The system name will be sent as the hostname in a DHCP request and when the codec is acting as an SNMP Agent.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration SystemUnit MenuLanguage

This has been replaced with the UserInterface Language setting.

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 xCommand CallHistory Get command.

Requires user role: ADMIN

Value space: <Off/O n>

Example:

xConfiguration SystemUnit Name: "Meeting Room"

Off: Disable logging. On: Enable logging.

xConfiguration SystemUnit CallLogging Mode: On

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 IrSensor

Not applicable in this version.

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Time configuration

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 DateFormat

Set the date format.

Requires user role: USER

Value space: <DD_MM_YY/MM_DD_YY/YY_MM_DD>

Example:

xConfiguration Time Zone

This has been replaced with the Time OlsonZone setting as of software version TC7.2.

xConfiguration Time TimeFormat: 24H

DD _ MM_YY: The date Januar y 30th 2010 will be displayed: 30.01.10 MM _ D D_YY: 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

xConfiguration Time DateFormat: DD _ MM _ YY

xConfiguration Time OlsonZone

Set the time zone for the geographical location of the video system. The information in the value space is from the tz database, also called the IANA Time Zone Database.

Requires user role: USER

Value space: <Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara,

Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/

Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/

Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/

Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/

Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/ Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/ Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/ Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/ Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/ Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/

Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/

Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Wayne, America/

Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/

Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/

Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/

Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/

Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/

Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/

Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/

Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/

Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/ Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/ Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/ Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/ Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/ Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/ St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/ Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/

Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha,

Brazil/East, Brazil/West, CET, CST6CDT, Canada/Atlantic, Canada/Central, Canada/ East-Saskatchewan, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Cuba, EET, EST, EST5EDT, Egypt, Eire, Etc/GMT, Etc/GMT+0, Etc/GMT+1, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12, Etc/ GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/ GMT-0, Etc/GMT-1, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT0, Etc/ Greenwich, Etc/UCT, Etc/UTC, Etc/Universal, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/ Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/ Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/ London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GB-Eire, GMT, GMT+0, GMT-0, GMT0, Greenwich, HST, Hongkong, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, PST8PDT, Pacific/Apia, Pacific/Auckland, Pacific/Chatham, Pacific/Chuuk,

Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/

Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston,

Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/

Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/

Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga,

Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk,

Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, ROC, ROK, Singapore, Turkey, UCT, US/ Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/

Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, Universal,

W-SU, WET, Zulu>

Ran ge: Select a time zone from the list.

Example:

xConfiguration Time OlsonZone: Etc/UTC

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

UserInterface configuration

xConfiguration UserInterface Language

Select the language to be used in menus and messages on the screen and Touch controller. The default language is English.

Requires user role: USER

Value space: <English/ChineseSimplified/ChineseTraditional/Catalan/Czech/Danish/Dutch/Finnish/

French/German/Hungarian/Italian/Japanese/Korean/Norwegian/Polish/PortugueseBrazilian/Russian/ Spanish/Swedish/Turkish/Arabic/Hebrew>

Ran ge: Select a language from the list.

Example:

xConfiguration UserInterface OSD EncryptionIndicator

Define for how long the encryption indicator (a padlock) will be shown on screen. The setting applies to both encrypted and non-encrypted calls, i.e. both to secure and non-secure conferences.

The icon for encrypted calls is a locked padlock, and the icon for non-encrypted calls is a crossed

out locked padlock.

Requires user role: ADMIN

Value space: <Auto/AlwaysOn/AlwaysOff>

Example:

xConfiguration UserInterface Language: English

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 Encryption 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 Encr yption 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.

xConfiguration UserInterface OSD EncryptionIndicator: Auto

xConfiguration UserInterface OSD LanguageSelection

In cases where you want to prevent users from easily changing the language settings from the

Settings menu, the language settings can be made available from within the Administrator Settings

menu. The administrator settings can be password protected.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The language is set from the Administrator Settings menu. On: The language is set from the Settings menu.

Example:

xConfiguration UserInterface OSD LanguageSelection: On

xConfiguration UserInterface OSD LoginRequired

Not applicable in this version.

xConfiguration UserInterface OSD Output

Define on which monitor the on-screen information and indicators should be displayed.

Requires user role: ADMIN

Value space: <Au to/1/2/3>

Auto: The system will detect when a monitor is connected to a video output, and send the infor-

mation and indicators to the first monitor you connect. If you have a multi-monitor setup, and all monitors are connected before switching on the system, the information and indicators will be sent to the video output with the lowest number, starting with Output Connector 1 (HDMI 1).

Rang e 1- 3: The system will send the on-screen information and indicators to the specified output. Choose n to send the information and indicators to the system's Output Connector n.

Example:

xConfiguration UserInterface OSD Output: Auto

xConfiguration UserInterface Wallpaper

Select a background image (wallpaper) for the video screen when idle. You may upload a custom wallpaper to the video system using the web interface. The following file

formats are suppor ted: BMP, GIF, JPEG, PNG. The maximum file size is 2 MByte.

Requires user role: USER

Value space: <None/Custom>

None: There is no background image on the screen. Custom: Use the custom wallpaper as background image on the screen. If no custom wallpaper is

uploaded to the system, the setting will revert to the default value.

Example:

xConfiguration UserInterface Wallpaper: None

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration UserInterface TouchPanel DefaultPanel

Define what (contact list, meeting list, or dial pad) the Touch controller will display on wake up.

Requires user role: USER

Value space: <None/LastUsed/ContactList/MeetingList/Dialpad>

None: None of the below options will appear as default on the Touch controller. LastUsed: The last used (contact list, meeting list, or dial pad) will appear as default on the Touch

controller. ContactList: The contact list (favorites, directory and history) will appear as default on the Touch

controller.

MeetingList: The list of scheduled meetings will appear as default on the Touch controller. DialPad: The dial pad will appear as default on the Touch controller.

Example:

xConfiguration UserInterface TouchPanel DefaultPanel: None

xConfiguration UserInterface UserPreferences

Some user preferences (ringtone, volume, language, date and time, etc) can be made available from the Settings menu, or from the Settings > Administrator menu on the Touch controller. Accessing the Administrator menus requires that the user has admin privileges.

Requires user role: ADMIN

Value space: <Off/O n>

Off: The user preferences are available from the Settings > Administrator menu on the Touch controller, for users with admin privileges.

On: The user preferences are available from the Settings menu on the Touch controller.

Example:

xConfiguration UserInterface UserPreferences: On

Video configuration

xConfiguration Video AllowWebSnapshots

Note: This setting is only available in TC7.3.0 to TC7.3.2. Allow or disallow snapshots being taken of the local input sources, remote sites and presentation

channel. If snapshots are allowed, the snapshots may be captured both when idle and in a call.

When snapshots are taken from a remote device, e.g. the web interface, a notification appears on

the video system's screens to alert the users that remote monitoring is in operation.

Requires user role: ADMIN

Value space: <Off/On/LocalDeviceOnly>

Off: It is not possible to capture snapshots. On: Snapshots can be captured and displayed anywhere, e.g. on the web interface. LocalDeviceOnly: Snapshots can only be captured and displayed on devices running the experi-

mental Cisco Proximity feature. The devices must be in the same room as the video system. It will not be possible to take and see snapshots on the web interface or by using 3rd party integrations.

Example:

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>

Example:

xConfiguration Video AllowWebSnapshots: LocalDeviceOnly

Off: self-view is not shown automatically during call setup. On: self-view is shown automatically during call setup.

xConfiguration Video CamCtrlPip CallSetup Mode: On

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 CamCtrlPip CallSetup Duration: 10

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video DefaultPresentationSource

Not applicable for this product.

xConfiguration Video Input Connector [1..5] Name

Enter a name for the video input connector.

Requires user role: ADMIN

Value space: <S: 0, 50>

Format: String with a maximum of 50 characters.

Example:

xConfiguration Video Input Connector 1 Name: ""

xConfiguration Video Input Connector [1..5] InputSourceType

Select which type of input source is connected to the video input.

Requires user role: ADMIN

Value space: <other/camera/PC/DVD/document_camera/whiteboard>

other: Use this when none of the below options match. camera: Use this when a camera is connected to the video input. PC: Use this when a computer is connected to the video input. DVD: Use this when a DVD player is connected to the video input. document_camera: Use this when a document camera is connected to the video input. whiteboard: Use this when a whiteboard camera is connected to the video input.

Example:

xConfiguration Video Input Connector 2 InputSourceType: camera

xConfiguration Video Input Connector [1..5] Visibility

Define the visibility of the video input connector in the menus on the user interface.

Requires user role: ADMIN

Value space: <Never/Always/IfSignal>

Never: When the input source is not expected to be used as a presentation source, set to Never. Always: When set to Always, the menu selection for the video input connector will always be

visible on the graphical user interface. IfSignal: When set to IfSignal, the menu selection for the video input connector will only be visible

when something is connected to the video input.

Example:

xConfiguration Video Input Connector 2 Visibility: IfSignal

xConfiguration Video Input Connector [1..5] CameraControl Mode

Define whether the camera that is connected to this video input connector can be controlled or not.

Note that camera control is not available for Connector 4 (DVI-I) and Connector 5 (S-video/

Composite).

Requires user role: ADMIN

Value space: Connector 1, 2, 3: <Off/On> Connector 4,5: <Off>

Off: Disable camera control. On: Enable camera control.

Example:

xConfiguration Video Input Connector 1 CameraControl Mode: On

xConfiguration Video Input Connector [1..5] CameraControl CameraId

The camera ID is used to identify all cameras that are controlled from the codec. Use the xStatus

Camera API command to see the IDs of the different cameras.

Requires user role: ADMIN

Value space: Connector 1, 2, 3: <1/2/3/4/5/6/7> Connector 4,5: <1>

Ran ge: Select the ID of the camera.

Example:

xConfiguration Video Input Connector 1 CameraControl CameraId: 1

xConfiguration Video Input Connector [1..5] Quality

When encoding and transmitting video there will be a trade-off between high resolution and high

frame rate. For some video sources it is more important to transmit high frame rate than high

resolution and vice versa.

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 a large number of participants are present or when there is a lot of motion in the picture.

Sharpness: Gives the highest possible resolution. Used when you want the highest quality of detailed images and graphics.

Example:

xConfiguration Video Input Connector 3 Quality: Sharpness

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Input Connector [1..5] OptimalDefinition Profile

This setting will only take effect if the corresponding Video Input Connector Quality setting is set to

Motion.

The optimal definition profile reflects the lighting conditions in the video conferencing room and

the quality of the camera. The better lighting conditions and the better quality of the camera, the higher the profile. In good lighting conditions, the video encoder will provide better quality (higher resolution or frame rate) for a given call rate. Generally, the Normal or Medium profiles are recommended. However, when the lighting conditions are very 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. The resolution must be supported 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

Optimal

Frame rate

30 fps

H.265

60 fps

30 fps

H.264

60 fps

* H.265 is preferred over H.264, and the maximum bit rate for H.265 is 3 Mbps. When the user sets a higher bit rate,

the codec will still use H.265 at 3 Mbps as long as all codecs involved supports H.265.

Definition

Profile

Normal 1280 × 720 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080

Medium 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080 1920 × 1080 1920 × 1080

High 1920 × 1080 1920 × 1080 1920 × 1080 1920 × 1080 1920 × 1080 1920 × 1080

Normal 768 × 448 1024 × 576 1280 × 720 1280 × 720 1280 × 720 1280 × 720

Medium 1024 × 576 1280 × 720 1280 × 720 1280 × 720 1280 × 720 1280 × 720

High 1280 × 720 1280 × 720 1280 × 720 1280 × 720 1280 × 720 1280 × 720

Normal 1024 × 576 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080

Medium 1280 × 720 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080

High 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080 1920 × 1080

Normal 640 × 360 768 × 448 1024 × 576 1280 × 720 1280 × 720 1920 × 1080

Medium 768 × 448 1024 × 576 1024 × 576 1280 × 720 1920 × 1080 1920 × 1080

High 1024 × 576 1280 × 720 1280 × 720 1920 × 1080 1920 × 1080 1920 × 1080

768 k bp s 115 2 k b p s 1472 kbp s 2560 kbps 4 Mbps

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.

High: Requires nearly optimal video conferencing lighting conditions and a good quality video input

in order to achieve a good overall experience. Rather high resolutions will be used.

Example:

xConfiguration Video Input Connector 1 OptimalDefinition Profile: Medium

Call rate

6 Mbps

xConfiguration Video Input Connector [1..5] 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 frame rate would be 30fps,

while above this resolution 60fps would also be possible, if the available bandwidth is adequate.

Requires user role: ADMIN

Value space: <512_288/768_448/1024_576/1280_720/1920_1080/Never>

512_ 2 88: Set the threshold to 512x288. 768 _4 48: Set the threshold to 768x448. 1024 _576: Set the threshold to 1024x576. 128 0 _720: 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 Connector 1 OptimalDefinition Threshold60fps:

xConfiguration Video Input Connector [1..4] PresentationSelection

Define how the video system will behave when you connect a presentation source to the video input.

If the video system is in standby mode, it will wake up when you connect a presentation source. Note that sharing the presentation with the far end always requires additional action (press Share

on the user interface).

Requires user role: ADMIN

Value space: <Manual/Automatic/OnConnect>

Manual: In manual mode, the contents of the video input will not be presented on the screen until

you choose it from the user interface. Automatic: In automatic mode, the contents on the video input will be presented on screen

automatically. If more than one source is set to Automatic, the last connected source will be used.

If any content is active (presented) when a call is disconnected, the content will still be displayed

locally.

OnConnect: When in on-connect mode, the content on the video input will be presented on

screen when a cable is connected. Otherwise, the behavior is the same as in manual mode.

Example:

xConfiguration Video Input Connector 1 PresentationSelection: Manual

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Input Connector [1..4] RGBQuantizationRange

The devices connected to the video input 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 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 CEA-861-E. CE video formats will use limited quantization range levels. IT video formats will use full quantization range levels.

Full: Full quantization range. The R, G, B quantization range includes all code values (0 - 255). This

is 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 Connector 1 RGBQuantizationRange: Auto

xConfiguration Video Input Connector [4] DviType

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 carr y 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 Connector 4 DviType: AutoDetect

xConfiguration Video Input Connector [5] SignalType

Connector 5 can be used for either S-Video or Composite video input format. Use this setting to

configure which video format the BNC connector(s) are used for.

Requires user role: ADMIN

Value space: <Composite/YC>

Composite: Connector 5 is configured for composite video input. Only the BNC connector that is

labeled "Y" is used. YC: Connector 5 is configured for S-Video input. Both BNC connectors ("Y" and "C") are used.

Example:

xConfiguration Video Input Connector 5 SignalType: Composite

xConfiguration Video Layout DisableDisconnectedLocalOutputs

This setting is fixed to On.

Requires user role: ADMIN

Value space: <On>

On: The built-in layout engine does only set layout on local outputs having a monitor connected.

Example:

xConfiguration Video Layout DisableDisconnectedLocalOutputs: On

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: Do not use this value.

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: Do not use this value.

PresentationLargeSpeaker: Do not use this value.

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 par ticipants 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 LocalLayoutFamily: Auto

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Layout PresentationDefault View

Determine how the presentation will show on screen when you start sharing a presentation.

Requires user role: ADMIN

Value space: <Default/Minimized/Maximized>

Default: The presentation is a part of the layout. Minimized: The presentation starts up in PIP mode. Maximized: The presentation starts up in full screen mode.

Example:

xConfiguration Video Layout PresentationDefault View: Default

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: Do not use this value. 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: Do not use this value. PresentationLargeSpeaker: Do not use this value. 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 RemoteLayoutFamily: Auto

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

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 ret chToF it: 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 between 0 and 100 percent.

Example:

xConfiguration Video Layout ScaleToFrameThreshold: 5

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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 effect 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 Touch controller.

The setting takes effect from the next call onwards; if changed during a call, it will have no effect on

the current call.

Requires user role: ADMIN

Value space: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/

LowerRight>

Current: The position of the presentation PiP will be kept unchanged when leaving a call. UpperLeft: The presentation PiP will appear in the upper left corner of the screen. UpperCenter: The presentation PiP will appear in the upper center position. UpperRight: The presentation PiP will appear in the upper right corner of the screen. CenterLeft: The presentation PiP will appear in the center left position. CentreRight: The presentation PiP will appear in the center right position. LowerLeft: The presentation PiP will appear in the lower left corner of the screen. LowerRight: The presentation PiP will appear in the lower right corner of the screen.

Example:

xConfiguration Video PIP Presentation DefaultValue Position: Current

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 SelfviewDefault FullscreenMode settings respectively.

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 af ter 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

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

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

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 lef t 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 Connector [n] MonitorRole setting.

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 set ting is set to Dual or Triple.

Requires user role: ADMIN

Value space: <First/Second/Third/Current>

First: The self-view picture will be shown on outputs with the Video Output Connector [n]

MonitorRole set to First.

Second: The self-view picture will be shown on outputs with the Video Output Connector [n]

MonitorRole set to Second.

Third: The self-view picture will be shown on outputs with the Video Output Connector [n]

MonitorRole set to Third.

Current: When leaving a call, the self-view picture will be kept on the same output as it was during the call.

Example:

xConfiguration Video SelfviewDefault OnMonitorRole: Current

xConfiguration Video Monitors

A role is assigned to each monitor using the Video Output Connector [n] MonitorRole setting. The

monitor role decides which layout (call participants and presentation) will appear on the monitor that is connected to this output. Monitors with the same monitor role will get the same layout; monitors with different monitor roles will have different layouts.

The monitor layout mode that is set in the Video Monitors setting should reflect the number of different layouts you want in your room setup. Note that some monitors can be reserved for

presentations.

Requires user role: ADMIN

Value space: <Auto/Single/Dual/DualPresentationOnly/TriplePresentationOnly/Triple>

Auto: The number of monitors connected to the codec is automatically detected, and the layout is

distributed on the monitors according to the MonitorRole settings.

Sin gle: The same layout is shown on all monitors.

Dual: The layout is distributed on monitors with monitor role First and Second. If a presentation is

part of the layout, all participants in the call are shown on monitors with monitor role First, and the

presentation is shown on monitors with monitor role Second.

DualPresentationOnly: All participants in the call are shown on monitors with monitor role First. If a

presentation is part of the layout, the presentation is shown on monitors with monitor role Second. Triple: The layout is distributed on monitors with monitor role First, Second and Third. If a presen-

tation is part of the layout, all participants in the call are shown on monitors with monitor role First

and Second, and the presentation is shown on the monitor with monitor role Third. TriplePresentationOnly: All participants in the call are distributed on monitors with monitor role First

and Second. If a presentation is part of the layout, the presentation is shown on the monitor with

monitor role Third.

Example:

xConfiguration Video Monitors: Auto

xConfiguration Video OSD LanguageSelection

This has been replaced with the UserInterface OSD LanguageSelection setting.

xConfiguration Video OSD EncryptionIndicator

This has been replaced with the UserInterface OSD EncryptionIndicator setting.

xConfiguration Video OSD Output

This has been replaced with the UserInterface OSD Output setting.

xConfiguration Video OSD LoginRequired

This has been replaced with the UserInterface OSD LoginRequired setting.

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Output Connector [1..2] CEC Mode

This video output (HDMI) supports Consumer Electronics Control (CEC). When this setting is On

(default is Off), the system will use CEC to set the monitor in standby when the system itself enters standby. Likewise the system will wake up the monitor when the system itself wakes up from standby. For this to happen, the monitor that is connected to the output must be CEC compatible and CEC must be configured on the monitor.

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 Connector 1 CEC Mode: Off

xConfiguration Video Output Connector [1..3] Location HorizontalOffset

HorizontalOffset and VerticalOffset settings are associated with each video output. These settings are used to signal the relative position of the displays that are connected to these outputs.

HorizontalOffset = 0 and VerticalOffset = 0 indicates that the display is positioned in center, both horizontally and vertically. A negative horizontal offset indicates that the monitor is left of center, and a positive horizontal offset indicates that the monitor is right of center. A negative vertical offset indicates that the monitor is below center, and a positive vertical offset indicates that the monitor is above center. The magnitude of the offset indicates how far the display is from center (relative to other displays).

Example: You have three displays side by side, with the left and right displays at equal distance from center. Then the following settings will apply: HorizontalOf fset = 0 for the center display, HorizontalOffset = -1 for the left display, and HorizontalOffset = 1 for the right display.

Example: You have two displays, one in center and one below. Then the following settings will apply: VerticalOffset = 0 for the center display, Vertical Offset = -1 for the lower display.

The default values for the different outputs are:

Video Output Connector [1] Location: HorizontalOffset = -1, VerticalOffset = 0 Video Output Connector [2] Location: HorizontalOffset = 0, VerticalOffset = 0 Video Output Connector [3] Location: HorizontalOffset = 1, VerticalOffset = 0

Requires user role: ADMIN

Value space: <-100..100>

Ran ge: The value must be between -100 and 100.

Example:

xConfiguration Video Output Connector 2 Location HorizontalOffset: -1

xConfiguration Video Output Connector [1..3] Location VerticalOffset

HorizontalOffset and VerticalOffset settings are associated with each video output. These settings

are used to signal the relative position of the displays that are connected to these outputs.

and a positive horizontal offset indicates that the monitor is right of center. A negative vertical offset

indicates that the monitor is below center, and a positive vertical offset indicates that the monitor is above center. The magnitude of the offset indicates how far the display is from center (relative to other displays).

Example: You have three displays side by side, with the left and right displays at equal distance

from center. Then the following settings will apply: HorizontalOf fset = 0 for the center display,

HorizontalOffset = -1 for the left display, and HorizontalOffset = 1 for the right display.

Example: You have two displays, one in center and one below. Then the following settings will apply: VerticalOffset = 0 for the center display, Vertical Offset = -1 for the lower display.

The default values for the different outputs are:

Video Output Connector [1] Location: HorizontalOffset = -1, VerticalOffset = 0

Video Output Connector [2] Location: HorizontalOffset = 0, VerticalOffset = 0

Video Output Connector [3] Location: HorizontalOffset = 1, VerticalOffset = 0

Requires user role: ADMIN

Value space: <-100..100>

Ran ge: The value must be between -100 and 100.

Example:

xConfiguration Video Output Connector 2 Location Vertical Offset: 0

xConfiguration Video Output Connector [1..3] RGBQuantizatonRange

Devices connected to an HDMI output 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>

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 Output Connector 1 RGBQuantizatonRange: Full

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

xConfiguration Video Output Connector [1..3] Resolution

Set the resolution and refresh rate for the connected screen.

Requires user role: ADMIN

Value space: <Auto/1280_720_50/1280_720_60/1920_1080_50/1920_1080_60>

Auto: The system will automatically try to set the optimal resolution based on negotiation with the connected monitor.

1280_720_50: The resolution is 1280 x 720, and the refresh rate is 50 Hz. 1280_720_60: The resolution is 1280 x 720, and the refresh rate is 60 Hz. 1920_1080_50: The resolution is 1920 x 1080, and the refresh rate is 50 Hz. 1920_1080_60: The resolution is 1920 x 1080, and the refresh rate is 60 Hz.

Example:

xConfiguration Video Output Connector 2 Resolution: Auto

xConfiguration Video Output Connector [1..3] MonitorRole

The monitor role describes which video streams will be shown on the monitor connected to this

video output connector. Together the Video Monitors setting and the MonitorRole settings for all outputs define which layout (video streams) will be shown on each monitor.

Requires user role: ADMIN

Value space: <Auto/First/Second/Third/PresentationOnly/Recorder>

Auto: The system will detect when a monitor is connected, and a monitor role (First, Second, Third) that corresponds with the Video Monitors setting will be assigned automatically.

First/Second/Third: Define the role of the monitor in a multi-monitor setup. In a single-monitor setup, there is no difference between First, Second and Third.

PresentationOnly: Show presentation video stream if active, and nothing else. Monitors/outputs with this monitor role are disregarded by the Video Monitors setting.

Recorder: Show all participants, including the local main video (self-view). If active, also show the presentation. Monitors/outputs with this monitor role are disregarded by the Video Monitors setting.

Example:

xConfiguration Video Output Connector 1 MonitorRole: Auto

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.

xConfiguration Video WallPaper

This has been replaced with the UserInterface Wallpaper setting.

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Chapter 4

xCommand commands

Cisco TelePresence SX80 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/sx-docs

Audio commands .................................................................................................................................. 88

xCommand Audio Equalizer List ................................................................................................................ 88

xCommand Audio Equalizer Update .......................................................................................................... 88

xCommand Audio LocalInput Add ............................................................................................................. 89

xCommand Audio LocalInput AddConnector ........................................................................................... 90

xCommand Audio LocalInput Remove ...................................................................................................... 90

xCommand Audio LocalInput RemoveConnector ..................................................................................... 90

xCommand Audio LocalInput Update ........................................................................................................91

xCommand Audio LocalOutput Add...........................................................................................................91

xCommand Audio LocalOutput AddConnector .........................................................................................92

xCommand Audio LocalOutput ConnectInput ...........................................................................................92

xCommand Audio LocalOutput DisconnectInput .......................................................................................92

xCommand Audio LocalOutput Remove ....................................................................................................92

xCommand Audio LocalOutput RemoveConnector ...................................................................................93

xCommand Audio LocalOutput Update .....................................................................................................93

xCommand Audio LocalOutput UpdateInputGain ......................................................................................94

xCommand Audio Microphones Mute ........................................................................................................94

xCommand Audio Microphones Unmute ...................................................................................................94

xCommand Audio RemoteOutput ConnectInput .......................................................................................94

xCommand Audio RemoteOutput DisconnectInput ...................................................................................94

xCommand Audio RemoteOutput UpdateInputGain ..................................................................................95

xCommand Audio Setup Clear ...................................................................................................................95

xCommand Audio Sound Play ....................................................................................................................95

xCommand Audio Sound Stop ...................................................................................................................95

xCommand Audio SoundsAndAlerts Ringtone List ...................................................................................95

xCommand Audio SoundsAndAlerts Ringtone Play ..................................................................................95

xCommand Audio Volume Decrease ........................................................................................................ 96

xCommand Audio Volume Increase .......................................................................................................... 96

xCommand Audio Volume Mute ................................................................................................................ 96

xCommand Audio Volume Set .................................................................................................................. 96

xCommand Audio Volume SetToDefault ................................................................................................... 96

xCommand Audio Volume UnMute ........................................................................................................... 96

xCommand Audio VUMeter Start .............................................................................................................. 96

xCommand Audio VUMeter Stop ............................................................................................................... 97

xCommand Audio VUMeter StopAll ........................................................................................................... 97

Bookings commands ............................................................................................................................ 97

xCommand Bookings Clear ........................................................................................................................97

xCommand Bookings List ......................................................................................................................... 98

Boot commands ................................................................................................................................... 99

xCommand Boot........................................................................................................................................ 99

Call commands ..................................................................................................................................... 99

xCommand Call Accept............................................................................................................................. 99

xCommand Call Disconnect ...................................................................................................................... 99

xCommand Call DisconnectAll .................................................................................................................. 99

xCommand Call Hold ............................................................................................................................... 100

xCommand Call HoldAll ........................................................................................................................... 100

xCommand Call Ignore ............................................................................................................................ 10 0

xCommand Call Join ............................................................................................................................... 100

xCommand Call Reject ............................................................................................................................ 100

xCommand Call Resume ......................................................................................................................... 10 0

xCommand Call UnattendedTransfer ...................................................................................................... 100

CallHistory commands .........................................................................................................................101

xCommand CallHistory AcknowledgeAllMissedCalls .............................................................................. 101

xCommand CallHistory AcknowledgeMissedCall ....................................................................................101

xCommand CallHistory DeleteAll .............................................................................................................101

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand CallHistory DeleteEntry .........................................................................................................101

xCommand CallHistory Get ......................................................................................................................102

xCommand CallHistory Recents ..............................................................................................................102

CamCtrlPip commands ....................................................................................................................... 10 3

xCommand CamCtrlPip ............................................................................................................................103

Camera commands ............................................................................................................................ 103

xCommand Camera PanTiltReset ............................................................................................................103

xCommand Camera PositionActivateFromPreset ....................................................................................103

xCommand Camera PositionReset ..........................................................................................................103

xCommand Camera PositionSet ..............................................................................................................104

xCommand Camera Preset Activate ........................................................................................................104

xCommand Camera Preset Edit ...............................................................................................................104

xCommand Camera Preset List ...............................................................................................................104

xCommand Camera Preset Remove ........................................................................................................105

xCommand Camera Preset Snapshot Get ...............................................................................................105

xCommand Camera Preset Snapshot Remove .......................................................................................105

xCommand Camera Preset Snapshot Store ............................................................................................105

xCommand Camera Preset Store ............................................................................................................105

xCommand Camera Ramp .......................................................................................................................106

xCommand Camera ReconfigureCameraChain .......................................................................................106

xCommand Camera TriggerAutofocus .....................................................................................................106

Cameras commands ............................................................................................................................107

xCommand Cameras SpeakerTrack Activate ...........................................................................................107

xCommand Cameras SpeakerTrack Deactivate .......................................................................................107

xCommand Cameras SpeakerTrack Whiteboard ActivatePosition ..........................................................107

xCommand Cameras SpeakerTrack Whiteboard AlignPosition ............................................................... 107

xCommand Cameras SpeakerTrack Whiteboard SetDistance ............................................................... 108

xCommand Cameras SpeakerTrack Whiteboard StorePosition ............................................................. 108

Dial commands ................................................................................................................................... 109

xCommand Dial ........................................................................................................................................109

DTMFSend commands ........................................................................................................................110

xCommand DTMFSend ............................................................................................................................ 110

FacilityService commands ...................................................................................................................110

xCommand FacilityService Dial ................................................................................................................11 0

FarEndControl commands ...................................................................................................................111

xCommand FarEndControl Camera Move ............................................................................................... 111

xCommand FarEndControl Camera Stop ................................................................................................. 111

xCommand FarEndControl Preset Activate.............................................................................................. 111

xCommand FarEndControl Preset Store .................................................................................................. 111

xCommand FarEndControl Source Select ............................................................................................... 112

GPIO commands ..................................................................................................................................112

xCommand GPIO ManualState Set .......................................................................................................... 112

HttpFeedback commands ...................................................................................................................113

xCommand HttpFeedback Deregister ..................................................................................................... 113

xCommand HttpFeedback Register ......................................................................................................... 113

Key commands ....................................................................................................................................113

xCommand Key Click ............................................................................................................................... 113

xCommand Key Press .............................................................................................................................. 113

xCommand Key Release .......................................................................................................................... 113

Logging commands .............................................................................................................................114

xCommand Logging ExtendedLogging Start ........................................................................................... 114

xCommand Logging ExtendedLogging Stop ........................................................................................... 114

Conference commands ...................................................................................................................... 108

xCommand Conference ActiveSpeaker Reset ....................................................................................... 108

xCommand Conference ActiveSpeaker Set ........................................................................................... 10 8

xCommand Conference DoNotDisturb Activate ..................................................................................... 108

xCommand Conference DoNotDisturb Deactivate ..................................................................................109

Message commands ...........................................................................................................................114

xCommand Message Alert Clear ............................................................................................................. 114

xCommand Message Alert Display .......................................................................................................... 114

xCommand Message Echo ......................................................................................................................11 5

xCommand Message FarendMessage ....................................................................................................11 5

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Message Prompt Clear .........................................................................................................11 5

xCommand Message Prompt Display ...................................................................................................... 115

xCommand Message Prompt Response .................................................................................................116

xCommand Message TextLine Clear ....................................................................................................... 116

xCommand Message TextLine Display .................................................................................................... 116

Peripherals commands ........................................................................................................................ 117

xCommand Peripherals Connect ............................................................................................................. 117

xCommand Peripherals HeartBeat ........................................................................................................... 117

xCommand Peripherals List ..................................................................................................................... 117

xCommand Peripherals ManualUpgrade ................................................................................................. 117

xCommand Peripherals Pairing DeviceDiscovery Start ........................................................................... 118

xCommand Peripherals Pairing Pair ......................................................................................................... 118

xCommand Peripherals Pairing Unpair .................................................................................................... 118

xCommand Peripherals Pairing Purge ..................................................................................................... 118

Phonebook commands ........................................................................................................................119

xCommand Phonebook Contact Add ......................................................................................................119

xCommand Phonebook Contact Delete...................................................................................................119

xCommand Phonebook Contact Modify ..................................................................................................119

xCommand Phonebook ContactMethod Add ..........................................................................................120

xCommand Phonebook ContactMethod Delete ......................................................................................120

xCommand Phonebook ContactMethod Modify ...................................................................................... 121

xCommand Phonebook Folder Add ......................................................................................................... 121

xCommand Phonebook Folder Delete ..................................................................................................... 121

xCommand Phonebook Folder Modify ....................................................................................................122

xCommand Phonebook Search ...............................................................................................................122

Presentation commands ..................................................................................................................... 12 3

xCommand Presentation Start ................................................................................................................. 123

xCommand Presentation Stop .................................................................................................................123

Preset commands ............................................................................................................................... 124

xCommand Preset Activate ......................................................................................................................124

xCommand Preset Clear ..........................................................................................................................124

xCommand Preset Store ..........................................................................................................................124

Provisioning commands ..................................................................................................................... 125

xCommand Provisioning CUCM CAPF OperationStart ............................................................................12 5

xCommand Provisioning CUCM CTL Delete ............................................................................................ 12 5

xCommand Provisioning CUCM CTL Show ............................................................................................. 125

xCommand Provisioning CUCM ExtensionMobility Login ........................................................................125

xCommand Provisioning CUCM ExtensionMobility Logout .....................................................................125

xCommand Provisioning CUCM ITL Show ............................................................................................... 12 5

xCommand Provisioning CompleteUpgrade ............................................................................................125

xCommand Provisioning PostponeUpgrade ............................................................................................126

xCommand Provisioning StartUpgrade ....................................................................................................126

Security commands ............................................................................................................................ 126

xCommand Security FIPSMode Activate .................................................................................................126

xCommand Security Persistency ............................................................................................................. 127

Standby commands .............................................................................................................................127

xCommand Standby Activate ................................................................................................................... 127

xCommand Standby Deactivate ............................................................................................................... 127

xCommand Standby ResetTimer.............................................................................................................. 127

SystemUnit commands ....................................................................................................................... 12 8

xCommand SystemUnit AdminPassword Set ..........................................................................................128

xCommand SystemUnit ConfigurationProfile CancelChange ..................................................................128

xCommand SystemUnit ConfigurationProfile Change .............................................................................128

xCommand SystemUnit ConfigurationProfile List ....................................................................................128

xCommand SystemUnit ConfigurationProfile Remove ............................................................................128

xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs ...........................................128

xCommand SystemUnit DateTime Get .....................................................................................................128

xCommand SystemUnit DateTime Set .....................................................................................................129

xCommand SystemUnit Diagnostics Run.................................................................................................129

xCommand SystemUnit FactoryReset .....................................................................................................129

xCommand SystemUnit Notifications RemoveAll ....................................................................................129

xCommand SystemUnit OptionKey Add ..................................................................................................129

xCommand SystemUnit OptionKey List ...................................................................................................129

xCommand SystemUnit OptionKey Remove ............................................................................................129

xCommand SystemUnit OptionKey RemoveAll ........................................................................................130

xCommand SystemUnit SoftwareUpgrade ..............................................................................................130

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

UserInterface commands ................................................................................................................... 130

xCommand UserInterface OSD Close .....................................................................................................130

xCommand UserInterface ScreenShot Get .............................................................................................130

xCommand UserInterface ScreenShot List .............................................................................................130

xCommand UserInterface ScreenShot Remove ......................................................................................130

xCommand UserInterface ScreenShot Request ...................................................................................... 131

xCommand UserInterface ScreenShot Store ..........................................................................................131

UserManagement commands ..............................................................................................................131

xCommand UserManagement RemoteSupportUser Create ................................................................... 131

xCommand UserManagement RemoteSupportUser Delete .................................................................... 131

xCommand UserManagement RemoteSupportUser DisablePermanently .............................................. 131

xCommand UserManagement RemoteSupportUser GetState ................................................................132

Video commands ................................................................................................................................ 132

xCommand Video AutoPresentationStart Disable ...................................................................................132

xCommand Video AutoPresentationStart Enable ....................................................................................132

xCommand Video Input SetMainVideoSource .........................................................................................132

xCommand Video Input Source SetActiveConnector .............................................................................133

xCommand Video Layout Add .................................................................................................................133

xCommand Video Layout Assign .............................................................................................................133

xCommand Video Layout AssignCall .......................................................................................................133

xCommand Video Layout AssignLocalOutput .........................................................................................134

xCommand Video Layout AssignPresentation .........................................................................................134

xCommand Video Layout Frame Add ......................................................................................................134

xCommand Video Layout Frame List .......................................................................................................135

xCommand Video Layout Frame Remove ................................................................................................135

xCommand Video Layout Frame Update .................................................................................................136

xCommand Video Layout List ..................................................................................................................136

xCommand Video Layout LoadDb ...........................................................................................................137

xCommand Video Layout Remove ...........................................................................................................137

xCommand Video Layout RemoveAll .......................................................................................................137

xCommand Video Layout Reset ...............................................................................................................137

xCommand Video Layout SetPresentationView ...................................................................................... 137

xCommand Video Layout UnAssign ........................................................................................................137

xCommand Video Layout UnAssignCall ..................................................................................................138

xCommand Video Layout UnAssignLocalOutput .....................................................................................138

xCommand Video Layout UnAssignPresentation ....................................................................................138

xCommand Video Matrix Assign ..............................................................................................................138

xCommand Video Matrix Reset ................................................................................................................138

xCommand Video Matrix Swap ................................................................................................................139

xCommand Video Matrix Unassign ..........................................................................................................139

xCommand Video OSD Close ..................................................................................................................13 9

xCommand Video PIP ActiveSpeaker Set................................................................................................13 9

xCommand Video PIP Presentation Set ...................................................................................................13 9

xCommand Video PictureLayoutSet ........................................................................................................140

xCommand Video PreviewFilmstrip Set ................................................................................................... 140

xCommand Video Selfview Set................................................................................................................140

Experimental commands ..................................................................................................................... 141

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Audio commands

xCommand Audio Equalizer List

Shows the current equalizer settings for the codec.

Requires user role: ADMIN

Parameters:

EqualizerId: <1..8>

Example:

xCommand Audio Equalizer List EqualizerId: 1 *r AudioEqualizerListResult Equalizer 1 Section 1 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 1 Frequency: "100" *r AudioEqualizerListResult Equalizer 1 Section 1 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 1 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 2 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 2 Frequency: "200" *r AudioEqualizerListResult Equalizer 1 Section 2 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 2 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 3 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 3 Frequency: "500" *r AudioEqualizerListResult Equalizer 1 Section 3 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 3 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 4 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 4 Frequency: "1000" *r AudioEqualizerListResult Equalizer 1 Section 4 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 4 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 5 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 5 Frequency: "2000" *r AudioEqualizerListResult Equalizer 1 Section 5 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 5 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 6 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 6 Frequency: "5000" *r AudioEqualizerListResult Equalizer 1 Section 6 Q: "0" *r AudioEqualizerListResult Equalizer 1 Section 6 Gain: "0"

xCommand Audio Equalizer Update

The system has eight user defined equalizers, each made up of six second order IIR sections. Each of the eight equalizers can be applied to one or more of the audio input and output connectors on the codec. Each IIR section can be modified independently.

There are five filter types, and the frequency response variations dependent on some of the parameter variations. The Q-value for low pass, high pass, low shelf and high shelf filters should be set to 1/sqrt(2) in order to get maximally flat responses. The Q-value (or Q-factor) is defined as Q=f0/bw. Where f0=resonance frequency in Hz; and bw=filter bandwidth in Hz.

To switch off one of the six equalizer sections; set the second order section to have a flat frequency response. This can be done by setting the filter type to "none" or by setting the filter type to "peaking" and the gain to "0" (zero).

We recommend using the TC Console tool, with the embedded equalizer GUI, to modify the equalizers. The TC Console software is found on the Developer Zone web page. Go to: http://developer. cisco.com/web/telepresence-developer/tools/integrators/tc-console.

Requires user role: ADMIN

Parameters:

EqualizerId(r): <1..8> Section(r): <1..6> FilterType(r): <highpass/highshelf/lowpass/lowshelf/none/peaking> Frequency(r): <S: 0, 32> Q(r): <S: 0, 32> Gain(r): <S: 0, 32>

Example:

xCommand Audio Equalizer List EqualizerId: 1 Section: 1 FilterType: Peaking Frequency: "100" Q: "4" Gain: "0"

*r AudioEqualizerListResult Equalizer 1 Section 1 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 1 Frequency: "100" *r AudioEqualizerListResult Equalizer 1 Section 1 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 1 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 2 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 2 Frequency: "200" *r AudioEqualizerListResult Equalizer 1 Section 2 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 2 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 3 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 3 Frequency: "500" *r AudioEqualizerListResult Equalizer 1 Section 3 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 3 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 4 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 4 Frequency: "1000"

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

*r AudioEqualizerListResult Equalizer 1 Section 4 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 4 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 5 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 5 Frequency: "2000" *r AudioEqualizerListResult Equalizer 1 Section 5 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 5 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 6 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 6 Frequency: "5000" *r AudioEqualizerListResult Equalizer 1 Section 6 Q: "0" *r AudioEqualizerListResult Equalizer 1 Section 6 Gain: "0"

xCommand Audio LocalInput Add

Create a local input and generate the local input id. A local input is a mix of input connectors with the following settings: Name, MixerMode, AGC, Mute and Channels.

This command is mainly intended for internal use by the TC console. TC console automatically generates a start-up script that makes the command persistent over a reboot. To use this command outside of TC console, you have to include it in a start-up script in order to make the setting persistent over a reboot. For more information on star-up scripts and TC console see the administrator guide for your codec.

InputId: A unique identifier for the local input. Name: Choose a name that describes the mix of input connectors. MixerMode Auto: The microphone with the strongest speaker is active and the others are strongly

attenuated. MixerMode Fixed: The input connector signals are mixed together with equal gains. MixerMode GainShared: The microphones are given a normalized gain factor relative to the stron-

gest speaker before being mixed together. AGC: Automatic Gain Control. Mute: Mutes the mix of input connectors. Channels: Set channels to 1 to mix the input connectors into a mono signal. To mix the input

connectors into a stereo signal, set channels to 2.

Requires user role: ADMIN

Parameters:

InputId: <0..65534> Name: <S: 0, 255> MixerMode: <Auto/Fixed/GainShared> AGC: <On/Off> Mute: <On/Off> Channels: <1..2>

Example:

xCommand Audio LocalInput Add InputId: 2

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio LocalInput AddConnector

Attach an input connector to the local input given by the input ID. A connector is defined by its type and ID.

InputId: A unique identifier for the local input. ConnectorType: Select the connector type. ConnectorId: Select a connector.

Requires user role: ADMIN

Parameters:

InputId(r): <0..65534> ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8>

Example:

xCommand Audio LocalInput AddConnector InputId: 3 ConnectorType: Line ConnectorId: 1

xCommand Audio LocalInput Remove

Remove the local input given by the input ID. This command is mainly intended for internal use by the TC console. TC console automatically

generates a start-up script that makes the command persistent over a reboot. To use this command outside of TC console, you have to include it in a start-up script in order to make the setting persistent over a reboot. For more information on star-up scripts and TC console see the administrator guide for your codec.

InputId: A unique identifier for the local input.

Requires user role: ADMIN

Parameters:

InputId(r): <0..65534>

Example:

xCommand Audio LocalInput Remove InputID: 2

xCommand Audio LocalInput RemoveConnector

Detach an input connector from the local input given by the input ID. A connector is defined by its type and ID.

InputId: A unique identifier for the local input. ConnectorType: Select the connector type. ConnectorId: Select the connector.

Requires user role: ADMIN

Parameters:

InputId(r): <0..65534> ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8>

Example:

xCommand Audio LocalInput RemoveConnector InputId: 3 ConnectorType: Line ConnectorId: 1

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio LocalInput Update

Update the settings of the local input given by the input ID. This command is mainly intended for internal use by the TC console. TC console automatically

attenuated. MixerMode Fixed: The input connector signals are mixed together with equal gains. MixerMode GainShared: The microphones are given a normalized gain factor relative to the stron-

connectors into a stereo signal, set channels to 2.

Requires user role: ADMIN

Parameters:

InputId(r): <0..65534> Name(r): <S: 0, 255> MixerMode(r): <Auto/Fixed/GainShared> AGC(r): <O n/O ff> Mute(r): <On/Of f> Channels(r): <1..2>

Example:

xCommand Audio LocalInput Update InputId: 2 Name: "Microphone" MixerMode: GainShared AGC: Off Mute: Off Channels: 1

xCommand Audio LocalOutput Add

Create a local output and generate the local output id. A local output is a mix of local input and remote input signals. All connectors attached to the local output receive the same signal.

OutputId: A unique identifier for the local output. Name: Choose a name that describes the local output. Loudspeaker: If one or more of the output connectors are connected to a loudspeaker, this signal

should be a reference signal to the echo canceler. Hence set loudspeaker to On. NOTE: When microphone reinforcement is disabled there should only be one loudspeaker local output.

Channels: Set channels to 1 to mix the local and remote inputs into a mono signal. To mix the inputs into a stereo signal, set channels to 2.

VolumeControlled: Choose whether this output's volume is controlled by global audio control (Off), or if it is at the level defined with xCommand Audio Volume Set (On). If you wish to set VolumeControlled to Off, you must also set the parameter Loudspeaker to Off. Added in TC7.3.3.

Requires user role: ADMIN

Parameters:

OutputId: <0..65534> Name: <S: 0, 255> Loudspeaker: <On/Off> Channels: <1..2> VolumeControlled: <On/Off>

Example:

xCommand Audio LocalOutput Add OutputId: 47

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio LocalOutput AddConnector

Attach an output connector to the local output given by the output ID. A connector is defined by its type and ID.

OutputId: A unique identifier for the local output. ConnectorType: Select the connector type. ConnectorId: Select a connector.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> ConnectorType(r): <HDMI/Line> ConnectorId(r): <1..8>

Example:

xCommand Audio LocalOutput AddConnector OutputId:5 ConnectorType: Line ConnectorId:1

xCommand Audio LocalOutput ConnectInput

Connect a local or remote input to a local output by giving their IDs as parameters. This command is mainly intended for internal use by the TC console. TC console automatically

OutputId: A unique identifier for the local output. InputId: A unique identifier for the local input. InputGain: Set a gain on the input signal in the range from -54dB to 15dB. The value -54dB equals

Off.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> InputId(r): <0..65534> InputGain: <-54..15>

Example:

xCommand Audio LocalOutput ConnectInput OutputId:6 InputId:3

xCommand Audio LocalOutput DisconnectInput

Disconnect a local or remote input from a local output. This command is mainly intended for internal use by the TC console. TC console automatically

OutputId: A unique identifier for the local output. InputId: A unique identifier for the local or remote input.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> InputId(r): <0..65534>

Example:

xCommand Audio LocalOutput DisconnectInput OutputId:6 InputId:3

xCommand Audio LocalOutput Remove

Remove the local output given by the output ID. This command is mainly intended for internal use by the TC console. TC console automatically

OutputId: A unique identifier for the local output.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534>

Example:

xCommand Audio LocalOutput Remove OutputId: 6

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio LocalOutput RemoveConnector

Detach an output connector from the local output given by the output ID. A connector is defined by its type and ID.

OutputId: A unique identifier for the local output. ConnectorType: Select the connector type. ConnectorId: Select the connector.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> ConnectorType(r): <HDMI/Line> ConnectorId(r): <1..8>

Example:

xCommand Audio LocalOutput RemoveConnector OutputId:5 ConnectorType: Line ConnectorId:1

xCommand Audio LocalOutput Update

Update the settings of the local output given by the output ID. This command is mainly intended for internal use by the TC console. TC console automatically

should be a reference signal to the echo canceler. Hence set loudspeaker to On. NOTE: When microphone reinforcement is disabled there should only be one loudspeaker local output.

Channels: Set channels to 1 to mix the local and remote inputs into a mono signal. To mix the inputs into a stereo signal, set channels to 2.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> Name(r): <S: 0, 255> Loudspeaker(r): <On/Off> Channels(r): <1..2> VolumeControlled: <On/Off>

Example:

xCommand Audio LocalOutput Update OutputId: 5 Name: "Loudspeaker" Loudspeaker: On Channels: 2

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio LocalOutput UpdateInputGain

Update the gain of a local or remote input connected to a local output. The gain on the input signal is in the range from -54dB to 15dB. The value -54dB equals Off.

OutputId: A unique identifier for the local output. InputId: A unique identifier for the local input. InputGain: Set a gain on the input signal in the range from -54dB to 15dB. The value -54dB equals

Off.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> InputId(r): <0..65534> InputGain: <-54..15>

Example:

xCommand Audio LocalOutput UpdateInputGain OutputId:6 InputId:3

xCommand Audio Microphones Mute

Mute all microphones.

Requires user role: USER

Example:

xCommand Audio Microphones Mute

xCommand Audio Microphones Unmute

Unmute microphones.

Requires user role: USER

Example:

xCommand Audio Microphones Unmute

xCommand Audio RemoteOutput ConnectInput

Connect a local or remote input to a remote output with their IDs as parameters. When a call is made a remote input and remote output pair is created.

OutputId: A unique identifier for the local output. InputId: A unique identifier for the local or remote input. InputGain: Set a gain on the input signal in the range from -54dB to 15dB. The value -54dB equals

Off.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> InputId(r): <0..65534> InputGain: <-54..15>

Example:

xCommand Audio RemoteOutput ConnectInput OutputId:10 InputId:8

xCommand Audio RemoteOutput DisconnectInput

Disconnect a local or remote input from a remote output with their IDs as parameters. This command is mainly intended for internal use by the TC console. TC console automatically

OutputId: A unique identifier for the local output. InputId: A unique identifier for the local or remote input.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> InputId(r): <0..65534>

Example:

xCommand Audio RemoteOutput DisconnectInput OutputId:10 InputId:8

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio RemoteOutput UpdateInputGain

Update the gain of a local or remote input connected to a remote output. This command is mainly intended for internal use by the TC console. TC console automatically

Off.

Requires user role: ADMIN

Parameters:

OutputId(r): <0..65534> InputId(r): <0..65534> InputGain: <-54..15>

Example:

xCommand Audio RemoteOutput UpdateInputGain OutputId:6 InputId:3

xCommand Audio Setup Clear

Remove all local inputs and local outputs.

Requires user role: ADMIN

Example:

xCommand Audio Setup Clear

xCommand Audio Sound Play

Play a specified audio sound.

Requires user role: USER

Parameters:

Sound(r): <Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/KeyTone/Nav/ NavBack/Notification/OK/PresentationConnect/Ringing/SpecialInfo/TelephoneCall/VideoCall/ Volume>

Loop: <On/Off>

Example:

xCommand Audio Sound Play Sound: Ringing

xCommand Audio Sound Stop

Stop playing audio sound.

Requires user role: USER

Example:

xCommand Audio Sound Stop

xCommand Audio SoundsAndAlerts Ringtone List

Lists all available ringtones that can be configured using xConfiguration Audio SoundsAndAlerts Ri n gTone .

Requires user role: USER

Example:

xCommand Audio SoundsAndAlerts Ringtone List *r AudioRingtoneListResult Ringtone 1 Id: "Sunrise" *r AudioRingtoneListResult Ringtone 2 Id: "Mischief" *r AudioRingtoneListResult Ringtone 3 Id: "Ripples" *r AudioRingtoneListResult Ringtone 4 Id: "Reflections" *r AudioRingtoneListResult Ringtone 5 Id: "Vibes" *r AudioRingtoneListResult Ringtone 6 Id: "Delight" *r AudioRingtoneListResult Ringtone 7 Id: "Evolve" *r AudioRingtoneListResult Ringtone 8 Id: "Playful" *r AudioRingtoneListResult Ringtone 9 Id: "Ascent" *r AudioRingtoneListResult Ringtone 10 Id: "Calculation" *r AudioRingtoneListResult Ringtone 11 Id: "Mellow" *r AudioRingtoneListResult Ringtone 12 Id: "Ringer"

xCommand Audio SoundsAndAlerts Ringtone Play

Play one of the available ringtones. To get a list of the available ringtones use the command xCommand Audio SoundsAndAlerts Ringtone List.

Requires user role: USER

Parameters:

RingTone(r): <S: 1, 100>

Example:

xCommand Audio SoundsAndAlerts Ringtone Play RingTone: Sunrise

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio Volume Decrease

Decrease the volume on the endpoint.

Requires user role: USER

Parameters:

Steps: < 1. .10 >

Example:

xCommand Audio Volume Decrease Steps:3

xCommand Audio Volume Increase

Increase the volume on the endpoint.

Requires user role: USER

Parameters:

Steps: < 1. .10 >

Example:

xCommand Audio Volume Increase Steps:3

xCommand Audio Volume Mute

Mute the volume on the endpoint.

Requires user role: USER

Example:

xCommand Audio Volume Mute

xCommand Audio Volume Set

Set the volume on the endpoint to a specified level.

Requires user role: USER

Parameters:

Lev e l ( r): <1..10 0 >

Example:

xCommand Audio Volume Set Level:30

xCommand Audio Volume SetToDefault

Set the current volume level as the default for the endpoint.

Requires user role: USER

Example:

xCommand Audio Volume SetToDefault

xCommand Audio Volume UnMute

Unmute the volume on the endpoint.

Requires user role: USER

Example:

xCommand Audio Volume SetToDefault

xCommand Audio VUMeter Start

Start collecting VU meter information for the connector identified by the ConnectorId and ConnectorType parameters. Together these parameters identify the connector.

ConnectorId: The connector identifier is printed on the codec connector panel. ConnectorType: Identifies whether it is an HDMI input connector, an audio line input connector or a

microphone connector.

Requires user role: USER

Parameters:

ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8>

Example:

xCommand Audio VUMeter Start ConnectorType: Microphone ConnectorId: 1

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

xCommand Audio VUMeter Stop

Stop collecting VU meter information for the connector identified by the ConnectorId and ConnectorType parameters. Together these parameters uniquely identify the connector.

ConnectorId: The connector identifier is printed on the codec connector panel. ConnectorType: Identifies whether it is an HDMI input connector, an audio line input connector or a

microphone connector.

Requires user role: USER

Parameters:

ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8>

Example:

xCommand Audio VUMeter Stop ConnectorType: Microphone ConnectorId: 1

xCommand Audio VUMeter StopAll

Stop collecting VU meter information for all connectors.

Requires user role: USER

Example:

xCommand Audio VUMeter StopAll

Bookings commands

xCommand Bookings Clear

Clear the current stored list of bookings.

Requires user role: USER

Example:

xCommand Bookings Clear

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

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) xCommand Bookings List OK *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 command" *r Bookings Booking 1 Privacy: Public *r Bookings Booking 1 Organizer FirstName: "Ola" *r Bookings Booking 1 Organizer LastName: "Normann" *r Bookings Booking 1 Organizer Email: "ola.normann@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 MaximumMeetingExtension: 30 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed *r Bookings Booking 1 BookingStatus: OK *r Bookings Booking 1 BookingStatusMessage: "" *r Bookings Booking 1 Webex Enabled: True

*r Bookings Booking 1 Webex Url: "http://webex.url" *r Bookings Booking 1 Webex MeetingNumber: "webexNumber@cisco.com" *r Bookings Booking 1 Webex Password: "" *r Bookings Booking 1 Webex HostKey: "" *r Bookings Booking 1 Webex DialInNumbers DialInNumber 1 Type: TollFree *r Bookings Booking 1 Webex DialInNumbers DialInNumber 1 Number: "+1 987

654321" *r Bookings Booking 1 Webex DialInNumbers DialInNumber 2 Type: Toll *r Bookings Booking 1 Webex DialInNumbers DialInNumber 2 Number: "+1 987

654322" *r Bookings Booking 1 InteropBridge Number: "" *r Bookings Booking 1 InteropBridge ConferenceId: "" *r Bookings Booking 1 ManualCallIn Number: "" *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 Number:

"91123456;conference-id=2100170569" *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

Example 2 (When no bookings have been received, or after all bookings have been removed by the command xCommand Bookings Clear)

xCommand Bookings List OK *r Bookings Error: "No bookings found." *r Bookings ResultInfo TotalRows: 0 *r Bookings LastUpdated: Never

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

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 OK CUIL reboot request, restarting Connection closed by foreign host.

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. CallType parameter is not in use.

Requires user role: USER

Parameters:

CallId: <0..65534> CallType: <Audio/Video> Not in use.

Example:

xCommand Call Accept CallId:19

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

xCommand Call DisconnectAll

Disconnect all active calls.

Requires user role: USER

Example:

xCommand Call DisconnectAll

Cisco TelePresence SX80 API Reference Guide

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

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: <Conference/Transfer/Other>

Example:

xCommand Call Hold CallId:19

xCommand Call HoldAll

Puts all ongoing calls on hold.

Requires user role: USER

Parameters:

Reason(0): <Conference/Transfer/Other>

Example:

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

xCommand Call Ignore CallId: 22

xCommand Call Join

Join all existing calls, active and on hold.

Requires user role: USER

Parameters:

CallId(r): <0..65534>

Example:

xCommand Call Join CallId: 34

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:

xCommand Call Reject CallId:20

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:

xCommand Call Resume CallId:19

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:

xCommand Call UnattendedTransfer CallId: 2 Number: destination@example. com

Cisco TelePresence SX80 Reference Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Introduction

About this guide

User documentation

Software release notes

New features and improvements

System configuration changes

System command changes

System status changes

About the API

API fundamentals

Connecting to the API

Password

RS-232/serial connection

Telnet

HTTP/HTTPS

Ethernet port

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

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..3] Mode

xConfiguration Audio Input HDMI [1..3] Level

xConfiguration Audio Input HDMI [1..3] VideoAssociation VideoInputSource

xConfiguration Audio Input HDMI [1..3] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Line [1..4] Equalizer ID

xConfiguration Audio Input Line [1..4] Equalizer Mode

xConfiguration Audio Input Line [1..4] VideoAssociation VideoInputSource

xConfiguration Audio Input Line [1..4] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Line [1..4] Channel

xConfiguration Audio Input Line [1..4] Level

xConfiguration Audio Input Line [1..4] Mode

xConfiguration Audio Input Microphone [1..8] EchoControl Mode

xConfiguration Audio Input Microphone [1..8] EchoControl NoiseReduction

xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation

xConfiguration Audio Input Microphone [1..8] Equalizer ID

xConfiguration Audio Input Microphone [1..8] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource

xConfiguration Audio Input Microphone [1..8] Level

xConfiguration Audio Input Microphone [1..8] Equalizer Mode

xConfiguration Audio Input Microphone [1..8] Mode

xConfiguration Audio Input Microphone [1..8] Type

xConfiguration Audio Output HDMI [1..2] Level

xConfiguration Audio Output HDMI [1..2] Mode

xConfiguration Audio Output Line [1..6] Channel

xConfiguration Audio Output Line [1..6] Equalizer ID

xConfiguration Audio Output Line [1..6] Equalizer Mode

xConfiguration Audio Output Line [1..6] Level

xConfiguration Audio Output Line [1..6] Mode

xConfiguration Audio Microphones Mute Enabled

xConfiguration Audio SoundsAndAlerts KeyTones Mode

xConfiguration Audio SoundsAndAlerts RingTone

xConfiguration Audio SoundsAndAlerts RingVolume

xConfiguration Audio DefaultVolume

Cameras configuration