Download  Print this page

Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs

Advertisement

Table of Contents
Cisco TelePresence SX20 Codec
Introduction
Software version CE8.3
JANUARY 2017
Application Programming Interface (API)
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API
xConfiguration
Reference Guide
Cisco TelePresence SX20 Codec
xCommand
1
API Reference Guide
xStatus
Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Advertisement

Table of Contents
loading

  Summary of Contents for Cisco TelePresence SX20 Codec

  • Page 1 About the API xConfiguration xCommand xStatus Appendices Software version CE8.3 JANUARY 2017 Application Programming Interface (API) Reference Guide Cisco TelePresence SX20 Codec SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 2: Table Of Contents

    Configurations ...............39 The SystemTools commands ..........202 Status ..................39 About disconnect cause types ...........204 Events ...................40 User documentation on the Cisco web site ......205 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 4: 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.3

    ActiveControl is a SIP-only feature that has been supported software version 8.3 (CE8.3) compared to CE8.2. You can customize our touch user interfaces to include input for a while for video systems in Cisco TelePresence Server sources that are connected to third-party external video hosted conferences.
  • Page 6 Basic call control) must be explicitly enabled by the administrator. As before, Proximity mode must be on in order to pair a laptop to a video system through the Cisco Proximity desktop client. Pairing is required before you can use any of the wireless sharing services.
  • Page 7 User role: Admin, User Standby WakeupAction OLD: User role: Admin NEW: User role: Admin, User UserInterface/Language Change: EnglishUK and SpanishLatin added to value space SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 8 User role: Admin NEW: User role: Admin, RoomControl UserInterface Message Prompt Response OLD: User role: Admin, User NEW: User role: Admin, User, RoomControl SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 9 MediaChannels Call [n] Channel [n] Video ResolutionX MediaChannels Call [n] Channel [n] Video ResolutionY Provisioning CUCM ExtensionMobility Enabled Provisioning CUCM ExtensionMobility LastLoggedInUserId Provisioning CUCM ExtensionMobility LoggedIn SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 10: What's New In Ce8.2

    The Room The administrator doesn’t have to visit the site or provide downgrade. System is managed by Cisco and if there are any issues, administrator credentials in order to pair or re-pair a touch contact Cisco Technical Assistance center through the controller to a video system.
  • Page 11 Wizard on the Touch 10. The Touch 10 has a new GUI control editor. The “RoomControl” role can be assigned when registered to Cisco Spark, which is similar to the when a new non-admin user is created from the codec’s Cisco TelePresence SX10 on-screen user interface.
  • Page 12 CUCM / Off / Spark / TMS / VCS OLD: User Role: ADMIN Provisioning Connectivity NEW: User Role: ADMIN, USER OLD: User Role: ADMIN NEW: User Role: ADMIN, USER SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 13 PC / camera / desktop / document_camera / mediaplayer / other / whiteboard Video Input Connector [n] PresentationSelection OLD: AutoShare / Manual / OnConnect NEW: AutoShare / Desktop / Manual / OnConnect SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 14 Phonebook ContactMethod Modify OLD: Protocol: <Auto / H320 / H323 / Sip> NEW: Protocol: <Auto / H320 / H323 / Sip / Spark> SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 15 SpeakerTrackEthernetConnection / ANATOnVCS / ECReferenceDelay / AudioPairingNoise / AudioPairingRate / AudioPairingSNR / AudioPairingInterference / AudioPairingTokenDecode / AudioInternalSpeakerDisabled / AbnormalCallTermination / HasActiveCallProtocol / SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 16: 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 17 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 18 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 19 <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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 20: What's New In Ce8.0

    CE8 before upgrading; other- software version TC7.3 or earlier for these products. Cisco Proximity allows you to automatically pair your device wise upgrading to CE8 can leave you with a (smartphone, tablet, or laptop) with the video system when...
  • Page 21 In this release Multistream is switched Off by default. We recommend the Cisco UCM 11.0.0 and later, and the latest versions of TelePresence Server and TelePresence Conductor for optimal experience.
  • Page 22 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 23 Edge> NEW: <Off / TMS / VCS / CUCM / Auto / Edge Video OSD AutoSelectPresentationSource Video OSD CallSettingsSelection Video OSD LanguageSelection SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 24 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 25 SIP Profile [1] Turn UserName Video Output HDMI [n] CEC Mode Renamed to: SIP Turn UserName Renamed to: Video Output Connector [n] CEC Mode SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 26 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 27 FacilityService Dial NEW: Axis: <All/Focus/PanTilt/Zoom> FarEndControl Preset Store Camera Preset Edit Key * NEW: DefaultPosition: <False/True> Logging ExtendedLogging * Message Echo Message FarendMessage SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 28 Time DateTime Get NEW: YourPassphrase: <S: 0, 255> SystemUnit DateTime Set Renamed to: Time DateTime Set OLD: Year: <2008..2037> NEW: Year: <2015..2037> SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 29 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 30 Conference Call [n] CalText (was Conference Site [n] CalText) Provisioning Software PreviousUpgrade * Conference Call [n] Preserved (was Conference Site [n] Preserved) SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 31 TemperatureCheck, AudioInternalSpeakerDisabled, and ContactInfoMismatch added to the value space Renamed to: Conference SpeakerLock CallId Conference ActiveSpeaker Mode Renamed to: Conference SpeakerLock Mode SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 32 Renamed to: Diagnostics Message [n] * SystemUnit Software MaxAudioCalls Renamed to: Capabilities Conference MaxAudioCalls SystemUnit Software MaxVideoCalls Renamed to: Capabilities Conference MaxVideoCalls SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 33: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 34: Api Fundamentals

    POST and GET methods are used to execute commands and get feedback from the codec. This is described in ”Using HTTP” on page 43 in this document. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 35: Rs-232 / Serial Connection

    For security reasons the password prompting is turned on by default, but it can be turned off if preferred. xConfiguration SerialPort LoginRequired: <Off/On> SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 36: Api Output

    To set output 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 37: 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 38: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 39: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 40: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 41: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 42: Terminal Connections

    Write in: xFeedback deregister /Status/Audio Result: ** end D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 43: Using Http

    Response: GET /configuration.xml HTTP/1.1 HTTP/1.1 204 No Content Cookie: SessionId=f08102c8ce5aaf8fba23a7238cc2ef46 Server: nginx/1.8.0 4b990e18bfbb7fb048820c0e28955c54 Connection: keep-alive Set-Cookie: SessionId=; Max-Age=0; Path=/; HttpOnly SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 44: Getting Status And Configurations

    </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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 45: Feedback From Codec Over Http

    JSON format. You can subscribe to changes on multiple Cisco TelePresence Management Suite (TMS) is used as TMS codec from which the notification originated. This means that parts of the API by register up to 15 different feedback uses this feedback slot to register its expressions.
  • Page 46: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 47: 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 48: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 49: Description Of The Xconfiguration Commands

    H323 CallSetup Mode ......................63 xConfiguration Cameras Camera [1] Gamma Level ...................58 xConfiguration H323 Encryption KeySize ....................64 xConfiguration Cameras Camera [1] Mirror ....................58 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 50 Phonebook Server [1] Type ....................81 xConfiguration Network [1] QoS Diffserv Data ...................73 xConfiguration Phonebook Server [1] URL ....................81 xConfiguration Network [1] QoS Diffserv Signalling ...................73 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 51 SIP Proxy [1..4] Address .....................88 xConfiguration UserManagement LDAP Admin Group ................97 xConfiguration SIP Turn Server ........................89 xConfiguration UserManagement LDAP Attribute ..................97 xConfiguration SIP Turn UserName ......................89 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 52 Video Selfview Default OnMonitorRole ................104 xConfiguration Video Selfview Default PIPPosition ..................104 xConfiguration Video Selfview OnCall Mode ...................105 xConfiguration Video Selfview OnCall Duration ..................105 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 53: Audio Configuration

    Auto: The phantom voltage is turned on if a Cisco microphone is connected; otherwise xConfiguration Audio DefaultVolume: DefaultVolume it is turned off. You can use this value if you are only using Cisco microphones, because where the video system automatically detects if such a microphone is connected.
  • Page 54: Xconfiguration Audio Soundsandalerts Ringvolume

    On: Turn on the echo control. Recommended, in general, to prevent the far end from when the video source is not presented. hearing their own audio. Once selected, echo cancellation is active at all times. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 55: Xconfiguration Audio Input Microphone [1

    : Unique ID that identifies the microphone input. Range: 1..2 : Off/On Dereverberation Off: Turn off the dereverberation. On: Turn on the dereverberation. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 56: Xconfiguration Audio Output Line [1] Delay Delayms

    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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 57: Xconfiguration Cameras Camera [1] Brightness Defaultlevel

    Manual: In manual mode the gamma value is changed with the gamma level setting, ref. Cameras Camera [n] Gamma Level. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 58: Xconfiguration Cameras Camera [1] Whitebalance Mode

    Off: Display the image as other people see you. On: Display the image as you see yourself in a mirror. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 59: Xconfiguration Cameras Preset Triggerautofocus

    : Off/On Mute Off: The incoming call will not be muted. On: The incoming call will be muted when automatically answered. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 60: Xconfiguration Conference Autoanswer Delay

    The number of minutes (maximum 1440 minutes = 24 hours) before the Do Not Disturb system cannot register, the auto-selection chooses H323. session times out automatically. H320: All calls are set up as H.320 calls (only applicable if connected to Cisco TelePresence ISDN Link). H323: All calls are set up as H.323 calls.
  • Page 61: Xconfiguration Conference Encryption Mode

    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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 62: Xconfiguration Conference Maxtotalreceivecallrate

    The video system supports multistream video for conferences, provided that the conference host a multipoint video conference. infrastructure supports the feature (Cisco TelePresence Server 4.2 or later). This means that the video system can compose the video streams locally into a conference layout which utilizes Define the maximum overall receive bit rate allowed.
  • Page 63: H323 Configuration

    H323 Gatekeeper Address must also be configured. xConfiguration H323 Authentication LoginName: "LoginName" where : String (0, 50) LoginName The authentication login name. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 64: Xconfiguration H323 Encryption Keysize

    The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID" : String (0, 255) Address A valid IPv4 address, IPv6 address or DNS name. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 65: Xconfiguration H323 Nat Mode

    "My IP Address: 10.0.2.1". If the H323 NAT Address is wrong or not set, H.323 calls cannot be set up. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 66: Network Configuration

    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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 67: Xconfiguration Network [1] Ieee8021X Useclientcertificate

    : Index that identifies the network. Range: 1..1 AnonymousIdentity The 802.1X Anonymous ID string. : String (0, 64) Identity The user name for 802.1X authentication. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 68: Xconfiguration Network [1] Ieee8021X Eap Md5

    Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN by Agere Systems, Proxim and Avaya. clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Requires user role: ADMIN, USER Requires user role: ADMIN, USER...
  • Page 69: Xconfiguration Network [1] Ipstack

    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. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 70: Xconfiguration Network [1] Ipv4 Subnetmask

    DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 71: Xconfiguration Network [1] Ipv6 Dhcpoptions

    Network MTU: where : Index that identifies the network. Range: 1..1 : Integer (576..1500) Set a value for the MTU (bytes). SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 72: Xconfiguration Network [1] Qos Diffserv Audio

    Set the priority of the video 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 73: Xconfiguration Network [1] Qos Diffserv Data

    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). SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 74: Xconfiguration Network [1] Qos Diffserv Icmpv6

    RemoteAccess Allow: "Allow" where : Index that identifies the network. Range: 1..1 : String (0, 255) Allow A valid IPv4 address or IPv6 address. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 75: Xconfiguration Network [1] Speed

    : Auto/Manual/Off Mode : Auto/10half/10full/100half/100full/1000full Speed Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. Auto: Autonegotiate link speed. If CDP is not available, VLAN is not enabled. 10half: Force link to 10 Mbps half-duplex.
  • Page 76: Networkservices Configuration

    NetworkServices CDP Mode setting is switched Off, you cannot use the web interface. Enable or disable the CDP (Cisco Discovery Protocol) daemon. Enabling CDP will make the If you need extra security (encryption and decryption of requests, and pages that are returned endpoint report certain statistics and device identifiers to a CDP-enabled switch.
  • Page 77: Xconfiguration Networkservices Https Verifyclientcertificate

    NTP Server [n] Address setting for time reference. 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 78: Xconfiguration Networkservices Snmp Mode

    These variables can then "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the be queried (set to ReadOnly) and sometimes set (set to ReadWrite) by managing applications.
  • Page 79: Xconfiguration Networkservices Snmp Systemlocation

    Off: The welcome text is: Login successful On: The welcome text is: Welcome to <system name>; Software version; Software release date; Login successful. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 80: Peripherals Configuration

    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...
  • Page 81: Phonebook Configuration

    CUCM: The phonebook is located on the Cisco Unified Communications Manager. Spark: The phonebook is located on Spark. 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 82: Provisioning Configuration

    Spark: Push configurations to the video system from Spark. 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.3, JANUARY 2017.
  • Page 83: Xconfiguration Provisioning Loginname

    Default value: "" USAGE: xConfiguration Provisioning ExternalManager Address: "Address" where : String (0, 64) Address A valid IPv4 address, IPv6 address or DNS name. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 84: 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 85: Proximity Configuration

    Requires user role: ADMIN, USER video system. In order to use a client, at least one of the Proximity services must be enabled Default value: Enabled (refer to the Proximity Services settings). In general, Cisco recommends enabling all the Proximity services. USAGE:...
  • Page 86: Serialport Configuration

    Default value: 38400 USAGE: xConfiguration SerialPort BaudRate: BaudRate where : 9600/19200/38400/57600/115200 BaudRate Set a baud rate from the baud rates listed (bps). SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 87: Sip Configuration

    A valid password. xConfiguration SIP DisplayName: "DisplayName" where : String (0, 550) DisplayName The name to be displayed instead of the SIP URI. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 88: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 89: Xconfiguration Sip Turn Password

    Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Turn Password: "Password" where : String (0, 128) Password A valid password. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 90: Standby Configuration

    Delay 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 91: Xconfiguration Standby Wakeupaction

    : String (0, 50) Name 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 92: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 93 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, SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 94: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 95: Xconfiguration Userinterface Osd Output

    Default value: "" USAGE: xConfiguration UserManagement LDAP Server Address: "Address" where : String (0, 255) Address A valid IPv4 address, IPv6 address or hostname. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 96: Xconfiguration Usermanagement Ldap Server Port

    Use the video system’s web interface to manage the list of trusted CAs (see more details in the administrator guide). SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 97: Xconfiguration Usermanagement Ldap Admin Filter

    UserManagement LDAP Admin Group: "Group" where : String (0, 255) Group The distinguishing name of the AD group. Example: "CN=admin_group, OU=company groups, DC=company, DC=com" SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 98: Video Configuration

    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. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 99: Xconfiguration Video Input Connector [1..2] Inputsourcetype

    : Unique ID that identifies the video input connector. Range: 1..2 : String (0, 50) Name Name for the video input connector. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 100: Xconfiguration Video Input Connector [1..2] Presentationselection

    (for example when a connected computer wakes up from sleep mode). Otherwise, the behavior is the same as in manual mode. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 101: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 102: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 103: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 104: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 105: Xconfiguration Video Selfview Oncall Mode

    : Integer (1..60) Duration Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 106: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 107: Description Of The Xcommand Commands

    Call Disconnect ........................114 xCommand Camera Preset Edit .......................120 xCommand Call FarEndControl Camera Move ..................114 xCommand Camera Preset List .......................120 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 108 Phonebook commands ........................128 xCommand Security Session List ......................136 xCommand Phonebook Contact Add .......................128 xCommand Security Session Terminate ....................136 xCommand Phonebook Contact Delete ....................128 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 109 UserInterface Message Prompt Display ................141 xCommand Video PresentationView Set ....................148 xCommand UserInterface Message Prompt Response ................142 xCommand Video Selfview Set ........................149 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 110: Audio Commands

    Audio SoundsAndAlerts Ringtone Play RingTone: "RingTone" reliable and robust results. where : String (1, 100) RingTone The name of the ringtone. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 111: Xcommand Audio Volume Decrease

    Audio Volume Set Level: Level where : Integer (0..100) Level Select the gain level. 70 equals 0 dB gain, and 100 equals 15 dB gain. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 112: Xcommand Audio Vumeter Start

    : Integer (1..2) for Microphone; Integer (1..1) for Line ConnectorID Select a connector number. Together with the ConnectorType it uniquely identifies the connector. : Line/Microphone ConnectorType Select the connector type. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 113: Bookings Commands

    : String (0, 128) : Integer (0..65534) Offset The booking ID of a call or conference. Offset number of bookings for this search. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 114: Call Commands

    Call command to see the CallId. : Left/Right/Up/Down/ZoomIn/ZoomOut Value : String (0, 32) DTMFString Select the action for how to move the camera. Enter the DTMF string. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 115: Xcommand Call Farendcontrol Camera Stop

    Call command to see the CallId. : Integer (1..15) PresetId The ID of the preset that is stored on the far end codec. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 116: Xcommand Call Hold

    Call command to see the CallId. : Integer (0..65534) CallId : String (0, 255) Number The number the call is transfered to. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 117: Callhistory Commands

    Requires user role: ADMIN, USER USAGE: xCommand CallHistory DeleteAll [Filter: Filter] where : All/Missed/Placed/Received Filter You can filter which calls to delete. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 118: Xcommand Callhistory Get

    CallHistoryId for the call in question. CallHistoryId for the call in question. : OccurrenceTime/OccurrenceFrequency Order Define the order in which the previous calls are presented. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 119: Camera Commands

    Move the camera to the left or right. : Integer (-2500..2500) Tilt Move the camera up or down. : Integer (0..8500) Zoom Zoom in or out. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 120: Xcommand Camera Preset Edit

    USAGE: xCommand Camera Preset Remove PresetId: PresetId where : Integer (1..35) PresetId The ID of the camera preset you want to remove. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 121: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 122: Xcommand Camera Ramp

    Zoom the camera In or Out, followed by Stop. : Integer (1..15) ZoomSpeed Set the zoom speed. : Far/Near/Stop Focus Focus the camera Far or Near, followed by Stop. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 123: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 124: Diagnostics Commands

    : Integer (1..999999999) Appearance Internal usage only. : String (0, 255) DisplayName The display name of the remote participant. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 125: Httpfeedback Commands

    FeedbackSlot Deregister the feedback slot that was registered using the xCommand HttpFeedback Note: Avoid using FeedbackSlot 3 in an environment where Cisco TelePresence Register command. Management Suite (TMS) is used as TMS uses this feedbackslot to register its expressions.
  • Page 126: Peripherals Commands

    Limit the search by device type. SoftwareInfo Software version the device is running. : Byod/ControlSystem/Other/TouchPanel Type Define the type of device you are connecting to. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 127: Xcommand Peripherals Pairing Devicediscovery Start

    Peripherals Pairing Pair MacAddress: "MacAddress" where : String (1, 1450) MacAddress Enter the MAC address for the ISDN Link you wish to pair to the endpoint. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 128: Phonebook Commands

    ContactMethod Add command. Note that only the first contact method will appear in the Delete an existing contact from the local phonebook. Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in the API, on the web interface and when using the remote control.
  • Page 129: Xcommand Phonebook Contact Modify

    Number, Protocol, CallRate, CallType and Device. You can add several contact methods to a contact. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact Requires user role: ADMIN, USER method may have been created when issuing the xCommand Phonebook Contact Add command to make the contact.
  • Page 130: Xcommand Phonebook Contactmethod Delete

    : Auto/H320/H323/SIP/Spark Protocol Select protocol. : Integer (0..6000) CallRate Set a call rate. : Audio/Video CallType Select a call type (audio or video). SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 131: Xcommand Phonebook Folder Add

    The unique identifier for the folder. The identifier will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 132: Xcommand Phonebook Search

    10, the ResultSet will contain only 10 entries (Contacts and Folders) even if the total number of hits is larger. The maximum limit is 1000. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 133: Presentation Commands

    Select which local presentation you wish to stop, identified by presentation instance. : Integer (1..2) PresentationSource Select which local presentation you wish to stop, identified by source number. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 134: Xcommand Provisioning Extensionmobility Login

    Provisioning ExtensionMobility Logout This command will log you out of your Extension Mobility profile. Requires user role: ADMIN, USER USAGE: xCommand Provisioning ExtensionMobility Logout SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 135: Roompreset Commands

    Requires user role: ADMIN, USER USAGE: xCommand RoomPreset Clear PresetId: PresetId where : Integer (1..15) PresetId The ID of the preset you want to delete. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 136: Security Commands

    : Yes ConfirmAndReboot Reboots the system. xCommand Security Session List List active sessions. Requires user role: ADMIN, USER USAGE: xCommand Security Session List SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 137: Standby Commands

    : NoAction/Restart/Shutdown TrailingAction : Integer (1..480) Delay Select Shutdown or NoAction to override the default behaviour (Restart). Set the delay in minutes. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 138: Xcommand Systemunit Notifications Removeall

    SystemUnit OptionKey Remove Remove a specified option key. Requires user role: ADMIN USAGE: xCommand SystemUnit OptionKey Remove Type: Type where : MultiSite/RemoteMonitoring Type SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 139: Xcommand Systemunit Softwareupgrade

    : Integer (2015..2037) Year : Integer (1..12) Month : Integer (1..31) : Integer (0..23) Hour : Integer (0..59) Minute : Integer (0..59) Second SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 140: Userinterface Commands

    UserInterface Extensions Clear Delete all user interface extensions (widgets) from the video system. Requires user role: ADMIN USAGE: xCommand UserInterface Extensions Clear SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 141: Xcommand Userinterface Message Alert Display

    The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command. : String (0, 255) Option.5 Enter the text to appear on the feedback options. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 142: Xcommand Userinterface Message Textline Clear

    Requires user role: ADMIN USAGE: xCommand UserInterface OSD Key Click Key: where : 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 143: Xcommand Userinterface Osd Key Press

    The unique string that identifies this input source. It was defined when the source was created with the UserInterface Presentation ExternalSource Add command. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 144: Xcommand Userinterface Presentation Externalsource Removeall

    : String (0, 80) ErrorReason This string is displayed in the user interface sharetray, given that the State parameter is set to Error. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 145: 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 : Yes Confirm SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 146: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 147: Xcommand Video Layout Layoutfamily Set

    Requires user role: ADMIN, USER USAGE: xCommand Video Matrix Reset [Output: Output] where : Integer (1..2) Output Choose the output you want to reset. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 148: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 149: Xcommand Video Selfview Set

    Choose between displaying the self-view in full screen or as picture-in-picture. : CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/ PIPPosition UpperRight Select the position for the self-view image. : First/Fourth/Second/Third OnMonitorRole Displays self-view on monitors with this role. SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 150: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 151: Description Of The Xstatus Commands

    Call [n] Duration..........................159 xStatus Capabilities Conference MaxCalls ....................162 xStatus Call [n] Encryption Type .......................159 xStatus Capabilities Conference MaxVideoCalls ..................163 xStatus Call [n] FacilityServiceId .......................159 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 152 MediaChannels Call [n] Channel [n] Video ChannelRole .............173 xStatus Diagnostics Message [n] Type .....................168 xStatus MediaChannels Call [n] Channel [n] Video FrameRate ..............173 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 153 Security FIPS Mode ........................184 xStatus NetworkServices NTP Server [n] Address ..................178 xStatus Security Persistency CallHistory ....................184 xStatus NetworkServices NTP Status ......................179 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 154 Video Input ..........................194 xStatus SystemUnit Hardware Temperature ....................189 xStatus Video Input Connector [n] Connected ..................194 xStatus SystemUnit Notifications Notification [n] Text ................189 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 155 Video Presentation PIPPosition ....................199 xStatus Video Selfview FullscreenMode ....................199 xStatus Video Selfview Mode ........................199 xStatus Video Selfview OnMonitorRole ....................199 xStatus Video Selfview PIPPosition ......................199 SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 156: Audio Status

    *s Audio Input Connectors Microphone 2 ConnectionStatus: Connected Example: ** end xStatus Audio Microphones Mute *s Audio Microphones Mute: Off ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 157: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 158: 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 (SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities. xStatus Call AnswerState *s Call 5 AnswerState: Answered...
  • Page 159: Xstatus Call [N] Holdreason

    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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 160: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 161: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 162: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 163: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 164: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 165: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 166: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 167: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 168: Diagnostics Status

    *s Diagnostics Message 4 Level: Warning AudioPairingNoise/AudioPairingRate/AudioPairingSNR/AudioPairingInterference/ ** end AudioPairingTokenDecode/AudioInternalSpeakerDisabled/AbnormalCallTermination/ HasActiveCallProtocol/SipOrH323ButNotBothEnabled/PresentationSourceSelection/ SoftwareUpgrade/PlatformSanity/ContactInfoMismatch/MicrophoneReinforcement Example: xStatus Diagnostics Message Type *s Diagnostics Message 1 Type: CamerasDetected ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 169: H323 Status

    H323 Gatekeeper Reason Example: *s H323 Gatekeeper Reason: "" xStatus H323 Mode Status ** end *s H323 Mode Status: "Disabled" ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 170: Httpfeedback Status

    URL. ** end Value space of the result returned: String Example: xStatus HttpFeedback 1 URL *s HttpFeedback 1 URL: "http://tms.company.com/tms/public/feedback/code.aspx" ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 171: Xstatus Mediachannels Call [N] Channel [N] Audio Protocol

    Value space of the result returned: Incoming/Outgoing Example: xStatus MediaChannels Call 27 Channel 327 Direction *s MediaChannels Call 27 Channel 327 Direction: Incoming ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 172: Xstatus Mediachannels Call [N] Channel [N] Netstat Jitter

    *s MediaChannels Call 27 Channel 327 NetStat LastIntervalReceived: 289 *s MediaChannels Call 27 Channel 327 NetStat Packets: 1551 ** end ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 173: Xstatus Mediachannels Call [N] Channel [N] Participantid

    Example: ** end xStatus MediaChannels Call 27 Channel 327 Video ChannelRole *s MediaChannels Call 27 Channel 327 Video ChannelRole: Main ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 174: Xstatus Mediachannels Call [N] Channel [N] Video Resolutionx

    Value space of the result returned: IpAddress: "192.168.136.130" String ** end Example: xStatus Network CDP DeviceId *s Network 1 CDP DeviceId: "123456.company.com" ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 175: Xstatus Network 1 Cdp Duplex

    Network CDP PortID xStatus Network CDP SysObjectID *s Network 1 CDP PortID: "GigabitEthernet1/0/23" *s Network 1 CDP SysObjectID: "" ** end ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 176: Xstatus Network 1 Cdp Version

    Example: xStatus Network 1 CDP Version xStatus Network 1 DNS Domain Name *s Network 1 CDP Version: "Cisco IOS Software, C3560CX Software (C3560CX- *s Network 1 DNS Domain Name: "www.example.com www.example.int" UNIVERSALK9-M), Version 15.2(3)E, RELEASE SOFTWARE (fc4)*Technical Support: ** end http://www.cisco.com/techsupport*Copyright (c) 1986-2014 by Cisco Systems,...
  • Page 177: Xstatus Network 1 Ethernet Speed

    Network 1 IPv4 Gateway xStatus Network 1 IPv6 Gateway *s Network 1 IPv4 Gateway: "192.0.2.10" *s Network 1 IPv6 Gateway: "" ** end ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 178: Xstatus Network 1 Vlan Voice Vlanid

    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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 179: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 180: Xstatus Peripherals Connecteddevice [N] Softwareinfo

    Note: The value space Camera only shows Precision 60 cameras. Value space of the result returned: Byod/Camera/ControlSystem/ISDNLink/Other/SpeakerTrack/TouchPanel Example: xStatus Peripherals ConnectedDevice 1001 Type *s Peripherals ConnectedDevice 1001 Type: TouchPanel ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 181: Provisioning Status

    Shows if someone is logged in to Extension Mobility or not. Value space of the result returned: True/False Example: xStatus Provisioning CUCM ExtensionMobility LoggedIn *s Provisioning CUCM ExtensionMobility LoggedIn: False ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 182: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 183: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 184: Security Status

    *s Security Persistency LocalPhonebook: Persistent Value space of the result returned: ** end NonPersistent/Persistent Example: xStatus Security Persistency Configurations *s Security Persistency Configurations: Persistent ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 185: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 186: Xstatus Sip Mailbox Messageswaiting

    Example: *s SIP Proxy 1 Address: "192.0.2.50" ** end xStatus SIP Registration 1 Authentication *s SIP Registration 1 Authentication: Off ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 187: 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 188: Standby Status

    SystemUnit Hardware Module CompatibilityLevel Shows whether the system is in standby mode or not. The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The endpoints running TC software are manufactured with a new version of the flash memory.
  • Page 189: Xstatus Systemunit Notifications Notification [N] Type

    *s SystemUnit ProductId: "Cisco TelePresence Codec SX80" Example: ** end xStatus SystemUnit Notifications Notification 1 Text *s SystemUnit Notifications Notification 1 Text: "OK" ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 190: Xstatus Systemunit Productplatform

    SystemUnit Software DisplayName xStatus SystemUnit Software OptionKeys RemoteMonitoring *s SystemUnit Software DisplayName: "Display Name" *s SystemUnit Software OptionKeys RemoteMonitoring: "true" ** end ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 191: Xstatus Systemunit Software Releasedate

    Example: Example: xStatus SystemUnit State NumberOfActiveCalls xStatus SystemUnit Uptime *s SystemUnit State NumberOfActiveCalls: 0 *s SystemUnit Uptime: 597095 ** end ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 192: Time Status

    ** end Value space of the result returned: Ethernet/Unknown/None Example: xStatus USB Device 1 Type *s USB Device 1 Type: Ethernet ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 193: Userinterface Status

    Returns the unique identifier for a widget. Widgets are used in custom panels, for example in-room controls, that are added to the user interface. Value space of the result returned: String SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 194: Video Status

    *s Video Input Connector 1 Connected: True Example: ** end xStatus Video Input Connector 1 Type *s Video Input Connector 1 Type: HDMI ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 195: Xstatus Video Input Mainvideosource

    *s Video Input Source 1 Resolution FormatStatus: Ok xStatus Video Input Source 1 Resolution Height ** end *s Video Input Source 1 Resolution Height: 1080 ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 196: Xstatus Video Input Source [N] Resolution Refreshrate

    Video Layout LayoutFamily Local *s Video Layout LayoutFamily Local: "equal" Shows the top level overview of the video output status. ** end SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 197: Xstatus Video Output Connector [N] Connected

    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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 198: Xstatus Video Output Connector [N] Connecteddevice Preferredformat

    *s Video Output Connector 1 Type: HDMI 120..3000 ** end Example: xStatus Video Output Connector 1 Resolution Height *s Video Output Connector 1 Resolution Height: 1080 ** en SX20 Codec API Reference Guide CE8.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 199: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 200: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 201: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 202: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 203 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 204: 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.3, JANUARY 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.05...
  • Page 205: 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 206 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.