Page 1 About the API xConfiguration xCommand xStatus Appendices Software version CE8.1 APRIL 2016 Application Programmer Interface (API) Reference Guide Cisco TelePresence SX20 Codec SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 2: Table Of Contents
The SystemTools commands ..........176 The output modes ..............25 About disconnect cause types ........... 178 Using the command line ............26 User documentation on the Cisco web site ....... 179 API commands ..............26 Other commands ...............26 Command line shortcuts ............ 27 Searching ................
Page 3: Introduction
Cisco TelePresence SX20 Codec API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 4: Text Anchor About This Guide
http://www.cisco.com/go/sx-docs Interface (API) for the TC software in general, and serve as a reference guide for the command line commands for the Guidelines for how to find the documentation on the Cisco following product: web site are included in the User documentation on the...
Page 5: What's New In Ce8.1
10 with the In-Room Control Editor. This is an easy to release notes: screen. This feature requires the latest version of Cisco use drag-and-drop editor that you launch from the video Intelligent Proximity for Desktop together with CE8.1.
Page 6: Xconfiguration Changes In Ce8.1
Conference DoNotDisturb DefaultTimeout OLD: Integer (0..1440) NEW: Integer (1..1440) Conference MaxTotalReceiveCallRate OLD: Integer (64..10000) Default value: 10000 NEW: Integer (64..6000) Default value: 6000 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 7: Xcommand Changes In Ce8.1
Pan: <-10000 – 10000> +/ -> OLD: Tilt: <-65535 – 65535> NEW: Tilt: <-2500 – 2500> OLD: Zoom: <0-65535> NEW: Zoom: <0-8000> SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 8: Xstatus Changes In Ce8.1
<Dual/ DualPresentationOnly/Quadruple/ Single/ Triple> ITLinstallation/InvalidSIPTransportConfig/LockDown/NetLinkStatus/ NEW: <Dual/ DualPresentationOnly/ Quadruple/ Single/ Triple/ TriplePresentationOnly> NetSpeedAutoNegotiated/NTPStatus/OSDVideoOutput/OutputConnectorLocations/ ProvisioningStatus/SIPEncryption/SIPListenPortAndOutboundMode/SIPProfileRegistration/ SIPProfileType/SelectedVideoInputSourceConnected/SipIceAndAnatConflict/ TemperatureCheck/ TLSVerifyRequiredCerts/TouchPanelConnection/TurnBandwidth/ UdpPortRangeViolation/ValidPasswords/VideoFromInternalCamera/VideoInputStability/ SpeakerTrackFrontPanelMountedCorrectly/SpeakerTrackMicrophoneConnection/ SpeakerTrackVideoInputs/SpeakerTrackEthernetConnection/ANATOnVCS/ ECReferenceDelay/AudioPairingSNR/AudioInternalSpeakerDisabled/ AbnormalCallTermination/HasActiveCallProtocol/SipOrH323ButNotBothEnabled/ PresentationSourceSelection/SoftwareUpgrade/ContactInfoMismatch> SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 9: What's New In This Version
In this release Multistream is switched Off by default. The number of API commands has been reduced. Some We recommend the Cisco UCM 11.0.0 and later, and the commands have been removed entirely while others are latest versions of TelePresence Server and TelePresence different syntactically to cater for underlying architectural Conductor for optimal experience.
Page 10 (involving Cisco TelePresence Server, Cisco TelePresence MCU, and/or Cisco TelePresence Conductor) may be used instead. • MediaNet is no longer supported. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 11: Xconfiguration Changes In Ce8.0
Experimental * SIP Profile [1] Outbound FacilityService * SIP Profile [1] Proxy [n] Discovery H323 Profile [1] Gatekeeper Discovery SIP Profile [1] TlsVerify SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 12 Edge> Video OSD AutoSelectPresentationSource NEW: <Off / TMS / VCS / CUCM / Auto / Edge Video OSD CallSettingsSelection Video OSD LanguageSelection SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 13 Cameras Camera [n] Brightness DefaultLevel H323 Profile [1] CallSetup Mode Conference [1] AutoAnswer Delay Renamed to: H323 CallSetup Mode Renamed to: Conference AutoAnswer Delay SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 14 Video Output Connector [n] CEC Mode Renamed to: SIP Turn UserName Video Output HDMI [n] MonitorRole SIP Profile [1] URI Renamed to: Video Output Connector [n] MonitorRole SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 15 Video Selfview Default Mode Video SelfviewDefault OnMonitorRole Renamed to: Video Selfview Default OnMonitorRole Video SelfviewDefault PIPPosition Renamed to: Video Selfview Default PIPPosition SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 16: Xcommand Changes In Ce8.0
Camera PositionReset FarEndControl Preset Store NEW: Axis: <All/Focus/PanTilt/Zoom> Key * Camera Preset Edit Logging ExtendedLogging * NEW: DefaultPosition: <False/True> Message Echo Message FarendMessage SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 17 SystemUnit Diagnostics Run Renamed to: xCommand Diagnostics Run Boot Renamed to: SystemUnit Boot xCommand Video Presentation Set Renamed to: xCommand Video PresentationPIP Set SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 18 Video PIP ActiveSpeaker Set Renamed to: xCommand Video ActiveSpeakerPIP Set xCommand Video PIP Presentation Set Renamed to: xCommand Video PresentationPIP Set SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 19: Xstatus Changes In Ce8.0
Conference Call [n] CalText (was Conference Site [n] CalText) Provisioning Server Conference Call [n] Preserved (was Conference Site [n] Preserved) Provisioning Software PreviousUpgrade * SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 20 Renamed to: Conference SpeakerLock CallId NEW: TemperatureCheck, AudioInternalSpeakerDisabled, and ContactInfoMismatch added to the value space Conference ActiveSpeaker Mode Renamed to: Conference SpeakerLock Mode SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 21 Diagnostics Message [n] * SystemUnit Software MaxAudioCalls Renamed to: Capabilities Conference MaxAudioCalls SystemUnit Software MaxVideoCalls Renamed to: Capabilities Conference MaxVideoCalls SystemUnit State MaxNumberOfActiveCalls SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 22: About The Api
Cisco TelePresence SX20 Codec API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 23: Api Fundamentals
During the initial boot sequence, the codec uses a baud rate of 38400 regardless of the application baud rate you have set. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 24: Telnet
POST and GET methods are used to execute commands and get feedback from the codec. This is described in ”Using HTTP” on page 32 in this document. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 25: Api Output
To set ouput mode to XML, issue the command: </Layout> xPreferences outputmode xml </Video> </Command> To revert to terminal mode, issue the command: xPreferences outputmode terminal SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 26: Using The Command Line
Echo <on/off> Refer to ”Configurations” on page can be used for advanced troubleshooting together with Cisco technical support. Systemtools are not a part of the If echo is set to the key inputs are displayed when enter- programming API. Refer to ”The SystemTools commands”...
Page 27: Command Line Shortcuts
XCOMMAND DIAL NUMBER: foo@bar.org *s Video Output Connector 3 Resolution Width: 1280 xcommand dial number: foo@bar.org ** end xCommand Dial Number: foo@bar.org SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 28: Commands
Write in: is separated with ‘:’. xConfiguration H323 Profile 1 H323Alias ID Result: *c xConfiguration H323 Profile 1 H323Alias ID: “changed@company.com” **end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 29: Events
** end and established. *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 30: Feedback Mechanism
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 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 31: Terminal Connections
/Status/Audio Write in: ** end Result: D: List the new feedback expressions. xFeedback list Write in: /Configuration/Video/MainVideoSource Result: ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 32: Using Http
</Camera> <Configuration> </Command> <SystemUnit> Response <Name>newName</Name> HTTP/1.1 200 OK </SystemUnit> Content-Type: text/xml </Configuration> Content-Length: 91 <?xml version=”1.0”?> <Command> <CameraPositionSetResult item=”1” status=”OK”/> </Command> SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 33: Feedback From Codec Over Http
Identification node with children that specify the Cisco TelePresence Management Suite (TMS) is used as TMS codec from which the notification originated. This means that uses this feedbackslot to register its expressions. you can handle multiple codecs with a single HTTP server URI.
Page 34: Translating From Terminal Mode To Xml
</Video> Terminal </Configuration> xCommand Video Layout AssignCall CallId: 2 LayoutId: 1 <Command> <Video> <Layout> <AssignCall command=”True”> <CallId>2</CallId> <LayoutId>1</LayoutId> </AssignCall> </Layout> </Video> </Command> SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 35: Dos And Don'ts
Appendices Dos and don’ts Here are some best practices when programming the Cisco SX series API. AVOID remote control emulation The use of xCommand UserInterface OSD Key Click and xCommand UserInterface OSD Key Press commands is highly discouraged.
Page 36: Xconfiguration Commands
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 37 Cameras Camera [1] Whitebalance Level ................45 xConfiguration H323 NAT Mode ........................51 xConfiguration Cameras Preset TriggerAutofocus ..................45 xConfiguration H323 NAT Address ......................52 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 38 Network [1] VLAN Voice Mode ...................62 xConfiguration Provisioning ExternalManager AlternateAddress ..............70 xConfiguration Network [1] VLAN Voice VlanId ..................62 xConfiguration Provisioning ExternalManager Protocol ................70 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 39 Video Selfview Default PIPPosition ..................87 xConfiguration Standby StandbyAction .....................76 xConfiguration Video Selfview OnCall Mode .....................88 xConfiguration Standby WakeupAction ......................77 xConfiguration Video Selfview OnCall Duration ..................88 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 40: Audio Configuration
The audio will be muted Select a ringtone from the list. when the video source is not presented. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 41: Xconfiguration Audio Input Line [1] Videoassociation Videoinputsource
Once selected, echo cancellation is active at all times. Dereverberation : Off/On Off: Turn off the dereverberation. On: Turn on the dereverberation. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 42: Xconfiguration Audio Input Microphone [1
HDMI output. The actual delay is HDMI-delay + DelayMs. The Audio Output Connectors Line [n] DelayMs status reports the actual delay. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 43: Cameras Configuration
Manual: Enable manual control of the camera brightness. The brightness level is set using the Cameras Camera [n] Brightness DefaultLevel setting. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 44: Xconfiguration Cameras Camera [1] Focus Mode
Manual: In manual mode the gamma value is changed with the gamma level setting, ref. Cameras Camera [n] Gamma Level. On: Display the image as you see yourself in a mirror. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 45: Xconfiguration Cameras Camera [1] Whitebalance Mode
Cameras Camera Whitebalance Level: Level where : Unique ID that identifies the camera. Range: 1..1 Level : Integer (1..16) The white balance level. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 46: Conference Configuration
Conference AutoAnswer Mute: Mute Sip: All calls are set up as SIP calls. where H320: All calls are set up as H.320 calls (only applicable if connected to Cisco Mute : Off/On TelePresence ISDN Link). Off: The incoming call will not be muted.
Page 47: Xconfiguration Conference Defaultcall Rate
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. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 48: Xconfiguration Conference Maxreceivecallrate
Requires user role: ADMIN Default value: 6000 USAGE: xConfiguration Conference MaxTotalTransmitCallRate: MaxTotalTransmitCallRate where MaxTotalTransmitCallRate : Integer (64..6000) The maximum transmit call rate (kbps). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 49: Xconfiguration Conference Multistream Mode
Conference MultiStream Mode The video system supports multistream video for conferences, provided that the conference infrastructure supports the feature (Cisco TelePresence Server 4.2 or later). This means that xConfiguration H323 Authentication Mode the video system can compose the video streams locally into a conference layout which utilizes all available screens.
Page 50: Xconfiguration H323 Authentication Password
Gatekeeper: The system uses a Gatekeeper to make an H.323 call. When choosing this option, the H323 Gatekeeper Address must also be configured. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 51: Xconfiguration H323 H323Alias E164
USAGE: xConfiguration H323 H323Alias ID: "ID" where : String (0, 49) The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID" SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 52: Xconfiguration H323 Nat Address
: Index that identifies the DNS server. Maximum three DNS servers are allowed. Range: 1..3 Address : String (0, 64) A valid IPv4 address or IPv6 address. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 53: Xconfiguration Network [1] Ieee8021X Mode
On: When set to On, the server-side X.509 certificate will be validated against the local CA-list for all TLS connections. Only servers with a valid certificate will be allowed. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 54: Xconfiguration Network [1] Ieee8021X Password
: Index that identifies the network. Range: 1..1 TThe 802.1X Anonymous ID string. Ttls : Off/On Off: The EAP-TTLS protocol is disabled. On: The EAP-TTLS protocol is enabled (default). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 55: Xconfiguration Network [1] Ieee8021X Eap Tls
Network [1] IPv4 Assignment Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Define how the system will obtain its IPv4 address, subnet mask and gateway address. This setting only applies to systems on IPv4 networks.
Page 56: Xconfiguration Network [1] Ipv4 Address
DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 57: Xconfiguration Network [1] Ipv6 Address
: Index that identifies the network. Range: 1..1 Gateway : String (0, 64) : Integer (576..1500) A valid IPv6 address. Set a value for the MTU (bytes). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 58: Xconfiguration Network [1] Qos Mode
Signalling, Network QoS Diffserv ICMPv6 and Network QoS Diffserv NTP settings are higher the priority. The default value is 0 (best effort). used to prioritize packets. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 59: Xconfiguration Network [1] Qos Diffserv Video
Set the priority of the video packets in the IP network - the higher the number, the the priority. The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 60: Xconfiguration Network [1] Qos Diffserv Signalling
Set the priority of the signalling packets in the IP network - the higher the number, the higher the priority. The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 61: Xconfiguration Network [1] Qos Diffserv Ntp
RemoteAccess Allow: "Allow" where : Index that identifies the network. Range: 1..1 Allow : String (0, 255) A valid IPv4 address or IPv6 address. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 62: Networkservices Configuration
NetworkServices CDP Mode: Mode Mode : Auto/Manual/Off where Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. Mode : Off/On If CDP is not available, VLAN is not enabled. Off: The CDP daemon is disabled.
Page 63: Xconfiguration Networkservices Http Mode
Off: The system will not use an NTP server. The NetworkServices NTP Server [n] Address setting will be ignored. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 64: Xconfiguration Networkservices Ntp Server [1..3] Address
: Identifies the SNMP host. Maximum three SNMP hosts are allowed. Range: 1..3 Address : String (0, 64) A valid IPv4 address, IPv6 address or DNS name. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 65: Xconfiguration Networkservices Snmp Communityname
Requires user role: ADMIN 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 Default value: "" same SNMP Community is configured there too. NOTE: The SNMP Community password is case sensitive.
Page 66: Xconfiguration Networkservices Telnet Mode
USAGE: panels does not match this setting, the diagnostics service will report it as an inconsistency. xConfiguration NetworkServices Telnet Mode: Mode Note that only one Cisco Touch controller is supported in this version. where Requires user role: ADMIN Mode : Off/On Default value: NotSet Off: The Telnet protocol is disabled.
Page 67: Phonebook Configuration
Off: Do not use a phonebook. CUCM: The phonebook is located on the Cisco Unified Communications Manager. TMS: The phonebook is located on the Cisco TelePresence Management Suite server. VCS: The phonebook is located on the Cisco TelePresence Video Communication Server.
Page 68: Provisioning Configuration
TMS: Push configurations to the video system from TMS (Cisco TelePresence Management System). VCS: Push configurations to the video system from VCS (Cisco TelePresence Video Communication Server). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 69: Xconfiguration Provisioning Loginname
Default value: "" USAGE: xConfiguration Provisioning ExternalManager Address: "Address" where Address : String (0, 64) A valid IPv4 address, IPv6 address or DNS name. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 70: Xconfiguration Provisioning Externalmanager Alternateaddress
Provisioning ExternalManager AlternateAddress xConfiguration Provisioning ExternalManager Path Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager Define the Path to the external manager / provisioning system. This setting is required when (CUCM) and an alternate CUCM is available for redundancy. Define the address of the alter- several management services reside on the same server, i.e.
Page 71: Proximity Configuration
Requires user role: ADMIN video system. In order to use a client, at least one of the Proximity services must be enabled Default value: Disabled (refer to the Proximity Services settings). In general, Cisco recommends enabling all the Proximity services. USAGE:...
Page 72: Serialport Configuration
Default value: 115200 USAGE: xConfiguration SerialPort BaudRate: BaudRate where BaudRate : 9600/19200/38400/57600/115200 Set a baud rate from the baud rates listed (bps). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 73: Sip Configuration
A valid password. xConfiguration SIP DisplayName: "DisplayName" where DisplayName : String (0, 550) The name to be displayed instead of the SIP URI. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 74: Xconfiguration Sip Ice Mode
Rflx: Send media to the video system's public IP address, as seen by the TURN server. Relay: Send media to the IP address and port allocated on the TURN server. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 75: Xconfiguration Sip Proxy [1..4] Address
Default value: "" USAGE: xConfiguration SIP URI: "URI" where : String (0, 255) An address (URI) that is compliant with the SIP URI syntax. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 76: Standby Configuration
: Integer (1..480) PrivacyPosition: When the video system enters standby, the camera turns to a sideways Set the standby delay (minutes). position for privacy. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 77: Systemunit Configuration
: String (0, 50) DefaultCameraPosition: When the video system leaves standby, the camera moves to Define the system name. the factory default position. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 78: Time Configuration
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, SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 79 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, SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 80: Userinterface Configuration
SystemName: Show the system's name (refer to the SystemUnit Name setting). DisplayName: Show the system's display name (refer to the SIP DisplayName setting). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 81: Xconfiguration Userinterface Osd Output
: Unique ID that identifies the video input connector. Range: 1..2 Mode : Connector 1: Off/On Connector 2: Off Off: Disable camera control. On: Enable camera control. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 82: Xconfiguration Video Input Connector [1
Sharpness: Gives the highest possible resolution. Used when you want the highest quality of detailed images and graphics. other: Use this when the other options do not match. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 83: Xconfiguration Video Input Connector [1
OnConnect: 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. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 84: Xconfiguration Video Monitors
DualPresentationOnly: All participants in the call are shown on the monitor with monitor role First. If a presentation is part of the layout, the presentation is shown on the monitor with monitor role Second. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 85: Xconfiguration Video Output Connector [1
High: The video system will not use the outer 6% of the output resolution. outputs with this monitor role are disregarded by the Video Monitors setting. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 86: Xconfiguration Video Output Connector [1..2] Resolution
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. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 87: Xconfiguration Video Selfview Default Onmonitorrole
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. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 88: Xconfiguration Video Selfview Oncall Mode
Duration : Integer (1..60) Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 89: Xcommand Commands
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 90 Camera Preset Store ......................103 xCommand Call FarEndControl Source Select ..................97 xCommand Camera Ramp ........................104 xCommand Call Hold ..........................97 xCommand Camera TriggerAutofocus .....................104 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 91 Phonebook Folder Delete ..................... 112 xCommand SystemUnit OptionKey Remove .................... 119 xCommand Phonebook Folder Modify ..................... 113 xCommand SystemUnit OptionKey RemoveAll ..................119 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 92 UserManagement User Passphrase Set ................125 Video commands ..........................125 xCommand Video ActiveSpeakerPIP Set ....................125 xCommand Video Input SetMainVideoSource ..................125 xCommand Video Input Source SetActiveConnector ................126 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 93: Audio Commands
Requires user role: ADMIN, USER USAGE: xCommand Audio SoundsAndAlerts Ringtone Play RingTone: "RingTone" where RingTone: String (1, 100) The name of the ringtone. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 94: Xcommand Audio Volume Set
The booking ID of a call or conference. Set the volume on the endpoint back on after muting. Requires user role: ADMIN, USER USAGE: xCommand Audio Volume Unmute SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 95: Xcommand Bookings List
The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId. DTMFString: String (0, 32) Enter the DTMF string. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 96: Xcommand Call Disconnect
Call command to see the CallId. PresetId: Integer (1..15) The ID of the preset that is stored on the far end codec. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 97: Xcommand Call Ignore
The CallID is returned when the xCommand Dial command is run. During a call you can run the xStatus Call command to see the CallId. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 98: Xcommand Call Resume
Deletes all information on previous calls. Requires user role: ADMIN, USER USAGE: xCommand CallHistory DeleteAll [Filter: Filter] where Filter: All/Missed/Placed/Received You can filter which calls to delete. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 99: Xcommand Callhistory Deleteentry
Allows you to set the command to apply to a specified display name or call back number. CallHistoryId: Integer (0..65534) CallHistoryId for the call in question. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 100: Xcommand Callhistory Recents
CallHistoryId: Integer (0..65534) CallHistoryId for the call in question. Order: OccurrenceTime/OccurrenceFrequency Define the order in which the previous calls are presented. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 101: Xcommand Camera Positionset
Requires user role: ADMIN, USER USAGE: xCommand Camera Preset Activate PresetId: PresetId where PresetId: Integer (1..35) The ID of the camera preset you want to activate. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 102: Xcommand Camera Preset Edit
USAGE: xCommand Camera Preset Remove PresetId: PresetId where PresetId: Integer (1..35) The ID of the camera preset you want to remove. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 103: Xcommand Camera Preset Show
Note that each camera can hold only one default position, so if set, the old default preset will automatically be marked as not default. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 104: Xcommand Camera Ramp
Zoom the camera In or Out, followed by Stop. ZoomSpeed: Integer (1..15) Set the zoom speed. Focus: Far/Near/Stop Focus the camera Far or Near, followed by Stop. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 105: Conference Commands
Releases locked speaker set by xCommand Conference SpeakerLock Set. Default voice switching is switched back on. Requires user role: ADMIN, USER USAGE: xCommand Conference SpeakerLock Release SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 106: Diagnostics Commands
Appearance: Integer (1..999999999) Internal usage only. DisplayName: String (0, 255) The display name of the remote participant. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 107: Httpfeedback Commands
You can have from 1 to 15 XPath expressions. Software version the device is running. Type: Byod/ControlSystem/Other/TouchPanel Define the type of device you are connecting to. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 108: Xcommand Peripherals Heartbeat
Enter the MAC address for the ISDN Link you wish to pair to the endpoint. Limit the search to currently connected devices. Type: All/ControlSystem/ISDNLink/Other/TouchPanel Limit the search by device type. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 109: Xcommand Peripherals Pairing Unpair
ContactMethod Add command. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in MacAddress: String (1, 100) the API, on the web interface and when using the remote control.
Page 110: Xcommand Phonebook Contact Delete
Title: String (0, 255) The title of the contact. Tag: Untagged/Favorite Tag the contact as a Favorite, or untag an already tagged contact. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 111: Xcommand Phonebook Contactmethod Add
You can add several contact methods to a contact. Note that only the first contact method USAGE: will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact xCommand Phonebook ContactMethod Delete ContactId: "ContactId" ContactMethodId: method may have been created when issuing the xCommand Phonebook Contact Add "ContactMethodId"...
Page 112: Xcommand Phonebook Contactmethod Modify
Set a call rate. Folder Add command was issued to make the folder. CallType: Audio/Video Select a call type (audio or video). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 113: Xcommand Phonebook Search
Limit: Integer (0..65534) Limit the number of records in the result set to this number. For example, if the limit is SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 114: Presentation Commands
Select which local presentation you wish to stop, identified by presentation instance. PresentationSource: Integer (1..2) Select which local presentation you wish to stop, identified by source number. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 115: Provisioning Commands
The codec reboots to complete the software upgrade. Requires user role: ADMIN, USER USAGE: xCommand Provisioning StartUpgrade SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 116: Roompreset Commands
Requires user role: ADMIN, USER USAGE: xCommand RoomPreset Clear PresetId: PresetId where PresetId: Integer (1..15) The ID of the preset you want to delete. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 117: Security Commands
In non-persistent mode all IP related information is deleted when the system reboots. USAGE: xCommand Standby ResetTimer Delay: Delay ConfirmAndReboot: Yes where Reboots the system. Delay: Integer (1..480) Set the delay in minutes. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 118: Systemunit Commands
[TrailingAction: USAGE: TrailingAction] xCommand SystemUnit OptionKey List where Confirm: Yes TrailingAction: NoAction/Restart/Shutdown Select Shutdown or NoAction to override the default behaviour (Restart). SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 119: Xcommand Systemunit Optionkey Remove
Requires user role: ADMIN USAGE: xCommand SystemUnit SoftReset Confirm: Confirm where Confirm: Yes SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 120: Time Commands
Delete all user interface extensions (widgets) from the video system. Second: Integer (0..59) Requires user role: ADMIN USAGE: xCommand UserInterface Extensions Clear SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 121: Xcommand Userinterface Extensions List
UserInterface Message Prompt Clear [FeedbackId: "FeedbackId"] where FeedbackId: String (0, 255) The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 122: Xcommand Userinterface Message Prompt Display
Enter the text to appear on the feedback options. Option.4: String (0, 255) Enter the text to appear on the feedback options. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 123: Xcommand Userinterface Message Textline Display
Requires user role: ADMIN USAGE: xCommand UserInterface OSD Key Click Key: where Key: 0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/ Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/ SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut/+/- Define the remote key to press. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 124: Usermanagement Commands
Disable the creation of new remote support users. To enable the remote support user again you must factory reset your system. Requires user role: ADMIN USAGE: xCommand UserManagement RemoteSupportUser DisablePermanently Confirm: Confirm where Confirm: Yes SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 125: Xcommand Usermanagement User Passphrase Set
The identifier (ID) of the input source. Input Source [n] has ID n. Run the following API command to find the ID: xStatus Video Input Source. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 126: Xcommand Video Layout Layoutfamily Set
Select a layout family. Output: Integer (1..2) CustomLayoutName: String (1, 128) Choose the output you want to reset. Enter a name for the layout. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 127: Xcommand Video Matrix Swap
The identifier (ID) of the input source. Input Source [n] has ID n. Run the following API command to find the ID: xStatus Video Input Source. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 128: Xcommand Video Selfview Set
Choose between displaying the self-view in full screen or as picture-in-picture. PIPPosition: CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight Select the position for the self-view image. OnMonitorRole: First/Fourth/Second/Third Displays self-view on monitors with this role. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 129: Xstatus Commands
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 130 Call [n] Encryption Type .......................137 Conference status ..........................141 xStatus Call [n] FacilityServiceId .......................137 xStatus Conference ..........................141 xStatus Call [n] HoldReason ........................137 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 131 Network 1 IPv6 Address ......................152 xStatus H323 ............................147 xStatus Network 1 IPv6 Gateway ......................152 xStatus H323 Gatekeeper Address ......................147 xStatus Network 1 VLAN Voice VlanId .....................152 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 132 SystemUnit Hardware Module SerialNumber ................162 xStatus SystemUnit Hardware Monitoring Fan [n] Status .................162 Security status ............................ 158 xStatus SystemUnit Hardware Temperature ....................162 xStatus Security ............................158 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 133 UserInterface Extensions Widget [n] WidgetId ................167 xStatus Video Selfview OnMonitorRole ....................173 xStatus UserInterface Extensions Widget [n] Value .................168 xStatus Video Selfview PIPPosition ......................173 SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 134: Audio Status
*s Audio Input Connectors Microphone 2 ConnectionStatus: Connected ** end Example: xStatus Audio Microphones Mute *s Audio Microphones Mute: Off ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 135: Xstatus Audio Output Connectors Line [N] Delayms
Shows whether the endpoint volume is set to mute. Value space of the result returned: Off/On Example: xStatus Audio VolumeMute *s Audio VolumeMute: Off ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 136: Call Status
Value space of the result returned: Unanswered/Ignored/Autoanswered/Answered xStatus Call [n] DeviceType Example: Indicates whether the remote system is a single endpoint or an MCU. Some Cisco endpoints xStatus Call AnswerState (SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities. *s Call 5 AnswerState: Answered...
Page 137: Xstatus Call [N] Placedonhold
Call 27 Encryption Type Example: *s Call 27 Encryption Type: "None" xStatus Call 27 PlacedOnHold ** end *s Call 27 PlacedOnHold: False ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 138: Xstatus Call [N] Protocol
Call to find the call identity. Value space of the result returned: String Example: xStatus Call 27 RemoteNumber *s Call 27 RemoteNumber: "5585232" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 139: Cameras Status
** end Value space of the result returned: Auto/On/Off Example: xStatus Cameras Camera 1 Flip *s Camera 1 Flip: "Off" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 140: Xstatus Cameras Camera [N] Serialnumber
Shows the the maximum number of simultaneous calls. Value space of the result returned: 0..5 Example: xStatus Capabilities Conference MaxCalls *s Capabilities Conference MaxCalls: 3 ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 141: Xstatus Capabilities Conference Maxvideocalls
Value space of the result returned: On/Off Example: xStatus Conference Call Capabilities FarendMessage Mode *s Conference Call 4 Capabilities FarendMessage Mode: Off ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 142: Xstatus Conference Call [N] Capabilities Fecc Mode
*s Conference Call 2 Capabilities FECC Source 1 SourceId: 6 xStatus Conference Call 2 Capabilities FECC NumberOfSources ** end *s Conference Call 2 Capabilities FECC NumberOfSources: 5 ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 143: Xstatus Conference Call [N] Capabilities Hold
Conference Call 2 SoftwareID *s Conference Call 2 Capabilities Presentation: True *s Conference Call 2 SoftwareID: "CE8" ** end ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 144: Xstatus Conference Donotdisturb
Shows the identity of the system that sends the presentation. Value space of the result returned: Integer Example: xStatus Conference Presentation CallId *s Conference Presentation CallId: 0 ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 145: Xstatus Conference Presentation Localinstance [N] Sendingmode
Shows the status of the secondary video stream. Value space of the result returned: On/Off Example: xStatus Conference Presentation Mode *s Conference Presentation Mode: Off ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 146: Diagnostics Status
VideoFromInternalCamera/VideoInputStability/SparkSoftwareCompatibility/SparkConnectivity/ Example: SpeakerTrackFrontPanelMountedCorrectly/SpeakerTrackMicrophoneConnection/ xStatus Diagnostics Message 4 Level SpeakerTrackVideoInputs/SpeakerTrackEthernetConnection/ANATOnVCS/ *s Diagnostics Message 4 Level: Warning ECReferenceDelay/AudioPairingNoise/AudioPairingRate/AudioPairingSNR/ AudioPairingInterference/AudioPairingTokenDecode/AudioInternalSpeakerDisabled/ ** end AbnormalCallTermination/HasActiveCallProtocol/SipOrH323ButNotBothEnabled/ PresentationSourceSelection/SoftwareUpgrade/PlatformSanity/ContactInfoMismatch/ ProximityContentShareToClientsWithMultistream SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 147: Xstatus H323 Gatekeeper Port
Shows the reason for rejected registration. Value space of the result returned: String Example: xStatus H323 Gatekeeper Reason *s H323 Gatekeeper Reason: "" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 148: Xstatus H323 Gatekeeper Status
Disabled: Registration is disable, because SIP is enabled. Value space of the result returned: Enabled/Disabled Example: xStatus H323 Mode Status *s H323 Mode Status: "Disabled" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 149: Network Status
** end Value space of the result returned: String Example: xStatus Network CDP DeviceId *s Network 1 CDP DeviceId: "123456.company.com" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 150: Xstatus Network 1 Cdp Primarymgmtaddress
Example: xStatus Network 1 CDP Version xStatus Network CDP PrimaryMgmtAddress *s Network 1 CDP Version: "Cisco IOS Software, C3560CX Software (C3560CX- *s Network 1 CDP PrimaryMgmtAddress: "10.1.1.2" UNIVERSALK9-M), Version 15.2(3)E, RELEASE SOFTWARE (fc4)*Technical Support: http://www.cisco.com/techsupport*Copyright (c) 1986-2014 by Cisco Systems, ** end Inc.*Compiled Sun 07-Dec-14 13:15 by prod _ rel _ team"...
Page 151: Xstatus Network 1 Dns Domain Name
Network 1 Ethernet MacAddress xStatus Network 1 IPv4 Gateway *s Network 1 Ethernet MacAddress: "00:50:60:02:FD:C7" *s Network 1 IPv4 Gateway: "192.0.2.10" ** end ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 152: Xstatus Network 1 Ipv4 Subnetmask
Shows the address of the IPv6 gateway. Value space of the result returned: String Example: xStatus Network 1 IPv6 Gateway *s Network 1 IPv6 Gateway: "" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 153: Networkservices Status
Returns the address of the NTP server(s) the codec is using. Value space of the result returned: String Example: xStatus NetworkServices NTP Address *s NetworkServices NTP Address: "12.104.193.12 64.104.222.16 144.254.15.121" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 154: Peripherals Status
Value space of the result returned: String Example: xStatus Peripherals ConnectedDevice 1007 Name *s Peripherals ConnectedDevice 1007 Name: "Cisco TelePresence Touch" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 155: Xstatus Peripherals Connecteddevice [N] Upgradestatus
Value space of the result returned: String Example: xStatus Provisioning Software Current VersionId *s Provisioning Software Current VersionId: "s52020ce8 _ 0 _ 0.pkg" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 156: Xstatus Provisioning Software Upgradestatus Lastchange
*s Provisioning Software UpgradeStatus URL: "http://.../s52020ce8 _ 0 _ 0.pkg" xStatus Provisioning Software UpgradeStatus Phase ** end *s Provisioning Software UpgradeStatus Phase: None ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 157: Xstatus Provisioning Software Upgradestatus Versionid
ConfigError: An error occurred during configuration. ** end Value space of the result returned: Failed/AuthenticationFailed/Provisioned/Idle/NeedConfig/ConfigError Example: xStatus Provisioning Status *s Provisioning Status: Provisioned ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 158: Xstatus Security Fips Mode
*s Security Persistency LocalPhonebook: Persistent ** end Value space of the result returned: NonPersistent/Persistent Example: xStatus Security Persistency Configurations *s Security Persistency Configurations: Persistent ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 159: Sip Status
Off: No authentication mechanism is used. Value space of the result returned: Digest/Off Example: xStatus SIP Authentication *s SIP Authentication: Off ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 160: Xstatus Sip Mailbox Messageswaiting
*s SIP Proxy 1 Address: "192.0.2.50" Example: xStatus SIP Registration 1 Authentication ** end *s SIP Registration 1 Authentication: Off ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 161: Xstatus Sip Registration [N] Reason
Shows whether or not the SSL certificate of the server that the video system / codec tries to register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or Deregister: The system is in the process of de-registering to the SIP Proxy.
Page 162: Standby Status
Shows the current maximum temperature (degree Celsius) measured in the codec/system. Value space of the result returned: String Example: xStatus SystemUnit Hardware Temperature *s SystemUnit Hardware Temperature: "64.0" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 163: Xstatus Systemunit Notifications Notification [N] Text
*s SystemUnit ProductType: "Cisco Codec" ** end Example: xStatus SystemUnit Notifications Notification 1 Type *s SystemUnit Notifications Notification 1 Type: SoftwareUpgradeOK ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 164: Xstatus Systemunit Software Displayname
Example: xStatus SystemUnit Software OptionKeys NaturalPresenter *s SystemUnit Software OptionKeys DualDisplay: "true" *s SystemUnit Software OptionKeys NaturalPresenter: "true" ** end ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 165: Xstatus Systemunit Software Optionkeys Premiumresolution
SystemUnit State NumberOfInProgressCalls Example: *s SystemUnit State NumberOfInProgressCalls: 0 xStatus SystemUnit Software ReleaseDate ** end *s SystemUnit Software ReleaseDate: "2015-05-05" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 166: Xstatus Systemunit State Numberofsuspendedcalls
Value space of the result returned: *s Time SystemTime: "2014-04-25T10:04:03Z" Integer ** end Example: xStatus SystemUnit Uptime *s SystemUnit Uptime: 597095 ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 167: Usb Status
*s UserInterface ContactInfo Name: "MySystem" ** end xStatus UserInterface Extensions Widget [n] WidgetId Returns the unique identifier for a widget in the touch controller user interface. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 168: Video Status
Value space of the result returned: False/True/Unknown Example: xStatus Video Input Connector 1 Connected *s Video Input Connector 1 Connected: True ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 169: Xstatus Video Input Connector [N] Signalstate
*s Video Input Source 1 Resolution FormatStatus: Ok Example: ** end xStatus Video Input Connector 1 Type *s Video Input Connector 1 Type: HDMI ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 170: Xstatus Video Input Source [N] Formattype
*s Video Input Source 1 Resolution Height: 1080 Value space of the result returned: ** end Single/Dual/DualPresentationOnly/Triple/TriplePresentationOnly/Quadruple Example: xStatus Video Monitors *s Video Monitors: Single ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 171: Xstatus Video Output
Value space of the result returned: String Example: xStatus Video Output Connector 1 ConnectedDevice Name *s Video Output Connector 1 ConnectedDevice Name: "G2420HDBL" ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 172: Xstatus Video Output Connector [N] Connecteddevice Preferredformat
Value space of the result returned: ** end 120..3000 Example: xStatus Video Output Connector 1 Resolution Height *s Video Output Connector 1 Resolution Height: 1080 ** en SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 173: Xstatus Video Presentation Pipposition
Shows whether selfview mode is set on or not. Value space of the result returned: On/Off Example: xStatus Video Selfview Mode *s Video Selfview Mode: Off ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 174: Appendices
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 175: About Startup Scripts
Use the codec’s web interface to create and manage startup scripts. Read more about the web interface and startup scripts in the Administrator guide for your product. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 176: The Systemtools Commands
<hostname> | netstat | addrs | ifconfig Max failed login attempts [0]? • Number of failed logins until a user is set inactive. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 177 Max consecutive equal digits in PINs [0]? • Maximum consecutive equal digits in PINs. Minimum number of digits in PINs [0]? • Minimum number of digits in PINs. SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 178: About Disconnect Cause Types
*h xHistory CallLogs Call 694 DisconnectCauseType: RemoteDisconnect *h xHistory CallLogs Call 694 DisconnectCauseCode: 16 *h xHistory CallLogs Call 694 DisconnectCauseOrigin: Q850 ** end SX20 Codec API Reference Guide CE8.1, APRIL 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15316.03...
Page 179: User Documentation On The Cisco Web Site
Release Notes • Administering CE Endpoints on CUCM: Tasks to • Software release notes perform to start using the product with the Cisco Unified Communications Manager (CUCM) Maintain and Operate > End-User Guides • User guides: How to use the product •...
Page 180 Tandberg ASA. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company.

Cisco TelePresence SX20 Codec Reference Manual

Quick Links

Related Manuals for Cisco TelePresence SX20 Codec

Summary of Contents for Cisco TelePresence SX20 Codec