Page 1 Introduction About the API xConfiguration xCommand xStatus Appendices Software version TC7.3 OCTOBER 2015 Application Programmer Interface (API) Reference Guide Cisco TelePresence SX80 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 2: Table Of Contents
Feedback expressions ............19 Terminal connections ............20 Audio commands ...............88 Bookings commands ............97 Boot commands ..............99 Call commands ..............99 CallHistory commands ............. 101 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 3 H320 status ..............173 H323 status ..............174 HttpFeedback status ............175 ICE status ................. 175 Logging status ..............178 MediaChannels status ............178 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 4: October
Cisco TelePresence SX80 API Reference Guide Contents Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 5: About This Guide
• Regulatory compliance and safety information guides • Licensing information for the TC software To download the user documentation go to: http://www.cisco.com/go/sx-docs Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 6: 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). Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 7: System Configuration Changes
OLD: <S: 0, 255> NEW: <S: 0, 1024> Phonebook Server [1..1] Type OLD: <VCS/TMS/Callway/CUCM> NEW: <VCS/TMS/CUCM> Provisioning Mode OLD: <Off/TMS/VCS/CallWay/CUCM/Auto/Edge> NEW: <Off/TMS/VCS/CUCM/Auto/Edge> Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 8: System Command Changes
ScreenShotId: 0 – 35 NEW: ScreenShotId: 0 – 50 UserInterface ScreenShot Remove OLD: ScreenShotId: 0 – 255 NEW: ScreenShotId: 0 – 50 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 9: System Status Changes
SipIceAndAnatConflict/TLSVerifyRequiredCerts/ H323GatekeeperStatus/HasValidReleaseKey/ RTCP Local Protocol TouchPanelConnection/TurnBandwidth/ IPv4Assignment/IPv6Assignment/IPv6Mtu/ UdpPortRangeViolation/ValidPasswords/ MediaChannels Call [n] OutgoingAudioChannel [n] Transport ISDNLinkCompatibility/ISDNLinkIpStack/ VideoFromInternalCamera/VideoInputStability/ RTCP Remote Protocol NTPStatus/NetSpeedAutoNegotiated/ TemperatureCheck> OSDVideoOutput/ProvisioningStatus/SIPEncryption/ Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 10: About The Api
Cisco TelePresence SX80 API Reference Guide Contents Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 11: Api Fundamentals
Telnet you have to enable it. Password You can connect a non-Cisco controller directly to an SX80 codec. Connect your device to the network port 2 or 3 with Initially, no password is set for the default admin user. We Codec configuration an Ethernet cable.
Page 12: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 13: Using The Command Line
Echo <on/off> Refer to ”Configurations” on page can be used for advanced troubleshooting together with Cisco technical support. Systemtools are not a part of the If echo is set to the key inputs are displayed when enter- programming API. Refer to ”The SystemTools commands”...
Page 14: Searching
*? xConfiguration Video SelfviewDefault PIPPosition: <Current/UpperLeft/UpperCenter/ XCOMMAND DIAL NUMBER: foo@bar.org UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight> *? xConfiguration Video Wallpaper: <None/Custom> DEPRECATED xcommand dial number: foo@bar.org xCommand Dial Number: foo@bar.org Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 15: Commands
‘:’. Section(r): <1..6> 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> Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 16: Configurations
*? xConfiguration Video SelfviewDefault Mode: <Off/Current/On> *? xConfiguration Video SelfviewDefault OnMonitorRole: <First/Second/Current/Third> *? xConfiguration Video SelfviewDefault PIPPosition: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/ CenterRight/LowerLeft/LowerRight> *? xConfiguration Video Wallpaper: <None/Custom> DEPRECATED Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 17: Status
*s Call 2 Protocol: “sip” *s Call 2 ReceiveCallRate: 6000 *s Call 2 RemoteNumber: “name@company.com” *s Call 2 TransmitCallRate: 4000 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 18: Events
** end *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 19: Feedback Mechanism
Video Input Connector 3 Name *c xConfiguration Video Input Connector 3 Name: “NameC” ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Connector[@item=’3’]/Name Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
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><DefaultVolume>80</ <CameraPositionSetResult item=”1” status=”OK”/> DefaultVolume></Audio><UserInterface><Wallpaper>C </Command> ustom</Wallpaper></UserInterface></Configuration> Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
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> Terminal </Configuration> xCommand Video Layout AssignCall CallId: 2 LayoutId: 1 <Command> <Video> <Layout> <AssignCall command=”True”> <CallId>2</CallId> <LayoutId>1</LayoutId> </AssignCall> </Layout> </Video> </Command> Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 24: Dos And Don'ts
Appendices Dos and don’ts Here are some best practices when programming the Cisco DO NOT use the experimental section in production C- and SX-series API. Under the listing of commands, status and configurations, you can find subsections that start with Experimental.
Page 25: Xconfiguration Commands
Cisco TelePresence SX80 API Reference Guide Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 26: Description Of The Xconfiguration Commands
Audio Output Line [1..6] Channel ..................34 xConfiguration Cameras Camera [1..7] Gamma Level ................39 xConfiguration Audio Output Line [1..6] Equalizer ID ..................34 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 27 Network [1..1] QoS Diffserv Data ..................51 xConfiguration FacilityService Service [1..5] CallType ................44 xConfiguration Network [1..1] QoS Diffserv Signalling ................51 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 28 RTP Ports Range Start .......................62 xConfiguration NetworkServices Medianet Metadata ................57 xConfiguration RTP Ports Range Stop .......................62 xConfiguration NetworkServices NTP Mode .....................57 xConfiguration NetworkServices NTP Address ..................57 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 29 Video AllowWebSnapshots ....................74 xConfiguration SIP Profile [1..1] Outbound ....................67 xConfiguration Video CamCtrlPip CallSetup Mode..................74 xConfiguration SIP Profile [1..1] Proxy [1..4] Address .................67 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 30 Video WallPaper ........................82 xConfiguration Video Layout Scaling ......................78 Experimental configuration ........................82 xConfiguration Video Layout ScaleToFrame ....................78 xConfiguration Video Layout ScaleToFrameThreshold ................78 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 31: Audio Configuration
Range: Select one of the video input sources. Example: xConfiguration Audio Input Line 1 Equalizer Mode: Off Example: xConfiguration Audio Input HDMI 3 VideoAssociation VideoInputSource: 1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 32 Left: The Audio Line input signal is the left channel of a stereo signal. Mono: The Audio Line input signal is a mono signal. Example: xConfiguration Audio Input 1 Channel: Left Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 33 On: Enable the microphone connector. Example: xConfiguration Audio Input Microphone 1 Equalizer Mode: Off Example: xConfiguration Audio Input Microphone 1 Mode: On Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 34 Left: The Audio Line output signal is the left channel of a stereo signal. Mono: The Audio Line output signal is a mono signal. Example: xConfiguration Audio Output Line 1 Channel: left Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 35 Requires user role: USER Value space: <S: 1, 100> Format: String with a maximum of 100 characters. Example: xConfiguration Audio SoundsAndAlerts RingTone: "Sunrise" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 36: Cameras Configuration
Auto option in the configuration. Requires user role: USER All Cisco Precision cameras support both anti-flickering and auto detection of line frequency. Auto Value space: <Auto/Off> is the default value, so you should change this setting if you have a camera that does not support auto detection.
Page 37 Cameras SpeakerTrack ConnectorDetection Mode xConfiguration Cameras SpeakerTrack Whiteboard Mode This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to the This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to the codec (video system).
Page 38 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 39 Example: xConfiguration Cameras Camera 1 Mirror: Auto xConfiguration Cameras Camera [1..7] MotorMoveDetection This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. If adjusting the camera position by hand you can configure whether the camera should keep its new position or return to the preset or position it had before.
Page 40: Conference Configuration
The active Off: The incoming call will not be muted. control feature is enabled by default, provided that it is supported by the infrastructure (Cisco On: The incoming call will be muted when automatically answered.
Page 41 Sip: All calls are set up as SIP calls. Example: xConfiguration Conference 1 FarEndControl Mode: On H320: All calls are set up as H.320 calls (only applicable if connected to a Cisco TelePresence ISDN Link gateway). xConfiguration Conference [1..1] FarEndControl SignalCapability Example: xConfiguration Conference 1 DefaultCall Protocol: Auto Set the far end control (H.224) signal capability mode.
Page 42 MaxReceiveCallRate setting. Requires user role: ADMIN Value space: <64..10000> Range: Select a value between 64 and 10000. Example: xConfiguration Conference 1 MaxTotalReceiveCallRate: 10000 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 43 (MCU). resolution for the presentation source. If registered to a Cisco Unified Communications Manager (CUCM) version 8.6.2 or newer, the video Requires user role: ADMIN system can use either the CUCM conference bridge, or the video system's built-in MultiSite feature.
Page 44: Facilityservice Configuration
Requires user role: ADMIN Value space: <S: 0, 1024> Format: String with a maximum of 1024 characters. Example: xConfiguration FacilityService Service 1 Name: "" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 45: Gpio Configuration
Requires user role: ADMIN Value space: <S: 0, 64> Format: A valid IPv4 address or IPv6 address. Example: xConfiguration H323 NAT Address: "" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 46 Gatekeeper for making H.323 calls and hence an IP address must be specified manually. Example: xConfiguration H323 Profile 1 Authentication Password: "" Example: xConfiguration H323 Profile 1 Gatekeeper Discovery: Manual Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 47 Requires user role: ADMIN Value space: <S: 0, 49> Format: String with a maximum of 49 characters. Example: xConfiguration H323 Profile 1 H323Alias ID: "firstname.lastname@company.com" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 48: Logging Configuration
Assignment is set to Static. Requires user role: ADMIN Value space: <S: 0, 64> Format: A valid IPv4 address. Example: xConfiguration Network 1 IPv4 Address: "192.0.2.2" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 49 DHCPv6 server. The Network IPv6 DHCPOptions setting deter- mines which method to use. Example: xConfiguration Network 1 IPv6 Assignment: Autoconf Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 50 Provisioning ExternalManager Address setting. Requires user role: ADMIN If the Network VLAN Voice Mode setting is Auto and the Cisco Discovery Protocol (CDP) assigns an Value space: <Off/Diffserv> ID to the voice VLAN, then a request for option 150 will always be sent. That is, the Network DHCP Off: No QoS method is used.
Page 51 0 (best effort). Example: xConfiguration Network 1 QoS Diffserv Data: 0 Example: xConfiguration Network 1 QoS Diffserv ICMPv6: 0 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 52 TLS connections. Only servers with a valid certificate will be allowed. Example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" Example: xConfiguration Network 1 IEEE8021X TlsVerify: Off Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 53 Set the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients Protocol that relies on a shared secret. Md5 is a Weak security. without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Requires user role: ADMIN Requires user role: ADMIN Value space: <Off/On>...
Page 54 2001:0db8:0000:0000:0000:ff00:0042:8329 2001:db8:abcd:0012::0/64" xConfiguration Network [1..1] VLAN Voice Mode Set the VLAN voice mode. The VLAN Voice Mode will be set to Auto automatically if you have Cisco UCM (Cisco Unified Communications Manager) as provisioning infrastructure. Note that Auto mode will NOT work if the NetworkServices CDP Mode setting is Off.
Page 55: Networkservices Configuration
NetworkServices CDP Mode Value space: <Off/On> 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 Off: Disable the possibility to place and receive SIP calls.
Page 56 Off: The HTTPS protocol is disabled. Example: xConfiguration NetworkServices HTTPS OCSP Mode: Off On: The HTTPS protocol is enabled. Example: xConfiguration NetworkServices HTTPS Mode: On Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 57 NetworkServices Medianet Metadata xConfiguration NetworkServices SNMP Mode Switch On or Off the capability to tag media flows with metadata related to the Cisco Medianet SNMP (Simple Network Management Protocol) is used in network management systems to monitor deployment.
Page 58 Requires user role: ADMIN to receive a response from the SNMP Agent in the codec. The default password is "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the same SNMP Value space: <Off/On> Community is configured there too. NOTE: The SNMP Community password is case sensitive.
Page 59: Peripherals Configuration
The default operation is that UPnP is enabled when you switch on or restart the video system. Then UPnP is automatically disabled after the timeout period that is defined in the NetworkServices UPnP In order to use Cisco Touch 10 (touch panel) as user interface for the video system, Touch 10 must Timeout setting.
Page 60: Phonebook Configuration
Example: xConfiguration Provisioning Connectivity: Auto Value space: <VCS/TMS/Callway/CUCM> xConfiguration Provisioning Mode VCS: Select VCS if the phonebook is located on the Cisco TelePresence Video Communication Server. It is possible to configure a video system using a provisioning system (external manager). This allows video conferencing network administrators to manage many video systems simultaneously.
Page 61 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 Password: "" (CUCM) and an alternate CUCM is available for redundancy. Enter the address of the alternate CUCM.
Page 62: Rtp Configuration
Requires user role: ADMIN Value space: <1120..65535> Range: Select a value between 1120 and 65535. Example: xConfiguration RTP Ports Range Stop: 2486 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 63: Security Configuration
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 64: Serialport Configuration
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 65: 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: <Off/On> Unified Communication Manager).
Page 66 Format: String with maximum 255 characters and compliant with the SIP URI syntax. network. Example: xConfiguration SIP Profile 1 URI: "sip:firstname.lastname@company.com" Example: xConfiguration SIP Profile Turn DropRflx: Off Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 67 Auto: The system will try to connect using transport protocols in the following order: TLS, TCP, UDP. Example: xConfiguration SIP Profile 1 DefaultTransport: Auto Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 68 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 69: Standby Configuration
DefaultCameraPosition: After a reboot the camera position will be set to the factory default position. Example: xConfiguration Standby BootAction: DefaultCameraPosition Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 70: Systemunit Configuration
Example: xConfiguration SystemUnit ContactInfo Type: Auto Off: Disable logging. On: Enable logging. xConfiguration SystemUnit IrSensor Example: xConfiguration SystemUnit CallLogging Mode: On Not applicable in this version. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 71: Time Configuration
Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/ Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/ Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/ Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 72 Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, PST8PDT, Pacific/Apia, Pacific/Auckland, Pacific/Chatham, Pacific/Chuuk, Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 73: Userinterface Configuration
Custom: Use the custom wallpaper as background image on the screen. If no custom wallpaper is uploaded to the system, the setting will revert to the default value. Example: xConfiguration UserInterface Wallpaper: None Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 74: Video Configuration
LocalDeviceOnly: Snapshots can only be captured and displayed on devices running the experi- xConfiguration UserInterface UserPreferences mental 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 integrations.
Page 75 IfSignal: When set to IfSignal, the menu selection for the video input connector will only be visible when something is connected to the video input. Example: xConfiguration Video Input Connector 2 Visibility: IfSignal Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 76 Rather high resolutions will be used. Example: xConfiguration Video Input Connector 1 OptimalDefinition Profile: Medium Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 77 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 LocalLayoutFamily: Auto Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 78 Requires user role: ADMIN Value space: <0..100> Range: Select a value between 0 and 100 percent. Example: xConfiguration Video Layout ScaleToFrameThreshold: 5 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 79 LowerRight: The presentation PiP will appear in the lower right corner of the screen. Example: xConfiguration Video PIP Presentation DefaultValue Position: Current Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 80 Example: xConfiguration Video SelfviewDefault OnMonitorRole: Current xConfiguration Video OSD LoginRequired This has been replaced with the UserInterface OSD LoginRequired setting. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 81 (16 - 235). This is defined in CEA-861-E. Example: xConfiguration Video Output Connector 2 Location HorizontalOffset: -1 Example: xConfiguration Video Output Connector 1 RGBQuantizatonRange: Full Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 82: Experimental Configuration
Video Output Connector [1..3] Resolution Set the resolution and refresh rate for the connected screen. The Experimental settings are for testing only and should not be used unless agreed with Cisco. Requires user role: ADMIN These settings are not documented and WILL change in later releases.
Page 83: Xcommand Commands
Cisco TelePresence SX80 API Reference Guide Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 84: Description Of The Xcommand Commands
Audio Volume Increase ......................96 xCommand CallHistory AcknowledgeMissedCall ..................101 xCommand Audio Volume Mute ........................ 96 xCommand CallHistory DeleteAll ......................101 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 85 Conference ActiveSpeaker Set ................... 108 xCommand Message Echo ........................115 xCommand Conference DoNotDisturb Activate ..................108 xCommand Message FarendMessage ....................115 xCommand Conference DoNotDisturb Deactivate ..................109 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 86 Preset Clear ..........................124 xCommand SystemUnit OptionKey Remove ....................129 xCommand Preset Store ..........................124 xCommand SystemUnit OptionKey RemoveAll ..................130 xCommand SystemUnit SoftwareUpgrade ....................130 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 87 Video Layout AssignLocalOutput ..................134 xCommand Video Selfview Set........................140 xCommand Video Layout AssignPresentation ..................134 xCommand Video Layout Frame Add ......................134 Experimental commands ........................141 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 88: Audio Commands
*r AudioEqualizerListResult Equalizer 1 Section 3 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 4 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 4 Frequency: "1000" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 89 Parameters: InputId: <0..65534> Name: <S: 0, 255> MixerMode: <Auto/Fixed/GainShared> AGC: <On/Off> Mute: <On/Off> Channels: <1..2> Example: xCommand Audio LocalInput Add InputId: 2 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 90 InputId: A unique identifier for the local input. Requires user role: ADMIN Parameters: InputId(r): <0..65534> Example: xCommand Audio LocalInput Remove InputID: 2 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 91 Audio LocalOutput Add OutputId: 47 Example: xCommand Audio LocalInput Update InputId: 2 Name: "Microphone" MixerMode: GainShared AGC: Off Mute: Off Channels: 1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 92 Audio LocalOutput Remove OutputId: 6 Off. Requires user role: ADMIN Parameters: OutputId(r): <0..65534> InputId(r): <0..65534> InputGain: <-54..15> Example: xCommand Audio LocalOutput ConnectInput OutputId:6 InputId:3 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 93 Name(r): <S: 0, 255> Loudspeaker(r): <On/Off> Channels(r): <1..2> VolumeControlled: <On/Off> Example: xCommand Audio LocalOutput Update OutputId: 5 Name: "Loudspeaker" Loudspeaker: On Channels: 2 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 94 Requires user role: ADMIN Requires user role: USER Parameters: Example: OutputId(r): <0..65534> xCommand Audio Microphones Unmute InputId(r): <0..65534> Example: xCommand Audio RemoteOutput DisconnectInput OutputId:10 InputId:8 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 95 Volume> RingTone(r): <S: 1, 100> Loop: <On/Off> Example: Example: xCommand Audio SoundsAndAlerts Ringtone Play RingTone: Sunrise xCommand Audio Sound Play Sound: Ringing Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 96 Set the volume on the endpoint to a specified level. Requires user role: USER Parameters: Level(r): <1..100> Example: xCommand Audio Volume Set Level:30 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 97: Bookings Commands
Audio VUMeter Stop ConnectorType: Microphone ConnectorId: 1 xCommand Audio VUMeter StopAll Stop collecting VU meter information for all connectors. Requires user role: USER Example: xCommand Audio VUMeter StopAll Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 98 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed *r Bookings Booking 1 BookingStatus: OK *r Bookings Booking 1 BookingStatusMessage: "" *r Bookings Booking 1 Webex Enabled: True Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 99: Boot Commands
CallId(r): <0..65534> Example: xCommand Call Disconnect CallId:17 xCommand Call DisconnectAll Disconnect all active calls. Requires user role: USER Example: xCommand Call DisconnectAll Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 100 Join all existing calls, active and on hold. xCommand Call UnattendedTransfer CallId: 2 Number: destination@example. Requires user role: USER Parameters: CallId(r): <0..65534> Example: xCommand Call Join CallId: 34 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 101: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 102 *r CallHistoryGetResult Entry 1 OccurrenceType: Received *r CallHistoryGetResult Entry 1 IsAcknowledged: Acknowledged *r CallHistoryGetResult ResultInfo Offset: 3 *r CallHistoryGetResult ResultInfo Limit: 65534 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 103: Camctrlpip Commands
Camera PositionReset Reset the camera position the the default position. Requires user role: USER Parameters: CameraId(r): <1..7> Example: xCommand Camera PositionReset CameraId:1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 104 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 105 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: "" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 106 Requires user role: USER Example: xCommand Camera ReconfigureCameraChain Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 107: Cameras Commands
WhiteboardId: The id set for the camera position used for the snap-to-whiteboard feature. Currently Auto (default). only id 1 can be used. This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera. Requires user role: ADMIN The SpeakerTrack 60 camera assembly consists of two cameras and uses an audio tracking Parameters: technique that finds and captures a close-up of the active speaker.
Page 108: Conference Commands
WhiteboardId:123 times out after 1440 minutes (24 hours). Requires user role: USER Parameters: Timeout: <0..1440> Example: xCommand Conference DoNotDisturb Activate Timeout: 120 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 109: Dial Commands
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 110: Dtmfsend Commands
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 111: Farendcontrol Commands
Requires user role: USER Parameters: CallId: <0..65534> PresetId(r): <0..15> Example: xCommand FarEndControl Preset Store CallId:3 PresetId:1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 112: Gpio Commands
SourceId(r): <0..15> Pin2: <High/Low> Example: Pin3: <High/Low> xCommand FarEndControl Source Select CallId:3 SourceId:1 Pin4: <High/Low> Example: xCommand GPIO ManualState Set Pin1: High Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 113: Httpfeedback Commands
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 114: Logging Commands
Text(r): <S: 0, 255> Duration: <0..3600> Example: xCommand Message Alert Display Title: "Message" Text: "The meeting will end in 5 minutes." Duration: 20 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 115 Do you want to extend the meeting?" Option.1: "No" Option.2: "Yes, extend with 5 minutes" Option.3: "Yes, extend with 10 minutes" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 116 Message TextLine Display Text: "The message to be displayed." Requires user role: ADMIN X:500 Y:2000 Duration: 20 Example: xCommand Message TextLine Clear Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 117: Peripherals Commands
Peripherals commands xCommand Peripherals List Lists all currently and previously connected peripherals. Note: Does not apply for the Cisco PrecisionHD cameras. xCommand Peripherals Connect Connected: Limit the search to currently connected devices. Register peripherals that are connected to the codec, such as control systems and touch panels.
Page 118 MacAddress: Enter the MAC address for the ISDN Link you wish to unpair from the endpoint. Requires user role: ADMIN Parameters: MacAddress(r): <S: 1, 100> Example: xCommand Peripherals Pairing Unpair MacAddress: 1.2.3.4 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 119: Phonebook Commands
You can add several contact methods to a contact using the xCommand Phonebook ContactMethod Parameters: 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 and on the web ContactId(r): <S: 0, 255> interface.
Page 120 You can add several contact methods to a contact. Note that only the first contact method will Phonebook Contact Add 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 delete. 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 121 CallRate: <0..6000> Parameters: CallType: <Audio/Video> FolderId(r): <S: 0, 255> Example: Example: xCommand Phonebook ContactMethod Modify ContactMethodId:117 xCommand Phonebook Folder Delete FolderId:localGroupId-3 ContactId:localContactId-10 Number:"newnumber@cisco.com" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 122 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: Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 123: Presentation Commands
*r ResultSet Contact 2 ContactMethod 2 Protocol: SIP Parameters: Instance: <1 / 2 / 3 / 4 / 5 / 6> Example: xCommand Presentation Stop Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 124: Preset Commands
PresetId: The ID of the preset you want to delete. Requires user role: USER Parameters: PresetId(r): <1..15> Example: xCommand Preset Clear PresetId:3 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 125: Provisioning Commands
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 126: Security Commands
The codec reboots to complete the software upgrade. Parameters: Confirm(r): <Yes> Requires user role: ADMIN Example: Example: xCommand Security FIPSMode Activate Confirm: "Yes" xCommand Provisioning StartUpgrade Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 127: Standby Commands
Persistent InternalLogging: Persistent LocalPhonebook: Persistent DHCP: Persistent ConfirmAndReboot: Yes Requires user role: USER Parameters: Delay(r): <1..480> Example: xCommand Standby ResetTimer Delay:10 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 128: Systemunit Commands
SystemUnit ConfigurationProfile List List configuration profiles that has been stored in the system. Requires user role: ADMIN Example: xCommand SystemUnit ConfigurationProfile List Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 129 TrailingAction: Select Shutdown or NoAction to override the default behavior (Restart). xCommand SystemUnit OptionKey Remove Type: PremiumResolution Requires user role: ADMIN Parameters: Confirm(r): <Yes> TrailingAction: <NoAction/Restart/Shutdown> Example: xCommand SystemUnit FactoryReset Confirm: Yes Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 130: Userinterface Commands
UserInterface ScreenShot Remove For internal use only. Requires user role: ADMIN Parameters: ScreenShotId(r): <S: 0-50> Example: xCommand UserInterface ScreenShot Remove ScreenShotId:5 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 131: Usermanagement Commands
Disable the creation of new remote support users. To enable the remote support user again you must factory reset your system. Requires user role: ADMIN Parameters: Confirm(r): <Yes> Example: xCommand UserManagement RemoteSupportUser DisablePermanently Confirm: Yes Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 132: Video Commands
ID: xStatus Video Input Source. Requires user role: USER Parameters: ConnectorId: <1..5> SourceId: <1..4> Example: xCommand Video Input SetMainVideoSource ConnectorId: 1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 133 During the call you can run the xStatus Call command to see the CallId. Requires user role: ADMIN Parameters: LayoutId(r): <1..2147483647> CallId: <0..65534> Example: xCommand Video Layout AssignCall LayoutId:2 CallId:1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 134 If the VideoSourceType is set to RemoteMain the VideoSourceId is the CallId of the remote site. If the VideoSourceType is set to LocalInput the VideoSourceId is the video input SourceId. Otherwise set to 1. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 135 Add' for a specific layout identified by 'LayoutId' Requires user role: ADMIN Parameters: LayoutId: <1..2147483647> Example: xCommand Video Layout Frame List LayoutId: 1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 136 If the VideoSourceType is set to RemoteMain the VideoSourceId is the CallId of the remote site. If the VideoSourceType is set to LocalInput the VideoSourceId is the video input SourceId. Otherwise set to 1. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 137 Loads and starts using the specified video layout database. The default video layout database Reset all layout compositions to factory default. is initially provided by the system. The custom database is generated by the Cisco TC Console Requires user role: ADMIN tool and is made available to the codec from within the TC Console tool.
Page 138 Remove the defined video layout, and go back to default. Parameters: Requires user role: ADMIN Output: <1 – 2> Example: Example: xCommand Video Layout UnAssignPresentation xCommand Video Matrix Reset Output:1 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 139 Element: The on–screen menu. xCommand Video PIP Presentation Set Position: LowerLeft Requires user role: ADMIN Parameters: Element(r): <Menu> Example: xCommand Video OSD Close Element: Menu Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 140 Requires user role: ADMIN Parameters: Example 2 Position(r): <LowerCenter/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight> xCommand Video Selfview Set FullscreenMode: On OnMonitorRole: Second Example: xCommand Video PreviewFilmstrip Set Position: LowerCenter Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 141: Experimental Commands
Appendices Experimental commands The Experimental commands are for testing only and should not be used unless agreed with Cisco. These commands are not documented and WILL change in later releases. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved.
Page 142: Xstatus Commands
Cisco TelePresence SX80 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 143: Description Of The Xstatus Commands
Call [n] Protocol ...........................154 xStatus Camera [n] Position Tilt ........................158 xStatus Call [n] CallType ...........................155 xStatus Camera [n] Position Zoom ......................159 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 144 Diagnostics Call [n] Channels OutgoingDataChannel [n] Netstat 1 Packets .......168 xStatus Conference Site [n] Manufacturer ....................164 xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 Loss........169 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 145 Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 MaxJitter ......172 xStatus ICE Call Local Candidate ......................176 xStatus Diagnostics Call [n] Channels IncomingDataChannel [n] Netstat 1 MaxJitter ......172 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 146 MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTCP Local Protocol ....189 xStatus MediaChannels Call [n] OutgoingAudioChannel [n] Encryption Status ........183 xStatus MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTCP Remote Protocol ....190 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 147 NetworkServices NTP CurrentAddress ..................195 xStatus Provisioning Software Current CompletedAt ................201 xStatus NetworkServices NTP Status ......................195 xStatus Provisioning CUCM CAPF Mode ....................201 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 148 SIP Profile 1 CallForward Mode ....................207 xStatus SystemUnit State NumberOfActiveCalls ..................212 xStatus SIP Profile 1 CallForward URI ......................207 xStatus SystemUnit State NumberOfSuspendedCalls ................212 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 149 Video Layout Prediction Site [n] Family[n] OutputRole [n] Frame[n] ParticipantId ..... 223 xStatus Video Output ..........................218 xStatus Video Layout Prediction Site [n] Family [n] OutputRole [n] Frame[n] VideoSourceInstance ..223 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 150 Video OSD Mode.........................225 xStatus Video Selfview PIPPosition ......................224 Experimental status ..........................225 xStatus Video Selfview OnMonitorRole ....................224 xStatus Video PIP ActiveSpeaker Position ....................224 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 151: Audio Status
Audio Input LocalInput 1 Mute xStatus Audio VolumeMute *s Audio Input LocalInput 1 Mute: "Off" *s Audio VolumeMute: Off ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 152: Xstatus Audio Input Localinput [N] Channels
Audio Input LocalInput 1 Connector *s Audio Output LocalOutput 4 Name: "MyLocalOutput1" *s Audio Input LocalInput 1 Connector: "Microphone.1" ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 153: Xstatus Audio Output Localoutput [N] Loudspeaker
Audio Output LocalOutput 4 Connector *s Audio Output RemoteOutput 9 CallId: 28 *s Audio Output LocalOutput 4 Connector: "Line.1" ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 154: Xstatus Audio Output Remoteoutput [N] Input [N] Gain
Value space of the result returned: <String> Example: xStatus Call 27 Protocol *s Call 27 Protocol: "h323" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 155: Xstatus Call [N] Remotenumber
Call 27 CallbackNumber xStatus Call 27 ReceiveCallRate *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" *s Call 27 ReceiveCallRate: 4000 ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 156: Xstatus Call [N] Facilityserviceid
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 157: Xstatus Call [N] Devicetype
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 158: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 159: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 160: Cameras Status
** end Value space of the result returned: <0/1/2/3> Example: xStatus Cameras SpeakerTrack RightCamera VideoInputConnector *s Cameras SpeakerTrack RightCamera VideoInputConnector: 0 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 161: Xstatus Cameras Speakertrack Whiteboard [N] Camera [N] Tilt
*s Cameras SpeakerTrack Whiteboard 1 Distance: -1 <0..3000> ** end Example: xStatus Conference Presentation Resolution Height *s Conference Presentation Resolution Height: 0 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 162: Xstatus Conference Presentation Resolution Width
Value space of the result returned: <Off/LocalRemote/LocalOnly> Example: xStatus Conference Presentation LocalSendingMode *s Conference Presentation LocalSendingMode: Off ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 163: Xstatus Conference Site [N] Capabilities Fecc Numberofpresets
Conference Site 2 Capabilities FECC Source 1 Name *s Conference Site 2 Capabilities FECC Source 1 Name: "Main camera" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 164: Xstatus Conference Site [N] Softwareid
Conference Site [n] BlackScreenCause Lists the audio mute status 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 165: Xstatus Conference Site [N] Bookingid
Conference Site UnattendedTransfer Example: *s Conference Site 14 UnattendedTransfer: True xStatus Conference Site CalText ** end *s Conference Site 14 CalText: "" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 166: Xstatus Conference Site [N] Hold
Value space of the result returned: <Idle/Private/Trying/Progressing/Alerting/Active/Held/HeldPrivate/Unknown> Example: xStatus Conference Line 1 Appearance Status *s Conference Line 1 Appearance 5464 Status: Held ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 167: Xstatus Conference Donotdisturb
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 168: Diagnostics Status
Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter: ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 169: Xstatus Diagnostics Call [N] Channels Incomingaudiochannel [N] Netstat 1 Loss
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Loss: 96 *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost: 0 ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 170 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived: 84 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 171 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes: *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 129920 ChannelRate: 128000 ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 172: Gpio Status
Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter: 0 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 173: H320 Status
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 174: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 175: Httpfeedback Status
Returns the IP address of the TURN server that is currently in use. Value space of the result returned: <String> Example: xStatus ICE Turn IP *s ICE Turn IP: "192.0.1.20" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 176: Xstatus Ice Call Local Ip
Value space of the result returned: <String> Example: xStatus ICE Call Local IP *s ICE Call 1 Local IP: “192.0.1.20” ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 177: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 178: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 179: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 180: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 181: Xstatus Mediachannels Call [N] Incomingvideochannel [N] Video Protocol
MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX Port: 16404 *s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768 ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 182: Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport Rtp Remote Ipaddress
*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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 183: Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Audio Protocol
*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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 184: Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport Rtp Remote Port
*s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local ** end Port: 16405 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 185: Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Channelrole
Example: ** end xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate *s MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate: 30 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 186: Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport Rtp Local Port
*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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 187: Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport Rctp Remote Port
*s MediaChannels Call 2 IncomingAudioChannel 127 Transport RTCP Remote *s MediaChannels Call 2 IncomingVideoChannel 127 Transport RTCP Local Protocol: UDP Protocol: UDP ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 188: Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport Rtcp Remote 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 189: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 190: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 191: Network Status
*s Network 1 IPv4 DHCP TftpServerAddress: "192.0.2.0" <String> ** end Example: xStatus Network 1 IPv4 Address *s Network 1 IPv4 Address: "192.0.2.149" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 192: Xstatus Network 1 Ipv4 Dhcp Tmsserver
*s Network 1 IPv6 Gateway: "" ** end xStatus Network 1 IPv4 DHCP ProvisioningDomain *s Network 1 IPv4 DHCP ProvisioningDomain: "1234@company.com" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 193: Xstatus Network 1 Vlan Voice Vlanid
Example: Example: xStatus Network CDP Version xStatus Network CDP PortID *s Network 1 CDP Version: "Cisco IOS Software, C3750E Software (C3750E- UNIVERSALK9-M), Version 15.0(1)SE2, RELEASE SOFTWARE (fc3)*Technical *s Network 1 CDP PortID: "GigabitEthernet1/0/23" Support: http://www.cisco.com/techsupport*Copyright (c) 1986-2011 by Cisco ** end Systems, Inc.*Compiled Thu 22-Dec-11 00:05 by prod _ rel _ team"...
Page 194: Xstatus Network 1 Cdp Duplex
Network CDP Address xStatus Network CDP SysObjectID *s Network 1 CDP Address: "192.0.1.20" *s Network 1 CDP SysObjectID: "" ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 195: Xstatus Network 1 Cdp Voipappliancevlanid
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 196: Peripherals Status
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 197: Xstatus Peripherals Connecteddevice [N] Upgradestatus
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 198: Provisioning Status
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 199: Xstatus Provisioning Software Previousupgrade Message
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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 200: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 201: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 202: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 203: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 204: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 205: 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 Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 206: Sip Status
Timeout: The attempt to establish communication to the SIP Proxy timed out. ter 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 207: Xstatus Sip Profile 1 Callforward Displayname
Value space of the result returned: ** end <String> Example: xStatus SIP Profile 1 CallForward DisplayName *s SIP Profile 1 CallForward DisplayName: "" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 208: Xstatus Sip Profile 1 Directoryuri Primary Uri
SIP Profile DirectoryURI Primary URI *s SIP Profile 1 DirectoryURI Primary URI: "123456@company.com" xStatus Standby Active ** end *s Standby Active: Off ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 209: Systemunit Status
Value space of the result returned: *s SystemUnit ProductPlatform: "C90" <String> ** end Example: xStatus SystemUnit Software Name *s SystemUnit Software Name: "s52000" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 210: Xstatus Systemunit Software Releasedate
SystemUnit Software OptionKeys MultiSite xStatus SystemUnit Hardware Module SerialNumber *s SystemUnit Software OptionKeys MultiSite: "true" *s SystemUnit Hardware Module SerialNumber: "FTT123456A1" ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 211: Xstatus Systemunit Hardware Module Compatibilitylevel
SystemUnit Hardware Module CompatibilityLevel xStatus SystemUnit Hardware MonitoringSoftware The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The The feedback shows the monitoring software id. endpoints running TC software are manufactured with a new version of the flash memory. Endpoints Value space of the result returned: having the new version of the flash memory must run software TC4.2.1 or later.
Page 212: Xstatus Systemunit Hardware Udi
*s SystemUnit State MaxNumberOfCalls: 3 Value space of the result returned: ** end <0..5> Example: xStatus SystemUnit State NumberOfInProgressCalls *s SystemUnit State NumberOfInProgressCalls: 0 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 213: 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" Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 214: Xstatus Systemunit Diagnostics Lastrun
Value space of the result returned: <String> Example: xStatus SystemUnit Diagnostics Message References *s SystemUnit DiagnosticsResult Message 1 References: "" ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 215: Time Status
Example: Example: xStatus UserInterface OSD Mode xStatus Time SystemTime *s UserInterface OSD Mode: Indicators *s Time SystemTime: "2014-04-25T10:04:03Z" ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 216: Video Status
Video Input Connector 1 Type *s Video Input Connector 1 Connected: True *s Video Input Connector 1 Type: HDMI ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 217: Xstatus Video Input Lastconnectedsource
Video Input Source 1 Resolution FormatStatus *s Video Input Source 1 Resolution Height: 1080 *s Video Input Source 1 Resolution FormatStatus: Ok ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 218: Xstatus Video Output Connector [N] Connected
Value space of the result returned: <176..4000> Example: xStatus Video Output Connector 1 Resolution Width *s Video Output Connector 1 Resolution Width: 1920 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 219: Xstatus Video Output Connector [N] Resolution Refreshrate
*s Video Output DVI 2 ConnectedDevice Name: "" *s Video Output HDMI 1 ConnectedDevice PreferredFormat: "" *s Video Output DVI 4 ConnectedDevice Name: "" ** end ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 220: Xstatus Video Output Hdmi Connecteddevice Cec Devicetype
<Unknown/Ok/In progress/Failed to power on/Failed to standby> Example: xStatus Video Output HDMI ConnectedDevice CEC PowerStatus *s Video Output HDMI 1 ConnectedDevice CEC 1 PowerStatus: Standby ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 221: Xstatus Video Layout Site [N] Output [N] Fullfamilyname
Video Layout Site 1 Output 1 Frame 1 Layer *s Video Layout Site 1 Output 1 Frame 1 Layer: 1 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 222: Xstatus Video Layout Site [N] Output [N] Frame [N] Mediachannelid
Video Layout Site 1 Output 1 Frame 1 VideoSourceId *s Video Layout Site 1 Output 1 Frame 1 VideoSourceId: 1 ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 223: Xstatus Video Layout Site [N] Output [N] Frame [N] Videosourcecontent
Video Layout Prediction Site [n] Family [n] OutputRole [n] Frame[n] <Integer> VideoSourceInstance For internal use only. Value space of the result returned: <Integer> Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 224 Video OSD Output Example: This status is replaced with xStatus UserInterface OSD Output. xStatus Video Selfview PIPPosition *s Video Selfview PIPPosition: LowerRight ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 225: Experimental Status
Video OSD Mode Deprecated; xStatus Video OSD Mode. 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 226: Appendices
Cisco TelePresence SX80 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 227: About Startup Scripts
Use the web interface of the codec to create and manage startup scripts. Read more about the web interface and startup scripts in the Administrator guide for your product. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 228: The Systemtools Commands
<add <method> <key> systemtools securitysettings isjitc [comment] | delete <id> | list | clear> Check if the current settings are JTIC compiant. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 229 Minimum number of character groups in passwords [0]? • The user can only change password once within this limit. • Minimum number of character groups in passwords. Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 230: About Disconnect Cause Types
DisconnectEvent *e CallDisconnect CauseValue: 1 CauseType: “LocalDisconnect” CauseString: “” OrigCallDirection: “outgoing” RemoteURI: “firstname.lastname@company.com” CallId: 89 CauseCode: 0 CauseOrigin: SIP ** end Codec SX80 API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. D15107.05...
Page 231 Tandberg ASA. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company.

Cisco TelePresence SX80 Reference Manual

What's in this Guide?

Description of the Xstatus Commands

Quick Links

Chapters

Related Manuals for Cisco TelePresence SX80

Summary of Contents for Cisco TelePresence SX80