Page 1 About the API xConfiguration xCommand xStatus Appendices Software version TC7.3 OCTOBER 2015 Application Programmer Interface (API) Reference Guide Cisco TelePresence SX20 Codec SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 2: Table Of Contents
Remote control key map ............. 214 Status ..................16 The SystemTools commands ..........215 Events ................... 17 About disconnect cause types ........... 217 Call history ................18 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 3: October
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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
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/sx-docs SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 5: What's New In This Version
(granted it has administrator rights). In previous software versions, this command changed the password for the default user account (admin). SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 6: System Configuration Changes
Video AllowWebSnapshots (removed in TC7.3.3) NetworkServices UPnP Timeout (TC7.3.4) OLD: <Off/On>, default Off NEW: <Off/On/LocalDeviceOnly>, default LocalDeviceOnly Video Monitors OLD: Default: Single NEW: Default: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 7: System Command Changes
ScreenShotId: 0 – 35 NEW: ScreenShotId: 0 – 50 UserInterface ScreenShot Store OLD: ScreenShotId: 0 – 255 NEW: ScreenShotId: 0 – 50 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 8: System Status Changes
MediaChannels Call [n] OutgoingVideoChannel [n] Transport SipIceAndAnatConflict/TLSVerifyRequiredCerts/ RTCP Local Protocol TouchPanelConnection/TurnBandwidth/ UdpPortRangeViolation/ValidAdminPassword/ MediaChannels Call [n] OutgoingVideoChannel [n] Transport VideoFromInternalCamera/VideoInputStability> RTCP Remote Protocol SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 9: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 10: Api Fundamentals
This is described in xCommand SystemUnit AdminPassword Set Password: ”Using HTTP” on page 21 in this document. <password> SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 11: Api Output
To set ouput mode to XML, issue the command: <LayoutId>1</LayoutId> xPreferences outputmode xml </AssignCall> </Layout> To revert to terminal mode, issue the command: </Video> </Command> xPreferences outputmode terminal SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 12: Using The Command Line
Refer to ”Feedback mechanism” on page session. Refer to ”Feedback mechanism” on page • <CTRL-w>: Erase the current line. SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 13: Searching
*? xConfiguration Video SelfviewPosition: <UpperLeft/UpperCenter/UpperRight/CenterLeft/ CenterRight/LowerLeft/LowerRight> XCOMMAND DIAL NUMBER: foo@bar.org *? xConfiguration Video Wallpaper: <None/Custom/Growing/Summersky/Waves/Blue> xcommand dial number: foo@bar.org xCommand Dial Number: foo@bar.org SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 14: Commands
‘:’. xCommand Video PreviewFilmstrip Set Position(r): <LowerCenter/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight> xCommand Video Selfview Set FullscreenMode: <On/Off> Mode: <On/Off> OnMonitorRole: <First/Fourth/Second/Third> PIPPosition: <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight> SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 15: Configurations
*? xConfiguration Video SelfviewDefault OnMonitorRole: <First/Second/Current> *? xConfiguration Video SelfviewDefault PIPPosition: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/ CenterRight/LowerLeft/LowerRight> *? xConfiguration Video SelfviewPosition: <UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/ LowerLeft/LowerRight> *? xConfiguration Video Wallpaper: <None/Custom/Growing/Summersky/Waves/Blue> SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 16: Status
*s Call 4 Protocol: “sip” *s Call 4 ReceiveCallRate: 1920 *s Call 4 RemoteNumber: “name@company.com” *s Call 4 TransmitCallRate: 1920 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 17: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 18: Call History
*h xHistory CallLogs Received 40 Counter: 6 *h xHistory CallLogs Recent 6 CounterMissed: 2 *h xHistory CallLogs Recent 6 Counter: 2 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 19: Feedback Mechanism
Video Input Source 2 Connector *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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 20: Terminal Connections
Write in: xFeedback deregister /Status/Audio Result: ** end D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 21: 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 22: 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 23: Translating From Terminal Mode To Xml
</Video> </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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 24: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 25: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 26: Description Of The Xconfiguration Commands
Cameras Camera [1] Mirror ....................35 xConfiguration Conference [1..1] Multipoint Mode ..................40 xConfiguration Cameras Camera [1] MotorMoveDetection ................35 xConfiguration Conference [1..1] IncomingMultisiteCall Mode ..............40 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 27 Network [1..1] QoS Mode ....................47 xConfiguration NetworkServices HTTPS OCSP URL ................53 xConfiguration Network [1..1] QoS Diffserv Audio ..................47 xConfiguration NetworkServices Medianet Metadata ................53 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 28 RTP Ports Range Start .......................59 xConfiguration SIP Profile [1..1] Outbound ....................64 xConfiguration RTP Ports Range Stop .......................59 xConfiguration SIP Profile [1..1] Proxy [1..4] Address ..................64 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 29 Video Input HDMI [1] RGBQuantizationRange ..............71 xConfiguration Video OSD TodaysBookings ....................79 xConfiguration Video Input Source [1..2] Name ..................71 xConfiguration Video OSD MyContactsExpanded ..................79 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 30 Video WallPaper .........................82 xConfiguration Video Output HDMI [1,2] Location VerticalOffset ...............80 Experimental configuration ........................82 xConfiguration Video Output HDMI [1,2] RGBQuantizationRange ..............80 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 31 Use the Audio Input Line [n] VideoAssociation VideoInputSource setting to define which video If you are connecting a Cisco camera with an integrated microphone to the codec's HDMI input, you source to associate the audio source with. Use the Audio Input Line [n] VideoAssociation can enable/disable audio input on the port;...
Page 32 When set to InCallOnly this will prevent the audio-system from being muted by mistake. Example: xConfiguration Audio Microphones Mute Enabled: True SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 33 Range: The value must be between 0 and 100. The values from 1 to 100 correspond to the range All Cisco Precision cameras support both anti-flickering and auto detection of line frequency. Auto is from -34.5 dB to 15 dB (0.5 dB steps). The value 0 means that the audio is switched off.
Page 34 Manual: In manual mode the gamma value is changed with the gamma level setting, ref: Cameras Camera [1..n] Gamma Level. Example: xConfiguration Cameras Camera 1 Gamma Mode: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 35 By setting the Gamma Level you can select which gamma correction table to use. This setting may This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. be useful in difficult lighting conditions, where changes to the brightness setting does not provide If adjusting the camera position by hand you can configure whether the camera should keep its new satisfactory results.
Page 36: Conference Configuration
Conference [1..1] ActiveControl Mode Requires user role: ADMIN Active control is a feature that allows conference participants to administer a conference on Cisco Value space: <Off/On> TelePresence Server using the video system's interfaces (not available from the TRC5 remote control and on-screen display).
Page 37 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 38 H323: All calls are set up as H.323 calls. Sip: All calls are set up as SIP calls. H320: All calls are set up as H.320 calls (only applicable if connected to a Cisco TelePresence ISDN Link gateway). Example: xConfiguration Conference 1 DefaultCall Protocol: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
Page 39 Static: The available transmit bandwidth is assigned to each video channel, even if it is not active. Example: xConfiguration Conference 1 VideoBandwidth Mode: Dynamic SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 40 (MCU). If registered to a Cisco Unified Communications Manager (CUCM) version 8.6.2 or newer, the video system can use either the CUCM conference bridge, or the video system's own built-in MultiSite feature.
Page 41 Requires user role: ADMIN Value space: <S: 0, 1024> Format: String with a maximum of 1024 characters. Example: xConfiguration FacilityService Service 1 Name: "" SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 42: 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 43 Gatekeeper for making H.323 calls and hence an IP address must be specified manually. Example: xConfiguration H323 Profile 1 Gatekeeper Discovery: Manual SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 44 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 45: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 46 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 47 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 48 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 49 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 50 Network [1..1] VLAN Voice Mode 10half: Force link to 10 Mbps half-duplex. Set the VLAN voice mode. The VLAN Voice Mode will be set to Auto automatically if you have Cisco 10full: Force link to 10 Mbps full-duplex. UCM (Cisco Unified Communications Manager) as provisioning infrastructure. Note that Auto mode will NOT work if the NetworkServices CDP Mode setting is Off.
Page 51 NetworkServices CDP Mode Value space: <1..4094> Enable or disable the CDP (Cisco Discovery Protocol) daemon. Enabling CDP will make the endpoint report certain statistics and device identifiers to a CDP-enabled switch. If CDP is disabled, the Range: Select a value between 1 and 4094.
Page 52 Example: xConfiguration NetworkServices HTTPS Mode: On Off: The XML API is disabled. On: The XML API is enabled (default). Example: xConfiguration NetworkServices XMLAPI Mode: On SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 53 Authority (CA). This requires that a list of trusted CAs are uploaded to the system in advance. Example: xConfiguration NetworkServices HTTPS VerifyServerCertificate: Off xConfiguration NetworkServices Medianet Metadata Switch On or Off the capability to tag media flows with metadata related to the Cisco Medianet xConfiguration NetworkServices HTTPS VerifyClientCertificate deployment.
Page 54 SNMP Agent in the codec. The default password is "public". If Requires user role: ADMIN you have the Cisco TelePresence Management Suite (TMS) you must make sure the same SNMP Community is configured there too. NOTE: The SNMP Community password is case sensitive.
Page 55 NetworkServices CTMS Mode Value space: <Off/On> This setting determines whether or not to allow multiparty conferences controlled by a Cisco Off: UPnP is disabled. The video system does not advertise its presence, and you have to enter TelePresence Multipoint Switch (CTMS).
Page 56 Peripherals Pairing CiscoTouchPanels RemotePairing xConfiguration Phonebook Server [1..1] ID In order to use Cisco Touch 10 (touch controller) as user interface for the video system, Touch 10 Enter a name for the external phone book. must be paired to the video system via the network (LAN). This is referred to as remote pairing.
Page 57 Auto: The provisioning server will automatically be selected by the video system. GET: Select GET when the provisioning server supports GET. TMS: The video system will be configured using TMS (Cisco TelePresence Management System). POST: Select POST when the provisioning server supports POST.
Page 58 Provisioning ExternalManager AlternateAddress Format: String with a maximum of 64 characters. Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager Example: xConfiguration Provisioning ExternalManager Domain: "any.domain.com" (CUCM) and an alternate CUCM is available for redundancy. Enter the address of the alternate CUCM.
Page 59 Ignore: The system will continue its normal operation, and rotate internal logs when full. When the connection is restored it will again send its audit logs to the syslog server. Example: xConfiguration Security Audit OnError Action: Ignore SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 60 TCP port number 6514 when the Security Audit Logging Mode is set to ExternalSecure. Manual: Will use the port value defined in the Security Audit Server Port setting. Example: xConfiguration Security Audit Server PortAssignment: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 61: Sip Configuration
IPv4: The preferred IP version for media is IPv4. IPv6: The preferred IP version for media is IPv6. Example: xConfiguration SIP PreferredIPMedia: IPv4 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 62 Thus the shortest route for audio and video is always Example: xConfiguration SIP Profile Turn DiscoverMode: On secured between the endpoints. NOTE: ICE is not supported when registered to CUCM (Cisco Unified Communication Manager).
Page 63 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 64 Requires user role: ADMIN Value space: <Standard/Cisco> Value space: <Off/On> Standard: Use this when registering to standard SIP Proxy (tested with Cisco TelePresence VCS Off: Connect to the single proxy configured first in Proxy Address list. and Broadsoft) On: Set up multiple outbound connections to servers in the Proxy Address list. A random proxy is Cisco: Use this when registering to Cisco Unified Communication Manager.
Page 65 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 66 CallHistory Get command. 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 67 The IR sensor of the codec is enabled only if the IR sensor of the camera is disabled. Off: Disable the IR sensor of the codec. On: Enable the IR sensor of the codec. Example: xConfiguration SystemUnit IrSensor: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 68 MST, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, PST8PDT, Pacific/Apia, Pacific/Auckland, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/ America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/ SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 69 On: The user preferences are available from the Settings menu on the Touch controller. Example: xConfiguration UserInterface UserPreferences: On SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 70 DVI sources expects full quantization range. experimental Cisco Proximity feature. The devices must be in the same room as the video system. It will not be possible to take and see snapshots on the web interface or by using 3rd party Requires user role: ADMIN integrations.
Page 71 Requires user role: ADMIN Value space: <S: 0, 50> Format: String with a maximum of 50 characters. Example: xConfiguration Video Input Source 1 Name: "" SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 72 IfSignal: When set to IfSignal, the menu selection for the video input source will only be visible when a presentation source is connected to the video input. Example: xConfiguration Video Input Source 1 Visibility: IfSignal SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 73 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 74 Single: The active speaker, or the presentation if present, will be shown in full screen. The other participants are not shown. Transitions between active speakers are voice switched. Example: xConfiguration Video Layout RemoteLayoutFamily: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 75 LowerRight: The presentation PiP will appear in the lower right corner of the screen. Example: xConfiguration Video Layout ScaleToFrameThreshold: 5 Example: xConfiguration Video PIP Presentation DefaultValue Position: Current SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 76 On: self-view is switched on when leaving a call. Example: xConfiguration Video SelfviewDefault Mode: Current SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 77 On: The Language menu will be available from the Settings menu. Second. Example: xConfiguration Video OSD LanguageSelection: On Example: xConfiguration Video Monitors: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 78 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 79 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 80 Limited: Limited Quantization Range. R, G, B quantization range that excludes some code values at the extremes (16 - 235). This is defined in CEA-861-E. Example: xConfiguration Video Output HDMI 1 RGBQuantizationRange: Full SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 81 1366_768_60: The resolution is 1366 x 768, and the refresh rate is 60 Hz. Example: xConfiguration Video Output HDMI 1 Resolution: Auto SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 82 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. You may upload a custom wallpaper to the video system using the web interface. The following file These settings are not documented and WILL change in later releases.
Page 83: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 84: Description Of The Xcommand Commands
CallLog Recent Delete ......................96 xCommand Call Accept ..........................92 xCommand Call Disconnect ........................92 CamCtrlPip commands ......................... 97 xCommand Call DisconnectAll ........................92 xCommand CamCtrlPip ..........................97 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 85 Phonebook Contact Add ....................... 110 xCommand FarEndControl Source Select ....................104 xCommand Phonebook Contact Delete ....................111 xCommand Phonebook Contact Modify ....................111 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 86 UserManagement RemoteSupportUser Delete ..............123 xCommand Standby Deactivate ....................... 119 xCommand UserManagement RemoteSupportUser DisablePermanently ..........123 xCommand Standby ResetTimer ......................119 xCommand UserManagement RemoteSupportUser GetState ..............124 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 87 Video Matrix Reset ........................125 xCommand Video Selfview Set ........................127 xCommand Video Matrix Swap ........................125 Experimental commands ........................127 xCommand Video Matrix Unassign ......................125 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 88: Audio Commands
Decrease the volume on the endpoint. Example: Requires user role: USER xCommand Audio Sound Stop Parameters: Steps: <1..10> Example: xCommand Audio Volume Decrease Steps:3 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 89 Audio Volume SetToDefault xCommand Audio Volume UnMute Unmute the volume on the endpoint. Requires user role: USER Example: xCommand Audio Volume SetToDefault SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 90 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed *r Bookings Booking 1 BookingStatus: OK *r Bookings Booking 1 BookingStatusMessage: "" *r Bookings Booking 1 Webex Enabled: True SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 91 Bookings Clear) xCommand Bookings List *r Bookings Error: "No bookings found." *r Bookings ResultInfo TotalRows: 0 *r Bookings LastUpdated: Never SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 92: Xcommand Call Extendconference
Call HoldAll Example: Puts all ongoing calls on hold. xCommand Call DisconnectAll Requires user role: USER Parameters: Reason(0): <Conference/Transfer/Other> Example: xCommand Call HoldAll SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 93: Xcommand Call Ignore
Example: CallId(r): <0..65534> Number(r): <S: 0, 255> xCommand Call Modify CallType: Audio CallId: 16 Example: xCommand Call UnattendedTransfer CallId: 2 Number: destination@example. SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 94: Callhistory Commands
Filter: You can filter which calls to delete, either all, missed, placed or received calls. Requires user role: USER Parameters: Filter: <All/Missed/Placed/Received> Example: xCommand CallHistory DeleteAll Filter: Missed SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 95 *r CallHistoryGetResult Entry 1 OccurrenceType: Received *r CallHistoryGetResult Entry 1 IsAcknowledged: Acknowledged *r CallHistoryGetResult ResultInfo Offset: 3 *r CallHistoryGetResult ResultInfo Limit: 65534 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 96: Calllog Commands
LogTag: <0..2147483647> Requires user role: USER Example: Parameters: xCommand CallLog Recent Delete LogTag: 786 LogTag: <0..2147483647> Example: xCommand CallLog Missed Dimissed LogTag:119 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 97: Camctrlpip Commands
Camera PositionReset Reset the camera position the the default position. Requires user role: USER Parameters: CameraId(r): <1..1> Example: xCommand Camera PositionReset CameraId:1 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 98 PresetId: Filter on specified preset. Example: Requires user role: USER xCommand Camera Preset Activate PresetId: 1 Parameters: PresetId: <1..35> Example: xCommand Camera Preset List PresetId: 1 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 99 Camera Preset Snapshot Remove PresetId:1 Name: <S: 0, 255> TakeSnapshot; <False/True> Example: xCommand Camera Preset Store PresetId: 1 CameraId: 1 ListPosition: 1 Name: "" SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 100 Requires user role: USER Parameters: Parameters: CameraId(r): <1..1> Timeout: <0..1440> Example: Example: xCommand Camera TriggerAutofocus CameraId:1 xCommand Conference DoNotDisturb Activate Timeout: 120 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 101 Number(r): <S: 0, 255> Protocol: <H320/H323/Sip> CallRate: <64..6000> CallType: <Audio/Video> BookingId: <S: 0, 255> Appearance: <1..999999999> DisplayName: <S: 0, 255> Example: xCommand Dial Number:543210 Protocol:h323 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 102 Requires user role: USER Parameters: Parameters: CallId: <0..65534> ServiceId(r): <1..5> DTMFString(r): <S: 0, 32> Example: Example: xCommand FacilityService Dial ServiceId: 1 xCommand DTMFSend CallId:2 DTMFString:1234 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 103 Requires user role: USER Parameters: CallId: <0..65534> PresetId(r): <0..15> Example: xCommand FarEndControl Preset Store CallId:3 PresetId:1 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 104: Xcommand Httpfeedback Deregister
Parameters: FeedbackSlot: <1..4> ServerUrl(r): <S: 1, 2048> Expression[1..15]: <S: 1, 255> Example: xCommand HttpFeedback Register FeedbackSlot:1 ServerUrl:10.47.19.41 Expression[1]:Status/Video Expression[2]:Status/Audio Expression[3]:Status/ Call Expression[4]:Status/Conference SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 105: Key Commands
Emulates a remote control key release. The Key Release command is issued after a Key Press command. 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 Release Key:Home SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 106: Message Commands
Message FarendMessage CallId: 3 Type: 3 Text: Hello xCommand Message Alert Display Title: "Message" Text: "The meeting will end in 5 minutes." Duration: 20 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 107: Xcommand Message Prompt Clear
Do you want to extend the meeting?" Option.1: "No" Option.2: "Yes, extend with 5 minutes" Option.3: "Yes, extend with 10 minutes" SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 108: Xcommand Message Textline Display
Duration: Set how long (in seconds) the text line is to be displayed on the screen. If set to 0 (zero) Note: Does not apply for the Cisco PrecisionHD cameras. the text line is displayed until a xCommand Message TextLine Clear command has been sent.
Page 109: Xcommand Peripherals List
Lists all currently and previously connected peripherals. Start device discovery to detect ISDN Links in the same network. Note: Does not apply for the Cisco PrecisionHD cameras. AutoPairing: You can select to automatically pair the detected device to the endpoint.
Page 110: Xcommand Peripherals Pairing Purge
ID(r): <S: 1, 100> You can add several contact methods to a contact using the xCommand Phonebook ContactMethod Add command. Note that only the first contact method will appear in the Favorites list on the Cisco Example: TelePresence Touch controller. All contact methods are available in the API, on the web interface xCommand Peripherals Purge ID: 1.2.3.4...
Page 111: Xcommand Phonebook Contact Delete
You can add several contact methods to a contact. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact method Requires user role: USER may have been created when issuing the xCommand Phonebook Contact Add command to make the contact.
Page 112: Xcommand Phonebook Contactmethod Delete
ContactMethodId(r): <S: 0, 255> 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 113 Requires user role: USER Parameters: FolderId(r): <S: 0, 255> Example: xCommand Phonebook Folder Delete FolderId:localGroupId-3 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 114 PhonebookType: <Corporate/Local> SearchString: <S: 0, 255> SearchField: <Name/Number> Offset: <0..65534> FolderId: <S: 0, 255> Limit: <0..65534> Recursive: <False/True> ContactType: <Any/Folder/Contact> Tag: <Untagged/Favorite> Example: SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 115 Instance: <1 / 2 / 3 / 4 / 5 / 6> Parameters: Example: PresetId(r): <1..15> xCommand Presentation Stop Example: xCommand Preset Clear PresetId:3 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 116 If a certificate has been deleted in CTL, it is marked accordingly in the output. Requires user role: USER Example: xCommand Provisioning CUCM CTL Show SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 117 Starts installing the software upgrade if you wish to install it before it is set to do so. Requires user role: USER Example: xCommand Provisioning CompleteUpgrade SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 118 LocalPhonebook(r): <NonPersistent/Persistent> DHCP(r): <NonPersistent/Persistent> ConfirmAndReboot(r): <Yes> Example: xCommand Security Persistency Configurations: Persistent CallHistory: Persistent InternalLogging: Persistent LocalPhonebook: Persistent DHCP: Persistent ConfirmAndReboot: Yes SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 119: Xcommand Systemunit Adminpassword Set
SystemUnit ConfigurationProfile List List configuration profiles that has been stored in the system. Requires user role: ADMIN Example: xCommand SystemUnit ConfigurationProfile List SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 120: Xcommand Systemunit Configurationprofile Remove
TrailingAction: Select Shutdown or NoAction to override the default behavior (Restart). Requires user role: ADMIN Parameters: Confirm(r): <Yes> TrailingAction: <NoAction/Restart/Shutdown> Example: xCommand SystemUnit FactoryReset Confirm: Yes SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 121: Xcommand Systemunit Menupassword Set
Set a menu password to restrict access to Administrator Settings menu. If you have a remote List all option keys that have been added to the system. Added in TC7.3.3. 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 122: Xcommand Systemunit Releasekey List
UserInterface ScreenShot Remove For internal use only. Requires user role: ADMIN Parameters: ScreenShotId(r): <S: 0-50> Example: xCommand UserInterface ScreenShot Remove ScreenShotId:5 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 123: Xcommand Userinterface Screenshot Request
Disable the creation of new remote support users. To enable the remote support user again you must factory reset your system. Requires user role: ADMIN Parameters: Confirm(r): <Yes> Example: xCommand UserManagement RemoteSupportUser DisablePermanently Confirm: Yes SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 124: Xcommand Usermanagement Remotesupportuser Getstate
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 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 125: Xcommand Video Osd Close
Closes all menus on the on-screen display. Element: The on–screen menu. Requires user role: ADMIN Parameters: Element(r): <Menu> Example: xCommand Video OSD Close Element: Menu SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 126: Xcommand Video Pip Activespeaker Set
Requires user role: ADMIN Parameters: Parameters: Position(r): <LowerCenter/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight> Position(r): <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight> Example: Example: xCommand Video PreviewFilmstrip Set Position: LowerCenter xCommand Video PIP Presentation Set Position: LowerLeft SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 127: Experimental Commands
Video Selfview Set Sets self-view on/off and specifies its size and position. If the parameter is not specified, current The Experimental commands are for testing only and should not be used unless agreed with Cisco. value is used. These commands are not documented and WILL change in later releases.
Page 128: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 129: Description Of The Xstatus Commands
Call [n] DeviceType ........................142 xStatus Conference Presentation LastLocalSource ................146 xStatus Call [n] AttendedTransferFrom .....................142 xStatus Conference Presentation Instance [n] LocalSendingMode ............146 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 130 Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 Jitter ........151 xStatus Diagnostics Call [n] Channels IncomingDataChannel [n] Netstat 1 Bytes ........154 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 131 HttpFeedback [1..4] Expression [1..15] ..................158 xStatus MediaChannels Call [n] IncomingVideoChannel [n] Video ResolutionX ........164 xStatus MediaChannels Call [n] IncomingVideoChannel [n] Video ResolutionY ........164 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 132 Network 1 CDP VTPMgmtDomain ....................177 xStatus Network 1 CDP Address ......................177 xStatus MediaChannels Call [n] IncomingVideoChannel [n] Transport RTCP Local Protocol ....170 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 133 Provisioning Software PreviousUpgrade Status .................181 xStatus Security Persistency Configurations ...................187 xStatus Provisioning Software PreviousUpgrade Message ..............182 xStatus Security Persistency CallHistory ....................187 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 134 SystemUnit Diagnostics Message [n] Level ................199 xStatus SystemUnit ProductPlatform .......................193 xStatus SystemUnit Diagnostics Message [n] Description ...............199 xStatus SystemUnit Uptime ........................194 xStatus SystemUnit Diagnostics Message [n] References...............199 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 135 Video Output DVI ConnectedDevice PreferredFormat ...............204 xStatus Video Selfview FullscreenMode ....................209 xStatus Video Output HDMI ConnectedDevice Name ................204 xStatus Video Selfview PIPPosition ......................209 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 136 Video PIP ActiveSpeaker Position ....................210 Experimental status ..........................211 xStatus Video PIP Presentation Position ....................210 xStatus Video OSD Output ........................210 xStatus Video OSD Mode .........................210 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 137: Audio Status
Value space of the result returned: *s Audio Connectors Microphone 1 EcReferenceDelay: 120 <Off/On> ** end Example: xStatus Audio VolumeMute *s Audio VolumeMute: Off ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 138: Call Status
Value space of the result returned: <String> Example: xStatus Call 27 Protocol *s Call 27 Protocol: "h323" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 139 Call 27 CallbackNumber xStatus Call 27 ReceiveCallRate *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" *s Call 27 ReceiveCallRate: 4000 ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 140 Idle: No Call Modify operation is pending. Value space of the result returned: <Idle/Outgoing/Incoming> Example: xStatus Call ModifyState *s Call 11 ModifyState: Idle ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 141: Camera Status
Appendices Camera status xStatus Call [n] DeviceType Indicates whether the remote system is a single endpoint or an MCU. Some Cisco endpoints (EX90, C40, C60, C90, SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities. xStatus Camera Value space of the result returned: Shows the top level overview of the camera status.
Page 142: Xstatus Camera [N] Model
Shows the camera IP address. Value space of the result returned: <String> Example: xStatus Camera 1 IpAddress *s Camera 1 IpAddress: "" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 143: Xstatus Camera [N] Position Zoom
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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 144: 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 145: Xstatus Conference Presentation Lastlocalsource
Conference Site 2 Capabilities FECC Source 1 Name *s Conference Site 2 Capabilities FECC Source 1 Name: "Main camera" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 146: Xstatus Conference Site [N] Capabilities Fecc Source [N] Options
*s Conference Site 2 SoftwareID: "TC5" Example: ** end xStatus Conference Site 2 Capabilities Presentation *s Conference Site 2 Capabilities Presentation: True ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 147: Xstatus Conference Site [N] Blackscreencause
Conference Site [n] BlackScreenCause xStatus Conference Site [n] BookingId Shows the reason why the screen is black while in a CTMS (Cisco TelePresence Multipoint Switch) Shows the booking ID of a conference (if assigned). The booking ID can be used for easy managed conference.
Page 148: Xstatus Conference Site [N] Attendedtransfer
Conference Line 1 Appearance Status *s Conference Site 14 CalText: "" *s Conference Line 1 Appearance 5464 Status: Held ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 149: Xstatus Conference Line [N] Appearance Uri
Shows the SiteId (CallId) for the participant locked as the active speaker in the conference. Value space of the result returned: <Integer> Example: xStatus Conference ActiveSpeaker Manual SiteId *s Conference ActiveSpeaker Manual SiteId: 0 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 150: Xstatus Conference Selectedcallprotocol
Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter: ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 151 *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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 152 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived: 84 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 153: Xstatus Diagnostics Call [N] Channels Outgoingaudiochannel [N] Netstat 1 Drop
*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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 154 *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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 155 Value space of the result returned: *s H320 Gateway Id: "00:50:60:0B:EF:11" <String> ** end Example: xStatus H320 Gateway Number *s H320 Gateway Number: "" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 156: 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 157: Xstatus Ice Configured
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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 158: Xstatus Ice Turn Hostname
Value space of the result returned: <String> Example: xStatus ICE Call Local IP *s ICE Call 1 Local IP: “192.0.1.20” ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 159: Xstatus Ice Call Remote Candidate
Off: Turn discovery mode is set to Off. Value space of the result returned: <Verified/NotVerified/Failed/Off> Example: xStatus ICE Turn Discovermode *s ICE Turn Discovermode: "Verified" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 160: Logging Status
Value space of the result returned: <AACLD/G722/G7221/G711Mu/G711A/G729/G729AB/Opus> Example: xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol *s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol: AACLD ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 161: Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Audio Mute
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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 162: Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport Rtcp Local Ipaddress
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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 163: Xstatus Mediachannels Call [N] Incomingvideochannel [N] Video Protocol
Example: ** end xStatus MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX *s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 164 *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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 165 *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress: "192.168.136.130" *s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1 ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 166 *s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local ** end Port: 16405 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 167 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 168 *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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 169 *s MediaChannels Call 2 IncomingAudioChannel 127 Transport RTCP Remote *s MediaChannels Call 2 IncomingVideoChannel 127 Transport RTCP Local Protocol: UDP Protocol: UDP ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 170: Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport Rtp Local Protocol
*s MediaChannels Call 2 OutgoingAudioChannel 127 Transport RTCP Local Protocol: UDP *s MediaChannels Call 2 IncomingVideoChannel 127 Transport RTP Local Protocol: UDP ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 171: Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport Rtcp Remote Protocol
*s MediaChannels Call 2 OutgoingVideoChannel 127 Transport RTCP Local Protocol: UDP *s MediaChannels Call 2 OutgoingAudioChannel 127 Transport RTP Local Protocol: UDP ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 172: Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport Rtcp Remote Protocol
MediaChannels Call 2 OutgoingVideoChannel 127 Transport RTP Local Protocol *s MediaChannels Call 2 OutgoingVideoChannel 127 Transport RTP Local Protocol: UDP ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 173: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 174: Xstatus Network 1 Ipv4 Dhcp Tftpserveraddress
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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 175: 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 176: Xstatus Network 1 Cdp Portid
Returns the first network address of both receiving and sending devices. Value space of the result returned: <String> Example: xStatus Network CDP Address *s Network 1 CDP Address: "192.0.1.20" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 177 Discarded: The NTP result has been discarded. Value space of the result returned: <Unknown/Synced/Discarded> Example: xStatus NetworkServices NTP Status *s NetworkServices NTP Status: Synced ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 178 Peripherals ConnectedDevice [n] Status ** end Shows peripheral devices that are currently connected to the endpoint. Note: Does not apply for the Cisco PrecisionHD cameras. xStatus Peripherals ConnectedDevice [n] ID Value space of the result returned: Shows the MAC-address of the connected device.
Page 179 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 180 Shows the status of the previous software upgrade. Value space of the result returned: <None/InProgress/Failed/InstallationFailed/Succeeded> Example: xStatus Provisioning Software PreviousUpgrade Status *s Provisioning Software PreviousUpgrade Status: None ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 181: Xstatus Provisioning Software Previousupgrade Versionid
Shows the ID of the session for the software upgrade. Value space of the result returned: <String> Example: xStatus Provisioning Software UpgradeStatus SessionId *s Provisioning Software UpgradeStatus SessionId: "" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 182: Xstatus Provisioning Software Upgradestatus Message
*s Provisioning Software UpgradeStatus URL: "http:// .../s52000tc5 _ 1 _ 0.pkg" xStatus Provisioning Software Current URL ** end *s Provisioning Software Current URL: "http:// .../s52000tc5 _ 1 _ 0.pkg" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 183: Xstatus Provisioning Software Current Completedat
*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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 184: Xstatus Provisioning Cucm Capf Operationresult
Provisioning CUCM CTL State CAPFNullSessiondata/CAPFInvalidSession/CAPFNullParameters/CAPFNoStat/CAPFTimeout/ CAPFConnLost/CAPFAbort/CAPFKeyGenFailed/CAPFConnectFailed/CAPFFenceError/ *s Provisioning CUCM CTL State: Installed CAPFServerBusy/CAPFAuthRejected/CAPFInvalidParms/CAPFCancelled/CAPFFailed/ ** end CAPFSuccess/CAPFLSCUpdated> Example: xStatus Provisioning CUCM CAPF OperationResult SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 185: Xstatus Provisioning Cucm Itl State
Provisioning CUCM ExtensionMobility LastLoggedInUserId *s Provisioning CUCM TVS Proxy 1 Priority: 0 *s Provisioning CUCM ExtensionMobility LastLoggedInUserId: "User 1" ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 186: Xstatus Provisioning Cucm Phonebook Url
Shows whether call history logging is set to persistent or non-persistent mode. Persistent is the default mode. Value space of the result returned: <NonPersistent/Persistent> Example: xStatus Security Persistency CallHistory *s Security Persistency CallHistory: Persistent ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 187: 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: <NonPersistent/Persistent> Example: xStatus Security Persistency DHCP *s Security Persistency DHCP: Persistent ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 188 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 189 *s SIP Profile 1 Proxy 1 Status: Active <String> ** end Example: xStatus SIP Registration 1 URI *s SIP Registration 1 URI: "firstname.lastname@company.com" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 190 Shows whether or not the SSL certificate of the server that the video system / codec tries to ** end 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 191 *s SIP Profile 1 DirectoryURI Primary URI: "123456@company.com" ** end Example: xStatus SIP Profile 1 Registration 1 Status *s SIP Profile 1 Registration 1 Status: Registered ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 192 SystemUnit ProductPlatform Shows the product platform. Value space of the result returned: <String> Example: xStatus SystemUnit ProductPlatform *s SystemUnit ProductPlatform: "C90" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 193: Xstatus Systemunit Software Application
SystemUnit Software Name xStatus SystemUnit Software ReleaseKey *s SystemUnit Software Name: "s52010" *s SystemUnit Software ReleaseKey: "true" ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 194: Xstatus Systemunit Software Optionkeys Naturalpresenter
SystemUnit Software OptionKeys HighDefinition xStatus SystemUnit Hardware Module Identifier *s SystemUnit Software OptionKeys HighDefinition: "true" *s SystemUnit Hardware Module Identifier: "1" ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 195: Xstatus Systemunit Hardware Mainboard Serialnumber
The feedback shows the monitoring software id. Value space of the result returned: <String> Example: xStatus SystemUnit Hardware MonitoringSoftware *s SystemUnit Hardware MonitoringSoftware: "39" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 196: Xstatus Systemunit State System
** end Value space of the result returned: <0..5> Example: xStatus SystemUnit State MaxNumberOfActiveCalls *s SystemUnit State MaxNumberOfActiveCalls: 3 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 197: Xstatus Systemunit State Subsystem Application
*s SystemUnit Notifications Notification 1 Text: "OK" ** end Not registered to a protocol xStatus SystemUnit ContactName: "192.0.2.0" Example 2: Registered on SIP xStatus SystemUnit ContactName: "1234@192.0.2.0" SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 198: Xstatus Systemunit Diagnostics Lastrun
Value space of the result returned: <String> Example: xStatus SystemUnit Diagnostics Message References *s SystemUnit DiagnosticsResult Message 1 References: "" ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 199 *s Time SystemTime: "2014-04-25T10:04:03Z" ** end Value space of the result returned: <1..1> Example: xStatus Video Input LastConnectedSource *s Video Input LastConnectedSource: 0 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 200 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 201 *s Video Input DVI 2 Connected: False Example: ** end xStatus Video Input USB SignalState *s Video Input USB 3 SignalState: Unknown ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 202 Video Output HDMI 1 Resolution Width Shows the top level overview of the video output status. *s Video Output HDMI 1 Resolution Width: 1280 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 203 Video Output HDMI 1 Type *s Video Output HDMI 3 ConnectedDevice Name: "" *s Video Output HDMI 1 Type: HDMI ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 204 Video Output HDMI ConnectedDevice CEC PowerControl *s Video Layout PresentationView: "Default" *s Video Output HDMI 1 ConnectedDevice CEC 1 PowerControl: Ok ** end ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 205 Video Layout Site 1 Output 1 Frame 1 Height *s Video Layout Site 1 Output 1 Frame 1 Height: 10000 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 206 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 207 Video Layout Prediction Site [n] FrameContainer OutputRole [n] PositionY <Integer> For internal use only. Value space of the result returned: <Integer> SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 208 Video Selfview PIPPosition VideoSourceInstance *s Video Selfview PIPPosition: LowerRight For internal use only. ** end Value space of the result returned: <Integer> SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 209 Indicates which monitor is used for on-screen display output. Value space of the result returned: <Integer> Example: xStatus Video OSD Output *s Video OSD Output: 3 ** end SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 210 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 TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved.
Page 211: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 212: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 213: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 214: 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 215: The Systemtools Commands
The name of the certificate. systemtools authorizedkeys ? usage: authorizedkeys <add <method> <key> [comment] | delete <id> | list | clear> SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 216 Minimum number of numerical characters in passwords [0]? • Number of previous PINs that the new PIN must differ from. • Minimum number of numerical characters in passwords. SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 217: 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.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D14949.13...
Page 218 Tandberg ASA. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third- party trademarks mentioned are the property of their respective owners.

Cisco TelePresence SX20 Codec Reference Manual

What's in this Guide?

Description of the Xcommand Commands

Description of the Xstatus Commands

Quick Links

Chapters

Related Manuals for Cisco TelePresence SX20 Codec

Summary of Contents for Cisco TelePresence SX20 Codec

Table of Contents