Cisco TelePresence SX20 Codec Reference Manual
  1. Manuals
  2. Brands
  3. Cisco Manuals
  4. Conference System
  5. TelePresence SX20
  6. Reference manual

Cisco TelePresence SX20 Codec Reference Manual

Software version tc7.0
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Quick Links

See also: Troubleshooting Manual , Reference Manual
Cisco TelePresence SX20 Codec
Contents
Introduction
Software version TC7.0
JANUARY 2014
Application Programmer Interface (API)
Reference Guide
Cisco TelePresence SX20 Codec
SX20 Codec API Reference Guide TC7.0, JANUARY 2014.
D14949.08
About the API
xConfiguration
1
xCommand
xStatus
Copyright © 2014 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices
Table of Contents
loading

Related Manuals for Cisco TelePresence SX20 Codec

Summary of Contents for Cisco TelePresence SX20 Codec

  • Page 1 About the API xConfiguration xCommand xStatus Appendices Software version TC7.0 JANUARY 2014 Application Programmer Interface (API) Reference Guide Cisco TelePresence SX20 Codec SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 2: Table Of Contents

    Configurations ..............13 The SystemTools commands ..........195 Status ..................14 About disconnect cause types ........... 197 Events ................... 15 Call history ................16 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 3: January

    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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 5: What's New In This Version

    You can also detect if packets are lost (dropped or in error). This can help to identify network problems that may cause issues in calls. SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 6: System Configuration Changes

    Video Input Source[n] PresentationSelection EthernetDuplexMatches/IPv4Assignment/ OLD:

  • Page 7: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 8: Api Fundamentals

    This is described in xCommand SystemUnit AdminPassword Set Password: ”Using HTTP” on page 19 in this document. SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 9: Api Output

    To set ouput mode to XML, issue the command: 1 xPreferences outputmode xml To revert to terminal mode, issue the command: xPreferences outputmode terminal SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 10: Using The Command Line

    : Incremental command history search. returned. Refer to ”Feedback mechanism” on page session. Refer to ”Feedback mechanism” on page • : Erase the current line. SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 11: Searching

    *? xConfiguration Video Output HDMI[2] CEC Mode: work. *? xConfiguration Video Output HDMI[2] MonitorRole: XCOMMAND DIAL NUMBER: [email protected] xcommand dial number: [email protected] xCommand Dial Number: [email protected] SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 12: Commands

    PhonebookId: PhonebookType: SearchString: SearchField: ContactType: Offset: <0..65534> FolderId: Limit: <0..65534> Recursive: SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 13: Configurations

    *? xConfiguration Video Output HDMI[2] OverscanLevel: *? xConfiguration Video Output HDMI[2] CEC Mode: *? xConfiguration Video Output HDMI[2] MonitorRole: SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 14: Status

    *s Call 10 Duration: 123 *s Call 10 AnswerState: Answered *s Call 10 ModifyState: Idle *s Call 10 DeviceType: Endpoint ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 15: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 16: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 17: Feedback Mechanism

    Video Input Source 2 Connector sluggish or unpredictable behavior. *c xConfiguration Video Input Source 2 Connector: ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Source[@item=’2’]/Connector SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 18: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 19: Using Http

    Content-Length: 91 Example 3: Changing multiple configurations in one go. Connection: close http:///formputxml?xmldoc= SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 20: 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 21: Translating From Terminal Mode To Xml

    Example 2: Assigning video layout to a call. Terminal xCommand Video Layout AssignCall CallId: 2 LayoutId: 1 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 22: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 23: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 24: Description Of The Xconfiguration Commands

    Conference [1..1] Multipoint Mode ..................36 xConfiguration Cameras Camera [1] Whitebalance Level ................32 xConfiguration Conference [1..1] IncomingMultisiteCall Mode ..............37 xConfiguration Cameras Camera [1] DHCP ....................32 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 25 Network [1..1] QoS Mode ....................43 xConfiguration NetworkServices HTTPS OCSP URL ................49 xConfiguration Network [1..1] QoS Diffserv Audio ..................43 xConfiguration NetworkServices NTP Mode .....................49 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 26 Security Audit Server Address ..................54 xConfiguration SIP Profile [1..1] Line ......................59 xConfiguration Security Audit Server Port ....................54 xConfiguration Security Audit Server PortAssignment ................54 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 27 Video Input Source [1..3] Type ...................65 xConfiguration Video OSD Output ......................73 xConfiguration Video Input Source [1..3] PresentationSelection ...............65 xConfiguration Video OSD InputMethod InputLanguage ................73 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 28 Video WallPaper .........................75 xConfiguration Video Output HDMI [1,2] CEC Mode .................. 74 Experimental configuration ........................75 xConfiguration Video Output HDMI [1,2] MonitorRole ................74 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 29 Audio Input HDMI [1] Mode Requires user role: ADMIN If you are connecting a Cisco camera with an integrated microphone to the codec’s HDMI 1 input, Value space: you can enable/disable audio input on the port; if you are using any other camera, the audio input will be disabled regardless of this setting.
  • Page 30 Requires user role: ADMIN Value space: <1..31> Range: Select a value from 1 to 31. Example: xConfiguration Cameras Camera 1 Brightness Level: 1 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 31 Applies to cameras which support gamma mode. Gamma describes the nonlinear relationship Value space: between image pixels and monitor brightness. The Cisco TelePresence PrecisionHD 720p camera Auto: When the camera is placed upside down the image is automatically mirrored. Use this supports gamma mode.
  • Page 32 Cameras Camera [1] MotorMoveDetection xConfiguration Cameras Camera [1] DHCP This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. Applies to cameras which support DHCP over LAN. When set, the command enables support for software upgrade of daisy chained cameras.

  • Page 33: Conference Configuration

    On: The incoming call will be muted when automatically answered. Example: xConfiguration Conference 1 DoNotDisturb Mode: Timed Example: xConfiguration Conference 1 AutoAnswer Mute: Off SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 34 Sip: Sip ensures that calls are set up as SIP calls. Requires user role: ADMIN H320: H320 ensures that calls are set up as H.320 calls (only applicable if connected to a Cisco Value space: TelePresence ISDN Link gateway).
  • Page 35 Range: Select a value between 64 and 10000. Value space: <1..10> Example: xConfiguration Conference 1 MaxTotalTransmitCallRate: 10000 Range: 1 to 10. Example: xConfiguration Conference 1 VideoBandwidth MainChannel Weight: 5 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 36 (MCU). LocalOnly: The presentation will only be shown locally. If registered to a Cisco Unified Communications Manager (CUCM) version 8.6.2 or newer, the video system can use either the CUCM conference bridge, or the video system's own built-in MultiSite Example: xConfiguration Conference 1 Presentation Policy: LocalRemote feature.
  • Page 37 Requires user role: ADMIN Value space: Format: String with a maximum of 255 characters. Example: xConfiguration FacilityService Service 1 Name: "" SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 38: H323 Configuration

    Requires user role: ADMIN Value space: Format: A valid IPv4 address or IPv6 address. Example: xConfiguration H323 NAT Address: "" SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 39 Format: String with a maximum of 50 characters. Example: xConfiguration H323 Profile 1 Gatekeeper Address: "192.0.2.0" Example: xConfiguration H323 Profile 1 Authentication Password: "" SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 40 Static: When set to Static the ports are given within a static predefined range [5555-6555]. Example: xConfiguration H323 Profile 1 PortAllocation: Dynamic SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 41: Network Configuration

    Format: A valid IPv4 address. determines which method to use. Example: xConfiguration Network 1 IPv4 Address: "192.0.2.2" Example: xConfiguration Network 1 IPv6 Assignment: Autoconf SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 42 Format: A valid IPv6 address. be set manually using the Provisioning ExternalManager Address setting. If the Network VLAN Voice Mode setting is Auto and the Cisco Discovery Protocol (CDP) assigns an Example: xConfiguration Network 1 IPv6 Address: "2001:0DB8:0000:0000:0000:0000:0000:000 ID to the voice VLAN, then a request for option 150 will always be sent. That is, the Network DHCP 2"...
  • Page 43 0 (best effort). value is 0 (best effort). Example: xConfiguration Network 1 QoS Diffserv Audio: 0 Example: xConfiguration Network 1 QoS Diffserv Data: 0 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 44 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 Network 1 IEEE8021X TlsVerify: Off SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 45 Requires user role: ADMIN Value space: Format: String with a maximum of 64 characters. Example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 46 Value space: 10half: Force link to 10 Mbps half-duplex. Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. If CDP is 10full: Force link to 10 Mbps full-duplex. not available, VLAN is not enabled.
  • Page 47 Example: xConfiguration NetworkServices XMLAPI Mode: On On: Enable the possibility to place and receive SIP calls (default). Example: xConfiguration NetworkServices SIP Mode: On SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 48 Example: xConfiguration NetworkServices HTTPS OCSP Mode: Off Off: The HTTPS protocol is disabled. On: The HTTPS protocol is enabled. Example: xConfiguration NetworkServices HTTPS Mode: On SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 49 Enter the NTP Address to define the network time protocol server address. This address will be you have the Cisco TelePresence Management Suite (TMS) you must make sure the same SNMP used if NTP Mode is set to Manual, or if set to Auto and no address is supplied by a DHCP server.
  • Page 50 NetworkServices SNMP SystemContact xConfiguration NetworkServices CTMS Mode Enter the name of the Network Services SNMP System Contact. This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence Multipoint Switch (CTMS). Requires user role: ADMIN Video systems running software TC5.0 or later are able to initiate or join non-encrypted multiparty...
  • Page 51 Example: xConfiguration Provisioning Connectivity: Auto Value space: 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 52 Provisioning ExternalManager AlternateAddress Value space: Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager Format: String with a maximum of 64 characters. (CUCM) and an alternate CUCM is available for redundancy. Enter the address of the alternate CUCM.
  • Page 53 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 54 Example: xConfiguration Security Audit Server PortAssignment: Auto connection is restored it will again send its audit logs to the syslog server. Example: xConfiguration Security Audit OnError Action: Ignore SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 55 Off: The user can access the codec via the serial port without any login. On: Login is required when connecting to the codec via the serial port. Example: xConfiguration SerialPort LoginRequired: On SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 56: Sip Configuration

    Thus the shortest route for audio and video is always Requires user role: ADMIN secured between the endpoints. NOTE: ICE is not supported when registered to CUCM (Cisco Value space: Unified Communication Manager).
  • Page 57 Format: String with maximum 255 characters and compliant with the SIP URI syntax. network. Example: xConfiguration SIP Profile 1 URI: "sip:[email protected]" Example: xConfiguration SIP Profile Turn DropRflx: Off SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 58 Auto: The system will try to connect using transport protocols in the following order: TLS, TCP, UDP. Example: xConfiguration SIP Profile 1 DefaultTransport: Auto SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 59 SIP Profile [1..1] Line Select if the SIP Proxy address is to be obtained manually or by using Dynamic Host Configuration When registered to a Cisco Unified Communications Manager (CUCM) the endpoint may be part Protocol (DHCP). of a shared line. This means that several devices share the same directory number. The different...
  • Page 60 DefaultCameraPosition: After a reboot the camera position will be set to the factory default position. Example: xConfiguration Standby BootAction: DefaultCameraPosition SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 61 Example: xConfiguration SystemUnit CallLogging Mode: On Off: Disable the IR sensor on the codec. On: Enable the IR sensor on the codec. Example: xConfiguration SystemUnit IrSensor: Auto SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 62 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 63 Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. Example: xConfiguration Video CamCtrlPip CallSetup Duration: 10 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 64 Requires user role: ADMIN Value space: Format: String with a maximum of 50 characters. Example: xConfiguration Video Input Source 1 Name: "" SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 65 Example: xConfiguration Video Input Source 1 Visibility: IfSignal Example: xConfiguration Video Input Source 1 Type: PC SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 66 Rather high resolutions will be used. Example: xConfiguration Video Input Source 1 OptimalDefinition Profile: Medium SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 67 DisabledPIPs: The built-in layout engine does not display any PIP frame in the layout on the local detailed images and graphics. output. Example: xConfiguration Video Layout Engine LocalMode: Enabled Example: xConfiguration Video Input Source 1 Quality: Motion SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 68 Maximized: The presentation starts up in full screen mode. Example: xConfiguration Video Layout Scaling: On Example: xConfiguration Video Layout PresentationDefault View: Default SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 69 LowerRight: The presentation PiP will appear in the lower right corner of the screen. Example: xConfiguration Video PIP Presentation DefaultValue Position: Current SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 70 On: self-view is switched on when leaving a call. Example: xConfiguration Video SelfviewDefault Mode: Current SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 71 Off: Hide the on-screen menus, icons and indicators. Example: xConfiguration Video OSD MenyStartUpMode: Home On: Display the on-screen menus, icons and indicators. Example: xConfiguration Video OSD Mode: On SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 72 Off: The call settings will be available from within the Conference settings in the Administrator Settings. On: The Call Settings menu will be available from the Settings menu. Example: xConfiguration Video OSD CallSettingsSelection: Off SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 73 The codec can be enabled for Cyrillic input characters in the menus on screen. Requires that Video This requires that the system is bookable by an external booking system, like for example the Cisco OSD InputMethod Cyrillic is set to On.
  • Page 74 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 75 Video WallPaper Select a background image (wallpaper) for the video screen when idle. The Experimental settings are for testing only and should not be used unless agreed with Cisco. Requires user role: USER These settings are not documented and WILL change in later releases.

  • Page 76: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 77: Description Of The Xcommand Commands

    Camera Preset Edit .........................92 xCommand Call Ignore ..........................85 xCommand Camera Preset List .........................92 xCommand Call Modify ..........................85 xCommand Camera Preset Remove ......................92 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 78 Message Alert Clear .......................99 xCommand Message TextLine Display ......................99 Security commands ..........................109 xCommand Message TextLine Clear ......................99 xCommand Security FIPSMode Activate ....................109 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 79 Video PreviewFilmstrip Set ....................117 xCommand SystemUnit DateTime Set ..................... 112 xCommand SystemUnit DateTime Get ..................... 113 Experimental commands ........................117 xCommand SystemUnit FactoryReset ..................... 113 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 80: Audio Commands

    Audio VUMeter Stop ConnectorType: Microphone ConnectorId: 1 xCommand Audio Sound Play Sound: Ringing *r AudioVumeterStopResult (status=OK): *r AudioSoundPlayResult (status=OK): ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 81 *r Bookings Booking 1 Time EndTimeBuffer: 0 *r Bookings Booking 1 MaximumMeetingExtension: 30 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed *r Bookings Booking 1 BookingStatus: OK SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 82 Bookings Clear) xCommand Bookings List *r Bookings Error: "No bookings found." *r Bookings ResultInfo TotalRows: 0 *r Bookings LastUpdated: Never ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 83: Call Commands

    Dial command is run. During the call you can run the xStatus Call command to see the CallId. Requires user role: USER Parameters: CallId: <0..65534> Example: xCommand Call Reject CallId:20 *r CallRejectResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 84 Call command to see the CallId. Requires user role: USER Parameters: CallId(r): <0..65534> Reason(o): Example: xCommand Call Hold CallId:19 *r CallHoldResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 85 Example: *r CallModifyResult (status=Error): xCommand Call UnattendedTransfer CallId: 2 Number: destination@example. Reason: Callescalation not enabled *r TransferUriResult (status=OK): ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 86 Filter: You can filter which calls to delete, either all, missed, placed or received calls. Requires user role: USER Parameters: Filter(o): SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 87 *r CallHistoryGetResult Entry 1 OccurrenceType: Received *r CallHistoryGetResult Entry 1 IsAcknowledged: Acknowledged *r CallHistoryGetResult ResultInfo Offset: 3 *r CallHistoryGetResult ResultInfo Limit: 65534 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 88 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 89 CallLog Missed Dimissed LogTag:119 Mode(r): *r DismissResult (status=OK): Duration: <0..60> ** end Example: xCommand CamCtrlPip Mode: On *r CamCtrlPipResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 90 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 91 ** end 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 92 Name: *r CameraPresetRemoveResult (status=OK) Example: ** end xCommand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: "" *r CameraPresetEditResult (status=OK) ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 93 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 94 BookingId: Appearance(o): <1..999999999> DisplayName(o): Example: xCommand Dial Number:543210 Protocol:h323 *r DialResult (status=OK): CallId: 2 ConferenceId: 1 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 95 FacilityService Dial ServiceId: 1 xCommand DTMFSend CallId:2 DTMFString:1234 *r DTMFSendResult (status=OK): *r FacilityServiceDialResult (status=OK): ** end CallId: 2 ConferenceId: 1 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 96 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 97 FarEndControl Source Select CallId:3 SourceId:1 xCommand HttpFeedback Deregister FeedbackSlot:1 *r FECCSelectSourceResult (status=OK): ** end *r FeedbackDeregisterResult (status=OK): FeedbackSlot: 1 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 98 Key Release command to emulate releasing the key. Requires user role: ADMIN Parameters: Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/ Left/Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/ SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut> Example: xCommand Key Press Key:Home *r KeyPressResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 99 Message TextLine Clear Requires user role: ADMIN Example: *r MessageTextLineClearResult (status=OK): xCommand Message Alert Clear ** end *r MessageAlertClearResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 100 FeedbackId: *r MessagePromptDisplayResult (status=OK): OptionId(r): <1..5> ** end Example: xCommand Message Prompt Response OptionId: 1 *r MessagePromptResponseResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 101 LocalEcho(o): Example: xCommand Message FarendMessage CallId: 3 Type: 3 Text: Hello *r FarendMessageResult (status=Error): Reason: Generic Message mode not enabled ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 102 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 Name(r): The name of the contact.
  • Page 103 ImageURL: Title: Example: xCommand Phonebook Contact Modify ContactId:localContactId-1 Name: "John Doe - office" *r PhonebookContactModifyResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 104 You can add several contact methods to a contact. Note that only the first contact method will command was issued to make the contact. appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact method ContactMethodId: The unique identifier for the contact method you want to modify. The identifier may have been created when issuing the xCommand Phonebook Contact Add command to make will be returned by an xCommand Phonebook Search command.
  • Page 105 Phonebook Search PhonebookType:Corporate Limit:2 FolderId:"corporate _ 001" *r PhonebookSearchResult ResultSet ResultInfo TotalRows: 25 *r PhonebookSearchResult ResultSet Contact 1 Name: "John Doe (office)" SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 106 Requires user role: USER "SIP:[email protected]" Example: *r PhonebookSearchResult ResultSet Contact 2 ContactMethod 2 Protocol: SIP xCommand Presentation Stop ** end *r PresentationStopResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 107 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 108 Postpones the installing of the software upgrade. Requires user role: USER Parameters: SecondsToPostpone(r): <0..65534> Example: xCommand Provisioning PostponeUpgrade SecondsToPostpone: 60 *r PostponeUpgradeResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 109 This command will log you out of your Extension Mobility profile. Requires user role: USER Example: xCommand Provisioning CUCM ExtensionMobility Logout *r NoResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 110 (or by xConfiguration Standby Delay). Next time this delay is the valid standby delay. Requires user role: USER Parameters: Delay(r): <1..480> Example: xCommand Standby ResetTimer Delay:10 *r ResetResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 111 Key(r): xCommand SystemUnit Diagnostics Run Example: *r DiagnosticsResult (status=OK): xCommand SystemUnit ReleaseKey Add Key:****************** ** end *r ReleaseKeyResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 112 Set a menu password to restrict access to Administrator Settings menu. If you have a remote Second:0 control the password can also be set from the on screen menu. If you have a Cisco TelePresence *r DateTimeSetResult (status=OK): Touch controller the menu password is set from the command line interface.
  • Page 113 Requires user role: ADMIN Parameters: Name(r): Example: xCommand SystemUnit ConfigurationProfile Remove Name: "My _ ConfigurationProfile _ 1" *r ConfigurationProfileRemoveResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 114 Cancel the "ConfigurationProfile Change" command, that would otherwise take effect after next system boot. Requires user role: ADMIN Example: xCommand SystemUnit ConfigurationProfile CancelChange *r ConfigurationProfileCancelChangeResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 115: Video Commands

    Requires user role: ADMIN *r ActiveSpeakerPipSetResult (status=OK): Parameters: ** end View(r): Example: xCommand Video Layout SetPresentationView View:Default *r VideoLayoutSetPresentationViewResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 116 CenterLeft OnMonitorRole: First *r SelfviewSetResult (status=OK): ** end Example 2 xCommand Video Selfview Set FullscreenMode: On OnMonitorRole: Second *r SelfviewSetResult (status=OK): ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 117 Video PIP Presentation Set Sets position for the presentation PiP (picture in picture). The Experimental commands are for testing only and should not be used unless agreed with Cisco. Position: Predefined positions. These commands are not documented and WILL change in later releases.
  • Page 118 Cisco TelePresence SX20 Codec API Reference Guide Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 119: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 120: Description Of The Xstatus Commands

    Call [n] ModifyState ........................130 xStatus Conference Presentation LocalSource ..................134 xStatus Call [n] DeviceType ........................130 xStatus Conference Presentation LocalSendingMode ................134 xStatus Conference Presentation LastLocalSource ................135 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 121 Diagnostics Call [n] Channels OutgoingVideoChannel [n] Netstat 1 Jitter ........139 xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 ChannelRate ......143 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 122 MediaChannels Call [n] IncomingVideoChannel [n] Transport RTCP Remote IpAddress ....153 xStatus ICE Turn Hostname ........................147 xStatus MediaChannels Call [n] IncomingVideoChannel [n] Transport RCTP Remote Port .....153 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 123 Provisioning Software UpgradeStatus LastChange ..............164 xStatus Network 1 IPv4 DHCP TmsServer ....................159 xStatus Provisioning Software UpgradeStatus Status ................164 xStatus Network 1 IPv4 DHCP ProvisioningServer ..................159 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 124 SIP Proxy [1] Status........................170 xStatus SystemUnit Software ReleaseKey ....................176 xStatus SIP Proxy [1] Address ........................170 xStatus SystemUnit Software OptionKeys NaturalPresenter ..............176 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 125 Video Layout Site [n] Output [n] FrameContainer [n] PositionX ...........188 xStatus Video Input LastConnectedSource .....................182 xStatus Video Layout Site [n] Output [n] FrameContainer [n] PositionY ............188 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 126 Video Layout Prediction Site [n] FrameContainer OutputRole [n] Height ........189 Experimental status ..........................190 xStatus Video Layout Prediction Site [n] Output [1..2] Frame [1..6] MediaChannelId .......189 xStatus Video Selfview Mode ........................189 SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 127: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 128: Call Status

    ** end Value space of the result returned: Example: xStatus Call 27 Protocol *s Call 27 Protocol: "h323" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 129: Xstatus Call [N] Displayname

    Call 27 PlacedOnHold xStatus Call 27 ReceiveCallRate *s Call 27 PlacedOnHold: False *s Call 27 ReceiveCallRate: 4000 ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 130: Xstatus Call [N] Duration

    Call [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 131: Camera Status

    Value space of the result returned: *s Camera 1 Manufacturer: "TANDBERG" ** end Example: xStatus Camera 1 IpAddress *s Camera 1 IpAddress: "" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 132: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 133: Xstatus Camera [N] Upgradestatus

    Value space of the result returned: Example: xStatus Camera 1 DownloadProgress *s Camera 1 DownloadProgress: 0 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 134: Conference Status

    Value space of the result returned: *s Conference Presentation Resolution Height: 0 ** end Example: xStatus Conference Presentation LocalSendingMode *s Conference Presentation LocalSendingMode: Off ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 135: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 136 Conference Site [n] Capabilities Presentation xStatus Conference Site [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 137 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 138 Value space of the result returned: Example: xStatus Conference Line 1 Appearance Status *s Conference Line 1 Appearance 5464 Status: Held ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 139 Indicates which call protocol is used as default. Value space of the result returned: Example: xStatus Conference SelectedCallProtocol *s Conference SelectedCallProtocol: SIP ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 140 *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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 141 *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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 142 *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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 143: Xstatus Diagnostics Call [N] Channels Incomingvideochannel [N] Netstat 1 Channelrate

    *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate: 128000 MaxJitter: 0 ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 144: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 145: H323 Status

    Shows the port which is used when connecting to on the gatekeeper. Value space of the result returned: Example: xStatus H323 Gatekeeper Port *s H323 Gatekeeper Port: 1719 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 146: Httpfeedback Status

    Returns the IP address of the TURN server that is currently in use. Value space of the result returned: Example: xStatus ICE Turn IP *s ICE Turn IP: "192.0.1.20" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 147: Xstatus Ice Turn Username

    Value space of the result returned: Example: xStatus ICE Call Remote Candidate *s ICE Call 1 Remote Candidate: “SRFLX” ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 148: Xstatus Ice Call Remote Ip

    Off: Turn discovery mode is set to Off. ** end Value space of the result returned: Example: xStatus ICE Turn Discovermode *s ICE Turn Discovermode: "Verified" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 149: Mediachannels Status

    IpAddress: "192.168.24.190" xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol ** end *s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol: AACLD ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 150: Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport Rtp Local Port

    *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port: 50932 *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress: "192.168.136.130" ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 151: Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport Rctp Remote Port

    MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX *s MediaChannels Call 27 IncomingVideoChannel 330 ChannelRole: Main *s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768 ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 152: Xstatus Mediachannels Call [N] Incomingvideochannel [N] Video Resolutiony

    MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP ** end Local IpAddress *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local IpAddress: "192.168.24.190" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 153: Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport Rtcp Local Port

    MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels Port: 50933 *s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1 ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 154: Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport Rtp Local Ipaddress

    *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port: 16405 *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress: "192.168.136.130" ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 155: Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport Rtcp Remote Ipaddress

    Example: ** end xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status *s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 156: Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Video Resolutionx

    MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port: 50932 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 157: Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport Rtcp Local Ipaddress

    MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress: "192.168.136.130" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 158: Network Status

    ** end 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 159: Xstatus Network 1 Ipv4 Dhcp Provisioningdomain

    Network 1 IPv4 DHCP ProvisioningServer *s Network 1 IPv6 Address: "" *s Network 1 IPv4 DHCP ProvisioningServer: "192.0.2.0" ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 160: Xstatus Network 1 Ipv6 Gateway

    Network 1 IPv6 Gateway xStatus Network CDP Version *s Network 1 IPv6 Gateway: "" *s Network 1 CDP Version: "Cisco IOS Software, C3750E Software (C3750E- 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 161: Xstatus Network Cdp Portid

    Returns the first network address of both receiving and sending devices. Value space of the result returned: Example: xStatus Network CDP Address *s Network 1 CDP Address: "192.0.1.20" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 162: Xstatus Network Cdp Voipappliancevlanid

    Discarded: The NTP result has been discarded. Value space of the result returned: Example: xStatus NetworkServices NTP Status *s NetworkServices NTP Status: Synced ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 163: Preset Status

    Value space of the result returned: *s Provisioning Reason: "" ** end Example: xStatus Preset 1 Description *s Preset 1 Description: "Zoom in" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 164: Xstatus Provisioning Server

    Provisioning Software UpgradeStatus URL *s Provisioning Software UpgradeStatus Status: None *s Provisioning Software UpgradeStatus URL: "http:// .../s52000tc5 _ 1 _ 0.pkg" ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 165: Xstatus Provisioning Software Upgradestatus Secondsuntilupgrade

    Value space of the result returned: ** end Example: xStatus Provisioning CUCM CAPF ServerName *s Provisioning CUCM CAPF ServerName: "192.168.0.1" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 166: Xstatus Provisioning Cucm Capf Serverport

    Value space of the result returned: *s Provisioning CUCM CAPF OperationState: NonPending Example: xStatus Provisioning CUCM CAPF OperationResult SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 167: Xstatus Provisioning Cucm Provisionsecurity

    *s Provisioning CUCM CTL State: Installed ** end Example: xStatus Provisioning CUCM TVS Proxy 1 Server *s Provisioning CUCM TVS Proxy 1 Server: "192.0.2.0" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 168: Xstatus Provisioning Cucm Tvs Proxy [N]Ipv6Address

    *s Provisioning CUCM TVS Proxy 1 Priority: 0 ** end Example: xStatus Security Persistency CallHistory *s Security Persistency CallHistory: Persistent ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 169: Xstatus Security Persistency Internallogging

    Shows whether DHCP logging is set to persistent or non-persistent mode. Persistent is the default mode. Value space of the result returned: Example: xStatus Security Persistency DHCP *s Security Persistency DHCP: Persistent ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 170: Xstatus Sip Proxy [1] Secure

    Timeout: The attempt to establish communication to the SIP Proxy timed out. register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or CUCM. UnableTCP: The system is unable to use TCP as the transport method.

  • Page 171: Xstatus Sip Registration [N] Status

    *s SIP Profile 1 Proxy 1 Status: Active ** end Example: xStatus SIP Registration 1 URI *s SIP Registration 1 URI: "[email protected]" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 172: Xstatus Sip Profile 1 Proxy [1] Address

    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 CallForward Mode valid.

  • Page 173: Xstatus Sip Profile 1 Callforward Uri

    *s SIP Profile 1 DirectoryURI Primary URI: "[email protected]" ** end Example: xStatus SIP Profile 1 Registration 1 Status *s SIP Profile 1 Registration 1 Status: Registered ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 174: Xstatus Sip Profile 1 Directoryuri Primary Uri

    SIP Profile DirectoryURI Primary URI Example: *s SIP Profile 1 DirectoryURI Primary URI: "[email protected]" xStatus Standby Active ** end *s Standby Active: Off ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 175: Systemunit Status

    Value space of the result returned: *s SystemUnit ProductPlatform: "C90" ** end Example: xStatus SystemUnit Software Name *s SystemUnit Software Name: "s52010" ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 176: Xstatus Systemunit Software Releasedate

    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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 177: Xstatus Systemunit Software Optionkeys Dualdisplay

    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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 178: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 179: Xstatus Systemunit State Numberofinprogresscalls

    SystemUnit Notifications Notification 1 Type xStatus SystemUnit ContactInfo *s SystemUnit Notifications Notification 1 Type: SoftwareUpgradeOK *s SystemUnit ContactInfo: "[email protected]" ** end ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 180: Xstatus Systemunit Notifications Notification [N] Text

    *s SystemUnit DiagnosticsResult Message 1 References: "" Example: ** end xStatus SystemUnit Diagnostics Message type *s SystemUnit Diagnostics Message 1 Type: InvalidAdminPassword ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 181: Xstatus Systemunit Diagnostics Extendedlogging Mode

    SystemUnit Diagnostics ExtendedLogging Mode *s SystemUnit Diagnostics ExtendedLogging Mode: Off Example: ** end xStatus Time ZoneOlson *s Time ZoneOlson: Europe/Berlin ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 182: Xstatus Video Input Mainvideosource

    Value space of the result returned: <0..300> Example: xStatus Video Input Source 1 Resolution RefreshRate *s Video Input Source 1 Resolution RefreshRate: 50 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 183: Xstatus Video Input Source [1

    *s Video Input Source 2 MediaChannelId: 3 xStatus Video Input DVI 2 Connected ** end *s Video Input DVI 2 Connected: False ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 184: Xstatus Video Input Dvi [2] Signalstate

    *s Video Output HDMI 1 Resolution Width: 1280 ** end xStatus Video Output Shows the top level overview of the video output status. SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 185: Xstatus Video Output Hdmi [1, 2] Resolution Refreshrate

    Indicates type of layout currently used by the codec, custom or default. ** end Value space of the result returned: Example: xStatus Video Layout Mode *s Video Layout Mode: Default ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 186: Xstatus Video Layout Site [N] Output [1..2] Graphicname

    Video Layout Site 1 Output 1 Frame 1 PositionY *s Video Layout Site 1 Output 1 Frame 1 PositionY: 0 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 187: Xstatus Video Layout Site [N] Output [1

    Video Layout Site 1 Output 1 Frame 1 VideoSourceId *s Video Layout Site 1 Output 1 Frame 1 VideoSourceId: 0 ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 188: Xstatus Video Layout Site [N] Output [N] Frame [N] Videosourcecontent

    Video Layout Prediction Site [n] FrameContainer OutputRole [n] PositionY For internal use only. Value space of the result returned: SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 189: Xstatus Video Selfview Fullscreenmode

    Value space of the result returned: ** end Example: xStatus Video PIP ActiveSpeaker Position *s Video PIP ActiveSpeaker Position: UpperCenter ** end SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 190: Xstatus Video Pip Presentation Position

    Video PIP Presentation Position Shows the position of the presentation image on the screen. The Experimental status is for testing only and should not be used unless agreed with Cisco. These Value space of the result returned: settings are not documented and WILL change in later releases.

  • Page 191: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 192: Startup Script

    Example of the text in such a file: #!/usr/bin/env tsh xCommand Audio LocalInput Update InputId: 1 MixerMode: Fixed SX20 Codec API Reference Guide TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 193: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 194: 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 195: The Systemtools Commands

    [comment] | delete | 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 196 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...

  • Page 197: 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 TC7.0, JANUARY 2014. Copyright © 2014 Cisco Systems, Inc. All rights reserved. D14949.08...
  • Page 198 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.

Table of Contents