Download  Print this page

Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs

Advertisement

Table of Contents
Cisco TelePresence SX20 Codec
Contents
Introduction
Software version TC6.2
JULY 2013
Application Programmer Interface (API)
Reference Guide
Cisco TelePresence SX20 Codec
SX20 Codec API Reference Guide TC6.2, JULY 2013.
D14949.04
About the API
xConfiguration
1
xCommand
xStatus
Copyright © 2013 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices

Advertisement

Table of Contents
loading

  Summary of Contents for Cisco TelePresence SX20 Codec

  • Page 1 About the API xConfiguration xCommand xStatus Appendices Software version TC6.2 JULY 2013 Application Programmer Interface (API) Reference Guide Cisco TelePresence SX20 Codec SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 2: Table Of Contents

    Configurations ..............14 The SystemTools commands ..........182 Status ..................15 About disconnect cause types ...........184 Events ...................16 Call history ................17 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 3: July

    Cisco TelePresence SX20 Codec API Reference Guide Contents Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 4: About This Guide

    Regulatory compliance and safety information guides • Legal and license information for the TC software To download the user documentation go to: http://www.cisco.com/go/quickset-docs SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 5: What's New In This Version

    More details can be found in the Administering TC endpoints (TelePresence Management System) version 13.x or later is on CUCM guide for TC6.2. used. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 6: Xconfiguration Changes

    Active Control gives more control and improved experience xConfiguration SIP Profile Turn UserName: <S: 0, 128> for the end user during conferences hosted on a Cisco Web interface enhancements xConfiguration SIP Profile Turn Password: <S: 0, 128> TelePresence Server. Using your Cisco Touch controller, you •...
  • Page 7: Xcommand Changes

    NEW: <Off/Raw/H261/H263/H263p/H263pp/H264/MP4V/ xStatus Conference Site Hold Disconnecting/OnHold> JPEG/HEVC> NEW: <Idle/Dialling/Ringing/Connecting/Connected/ xStatus Conference Site Preserved Disconnecting/OnHold/EarlyMedia/Preserved/ xStatus ICE Configured RemotePreserved> xStatus ICE Defaultcandidate SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 8: About The Api

    Cisco TelePresence SX20 Codec API Reference Guide Contents Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 9: Api Fundamentals

    This is described in xCommand SystemUnit AdminPassword Set Password: ”Using HTTP” on page 20 in this document. <password> SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 10: Api Output

    To set ouput mode to XML, issue the command: <LayoutId>1</LayoutId> xPreferences outputmode xml </AssignCall> </Layout> </Video> To revert to terminal mode, issue the command: </Command> xPreferences outputmode terminal SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 11: Using The Command Line

    <CTRL-r>: Incremental command history search. returned. Refer to ”Feedback mechanism” on page session. Refer to ”Feedback mechanism” on page • <CTRL-w>: Erase the current line. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 12: Searching

    *? xConfiguration Video OSD InputMethod Cyrillic: <Off/On> XCOMMAND DIAL NUMBER: foo@bar.org *? xConfiguration Video OSD LoginRequired: <Off/On> xcommand dial number: foo@bar.org xCommand Dial Number: foo@bar.org SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 13: Commands

    PhonebookId: <S: 0, 255> PhonebookType: <Corporate/Local> SearchString: <S: 0, 255> SearchField: <Name/Number> Offset: <0..65534> FolderId: <S: 0, 255> Limit: <0..65534> Recursive: <False/True> SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 14: Configurations

    *? xConfiguration Video OSD Output: <1/2> *? xConfiguration Video OSD InputMethod InputLanguage: <Latin/Cyrillic> *? xConfiguration Video OSD InputMethod Cyrillic: <Off/On> *? xConfiguration Video OSD LoginRequired: <Off/On> SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 15: Status

    *s Call 3 FacilityServiceId: 0 *s Call 3 Encryption Type: “None” *s Call 3 PlacedOnHold: False *s Call 3 Duration: 9 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 16: Events

    1 Tilt: 0 TiltUp: 0 Zoom: 0 ZoomIn: 0 Focus: 0 FocusIn: 0 Timeout: 300 VideoSrc: 0 m: 0 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 17: Call History

    *h xHistory CallLogs Received 40 Counter: 6 *h xHistory CallLogs Missed 50 Counter: 2 *h xHistory CallLogs Missed 50 NewCounter: 0 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 18: Feedback Mechanism

    ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Source[@item=’2’]/Connector SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 19: Terminal Connections

    Write in: xFeedback deregister /Status/Audio ** end Result: D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 20: Using Http

    Content-Length: 91 Example 3: Changing multiple configurations in one go. Connection: close <?xml version=”1.0”?> http://<ip-address>/formputxml?xmldoc= <Command> <Configuration><Audio><Volume>80</Volume> <CameraPositionSetResult item=”1” status=”OK”/> </Audio><Video><OSD><TodaysBookings>On </Command> </TodaysBookings></OSD></video><Configuration> SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 21: 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 22: Translating From Terminal Mode To Xml

    Example 2: Assigning video layout to a call. </Configuration> Terminal 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 TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 23: Dos And Don'ts

    The on-screen- display in is using the exact same API as you have access to through the command interface. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 24: Xconfiguration Commands

    Cisco TelePresence SX20 Codec API Reference Guide Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 25: Description Of The Xconfiguration Commands

    FacilityService Service [1..5] Number ................37 xConfiguration Conference [1..1] AutoAnswer Mute ...................33 xConfiguration FacilityService Service [1..5] Type ..................37 xConfiguration Conference [1..1] CallProtocolIPStack ................32 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 26 NetworkServices SSH Mode .....................48 xConfiguration Network [1..1] IPv6 Gateway ....................41 xConfiguration NetworkServices Telnet Mode ..................49 xConfiguration Network [1..1] MTU ......................45 xConfiguration NetworkServices XMLAPI Mode ..................46 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 27 SIP Profile [1..1] Authentication [1..1] LoginName ...............55 UserInterface configuration ........................61 xConfiguration SIP Profile [1..1] Authentication [1..1] Password ..............55 xConfiguration UserInterface TouchPanel DefaultPanel ................61 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 28 Video WallPaper .........................72 xConfiguration Video OSD AutoSelectPresentationSource ...............70 Experimental configuration ........................73 xConfiguration Video OSD EncryptionIndicator ..................69 xConfiguration Video OSD InputMethod Cyrillic ..................71 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 29 Audio Input HDMI [1] Mode Value space: <Marbles/IceCrystals/Polaris/Alert/Discreet/Fantasy/Jazz/Nordic/Echo/Rhythmic> If you are connecting a Cisco camera with an integrated microphone to the codec’s HDMI 1 input, you can enable/disable audio input on the port; if you are using any other camera, the audio input Range: Select a tone from the list of ring tones.
  • Page 30 Manual: Enable manual control of the camera brightness. The brightness level is set using the Cameras Camera Brightness Level setting. Example: xConfiguration Cameras Camera 1 Brightness Mode: Auto SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 31 By setting the Gamma Level you can select which gamma correction table to use. This setting may be useful in difficult lighting conditions, where changes to the brightness setting does not provide This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. satisfactory results. NOTE: Requires the Gamma Mode to be set to Manual.
  • Page 32: Conference Configuration

    IPv4: When set to IPv4, the call protocol (SIP, H323) will use IPv4. Applies to cameras which support DHCP (for example the Cisco TelePresence PrecisionHD 1080p 12X camera). The camera must be connected to a LAN. When set, the command enables support IPv6: When set to IPv6, the call protocol (SIP, H323) will use IPv6.
  • Page 33 You will still be able to control your camera and select your video sources as normal. Example: xConfiguration Conference 1 FarEndControl Mode: On SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 34 H323: H323 ensures that calls are set up as H.323 calls. Sip: Sip ensures that calls are set up as SIP calls. H320: H320 ensures that calls are set up as H.320 calls (only applicable if connected to a Cisco TelePresence ISDN Link gateway).
  • Page 35 LocalOnly: The presentation will only be shown locally. Example: xConfiguration Conference 1 VideoBandwidth Mode: Dynamic Example: xConfiguration Conference 1 Presentation Policy: LocalRemote SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 36 (MCU). resolution for the presentation source. If registered to a Cisco Unified Communications Manager (CUCM) version 8.6.2 or newer, the video Requires user role: ADMIN system can use either the CUCM conference bridge, or the video system's own built-in MultiSite feature.
  • Page 37 Requires user role: ADMIN Value space: <S: 0, 255> Format: String with a maximum of 255 characters. Example: xConfiguration FacilityService Service 1 Name: "" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 38: H323 Configuration

    Example: xConfiguration H323 NAT Address: "" Value space: <S: 0, 50> Format: String with a maximum of 50 characters. Example: xConfiguration H323 Profile 1 Authentication Password: "" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 39 Static: When set to Static the ports are given within a static predefined range [5555-6555]. Example: xConfiguration H323 Profile 1 Gatekeeper Address: "192.0.2.0" Example: xConfiguration H323 Profile 1 PortAllocation: Dynamic SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 40: Network Configuration

    Value space: <S: 0, 64> Example: xConfiguration Network 1 IPv6 Assignment: Autoconf Format: A valid IPv4 address. Example: xConfiguration Network 1 IPv4 Address: "192.0.2.2" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 41 Network [1..1] DHCP RequestTFTPServerAddress Enter the static IPv6 network address for the system. This setting is only applicable when the This setting is used only for video systems that are registered to a Cisco Unified Communications Network IPv6 Assignment is set to Static.
  • Page 42 Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default Example: xConfiguration Network 1 QoS Diffserv Audio: 0 value is 0 (best effort). Example: xConfiguration Network 1 QoS Diffserv Data: 0 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 43 On: When set to On, the server-side X.509 certificate will be validated against the local CA-list for all TLS connections. Only servers with a valid certificate will be allowed. Example: xConfiguration xConfiguration Network 1 IEEE8021X TlsVerify: Off SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 44 Requires user role: ADMIN Value space: <S: 0, 64> Format: String with a maximum of 64 characters. Example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 45 Requires user role: ADMIN Value space: <Auto/Manual/Off> Value space: <Auto/10half/10full/100half/100full/1000full> Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. If CDP is Auto: Autonegotiate link speed. not available, VLAN is not enabled. 10half: Force link to 10 Mbps half-duplex.
  • Page 46 H323: The H323 protocol will be used for MultiWay calls. Sip: The SIP protocol will be used for MultiWay calls. Example: xConfiguration NetworkServices MultiWay Protocol: Auto SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 47 Format: A valid IPv4 address, IPv6 address or DNS name. Example: xConfiguration NetworkServices HTTPS OCSP Mode: Off Example: xConfiguration NetworkServices NTP Address: "1.ntp.tandberg.com" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 48 Requires user role: ADMIN to receive a response from the SNMP Agent in the codec. The default password is "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the same SNMP Value space: <Off/On> Community is configured there too. NOTE: The SNMP Community password is case sensitive.
  • Page 49 Example: xConfiguration NetworkServices Telnet Mode: Off xConfiguration NetworkServices CTMS Mode This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence Multipoint Switch (CTMS). Video systems running software TC5.0 or later are able to initiate or join non-encrypted multiparty conferences controlled by CTMS version 1.8 or later.
  • Page 50 Example: xConfiguration Provisioning Connectivity: Auto Value space: <VCS/TMS/Callway/CUCM> xConfiguration Provisioning Mode VCS: Select VCS if the phonebook is located on the Cisco TelePresence Video Communication Server. It is possible to configure a video system using a provisioning system (external manager). This allows video conferencing network administrators to manage many video systems simultaneously.
  • Page 51 Requires user role: ADMIN Value space: <S: 0, 255> Format: String with a maximum of 255 characters. Example: xConfiguration Provisioning ExternalManager Path: "tms/public/external/ management/SystemManagementService.asmx" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 52 Requires user role: ADMIN Value space: <1056..65535> Range: Select a value from 1056 to 65535. Example: xConfiguration RTP Ports Range Stop: 2486 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 53 Requires user role: AUDIT Value space: <0..65535> Range: Select a value from 0 to 65535. Example: xConfiguration Security Audit Server Port: 514 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 54: Sip Configuration

    Thus the shortest route for audio and video is always Requires user role: ADMIN secured between the endpoints. Value space: <Off/On> NOTE: ICE is not supported when registered to CUCM (Cisco Unified Communication Manager). Off: Disable the serial port. Requires user role: ADMIN On: Enable the serial port.
  • Page 55 Requires user role: ADMIN Value space: <S: 0, 255> Format: String with a maximum of 255 characters. Example: xConfiguration SIP Profile 1 DisplayName: "" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 56 The current version supports RFC 5626. Value space: <Standard/Alcatel/Avaya/Cisco/Microsoft/Nortel> Requires user role: ADMIN Standard: To be used when registering to standard SIP Proxy (tested with Cisco TelePresence VCS and Broadsoft) Value space: <Off/On> Alcatel: To be used when registering to Alcatel-Lucent OmniPCX Enterprise. NOTE: This mode is Off: Connect to the single proxy configured first in Proxy Address list.
  • Page 57 Standby configuration xConfiguration SIP Profile [1..1] Line When registered to a Cisco Unified Communications Manager (CUCM) the endpoint may be part of a shared line. This means that several devices share the same directory number. The different devices sharing the same number receive status from the other appearances on the line as defined xConfiguration Standby Control in RFC 4235.
  • Page 58 DefaultCameraPosition: When leaving standby the camera position will be set to the factory default Example: xConfiguration SystemUnit MenuLanguage: English position. Example: xConfiguration Standby WakeupAction: RestoreCameraPosition SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 59 Requires user role: ADMIN Value space: <Off/On> Off: Disable logging. On: Enable logging. Example: xConfiguration SystemUnit CallLogging Mode: On SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 60 Range: Select a time zone from the list time zones. If using a command line interface; watch up for typos. Example: xConfiguration Time Zone: "GMT (Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London)" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 61 USB: Select USB when you want to use the USB as input source 3. Example: xConfiguration Video Input Source 3 Connector: USB SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 62 Hidden: The input source is not expected to be used as a presentation source. Example: xConfiguration Video Input Source 1 PresentationSelection: Manual SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 63 Example: xConfiguration Video Input Source 1 OptimalDefinition Profile: Medium Range: Select the source to be used as the main video source. Example: xConfiguration Video MainVideoSource: 1 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 64 Limited: Limited Quantization Range. R, G, B quantization range that excludes some code values at the extremes (16 - 235). This is defined in CEA-861-E. Example: xConfiguration Video Input 1 DVI 2 RGBQuantizationRange: Full SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 65 Value space: <Off/On> Off: Do not display self view on screen. On: Display self view on screen. Example: xConfiguration Video Selfview: On SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 66 Current: When leaving the call, the self view picture will be kept on the same output as during the call. Example: xConfiguration Video SelfviewDefault OnMonitorRole: Current SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 67 LowerRight: The active speaker PiP will appear in the lower right corner of the screen. Example: xConfiguration Video PIP ActiveSpeaker DefaultValue Position: Current SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 68 DualPresentationOnly: All participants in the call will be shown on the first monitor, while the presentation (if any) will be shown on the second monitor. Example: xConfiguration Video Monitors: Single SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 69 AlwaysOff: The encryption indicator is never displayed on screen. This applies to both encrypted and non-encrypted calls for all Conference Encryption Mode settings. Example: xConfiguration Video OSD EncryptionIndicator: Auto SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 70 This setting can be used to display the system's bookings for today on the main OSD menu. This Requires user role: ADMIN requires that the system is bookable by an external booking system, like Cisco TelePresence Value space: <1/2> Management Suite (TMS).
  • Page 71 Off: Capturing web snapshots is not allowed. On: Web snapshots can be captured and displayed on the web interface. Example: xConfiguration Video AllowWebSnapshots: Off SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 72 Auto: The system will automatically try to set the optimal resolution based on negotiation with the connected monitor. Range: 1024x768@60p, 1280x1024@60p, 1280x720@60p, 1920x1080@60p, 1280x768@60p, 1360x768@60p, 1366x768@60p Example: xConfiguration Video Output HDMI 1 Resolution: Auto SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 73 Appendices Experimental configuration The Experimental settings are for testing only and should not be used unless agreed with Cisco. These settings are not documented and WILL change in later releases. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved.
  • Page 74: Xcommand Commands

    Cisco TelePresence SX20 Codec API Reference Guide Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 75: Description Of The Xcommand Commands

    Conference DoNotDisturb Deactivate ..................89 CallLog commands ..........................83 Dial commands ............................. 90 xCommand CallLog Clear...........................83 xCommand Dial ............................90 xCommand CallLog Missed Delete ......................84 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 76 SystemUnit ConfigurationProfile List ..................108 xCommand Phonebook ContactMethod Add ....................99 xCommand SystemUnit ConfigurationProfile Remove ................108 xCommand Phonebook ContactMethod Delete ..................100 xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs ...........108 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 77 Video PIP Presentation Set ....................111 xCommand Video PreviewFilmstrip Set ....................111 xCommand Video Selfview Set ........................ 111 Experimental commands ........................112 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 78 Play a specified audio sound. Requires user role: USER Parameters: Sound(r): <Busy/CallWaiting/Dial/KeyTone/Ringing/SpecialInfo/TelephoneCall/VideoCall> Loop: <On/Off> Example: xCommand Audio Sound Play Sound: Ringing *r AudioSoundPlayResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 79 *r Bookings Booking 1 Time EndTimeBuffer: 0 ** end *r Bookings Booking 1 MaximumMeetingExtension: 30 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed *r Bookings Booking 1 BookingStatus: OK SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 80 Requires user role: USER Parameters: Action: <Restart/Shutdown> Example: xCommand Boot *r BootResult (status=OK): ** end CUIL reboot request, restarting Connection closed by foreign host. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 81: Call Commands

    Call Reject CallId:20 Parameters: *r CallRejectResult (status=OK): CallId(r): <0..65534> ** end Reason(o): <Conference/Transfer/Other> Example: xCommand Call Hold CallId:19 *r CallHoldResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 82 ** end Parameters: CallId(r): <0..65534> Number(r): <S: 0, 255> Example: xCommand Call UnattendedTransfer CallId: 2 Number: destination@example. *r TransferUriResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 83 CallId(r): <0..65534> ** end CallType(r): <Audio/Video> Example: xCommand Call Modify CallType: Audio CallId: 16 *r CallModifyResult (status=Error): Reason: Callescalation not enabled ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 84 CallLog Missed command. Requires user role: USER Parameters: LogTag: <0..2147483647> Example: xCommand CallLog Missed Delete LogTag:119 *r DeleteResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 85 Reset the camera position the the default position. Requires user role: USER Parameters: CameraId(r): <1..1> Example: xCommand Camera PositionReset CameraId:1 *r CameraPositionResetResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 86 Example: xCommand Camera Ramp CameraId:1 Pan:left PanSpeed:1 *r RampResult (status=OK): ** end xCommand Camera Ramp CameraId:1 Pan:stop *r RampResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 87 ListPosition: <1..35> Name: <S: 0, 255> Example: xCommand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: "" *r CameraPresetEditResult (status=OK) ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 88 Requires user role: USER *r CameraPresetStoreResult (status=OK) Parameters: ** end PresetId(r): <1..35> Example: xCommand Camera Preset Remove PresetId: 1 *r CameraPresetRemoveResult (status=OK) ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 89 Resets ActiveSpeaker. Normal voice switching is switched back on. Requires user role: USER Example: xCommand Conference ActiveSpeaker Reset *r ConferenceActiveSpeakerResetResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 90 CallType: <Audio/Video> BookingId: <S: 0, 255> Appearance(o): <1..999999999> Example: xCommand Dial Number:543210 Protocol:h323 *r DialResult (status=OK): CallId: 2 ConferenceId: 1 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 91 Call command to see the CallId. Requires user role: USER Parameters: CallId: <0..65534> Example: xCommand FarEndControl Camera Stop CallId:3 *r FECCMoveResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 92 SourceId: Select a video input source on the far end. Requires user role: USER Parameters: CallId: <0..65534> SourceId(r): <0..15> Example: xCommand FarEndControl Source Select CallId:3 SourceId:1 *r FECCSelectSourceResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 93 Requires user role: USER *r KeyPressResult (status=OK): ** end Parameters: FeedbackSlot(r): <1..4> Example: xCommand HttpFeedback Deregister FeedbackSlot:1 *r FeedbackDeregisterResult (status=OK): FeedbackSlot: 1 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 94 This is required when the Duration parameter is not set. Requires user role: ADMIN Example: xCommand Message Alert Clear *r MessageAlertClearResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 95 Clears the text line which was defined by the xCommand Message TextLine Display command. minutes" Requires user role: ADMIN Example: *r MessagePromptDisplayResult (status=OK): xCommand Message TextLine Clear ** end *r MessageTextLineClearResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 96 Message Prompt Response OptionId: 1 *r FarendMessageResult (status=Error): Reason: Generic Message mode not enabled *r MessagePromptResponseResult (status=OK): ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 97 Requires user role: ADMIN Parameters: FolderId(r): <S: 0, 255> Example: xCommand Phonebook Folder Delete FolderId:localGroupId-3 *r PhonebookFolderDeleteResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 98 You can add several contact methods to a contact using the xCommand Phonebook ContactMethod Protocol, CallRate, CallType and Device. Add command. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in the API, on the web interface ContactId: The unique identifier for the contact you want to modify.
  • Page 99 You can add several contact methods to a contact. Note that only the first contact method will appear command was issued to make the contact. in the Favorites list on the Cisco TelePresence Touch controller. The first contact method may have been created when issuing the xCommand Phonebook Contact Add command to make the contact. All Requires user role: ADMIN contact methods are available in the API, on the web interface and when using the remote control.
  • Page 100 ** end Device: <Mobile/Other/Telephone/Video> Number: <S: 0, 255> Protocol: <Auto, H320/H323/SIP> CallRate: <0..6000> CallType: <Audio/Video> Example: xCommand Phonebook ContactMethod Modify ContactMethodId:117 ContactId:localContactId-10 Number:"newnumber@cisco.com" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 101 *r ResultSet Contact 1 ContactMethod 1 ContactMethodId: "1" The search command lets you search in both the local and corporate phone books. A search gives a ResultSet. More examples can be found on the Cisco Developer Network at http://developer.cisco. *r ResultSet Contact 1 ContactMethod 1 Number: "H323:John.Doe.Office@ com/web/telepresence-developer/howtos/cseries-api/phonebook.
  • Page 102 PresetId: The ID of the preset you want to activate. Requires user role: USER Parameters: PresetId(r): <1..15> Example: xCommand Preset Activate PresetId:3 *r PresetActivateResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 103 Postpones the installing of the software upgrade. Requires user role: ADMIN Parameters: SecondsToPostpone(r): <0..65534> Example: xCommand Provisioning PostponeUpgrade SecondsToPostpone: 60 *r PostponeUpgradeResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 104 Security FIPSMode Activate Confirm: "Yes" Requires user role: USER *r SecurityFIPSModeActivateConfirmResult (status=OK) Example: ** end xCommand Provisioning CUCM CTL Delete *r DeleteResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 105 Key(r): <S: 16, 24> Example: Example: xCommand Standby ResetTimer Delay:10 xCommand SystemUnit ReleaseKey Add Key:****************** *r ResetResult (status=OK): *r ReleaseKeyResult (status=OK): ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 106 Removes all Release keys. Set a menu password to restrict access to Administrator Settings menu. If you have a remote control the password can also be set from the on screen menu. If you have a Cisco TelePresence Requires user role: ADMIN Touch controller the menu password is set from the command line interface.
  • Page 107 Hour: 12 address>/s52000tc4 _ 0 _ 0.pkg" UserName: testDownload Password: 1234 Minute: 0 *r SystemUnitSoftwareUpgradeResult (status=OK): Second: 0 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 108 ** end Parameters: Name(r): <S: 0, 255> Example: xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs Name: "My _ ConfigurationProfile _ 1" *r ConfigurationProfileSaveCurrentConfigurationResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 109: Video Commands

    Minimized when you want the presentation to be displayed in a small picture on screen. Requires user role: ADMIN Parameters: View(r): <Default/Maximized/Minimized> Example: xCommand Video Layout SetPresentationView View:Default *r VideoLayoutSetPresentationViewResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 110 UpperRight: The ActiveSpeaker PiP appears in the upper right corner of the screen. Requires user role: ADMIN Parameters: Position(r): <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight> Example: xCommand Video PIP ActiveSpeaker Set Position: UpperRight *r ActiveSpeakerPipSetResult (status=OK): ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 111 Video Selfview Set FullscreenMode: On OnMonitorRole: Second xCommand Video PreviewFilmstrip Set Position: LowerCenter *r PreviewFilmstripSetResult (status=OK): *r SelfviewSetResult (status=OK): ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 112 Appendices Experimental commands The Experimental commands are for testing only and should not be used unless agreed with Cisco. These commands are not documented and WILL change in later releases. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved.
  • Page 113: Xstatus Commands

    Cisco TelePresence SX20 Codec API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 114: Description Of The Xstatus Commands

    Conference Presentation Mode ....................126 xStatus Camera ............................124 xStatus Conference Presentation Protocol ....................126 xStatus Camera [1..1] Capabilities Options ....................125 xStatus Conference Presentation Resolution Height ................126 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 115 Diagnostics Call [1..n] Channels IncomingDataChannel [1..n] Netstat 1 Drop ......134 xStatus Diagnostics Call [1..n] Channels OutgoingVideoChannel [1..n] Netstat 1 LastIntervalLost ..133 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 116 MediaChannels Call [1..n] OutgoingAudioChannel [1..n] Transport RTP Local IpAddress ...145 xStatus MediaChannels Call [1..n] OutgoingAudioChannel [1..n] Transport RTP Local Port ....145 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 117 Provisioning Software UpgradeStatus Message ................156 xStatus Network CDP Capabilities ......................152 xStatus Provisioning Software UpgradeStatus Phase ................156 xStatus Network CDP DeviceId ........................152 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 118 SystemUnit State MaxNumberOfActiveCalls ................167 Standby status ............................ 163 xStatus SystemUnit State MaxNumberOfCalls ..................167 xStatus Standby Active ..........................163 xStatus SystemUnit State NumberOfActiveCalls ..................167 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 119 Video Layout Mode ........................173 Experimental status ..........................177 xStatus Video Layout PresentationView ....................173 xStatus Video Layout Site [1..n] Output [1..2] FamilyName ...............173 SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 120: Audio Status

    Value space of the result returned: <0..65534> Example: xStatus Audio Input RemoteInput 8 CallId *s Audio Input RemoteInput 8 CallId: 28 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 121: Call Status

    ** end Value space of the result returned: <H323/SIP> Example: xStatus Call 27 Protocol *s Call 27 Protocol: "h323" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 122: Xstatus Call [1

    Call 27 PlacedOnHold xStatus Call 27 ReceiveCallRate *s Call 27 PlacedOnHold: False *s Call 27 ReceiveCallRate: 4000 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 123: Xstatus Call [1

    Call [1..n] DeviceType Shows the duration of a call (in seconds). You can run the command xStatus Call to find the call Indicates whether the remote system is a single endpoint or a MCU. Some Cisco endpoints (EX90, identity.
  • Page 124: Xstatus Camera [1

    Value space of the result returned: *s Camera 1 Manufacturer: "TANDBERG" <String> ** end Example: xStatus Camera 1 IpAddress *s Camera 1 IpAddress: "" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 125: Xstatus Camera [1

    In Flip mode (vertical flip) the image can be flipped upside down. Value space of the result returned: <"Auto"/"On"/"Off"> Example: xStatus Camera 1 Flip *s Camera 1 Flip: "Off" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 126: Conference Status

    Value space of the result returned: *s Conference Presentation Resolution Height: 0 <Off/LocalRemote/LocalOnly> ** end Example: xStatus Conference Presentation LocalSendingMode *s Conference Presentation LocalSendingMode: Off ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 127: Xstatus Conference Presentation Lastlocalsource

    Example: xStatus Conference Site 2 Capabilities FECC Source 1 SourceId *s Conference Site 2 Capabilities FECC Source 1 SourceId: 6 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 128 Conference Site [1..n] Capabilities Presentation xStatus Conference Site [1..n] BlackScreenCause Lists the presentation capabilities for other participants in the conference. Shows the reason why the screen is black while in a CTMS (Cisco TelePresence Multipoint Switch) managed conference. Value space of the result returned: FirstParticipant: You are the first and only participant in the meeting.
  • Page 129 Conference Site UnattendedTransfer Example: *s Conference Site 14 UnattendedTransfer: True xStatus Conference Site CalText ** end *s Conference Site 14 CalText: "" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 130: Xstatus Conference Line [1

    Value space of the result returned: <Idle/Private/Trying/Progressing/Alerting/Active/Held/HeldPrivate/Unknown> Example: xStatus Conference Line 1 Appearance Status *s Conference Line 1 Appearance 5464 Status: Held ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 131: Xstatus Conference Activespeaker Mode

    Conference ActiveSpeaker SiteId *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter: *s Conference ActiveSpeaker SiteId: 0 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 132: Xstatus Diagnostics Call [1

    *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets: *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Loss: 96 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 133 *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost: 0 LastIntervalReceived: 84 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 134 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Drop: 0 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes: 129920 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 135: Xstatus Diagnostics Call [1..N] Channels Incomingdatachannel [1..N] Netstat 1 Maxjitter

    *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate MaxJitter: 0 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ** end ChannelRate: 128000 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 136: H320 Status

    H320 Gateway Id Example: *s H320 Gateway Id: "00:50:60:0B:EF:11" xStatus H320 Gateway Number ** end *s H320 Gateway Number: "" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 137: H323 Status

    Shows the port which is used when connecting to on the gatekeeper. Value space of the result returned: <Integer> Example: xStatus H323 Gatekeeper Port *s H323 Gatekeeper Port: 1719 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 138: Httpfeedback Status

    Returns the IP address of the TURN server that is currently in use. Value space of the result returned: <String> Example: xStatus ICE Turn IP *s ICE Turn IP: "192.0.1.20" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 139: Xstatus Ice Call Local Candidate

    Value space of the result returned: <HOST/PRFLX/SRFLX/RELAY> Example: xStatus ICE Call Remote Candidate *s ICE Call 1 Remote Candidate: “SRFLX” ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 140: Xstatus Ice Call Remote Ip

    Value space of the result returned: <AACLD/G722/G7221/G711Mu/G711A/G729/G729AB> Example: xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol *s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol: AACLD ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 141 MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port: 50932 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 142 MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress: "192.168.136.130" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 143 *s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768 Local Port ** end *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port: 16404 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 144 *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote IpAddress: "192.168.24.190" Port: 50933 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 145: Xstatus Mediachannels Call [1

    *s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1 Remote IpAddress ** end *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress: "192.168.136.130" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 146: Xstatus Mediachannels Call [1

    MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP ** end Local Port *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port: 16405 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 147: Xstatus Mediachannels Call [1

    MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate IpAddress: "192.168.24.190" *s MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate: 30 ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 148: Xstatus Mediachannels Call [1

    *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote Port: 50932 IpAddress: "192.168.136.130" ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 149: Xstatus Mediachannels Call [1

    Shows the IPv4 address that uniquely identifies this system. Value space of the result returned: <String> Example: xStatus Network 1 IPv4 Address *s Network 1 IPv4 Address: "192.0.2.149" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 150: Xstatus Network 1 Ipv4 Dhcp Provisioningserver

    ** end <String> Example: xStatus Network 1 IPv4 DNS Server 1. Address *s Network 1 IPv4 DNS Server 1 Address: "192.0.2.60" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 151: Xstatus Network Vlan Native Vlanid

    Value space of the result returned: <String> Example: xStatus Network VLAN Native VlanId *s Network 1 VLAN Native VlanId: "200" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 152: Xstatus Network Cdp Duplex

    Example: Example: xStatus Network CDP Version xStatus Network CDP PortID *s Network 1 CDP Version: "Cisco IOS Software, C3750E Software (C3750E- *s Network 1 CDP PortID: "GigabitEthernet1/0/23" UNIVERSALK9-M), Version 15.0(1)SE2, RELEASE SOFTWARE (fc3)*Technical ** end Support: http://www.cisco.com/techsupport*Copyright (c) 1986-2011 by Cisco Systems, Inc.*Compiled Thu 22-Dec-11 00:05 by prod _ rel _ team"...
  • Page 153: Xstatus Network Cdp Primarymgmtaddress

    Returns the SysObjectID as configured in the switch the endpoint is connected to. Value space of the result returned: <String> Example: xStatus Network CDP SysObjectID *s Network 1 CDP SysObjectID: "" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 154: Networkservices Status

    Lists the configured name for the specific preset. Value space of the result returned: <String> Example: xStatus Preset 1 Description *s Preset 1 Description: "Zoom in" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 155: Provisioning Status

    Shows the status of the software upgrade. Value space of the result returned: <None/InProgress/Failed/InstallationFailed/Succeeded> Example: xStatus Provisioning Software UpgradeStatus Status *s Provisioning Software UpgradeStatus Status: None ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 156: Xstatus Provisioning Software Current Url

    Value space of the result returned: <String> Example: xStatus Provisioning Software UpgradeStatus URL *s Provisioning Software UpgradeStatus URL: "http:// .../s52000tc5 _ 1 _ 0.pkg" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 157: Xstatus Provisioning Cucm Capf Lsc

    *s Provisioning CUCM CAPF OperationState: NonPending Example: ** end xStatus Provisioning CUCM CAPF ServerName *s Provisioning CUCM CAPF ServerName: "192.168.0.1" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 158: Xstatus Provisioning Cucm Capf Operationresult

    CAPFLSCUpdated: Locally Significant Certificate (LSC) has been updated. CAPF operation has succeeded. Value space of the result returned: <NotSet/CAPFUnknown/CAPFInvalidAuthStrLen/CAPFInvalidInitReason/CAPFInvalidAuthMode/ CAPFNotNone/CAPFNullClnt/CAPFNullClntcontext/CAPFInvalidUsageStartSession/ CAPFNullSessiondata/CAPFInvalidSession/CAPFNullParameters/CAPFNoStat/CAPFTimeout/ CAPFConnLost/CAPFAbort/CAPFKeyGenFailed/CAPFConnectFailed/CAPFFenceError/ CAPFServerBusy/CAPFAuthRejected/CAPFInvalidParms/CAPFCancelled/CAPFFailed/ CAPFSuccess/CAPFLSCUpdated> Example: xStatus Provisioning CUCM CAPF OperationResult SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 159: Security Status

    Shows the address of the SIP Proxy that the system communicates with. Value space of the result returned: <String> Example: xStatus SIP Proxy 1 Address *s SIP Proxy 1 Address: "192.0.2.50" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 160: Xstatus Sip Proxy [1] Secure

    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 CUCM. *s SIP Registration 1 Status: Registered True: The server’s SIP certificate is checked against the trusted CA-list on the codec and found...
  • Page 161: Xstatus Sip Profile 1 Authentication

    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 CUCM. True: The server’s SIP certificate is checked against the trusted CA-list on the codec and found xStatus SIP Profile 1 Proxy [1] Status valid.
  • Page 162: Xstatus Sip Profile 1 Callforward Displayname

    Not in use in this release. *s SIP Profile 1 CallForward DisplayName: "" Value space of the result returned: ** end <String> SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 163: Xstatus Sip Profile 1 Directoryuri Primary Uri

    Value space of the result returned: <String> Example: xStatus SIP Profile DirectoryURI Primary URI *s SIP Profile 1 DirectoryURI Primary URI: "123456@company.com" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 164: Systemunit Status

    Value space of the result returned: *s SystemUnit ProductPlatform: "C90" <String> ** end Example: xStatus SystemUnit Software Name *s SystemUnit Software Name: "s52010" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 165: Xstatus Systemunit Software Maxaudiocalls

    SystemUnit Software ReleaseKey xStatus SystemUnit Software OptionKeys HighDefinition *s SystemUnit Software ReleaseKey: "true" *s SystemUnit Software OptionKeys HighDefinition: "true" ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 166: Xstatus Systemunit Hardware Bootsoftware

    SystemUnit Hardware Monitoring Fan 1 Status *s SystemUnit Hardware MainBoard SerialNumber: "PH0999989" *s SystemUnit Hardware Monitoring Fan 1 Status: "locked on 1096 rpm" ** end ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 167: Xstatus Systemunit Hardware Temperature

    Value space of the result returned: *s SystemUnit State System: Initialized <0..5> ** end Example: xStatus SystemUnit State NumberOfSuspendedCalls *s SystemUnit State NumberOfSuspendedCalls: 0 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 168: Xstatus Systemunit Contactinfo

    *s SystemUnit Notifications Notification 1 Text: "OK" xStatus SystemUnit ContactName: "192.0.2.0" Example 2: Registered on SIP ** end xStatus SystemUnit ContactName: "1234@192.0.2.0" SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 169: Xstatus Systemunit Diagnostics Lastrun

    Value space of the result returned: <Error/Warning/Critical> Example: xStatus SystemUnit Diagnostics Message Level *r Status (status=Error): Reason: No match on address expression XPath: Status/SystemUnit/Diagnostics/Message/Level ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 170: Time Status

    Value space of the result returned: <0..4000> Example: xStatus Video Input Source 1 Resolution Width *s Video Input Source 1 Resolution Width: 1920 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 171: Xstatus Video Input Hdmi [1] Connected

    *s Video Input Source 1 Resolution FormatStatus: Ok <Unknown/OK/Unsupported> ** end Example: xStatus Video Input HDMI 1 SignalState *s Video Input HDMI 1 SignalState: OK ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 172: Xstatus Video Input Dvi [2] Connected

    *s Video Input USB 3 Connected: False ** end Example: xStatus Video Output HDMI 1 Resolution Width *s Video Output HDMI 1 Resolution Width: 1280 ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 173: Xstatus Video Layout Site [1

    Indicates type of layout currently used by the codec, custom or default. ** end Value space of the result returned: <Default/Custom> Example: xStatus Video Layout Mode *s Video Layout Mode: Default ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 174: Xstatus Video Layout Site [1

    Video Layout Site 1 Output 1 Frame 1 VideoSourceType *s Video Layout Site 1 Output 1 Frame 1 VideoSourceType: "graphic" ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 175: Xstatus Video Layout Site [1

    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 TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 176: Xstatus Video Pip Activespeaker Position

    Shows the position of the active speaker’s image on the screen. Value space of the result returned: <UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight> Example: xStatus Video PIP ActiveSpeaker Position *s Video PIP ActiveSpeaker Position: UpperCenter ** end SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 177: Experimental Status

    Appendices Experimental status The Experimental status is for testing only and should not be used unless agreed with Cisco. These settings are not documented and WILL change in later releases. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved.
  • Page 178: Appendices

    Cisco TelePresence SX20 Codec API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 179: Startup Script

    The file can have any name as long as it is placed in this directory. • For multiple commands you must use Unix end of line (LF). Windows end of line does not work. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 180: Cisco Telepresence Remote Control

    Short range (1 m): Move the DIP switch down. or: Press any key on the remote control. • Longer range: Move the DIP switch up. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 181: Remote Control Key Map

    Button codes - Remote control 5 Button codes - Remote control 5 Address Button name Address Button name The Cisco TelePresence Remote Control 5 has the following button codes and IR signal parameters. Arrow left Number 1 Arrow right Number 2...
  • Page 182: The Systemtools Commands

    [comment] | delete <id> | list | clear> Shows the content of a license file, define by the name. name(r): The name of the license file. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 183 Minimum time between PIN renewals (hours) [0]? systemtools securitystatus • The user can only change PIN once within this limit. Shows the security status for the codec. SX20 Codec API Reference Guide TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 184: 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 TC6.2, JULY 2013. Copyright © 2013 Cisco Systems, Inc. All rights reserved. D14949.04...
  • Page 185 INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system.