Page 1 About the API xConfiguration xCommand xStatus Appendices Software version TC5.0 November 2011 Application Programmer Interface (API) Reference Guide Cisco TelePresence System Codec C90 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 2: Table Of Contents
Description of the xStatus commands Special commands ............14 Description of the xStatus commands ......113 Feedback type command ...........14 Preferences type command ........14 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 3 Remote control key map ..........173 Overview of the xConfiguration commands.....174 Overview of the xCommand commands ......178 Overview of the xStatus commands ........181 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 4 API Reference Guide Cisco TelePresence System Codec C90 Contents Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 5: User Documentation
Appendices About this guide User documentation The user documentation for the Cisco TelePresence systems, This guide will introduce you to the Application Programmer running the TC software, have several guides suitable to Interface (API) for the TC software in general, and serve as various user groups.
Page 6: What's New In This Version
Support for native CUCM registration Web interface enhancements Software release notes With TC5 the video systems are able to register to the Cisco New call application with support for: • Unified Communications Manager (CUCM) version 8.6 as a Making calls and start/stop presentation For a complete overview of the news and changes, we native Cisco device.
Page 7: Xconfiguration Changes
Security FIPS Mode xStatus SystemUnit Hardware Module CompatibilityLevel xStatus SystemUnit Hardware MonitoringSoftware xStatus SystemUnit Hardware Monitoring Fan [1..n] Status xStatus SystemUnit Hardware Temperature D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 8: November
Cisco TelePresence System Codec C90 Contents Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 9: About The Api About The Api
(r) used Telnet Mode: On to indicate required parameters in the Commands tables. Information flowing to target. This we call WRITE information (W). D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 10: Addressing Using Xpath Or Simplepath
Addressing Using XPath or SimplePath Feedback To address information in the hierarchic structure of Status Feedback is an extremely powerful feature where the Cisco and Configuration information, the Cisco systems support system actively returns updated status and configuration abbreviated XML Path Language (XPath) and a proprietary information to the user/control application whenever changes notation called SimplePath (only available using XACLI).
Page 11: Connecting To The Codec
The configuration command for the baud rate is: xConfiguration SerialPort BaudRate: <9600/19200/38400/57600/115200> • xConfiguration SerialPort BaudRate: 38400 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 12: Value Types And Formats
Defines that the input must be an IPv4 or IPv6 address with minimum length x and maximum length y. <IPv4v6Addr: 0, 43> * Not supported in this version D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 13: User Commands
If echo is set to Off no user input is displayed when entering text in a command line interface. The oher commands The other user commands are described in the following pages. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 14: Main Type Of Commands
Codec C–Series very simple. More on this can be found in xfeedback. More on this can be found in xpreferences. xFeedback xPreferences xEvent D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 15: About Xconfiguration
Addresses the specific microphone. On: Turns the microphone On. Off: Connected but unused inputs should be set to Off to prevent audio/noise from the inputs. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 16: Xconfiguration Operations
Gatekeeper Discovery: Auto Writes this value to the setting defined by xConfiguration H323 Profile 1 Gatekeeper Discovery: Auto the path. ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 17: About Xcommand
*h xCommand Audio Vumeter Start ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8> *h xCommand Audio Vumeter Stop ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8> *h xCommand Audio Setup Clear D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 18: Xcommand Operations
XACLI Status format. The XML status format is also supported. *r/end You can read more about XML in the xPreferences section. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 19: About Xstatus Commands
Return result parameters The following operation can be performed on xStatus commands: xStatus Read • is used when returning the result of xStatus read query D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 20: Quering Status Information
*s Call 3 Duration: 9 ** end Example 2: Query the protocol for a call: xstatus call protocol *s Call 3 Protocol: “h323” D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 21: About Xhistory
*h xHistory CallLogs Outgoing 29 Counter: 1 *h xHistory CallLogs Outgoing 30 Counter: 1 *h xHistory CallLogs Missed 50 Counter: 2 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 22: About Xevent
*es Event IncomingCallIndication DisplayNameValue *es Event IncomingCallIndication CallId ** end xfeedback register event/incomingcallindication ** end *e IncomingCallIndication RemoteURI: “h323:559216” DisplayNameValue: “firstname.lastname@company.com” CallId: 11 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 23: About Xfeedback
Status/Audio systems are able to handle. xFeedback register Configuration/Video xFeedback register Event xFeedback list xFeedback deregister Event xFeedback list D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 24: About Xpreferences
XML. NOTE! This mode is to be considered experimental in version 1 of the software. Its format WILL change in next version. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 25: The Systemtools Commands
To get back the root user the system must be reset to factory defaults, ref. xCommand SystemUnit FactoryReset. systemtools pairing unpair Remove association with Cisco TelePresence Touch controller. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 26 Maximum number of digits in PINs [0]? • Maximum number of simultaneous sessions per user. • Maximum number of digits in PINs. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 27: Xml Api Service
XML API service getxml TXAS is a service provided by Cisco units for transmitting and /getxml request returns an XML document based on the location parameter passed to the request. The elements (or complete receiving (transceiving) information encoded in XML format.
Page 28 Cisco TelePresence System Codec C90 Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 Description of the xConfiguration commands D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 29: The Audio Configuration
Requires user role: ADMIN Value space: <1/2/3/4/5> Range: Select one of the video input sources. Example: xConfiguration Audio Input HDMI 3 VideoAssociation VideoInputSource: 1 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 30: Xconfiguration Audio Input Line [1
Value space: <On/Off> On: Enable the Audio Line input. Off: Disable the Audio Line input. xConfiguration Audio Input Line 1 Mode: On Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 31: Xconfiguration Audio Input Microphone [1
Audio Input Microphone 1 Level: 15 Value space: <1..17> Range: Select Equalizer ID 1 to 17. Example: xConfiguration Audio Input Microphone 1 Equalizer ID: 1 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 32: Xconfiguration Audio Input Microphone [1
On: Enable the audio channel on the HDMI output. Example: Off: Disable the audio channel on the HDMI output. xConfiguration Audio Output HDMI 1 Mode: On Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 33: Xconfiguration Audio Microphones Mute Enabled
Audio Output Line [1, 3] Type xConfiguration Audio SoundsAndAlerts RingTone Determine if the Audio Line output will be analog or digital type output. The digital output on the Cisco Select the ring tone for incoming calls. TelePresence Profile systems are identified as DNAM (Digital Natural Audio Module).
Page 34: The Cameras Configuration
Gamma describes the nonlinear relationship between image pixels and monitor Value space: <Auto/Manual> brightness. The Cisco TelePresence PrecisionHD 720p camera supports gamma mode. The Auto: The camera brightness is automatically set by the system. PrecisionHD 1080p camera does not support gamma mode.
Page 35: Xconfiguration Cameras Camera [1
Cameras Camera 1 Gamma Level: 0 Example: xConfiguration Cameras Camera [1..7] DHCP Applies to cameras which supports DHCP. The Cisco TelePresence PrecsisionHD 1080p camera xConfiguration Cameras Camera [1..7] IrSensor supports DHCP. The camera must be connected to a LAN. When set, the command enables support The IR sensor LED is located in the front of the camera and flickers when the IR sensor is activated for SW upgrade of daisy chained cameras.
Page 36: The Conference Configuration
On: Un-mute the microphones after the call is disconnected. Off: If muted, let the microphones remain muted after the call is disconnected. Example: xConfiguration Conference 1 MicUnmuteOnDisconnect Mode: On D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 37: Xconfiguration Conference [1
Range: Select a value between 64 and 6000 kbps. Example: xConfiguration Conference 1 VideoBandwidth PresentationChannel Weight: Example: xConfiguration Conference 1 MaxTransmitCallRate: 6000 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 38: Xconfiguration Conference [1
Deny: The system will not accept incoming calls when you are in a call. The calling side will receive a busy signal. xConfiguration Conference 1 IncomingMultisiteCall Mode: Allow Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 39: The H323 Configuration
Off: If the H.323 Gatekeeper Authentication Mode is set to Off the system will not try to authenticate itself to a H.323 Gatekeeper, but will still try a normal registration. xConfiguration H323 Profile 1 Authentication Mode: Off Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 40: Xconfiguration H323 Profile [1
Value space: <S: 0, 49> Format: String with a maximum of 49 characters Example: xConfiguration H323 Profile 1 H323Alias ID: "firstname.surname@company. com" D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 41: The Network Configuration
IPv6: IP version 6 is supported. The IPv4 settings (IP Address, IP Subnet Mask and Gateway) will be disabled. Example: xConfiguration Network 1 IPStack: IPv4 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 42: Xconfiguration Network [1
Diffserv: When you set the QoS Mode to Diffserv you must configure the Diffserv sub menu settings (Audio, Data, Signalling and Video). Example: xConfiguration Network 1 QoS Mode: diffserv D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 43: Xconfiguration Network [1
Format: String with a maximum of 64 characters. Example: xConfiguration xConfiguration Network 1 IEEE8021X TlsVerify: Off Example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 44: Xconfiguration Network [1
Network [1..1] RemoteAccess Allow Filter IP addresses for access to ssh/telnet/HTTP/HTTPS. Set the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Requires user role: ADMIN...
Page 45: The Networkport Configuration
Set the VLAN voice mode. Requires user role: ADMIN xConfiguration NetworkPort [2] Mode Define if the network port 2 shall be enabled for direct pairing with the Cisco TelePresence Touch for Value space: <Auto/Manual/Off> C Series. Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. If CDP is not available, VLAN is not enabled.
Page 46: The Networkservices Configuration
Off: Disable the possibility to place and receive H.323 calls. Off: Do not verify client certificates. xConfiguration NetworkServices H323 Mode: On Example: Example: xConfiguration NetworkServices HTTPS VerifyClientCertificate: Off D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 47: Xconfiguration Networkservices Https Ocsp Mode
ADMIN Value space: <S: 0, 64> Format: String with a maximum of 64 characters. Example: xConfiguration NetworkServices SNMP Host 1 Address: "" D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 48: Xconfiguration Networkservices Snmp Communityname
Requires user role: ADMIN 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 Community is Value space: <On/Off>...
Page 49: The Phonebook Configuration
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 the codec (video system) using a provisioning system / an external manager. This allows video conferencing network administrators to manage many video systems TMS: Select TMS if the phonebook is located on the Cisco TelePresence Management Suite simultaneously.
Page 50: Xconfiguration Provisioning Externalmanager Address
Format: A valid IP address format or DNS name; a compact string with a maximum of 64 characters. xConfiguration Provisioning ExternalManager Address: "" Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 51: The Rtp Configuration
Ignore: The system will continue its normal operation, and rotate internal logs when full. When connection is restored it will again send its audit logs to the syslog server. Example: xConfiguration Security Audit OnError Action: Ignore D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 52: Xconfiguration Security Audit Logging Mode
Range: Select a value from 0 to 10000 seconds. 0 means that inactivity will not enforce automatically logout. xConfiguration Security Session InactivityTimeout: 0 Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 53: The Sip Configuration
SIP Profile 1 Outbound: Off Format: String with a maximum of 128 characters. Example: Example: xConfiguration SIP Profile 1 Authentication 1 Password: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 54: Xconfiguration Sip Profile [1
<Standard/Alcatel/Avaya/Cisco/Microsoft/Nortel> Value space: <None/Preset1/Preset2/Preset3/Preset4/Preset5/Preset6/Preset7/ Preset8/Preset9/Preset10/Preset11/Preset12/Preset13/Preset14/Preset15/ Standard: To be used when registering to standard SIP Proxy (tested with Cisco TelePresence RestoreCameraPosition/DefaultCameraPosition> VCS and Broadsoft) None: No action. Alcatel: To be used when registering to Alcatel-Lucent OmniPCX Enterprise. NOTE: This mode is not fully supported.
Page 55: Xconfiguration Standby Standbyaction
SipUri: Shows the SIP URI as the contact information. SystemName: Shows the system name as the contact information. Example: xConfiguration SystemUnit ContactInfo Type: Auto D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 56: Xconfiguration Systemunit Calllogging Mode
Range: Select a time zone from the list time zones. If using a command line interface; watch up for typos. Example: xConfiguration Time Zone: "GMT (Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London)" D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 57: The Userinterface Configuration
MM_DD_YY: The date January 30th 2010 will be displayed: 01.30.10 YY_MM_DD: The date January 30th 2010 will be displayed: 10.01.30 Example: xConfiguration Time DateFormat: DD _ MM _ YY D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 58: The Video Configuration
HDSDI: Select HD-SDI when you want to use the HD-SDI 3 as input source 3. xConfiguration Video Input Source 1 CameraControl Mode: On Example: xConfiguration Video Input Source 3 Connector: DVI Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 59: Xconfiguration Video Defaultpresentationsource
768 kbit/s 1152 kbit/s 1920 kbit/s xConfiguration Video DefaultPresentationSource: 3 Example: High 128 kbit/s 256 kbit/s 512 kbit/s 768 kbit/s 1152 kbit/s D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 60: Xconfiguration Video Input Dvi [3, 5] Type
LowerRight: The selfview PiP will appear in the lower right corner of the screen. CenterRight: The selfview PiP will appear in to the right side of the screen, in center. Example: xConfiguration Video SelfviewPosition: LowerRight D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 61: Xconfiguration Video Layout Locallayoutfamily
This setting can be used to display the systems bookings for today on the main OSD menu. This Define which video input source shall be used as the main video source. requires that the system is bookable by an external booking system, like Cisco TelePresence Management Suite (TMS).
Page 62: Xconfiguration Video Allowwebsnapshots
Value space: Latin: Latin characters can be entered when using the remote control (default). Cyrillic: Cyrillic characters can be entered using the remote control. NOTE: Requires a Cisco TelePresence Remote Control with Cyrillic fonts. xConfiguration Video OSD InputMethod InputLanguage: Latin Example: D14641.06...
Page 63: Xconfiguration Video Output Dvi [2, 4] Monitorrole
None: The system will use all of the output resolution. xConfiguration Video Output DVI 2 OverscanLevel: None Example: xConfiguration Video Output HDMI 1 OverscanLevel: None Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 64: Xconfiguration Video Output Composite [5] Monitorrole
High: The system will not use the outer 6% of the output resolution None: The system will use all of the output resolution. xConfiguration Video Output Composite 5 OverscanLevel: None Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 65: The Experimental Configuration
Mono: The microphone signal is a mono signal. Example: xConfiguration Experimental Audio Panning MonitorRight: 1 Example: xConfiguration Experimental Audio Input Microphone 1 Channel: Mono D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 66: Xconfiguration Experimental Audio Microphonereinforcement Agc
NOTE: The Experimental settings can be used 'as is' and will not be further documented. The Experimental settings WILL change. NOTE: Applies to Cisco TelePresence T1/T3. This settings can be configured from the command line xConfiguration Experimental Audio MicrophoneReinforcement Input Microphone [1..8] interface, and not from the menu.
Page 67: Xconfiguration Experimental Brightnessgradient Camera [1..7] Level
Experimental settings WILL change. Experimental settings WILL change. NOTE: Applies to Cisco TelePresence T1/T3. This settings can be configured from the command Will use the a RateAdaption algorithm adapted to the PacketLossResilience mechanism. Default value line interface, and not from the menu. Set the camera brightness gradient level to control the row is On.
Page 68: Xconfiguration Experimental Ctmssupport Mode
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change. Experimental settings WILL change. This configuration tells whether CTMS (Cisco TelePresence Multipoint Switch) is supported or not. Requires user role: ADMIN...
Page 69: Xconfiguration Experimental Systemunit Controller Address
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change. ADMIN Requires user role: <S: 0, 255> Value space: xConfiguration Experimental SystemUnit Controller Address: "" Example: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 70 Cisco TelePresence System Codec C90 Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 Description of the xCommand commands D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 71: The Audio Commands
*r AudioEqualizerListResult Equalizer 1 Section 6 Frequency: "5000" *r AudioEqualizerListResult Equalizer 1 Section 6 Q: "0" *r AudioEqualizerListResult Equalizer 1 Section 6 Gain: "0" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 72: Xcommand Audio Equalizer Update
*r AudioEqualizerListResult Equalizer 1 Section 4 Q: "4" *r AudioEqualizerListResult Equalizer 1 Section 4 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 5 FilterType: "Peaking" D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 73: Xcommand Audio Localinput Add
InputId: A unique identifier for the local input. Requires user role: USER Parameters: InputId(r): <0..65534> Example: xCommand Audio LocalInput Remove InputID: 2 *r AudioInputGroupRemoveResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 74: Xcommand Audio Localinput Addconnector
InputId(r): <0..65534> ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8> Example: xCommand Audio LocalInput RemoveConnector InputId: 3 ConnectorType: Line ConnectorId: 1 *r AudioInputGroupRemoveConnectorResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 75: Xcommand Audio Localoutput Addconnector
Audio LocalOutput Remove OutputId: 6 Example: xCommand Audio LocalOutput RemoveConnector OutputId:5 ConnectorType: Line *r AudioOutputGroupRemoveResult (status=OK): ConnectorId:1 ** end *r AudioOutputGroupRemoveConnectorResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 76: Xcommand Audio Localoutput Connectinput
Audio RemoteOutput ConnectInput OutputId:10 InputId:8 InputGain: <-54..15> Example: *r AudioRemoteOutputGroupConnectInputResult (status=OK): xCommand Audio LocalOutput UpdateInputGain OutputId:6 InputId:3 ** end *r AudioOutputGroupUpdateInputGainResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 77: Xcommand Audio Remoteoutput Disconnectinput
Audio Setup Clear Remove all local inputs and local outputs. Requires user role: USER Example: xCommand Audio Setup Clear *r AudioSetupClearResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 78: Xcommand Audio Vumeter Stop
ConnectorId(r): <1..8> Example: Example: xCommand Bookings Clear xCommand Audio Vumeter Stop ConnectorType: Microphone ConnectorId: 1 ** end *r AudioVumeterStopResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 79: Xcommand Bookings List
*r Bookings Booking 1 Webex Enabled: True *r Bookings Booking 1 Webex Url: "http://webex.url" *r Bookings Booking 1 Webex MeetingNumber: "webexNumber@cisco.com" *r Bookings Booking 1 Webex Password: "" D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 80: The Boot Commands
Call command to see the CallId. USER Requires user role: Parameters: CallId(r): <0..65534> Example: xCommand Call Disconnect CallId:17 *r DisconnectCallResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 81: Xcommand Call Disconnectall
Example: No parameters. xCommand Call ExtendConference CallId: 1 Example: *r CallExtendConferenceResult (status=OK) xCommand Call Join ** end *r CallJoinResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 82: The Calllog Commands
CallLog Missed Dimissed LogTag:119 LogTag: <0..2147483647> *r DismissResult (status=OK): Example: ** end xCommand CallLog Outgoing Delete LogTag:202 *r DeleteResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 83: The Camctrlpip Commands
Reset the camera position the the deafult position. Requires user role: USER Parameters: CameraId(r): <1..7> Example: xCommand Camera PositionReset CameraId:1 *r CameraPositionResetResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 84: Xcommand Camera Positionset
Example: xCommand Camera Ramp CameraId:1 Pan:left PanSpeed:1 *r RampResult (status=OK): ** end xCommand Camera Ramp CameraId:1 Pan:stop *r RampResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 85: Xcommand Camera Positionactivatefrompreset
Camera PositionActivateFromPreset CameraId:1 PresetID:1 Example: xCommand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: "" *r PositionActivateFromPresetResult (status=OK): ** end *r CameraPresetEditResult (status=OK) ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 86: Xcommand Camera Preset List
PresetId: The id of the camera preset to remove. Requires user role: USER Parameters: PresetId(r): <1..35> Example: xCommand Camera Preset Remove PresetId: 1 *r CameraPresetRemoveResult (status=OK) ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 87: The Dial Commands
CallRate: <64..6000> CallType: <Audio/Video> BookingId: <S: 0, 255> Example: xCommand Dial Number:543210 Protocol:h323 *r DialResult (status=OK): CallId: 2 ConferenceId: 1 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 88: The Farendcontrol Commands
FarEndControl Preset Store CallId:3 PresetId:1 Example: *r FECCPresetStoreResult (status=OK): xCommand FarEndControl Camera Stop CallId:3 ** end *r FECCMoveResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 89: Xcommand Farendcontrol Source Select
FarEndControl Source Select CallId:3 SourceId:1 Pin4: <High/Low> *r FECCSelectSourceResult (status=OK): Example: ** end xCommand GPIO ManualState Set Pin1: High *r GpioStateSetResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 90: The Httpfeedback Commands
*r FeedbackDeregisterResult (status=OK): Parameters: FeedbackSlot: 1 Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/ ** end 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 *r KeyReleaseResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 91: The Message Commands
Requires user role: ADMIN xCommand Message TextLine Clear Example: xCommand Message Alert Clear *r MessageTextLineClearResult (status=OK): ** end *r MessageAlertClearResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 92: Xcommand Message Prompt Clear
FeedbackId: <S: 0, 255> *r MessagePromptDisplayResult (status=OK): OptionId(r): <1..5> ** end Example: xCommand Message Prompt Response OptionId: 1 *r MessagePromptResponseResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 93: Xcommand Message Echo
Name: <S: 0, 255> ParentFolderId: <S: 0, 255> Example: xCommand Phonebook Folder Modify FolderId:localGroupId-3 Name: "New York Head Office" *r PhonebookFolderModifyResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 94: Xcommand Phonebook Contact Add
Protocol: <H323/SIP> CallRate: <0..65534> Device: <Mobile/Other/Telephone/Video> Example: xCommand Phonebook Contact Add Name: "John Doe" Number:12345 *r PhonebookContactAddResult (status=OK): Name: localContactId-1 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 95: Xcommand Phonebook Contact Delete
ContactId(r): <S: 0, 255> ContactMethodId(r): <S: 0, 255> *r PhonebookContactDeleteResult (status=OK): Example: ** end xCommand Phonebook ContactMethod Delete ContactId:localContactId-2 ContactMethodId:1 *r PhonebookContactMethodDeleteResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 96: Xcommand Phonebook Search
*r ResultSet Contact 1 ContactId: "e _ 9664921" *r ResultSet Contact 1 ContactMethod 1 ContactMethodId: "1" *r ResultSet Contact 1 ContactMethod 1 Number: "H323:/John.Doe.Office@company. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 97: The Presentation Commands
Activate one of the local presets. ** end Requires user role: USER Parameters: PresetId(r): <1..15> Example: xCommand Preset Activate PresetId:3 *r PresetActivateResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 98: Xcommand Preset Clear
Provisioning CancelUpgrade Cancel a software update in progress. USER Requires user role: Parameters: None Example: xCommand Provisioning CancelUpgrade *r CancelUpgradeResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 99: The Security Commands
SStringSend CallId:4 Message:"This is a test" Example: *r SStringSendResult (status=OK): xCommand Security FIPSMode Activate Confirm: "Yes" ** end *r SecurityFIPSModeActivateConfirmResult (status=OK) ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 100: The Standby Commands
Password(r): <S: 0, 64> xCommand Standby ResetTimer Delay:10 Example: *r ResetResult (status=OK): xCommand SystemUnit AdminPassword Set Password:*********** ** end *r AdminPasswordSetResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 101: Xcommand Systemunit Datetime Get
Set a menu password to restrict access to Administrator Settings menu. If you have a remote control Read the time and date from the system. the password can also be set from the on screen menu. If you have a Cisco TelePresence Touch Requires user role: USER controller the menu password is set from the command line interface.
Page 102: Xcommand Systemunit Configurationprofile Cancelchange
USER Parameters: Name(r): <S: 0, 255> Example: xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs Name: "My _ ConfigurationProfile _ 1" *r ConfigurationProfileSaveCurrentConfigurationResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 103: The Tstringsend Commands
Requires user role: USER Parameters: LayoutId: <1..2147483647> Example: xCommand Video Layout Add *r VideoLayoutAddResult (status=OK): LayoutId: 1 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 104: Xcommand Video Layout Frame Add
VideoSourceId parameter. VideoFile: Not in use. Requires user role: ADMIN Parameters: LayoutId(r): <1..2147483647> FrameId: <1..65535> PositionX(r): <0..10000> PositionY(r): <0..10000> Width(r): <1..10000> D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 105: Xcommand Video Layout Frame Remove
VideoSourceId parameter. VideoFile: Not in use. Requires user role: USER Parameters: LayoutId(r): <1..2147483647> FrameId(r): <1..65535> PositionX: <0..10000> PositionY: <0..10000> Width: <1..10000> D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 106: Xcommand Video Layout Assign
Video Layout Assign CallId:1 OutputId:1 LayoutId:2 xCommand Video Layout AssignCall LayoutId:2 CallId:1 *r VideoLayoutAssignResult (status=OK): *r VideoLayoutAssignCallResult (status=OK): ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 107: Xcommand Video Layout Assignpresentation
Remove the defined video layout, and go back to default. USER Requires user role: Example: xCommand Video Layout UnAssignPresentation *r VideoLayoutUnAssignPresentationResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 108: Xcommand Video Layout Loaddb
Loads and starts using the specified video layout database. The default video layout database is initially provided by the system. The custom database is generated by the Cisco TC Console tool and is made available to the codec from within the TC Console tool. The TC Console software is found xCommand Experimental Audio LocalInput Unmute at the Developer Zone web page.
Page 109: Xcommand Experimental Audio Localoutput Mute
Experimental Audio RemoteOutput Unmute CallID:1 xCommand Experimental Audio StereoEchoCancellation Mode: Off *r AudioRemoteOutputUnmuteResult (status=OK): *r AudioStereoEchoCancellationModeResult (status=OK): ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 110: Xcommand Experimental Call Attendedtransfer
Experimental SetLowLevel Mode:Off PositionY: <0..10000> *r SetLowLevelResult (status=OK): Example: ** end xCommand Experimental UserInput CallId:0 Device:NavKey Button:0 *r UserInputResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 111: Xcommand Experimental Takewebsnapshot
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change. Requires user role: ADMIN Parameters: Type(r): <A/B> Example: xCommand Experimental TouchPanelAdjustment Type:A *r TouchPanelAdjustmentResult (status=OK): ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 112 Cisco TelePresence System Codec C90 Contents Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 Description of the xStatus commands D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 113: The Audio Status
*s Audio Input LocalInput 4 Name: "DVD input" *s Audio Input LocalInput 4 MixerMode: "Fixed" *s Audio Input LocalInput 4 Mute: "Off" *s Audio Input LocalInput 4 Channels: 2 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 114: Xstatus Audio Input Localinput [1..N] Name
*s Audio Module 1 Type: Unknown *s Audio Module 1 SoftwareID: "" *s Audio Module 1 HardwareID: "" *s Audio Module 1 Connector: "" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 115: Xstatus Audio Input Localinput [1..N] Mixermode
Value space of the result returned: <On/Off> Example: xStatus Audio Input RemoteInput 8 AGC *s Audio Input RemoteInput 8 AGC: "Off" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 116: Xstatus Audio Output Localoutput [1
Audio Output RemoteOutput 9 CallId *s Audio Output LocalOutput 4 Channels: "1" *s Audio Output RemoteOutput 9 CallId: 28 ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 117: Xstatus Audio Module [0] Connector
Value space of the result returned: <S: 0, 255> Example: xStatus Audio Module 0 HardwareID *s Audio Module 0 HardwareID: "B40F69" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 118: The Call Status
Call 27 Direction xStatus Call 27 CallbackNumber *s Call 27 Direction: Outgoing *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 119: Xstatus Call [1
Shows the encryption type of the call. You can run the command xStatus Call to find the call identity. Value space of the result returned: <None/Aes-128> Example: xStatus Call 27 Encryption Type *s Call 27 Encryption Type: "None" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 120: The Camera Status
Value space of the result returned: ** end <S: 0, 100> Example: xStatus Camera 1 SoftwareID *s Camera 1 SoftwareID: "S01718-4.0FINAL [ID:40063] 2010-10-20" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 121: Xstatus Camera [1
Camera 1 Position Pan xStatus Camera 1 Capabilities Options *s Camera 1 Position Pan: 412 *s Camera 1 Capabilities Options: "ptzf" ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 122: Xstatus Camera [1
Shows the video protocol used when transmitting the presentation. Value space of the result returned: <S: 0, 10> Example: xStatus Conference Presentation Protocol *s Conference Presentation Protocol: "H264" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 123: Xstatus Conference Presentation Localsource
Shows the local video input source that is used when the presentation is sent from the local site. Value space of the result returned: <1..5> Example: xStatus Conference Presentation LocalSource *s Conference Presentation LocalSource: 0 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 124 *s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Loss: 0 *s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 LastIntervalLost: 0 *s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 125 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets: ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 126 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Drop *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Drop: 0 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 127 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate: 128000 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 128 Shows the port which is used when connecting to on the gatekeeper. Value space of the result returned: <Integer value> Example: xStatus H323 Gatekeeper Port *s H323 Gatekeeper Port: 1719 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 129 URL. Value space of the result returned: <S: 0, 100> Example: xStatus HttpFeedback 1 URL *s HttpFeedback 1 URL: "http://tms.company.com/tms/public/feedback/code.aspx" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 130: The Mediachannels Status
IpAddress: "10.54.86.240" *s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTP Remote Port: 2336 *s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTCP Local D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 131 IpAddress: "10.54.86.240" *s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTCP Local Port: *s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTCP Remote Port: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 132: Xstatus Mediachannels Call [1..N] Incomingaudiochannel [1..N] Encryption Status
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTCP Remote IpAddress: "" *s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTCP Remote Port: ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 133: Xstatus Mediachannels Call [1..N] Incomingaudiochannel [1..N] Audio Channels
MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Local IpAddress *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Local IpAddress: "192.168.24.190" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 134: Xstatus Mediachannels Call [1..N] Incomingaudiochannel [1..N] Transport Rtcp Local
** end Example: xStatus MediaChannels Call 27 IncomingVideoChannel 330 Video FrameRate *s MediaChannels Call 27 IncomingVideoChannel 330 Video FrameRate: 25 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 135: Xstatus Mediachannels Call [1
MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port ** end *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port: D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 136: Xstatus Mediachannels Call [1
MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote Port *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote Port: 50933 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 137: Xstatus Mediachannels Call [1
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress: "192.168.136.130" *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port: 16405 ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 138: Xstatus Mediachannels Call [1..N] Outgoingaudiochannel [1..N] Transport Rtcp Remote
<Integer value.> Example: xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video ResolutionX *s MediaChannels Call 27 OutgoingVideoChannel 331 Video ResolutionX: 768 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 139: Xstatus Mediachannels Call [1..N] Outgoingvideochannel [1..N] Video Resolutiony
MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Local IpAddress *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Local IpAddress: "192.168.24.190" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 140: The Network Status
Value space of the result returned: Port: 50933 <10half/10full/100half/100full/1000full> ** end Example: xStatus Network 1 Ethernet Speed *s Network 1 Ethernet Speed: "100full" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 141: Xstatus Network 1 Ipv4 Address
Network 1 MTU *s Network 1 IPv4 DNS Domain Name: "www.example.com www.example.int" *s Network 1 MTU: 1500 ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 142: Xstatus Network 1 Vlan Voice Vlanid
Shows the camera preset type. Value space of the result returned: <All/Camera> Example: xStatus Preset 1 Type *s Preset 1 Type: All ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 143: Xstatus Preset [1..15] Description
NeedConfig: The endpoint needs to be configured. Value space of the result returned: <Failed/AuthenticationFailed/Provisioned/Idle/NeedConfig> Example: xStatus Provisioning Status *s Provisioning Status: Provisioned ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 144: Xstatus Provisioning Reason
Provisioning Software UpgradeStatus Status xStatus Provisioning Software Current URL *s Provisioning Software UpgradeStatus Status: None *s Provisioning Software Current URL: "" ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 145: Xstatus Provisioning Software Current Completedat
Provisioning Software Current CompletedAt <On/Off> *s Provisioning Software Current CompletedAt: "2011-06-07T07:20:03Z" Example: ** end xStatus Security FIPS Mode *s Security FIPS Mode: "Off" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 146: The Sip Status
Unknown: The status of the communication is not known. Value space of the result returned: <Active/DNSFailed/Off/Timeout/UnableTCP/UnableTLS/Unknown> Example: xStatus SIP Proxy 1 Status *s SIP Proxy 1 Status: Active ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 147: Xstatus Sip Profile 1 Proxy [1] Address
** end <S: 0, 255> Example: xStatus SIP Profile 1 Proxy 1 Address *s SIP Profile 1 Proxy 1 Address: "192.0.2.50" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 148: Xstatus Sip Profile 1 Authentication
*s SIP Profile 1 Authentication: Off Example: ** end xStatus SIP Profile 1 Registration 1 URI *s SIP Profile 1 Registration 1 URI: "firstname.lastname@company.com" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 149: The Systemunit Status
*s SystemUnit State NumberOfSuspendedCalls: 0 *s SystemUnit State NumberOfInProgressCalls: 0 *s SystemUnit State Subsystem Application: Initialized *s SystemUnit ContactInfo: "anyname@company.com" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 150: Xstatus Systemunit Productid
Example: Example: xStatus SystemUnit Uptime xStatus SystemUnit Software ReleaseDate *s SystemUnit Uptime: 597095 *s SystemUnit Software ReleaseDate: "2011-07-19" ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 151: Xstatus Systemunit Software Maxaudiocalls
SystemUnit Software OptionKeys NaturalPresenter xStatus SystemUnit Software OptionKeys DualDisplay *s SystemUnit Software OptionKeys NaturalPresenter: "true" *s SystemUnit Software OptionKeys DualDisplay: "true" ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 152: Xstatus Systemunit Hardware Mainboard Identifier
SystemUnit Hardware Module CompatibilityLevel xStatus SystemUnit Hardware VideoBoard SerialNumber The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The Shows the serial number of the video board in the codec. endpoints running TC software will be manufactured with a new version of the flash memory.
Page 153: Xstatus Systemunit Hardware Audioboard Identifier
Value space of the result returned: *s SystemUnit State System: Initialized <Integer value> ** end Example: xstatus SystemUnit Hardware MonitoringSoftware *s SystemUnit Hardware MonitoringSoftware: "39" ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 154: Xstatus Systemunit Contactinfo
Shows the number of suspended calls. Value space of the result returned: <0..5> Example: xStatus SystemUnit State NumberOfSuspendedCalls *s SystemUnit State NumberOfSuspendedCalls: 0 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 155: The Time Status
*s Video Input HDMI 3 Connected: True *s Video Input HDMI 3 SignalState: OK *s Video Input HDMI 4 Connected: False *s Video Input HDMI 4 SignalState: Unknown D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 156: Xstatus Video Input Lastconnectedsource
Video Input Source 1 Resolution FormatStatus *s Video Input Source 1 Resolution FormatStatus: Ok *s Video Input Source 1 Resolution Height: 1080 ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 157: Xstatus Video Input Hdmi [1
*s Video Input HDSDI 1 Connected: False Example: ** end xStatus Video Input YPbPr 1 SignalState *s Video Input YPbPr 1 SignalState: OK ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 158: Xstatus Video Input Dvi [3, 5] Connected
*s Video Input Legacy 5 Connected: False *s Video Output Legacy 5 Resolution Width: 720 ** end *s Video Output Legacy 5 Resolution RefreshRate: 50 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 159: Xstatus Video Output Dvi [2, 4] Resolution Height
Video Output Legacy 5 Resolution Width *s Video Output DVI 2 Resolution Height: 720 *s Video Output Legacy 5 Resolution Width: 720 ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 160: Xstatus Video Layout
** end Example: xStatus Video Layout Site 1 Output 1 FamilyNumber *s Video Layout Site 1 Output 1 FamilyNumber: 1014 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 161: Xstatus Video Layout Site [1
** end Example: xStatus Video Layout Site 1 Output 1 DescriptorOutput *s Video Layout Site 1 Output 1 DescriptorOutput: 1 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 162: Xstatus Video Layout Site [1
Video Layout Site 1 Output 1 Frame 1 InputNumber *s Video Layout Site 1 Output 1 Frame 1 InputNumber: 0 ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 163: The Experimental Status
Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets OutOfOrder: 0 PacketRecovery ProtectionPackets Received ** end *s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 164: Mediapackets Lost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 *s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Lost: 0 PacketRecovery MediaPackets Recovered: 0 ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 165: Mediapackets Consecutivelost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics ZeroLost: 0 PacketRecovery MediaPackets Statistics TwoLost: 0 ** end ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 166: Xstatus Experimental Audio Input Connectors Microphone [1
** end Example: xStatus Experimental Audio Input Connectors Microphone 1 Activity *s Experimental Audio Input Connectors Microphone 1 Activity: True ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 167: Xstatus Experimental Audio Input Connectors Hdmi [3, 4] Activity
Experimental CTMS *s Experimental CTMS Call 4 CTMS Negotiation Status: Failed *s Experimental CTMS Call 4 CTMS Negotiation Reason: "Media received before D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 168 Appendices completion" *s Experimental CTMS Call 4 CTMS Negotiation Version: 0 ** end No negotiation: xStatus Experimental CTMS ** end D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 169 API Reference Guide Cisco TelePresence System Codec C90 Contents Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 170: The Video Input Matrix
Video Input Source 5 Quality: Sharpness <1..5> • Video MainVideoSource: 1 (which is the main camera) • Video DefaultPresentationSource: 3 (which is the PC) D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 171: Startup Script
The file can have any name as long as it is placed in this directory. • For multiple commands you must use Unix end of line (LF). Windows end of line will not work. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 172: Cisco Telepresence Remote Control
Short range (1 m): Move the DIP switch down. • or: Touch any key on the remote control. Longer range: Move the DIP switch up. D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 173: Remote Control Key Map
Volume up Address 4 and 7 Microphone off IR wavelength 940 nm IR carrier frequency 30 kHz Arrow up Arrow down Arrow left D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 174: Overview Of The Xconfiguration Commands
Audio SoundsAndAlerts RingVolume ..................33 xConfiguration Audio Volume ..........................33 The GPIO configuration ......................38 xConfiguration GPIO Pin [1..4] Mode ......................... 38 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 175 Network [1..1] VLAN Voice Mode ....................45 xConfiguration RTP Ports Range Start .......................51 xConfiguration Network [1..1] VLAN Voice VlanId ..................... 45 xConfiguration RTP Ports Range Stop .......................51 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 176 Video Selfview .......................... 64 xConfiguration Time TimeFormat ........................57 xConfiguration Video SelfviewPosition ......................60 xConfiguration Time Zone ..........................56 xConfiguration Video WallPaper ........................64 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 177 Experimental SystemUnit CrashReporting Mode..............69 xConfiguration Experimental SystemUnit CrashReporting URI ................ 69 xConfiguration Experimental SystemUnit MenuType ..................68 xConfiguration Experimental SystemUnit SoftwareUpgrade RequireAuthentication ........68 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 178: Overview Of The Xcommand Commands
Call Join ............................81 The GPIO commands ......................89 xCommand Call Reject ............................80 xCommand GPIO ManualState Set ........................89 xCommand Call Resume ............................81 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 179 Preset Store ........................... 97 The Provisioning commands ....................98 xCommand Provisioning CancelUpgrade ......................98 xCommand Provisioning CompleteUpgrade..................... 98 xCommand Provisioning StartUpgrade ......................98 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 180 Experimental SetLowLevel ......................110 xCommand Experimental TakeWebSnapshot ....................111 xCommand Experimental TouchPanelAdjustment ................... 111 xCommand Experimental UserInput ........................110 xCommand Experimental VideoIndicator ......................110 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 181: Overview Of The Xstatus Commands
Call [1..n] Protocol ..........................118 xStatus Call [1..n] ReceiveCallRate ........................119 xStatus Call [1..n] RemoteNumber ........................118 xStatus Call [1..n] Status ...........................118 xStatus Call [1..n] TransmitCallRate ........................119 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 182 Diagnostics Call [1..n] Channels OutgoingVideoChannel [1..n] Netstat 1 Loss ........125 xStatus Diagnostics Call [1..n] Channels OutgoingVideoChannel [1..n] Netstat 1 MaxJitter ......127 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 183 MediaChannels Call [1..n] OutgoingVideoChannel [1..n] Transport RTP Remote IpAddress ..... 139 xStatus MediaChannels Call [1..n] OutgoingVideoChannel [1..n] Transport RTP Remote Port ....... 139 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 184 SystemUnit State Subsystem Application ..................154 xStatus SystemUnit State System ........................153 xStatus SystemUnit Uptime ..........................150 The Time status ........................155 xStatus Time ZoneOlson ..........................155 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 185 Experimental Diagnostics Call [1..n] Channels IncomingDataChannel [1..n] PacketRecovery MediaPackets Statistics FourLost ........................166 xStatus Experimental Diagnostics Call [1..n] Channels IncomingDataChannel [1..n] PacketRecovery MediaPackets Statistics MoreThanFourLost ....................166 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 186 Experimental Diagnostics Call [1..n] Channels IncomingVideoChannel [1..n] PacketRecovery ProtectionPackets OutOfOrder ........................163 xStatus Experimental Diagnostics Call [1..n] Channels IncomingVideoChannel [1..n] PacketRecovery ProtectionPackets Received ........................... 163 D14641.06 Codec C90 API Reference Guide TC5.0 November 2011. www.cisco.com © 2010-2011 Cisco Systems, Inc. All rights reserved.
Page 187 INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system.

Cisco TelePresence System Codec C90 Reference Manual

This Guide?

Quick Links

Chapters

Related Manuals for Cisco TelePresence System Codec C90

Summary of Contents for Cisco TelePresence System Codec C90