Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Software version TC6.2 JULY 2013 Application Programmer Interface (API) Reference Guide Cisco TelePresence System Codec C90 D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 1 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction What’s in this guide? The top menu bar and the entries in the table of contents are all hyperlinks, just click on them to go to the topic. TA - ToC - Hidden Wetext recommend you anchor visit our web site regularly for updated versions of the user documentation. Go to:http://www.cisco.com/go/cseries-docs API Reference Guide About the API xConfiguration xCommand xStatus Appendices Table of Contents Introduction................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 3 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand About this guide User documentation This guide introduces you to the Application Programmer Interface (API) for the TC software in general, and serve as a reference guide for the command line commands for the Codec C Series listed below: The user documentation for the Cisco TelePresence systems, running the TC software, have several guides suitable to various user groups.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand What’s new in this version New features and improvements This section provides an overview of the new and changed system settings and new features in the TC6.2 software version. Cisco Unified Communication Manager (CUCM) redundancy support Software release notes The TelePresence endpoints have CUCM redundancy support with failover and fallback.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Interactive Connectivity Establishment (ICE) support Extended Binary Floor Control Protocol (BFCP) port range TelePresence systems can use the ICE protocol (RFC 5245) to find the best media path through the network. ICE separates signalling and media, and is a NAT traversal solution that finds the shortest route for audio and video.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand changes xStatus changes New commands New status xCommand Video Layout Frame List xStatus Conference Site Hold xCommand Video Layout List xStatus Conference Site Preserved Commands that are modified xCommand Message FarendMessage OLD: CallId was required xStatus ICE Turn Username xCommand Video Layout Frame Add xStatus ICE Call Result xStatus ICE Call Local Candidate OLD: VideoS
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 8 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices API fundamentals RS-232/serial connection Telnet This chapter contains a top-level view of the mechanisms supported by the codec API. You can use the API to manage all parts of the TelePresence system. This is one of the most used connections to our products for integrators, as it can be used without an IP-address, DNS or a network.
Cisco TelePresence System Codec C90 Contents Introduction API output The xPreferences is used to set preferences for the RS-232, Telnet and SSH sessions. API Reference Guide About the API xConfiguration xCommand xStatus Appendices Example: Layout command in terminal mode xCommand Video Layout AssignCall CallId: 2 LayoutId: 1 The output modes • Terminal: Line based output for use with line based control systems • XML: XML output for use with control systems that understand XML.
Cisco TelePresence System Codec C90 Contents Introduction Using the command line Help API Reference Guide About the API xConfiguration xCommand xStatus Appendices ? - User Commands help xconfiguration xfeedback bye log echo To get a list of all supported root commands you can type ? or help after connecting to the TelePresence System using RS-232, Telnet or SSH.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API Searching You can use // to search for elements anywhere in the status or configuration hierarchy (Example 1). You can also combine multiple //’s (Example 2). WARNING: The search shortcuts work well for inspecting the API, but should not be used in applications. We recommend that you always use the complete paths to avoid command ambiguity when upgrading to newer firmware releases.
Cisco TelePresence System Codec C90 Contents Introduction Commands Commands instruct the codec to execute actions, such as to dial a number or to search the phone book. All commands start with the prefix xCommand followed by a command path. Writing xCommand ? on the command line will list all the top level commands. API Reference Guide About the API xConfiguration Command arguments are key-value pairs. The (r) behind the argument name indicates that the argument is required for the command.
Cisco TelePresence System Codec C90 Contents Introduction Configurations Configurations are system settings that are persistent across boots. Like commands, also configurations are structured in a hierarchy. API Reference Guide About the API xConfiguration Writing xConfiguration ?? lists all configurations and their value spaces. Writing xConfiguration lists all configurations and their current values.
Cisco TelePresence System Codec C90 Contents Introduction Status A status contains the current state of the codec, such as connected calls, the status of the gatekeeper registration, connected inputs and output sources. Writing xStatus ? on the command line lists all top level statuses. Writing xStatus lists all statuses and their current values. To list out only some of the statuses, write xstatus followed by the relevant part of the status path.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Events Example 1: Outgoing Call Indication Example 4: FECC Action request Event returns information about the events that are available for feedback. This overview presents examples of some the events that are available on the API. Outgoing Call Indication is an event reported when an outgoing call is about to be dialled.
Cisco TelePresence System Codec C90 Contents Introduction Call history The xHistory command returns the call logs. API Reference Guide About the API xConfiguration xCommand xStatus Appendices Example with xHistory CallLogs xHistory *h xHistory CallLogs Call 1 CallId: 13 *h xHistory CallLogs Call 1 Protocol: “h323” *h xHistory CallLogs Call 1 Direction: Incoming *h xHistory CallLogs Call 1 CallType: Video *h xHistory CallLogs Call 1 RemoteNumber: "h323:firstname.lastname.office@company.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Feedback mechanism Example 1: Microphones Mute status. To build solutions that can reliably keep the state between the application and the codec synchronized, you need to set up a notification system to report the changes in the state of the codec.
Cisco TelePresence System Codec C90 Contents Introduction Terminal connections Managing feedback subscriptions To register, list and deregister feedback expressions you use the command xFeedback and its corresponding sub commands. The registered expressions are only valid for the currently active connection. If you open two Telnet sessions and register to get feedback in one session, you do not receive feedback in the other serssion.
Cisco TelePresence System Codec C90 Introduction Contents API Reference Guide About the API xConfiguration xCommand xStatus Appendices Using HTTP Using HTTP POST The codec supports sending commands and configurations over HTTP and HTTPS. It is also possible to retrieve configurations and statuses this way. This interface exposes the same API as the command line, but in XML format.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Feedback from codec over HTTP To get notifications from the codec, you need to register HTTP feedback expressions. The codec will then use HTTP POST to send feedback messages to the supplied IP-address. This means that you have to have a HTTP server running for your application to receive updates from the codec.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Translating from terminal mode to XML Translating commands Translating configurations The XML commands maintain the same structure as the terminal commands, but they use a parent-child relationship to describe the hierarchy. You can see this structure in the examples below.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Dos and don’ts Here are some issues you should consider when programming the Cisco C- and SX-series API. AVOID remote control emulation The use of xCommand Key Press and xCommand Key Click commands is highly discouraged.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 24 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Description of the xConfiguration commands In this chapter, you can find a complete list of the xConfiguration commands. The examples show either the default value or an example of a value. We recommend you visit our web site regularly for updated versions of the manual. Go to: http://www.cisco.com/go/cseries-docs Audio configuration.................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Conference configuration...................................................................................................................... 37 H323 configuration................................................................................................................................ 43 xConfiguration Conference [1..1] AutoAnswer Delay.......................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xConfiguration Network [1..1] QoS Diffserv Audio.......................................................................................47 xConfiguration NetworkServices SSH Mode..............................................................................................54 xConfiguration Network [1..1] QoS Diffserv Data...............................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices SIP configuration................................................................................................................................... 60 UserInterface configuration................................................................................................................... 67 xConfiguration SIP ListenPort.........................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xConfiguration Video OSD MissedCallsNotification....................................................................................76 xConfiguration Video Output HDMI [1,3] OverscanLevel............................................................................78 xConfiguration Video OSD Mode.........................................................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Audio configuration xCommand xStatus Appendices xConfiguration Audio Input Line [1..4] Equalizer ID Select the audio input line equalizer ID. Requires user role: ADMIN xConfiguration Audio Input HDMI [3,4] Mode Determine if the audio channels on the HDMI input shall be enabled. The HDMI input 3 and 4 have two audio channels. Value space: <1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Audio Input Line [1..4] Channel xCommand xStatus Appendices xConfiguration Audio Input Line [1..4] Mode Define whether the Audio Line input is a mono signal or part of a multichannel signal. Set the audio input line mode.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation xCommand xStatus Appendices xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource The system has built-in signal processing to reduce the effect of room reverberation. NOTE: Requires the Echo Control Mode to be enabled for the microphone. Select the associated video input source.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Audio Output HDMI [1,3] Level xCommand xStatus Appendices xConfiguration Audio Output Line [1..6] Equalizer Mode Define the output level of the HDMI output connector, in steps of 1 dB. Set the audio output line equalizer mode. See the Audio Level tables in the Physical Interfaces Guide for the codec for a complete overview of the menu values represented in dB.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Audio Output Line [2,4,5,6] Type xCommand xStatus Appendices xConfiguration Audio SoundsAndAlerts RingVolume Line output 2, 4, 5, 6 are dedicated analog outputs, hence type can be set to analog only. Sets the ring volume for an incoming call. Requires user role: ADMIN Requires user role: USER Value space: Value space: <0..100> Analog: Can be set to analog only.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Cameras configuration xCommand xStatus Appendices xConfiguration Cameras Camera [1..7] Brightness Level Set the brightness level. NOTE: Requires the Camera Brightness Mode to be set to Manual. Requires user role: ADMIN xConfiguration Cameras PowerLine Frequency Applies to cameras supporting PowerLine frequency anti-flickering, i.e. PrecisionHD 1080p cameras. Value space: <1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Cameras Camera [1..7] Gamma Mode xCommand xStatus Appendices xConfiguration Cameras Camera [1..7] Mirror Applies to cameras which support gamma mode. The Gamma Mode setting enables for gamma corrections. Gamma describes the nonlinear relationship between image pixels and monitor brightness. The Cisco TelePresence PrecisionHD 720p camera supports gamma mode.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Conference configuration xConfiguration Cameras Camera [1..7] Whitebalance Level Set the whitebalance level. NOTE: Requires the Camera Whitebalance Mode to be set to manual. Requires user role: ADMIN xConfiguration Conference [1..1] CallProtocolIPStack Value space: <1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Conference [1..1] AutoAnswer Mute xCommand xStatus Appendices xConfiguration Conference [1..1] DoNotDisturb Mode Determine if the microphone shall be muted when an incoming call is automatically answered. NOTE: Requires that AutoAnswer Mode is switched on. Determine if there should be an alert on incoming calls.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Conference [1..1] FarEndControl SignalCapability xCommand xStatus Appendices xConfiguration Conference [1..1] DefaultCall Rate Set the far end control (H.224) signal capability mode. Set the Default Call Rate to be used when placing calls from the system. Requires user role: ADMIN Requires user role: ADMIN Value space: Value space: <64..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Conference [1..1] MaxTotalTransmitCallRate xCommand xStatus Appendices xConfiguration Conference [1..1] VideoBandwidth MainChannel Weight This configuration applies when using a video system's built-in MultiSite feature (optional) to host a multipoint video conference.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Conference [1..1] Presentation RelayQuality xCommand xStatus Appendices xConfiguration Conference [1..1] Multipoint Mode This configuration applies to video systems that are using the built-in MultiSite feature (optional) to host a multipoint video conference.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration FacilityService configuration xCommand xStatus Appendices xConfiguration FacilityService Service [1..5] Number Set the number for each facility service. Up to five different facility services are supported. A facility service is not available unless both the FacilityService Service Name and the FacilityService Service Number settings are properly set. xConfiguration FacilityService Service [1.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand GPIO configuration H323 configuration xConfiguration GPIO Pin [1..4] Mode xConfiguration H323 NAT Mode The four GPIO pins are configured individually. The state can be retrieved by "xStatus GPIO Pin [1..4] State". The default pin state is High (+12 V). When activated as output, they are set to 0 V. To activate them as input, they must be pulled down to 0 V.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration H323 Profile [1..1] Authentication Mode xCommand Appendices xConfiguration H323 Profile [1..1] CallSetup Mode Set the authenticatin mode for the H.323 profile. The H.323 Call Setup Mode defines whether to use a Gatekeeper or Direct calling when establishing H323 calls. Requires user role: ADMIN NOTE: Direct H.323 calls can be made even though the H.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Network configuration xConfiguration H323 Profile [1..1] H323Alias E164 The H.323 Alias E.164 defines the address of the system, according to the numbering plan implemented in the H.323 Gatekeeper. The E.164 alias is equivalent to a telephone number, sometimes combined with access codes. xConfiguration Network [1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Network [1..1] IPv4 Gateway xCommand xStatus Appendices xConfiguration Network [1..1] IPv6 Address Define the IPv4 network gateway. This setting is only applicable when the Network Assignment is set to Static. Enter the static IPv6 network address for the system. This setting is only applicable when the Network IPv6 Assignment is set to Static.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Network [1..1] DHCP RequestTFTPServerAddress xCommand xStatus Appendices xConfiguration Network [1..1] QoS Mode This setting is used only for video systems that are registered to a Cisco Unified Communications Manager (CUCM). The QoS (Quality of Service) is a method which handles the priority of audio, video and data in the network.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Network [1..1] QoS Diffserv Video xCommand xStatus Appendices xConfiguration Network [1..1] QoS Diffserv Signalling Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Define which priority Video packets should have in the IP network.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Network [1..1] QoS Diffserv NTP xCommand xStatus xConfiguration Network [1..1] IEEE8021X UseClientCertificate Note: This setting will only take effect if Network QoS Mode is set to Diffserv. Authentication using a private key/certificate pair during an IEEE802.1x connection. The authentication X.509 certificate must be uploaded to the video system.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Network [1..1] IEEE8021X Eap Md5 xCommand xStatus Appendices xConfiguration Network [1..1] IEEE8021X Eap Peap Set the Md5 (Message-Digest Algorithm 5) mode. This is a Challenge Handshake Authentication Protocol that relies on a shared secret. Md5 is a Weak security. Set the Peap (Protected Extensible Authentication Protocol) mode.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices NetworkPort configuration xConfiguration Network [1..1] TrafficControl Mode Set the network traffic control mode to decide how to control the video packets transmission speed.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration NetworkServices configuration xCommand xStatus Appendices xConfiguration NetworkServices H323 Mode Determine whether the system should be able to place and receive H.323 calls or not. Requires user role: ADMIN xConfiguration NetworkServices XMLAPI Mode Enable or disable the video system's XML API. For security reasons this may be disabled.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration NetworkServices HTTPS VerifyServerCertificate xCommand Appendices xConfiguration NetworkServices HTTPS OCSP URL When the video system connects to an external HTTPS server (like a phone book server or an external manager), this server will present a certificate to the video system to identify itself.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration NetworkServices SIP Mode xCommand xStatus Appendices xConfiguration NetworkServices SNMP CommunityName Determine whether the system should be able to place and receive SIP calls or not. Enter the name of the Network Services SNMP Community. SNMP Community names are used to authenticate SNMP requests.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration NetworkServices SSH AllowPublicKey xCommand xStatus Appendices xConfiguration NetworkServices CTMS Encryption Secure Shell (SSH) public key authentication can be used to access the codec. This setting indicates whether or not the video system supports encryption when participating in a multiparty meeting controlled by a Cisco TelePresence Multipoint Switch (CTMS).
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Phonebook configuration Provisioning configuration xConfiguration Phonebook Server [1..1] ID xConfiguration Provisioning Connectivity Enter a name for the external phone book. Appendices This setting controls how the device discovers whether it should request an internal or external configuration from the provisioning server.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Provisioning LoginName xCommand xStatus Appendices xConfiguration Provisioning ExternalManager Address This is the user name part of the credentials used to authenticate the video system with the provisioning server. This setting must be used when required by the provisioning server. If Provisioning Mode is Callway (WebEx TelePresence), enter the video number.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices RTP configuration xConfiguration Provisioning ExternalManager Domain Enter the SIP domain for the VCS provisioning server. Requires user role: ADMIN xConfiguration RTP Ports Range Start Value space: Specify the first port in the range of RTP ports. Also see the H323 Profile [1..1] PortAllocation setting. Format: String with a maximum of 64 characters.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Security configuration xCommand xStatus Appendices xConfiguration Security Audit OnError Action Determine what happens when the connection to the audit server is lost. This setting is only relevant when Security Audit Logging Mode is set to ExternalSecure. xConfiguration Security Audit Logging Mode NOTE: Restart the system for any change to this setting to take effect.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand SerialPort configuration SIP configuration xConfiguration SerialPort Mode xConfiguration SIP Profile [1..1] Ice Enable/disable the serial port (COM port). xStatus Appendices Requires user role: ADMIN ICE (Interactive Connectivity Establishment, RFC 5245) is a NAT traversal solution that the endpoints can use to discover the optimized media path.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration SIP Profile [1..1] Turn UserName xCommand xStatus Appendices xConfiguration SIP Profile [1..1] Authentication [1..1] LoginName The user name needed for accessing the TURN server. This is the user name part of the credentials used to authenticate towards the SIP proxy.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration SIP Profile [1..1] TlsVerify xCommand xStatus Appendices xConfiguration SIP Profile [1..1] Proxy [1..4] Discovery For TLS connections a SIP CA-list can be uploaded to the video system. This can be done from the web interface. Select if the SIP Proxy address is to be obtained manually or by using Dynamic Host Configuration Protocol (DHCP).
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Standby configuration xConfiguration SIP Profile [1..1] Line When registered to a Cisco Unified Communications Manager (CUCM) the endpoint may be part of a shared line. This means that several devices share the same directory number. The different devices sharing the same number receive status from the other appearances on the line as defined in RFC 4235.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices SystemUnit configuration xConfiguration Standby StandbyAction Define the camera position when going into standby mode. Requires user role: ADMIN xConfiguration SystemUnit Name Value space: None: No action. Enter a System Name to define a name of the system unit. If the H.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration SystemUnit ContactInfo Type xCommand xStatus Appendices xConfiguration SystemUnit IrSensor Choose which type of contact information to show in the status field in the upper left corner of the main display and Touch controller. The information can also be read with the command xStatus SystemUnit ContactInfo.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Time configuration xCommand xStatus Appendices xConfiguration Time TimeFormat Set the time format. Requires user role: USER xConfiguration Time Zone Value space: <24H/12H> Set the time zone where the system is located, using Windows time zone description format. 24H: Set the time format to 24 hours. Requires user role: USER 12H: Set the time format to 12 hours (AM/PM).
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus UserInterface configuration Video configuration xConfiguration UserInterface TouchPanel DefaultPanel xConfiguration Video Input Source [1..5] Name Select whether to display the list of contacts, the list of scheduled meetings, or a dial pad on the Touch controller as default. Appendices Enter a name for the video input source.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Input Source [3] Connector xCommand xStatus Appendices xConfiguration Video Input Source [1..5] Type Select which video input connector to be active on video input source 3. Set which type of input source is connected to the video input.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Input Source [1..5] CameraControl Mode xCommand xStatus Appendices xConfiguration Video Input Source [1..5] OptimalDefinition Profile Select whether or not to enable camera control for the selected video input source when the video input is active. The Video Input Source Quality setting must be set to Motion for the optimal definition settings to take any effect.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Input Source [1..5] OptimalDefinition Threshold60fps xCommand xStatus Appendices xConfiguration Video DefaultPresentationSource For each video input, this setting tells the system the lowest resolution where it should transmit 60fps.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Input DVI [3,5] RGBQuantizationRange xCommand xStatus Appendices xConfiguration Video Layout Scaling All devices with DVI inputs should follow the rules for RGB video quantization range defined in CEA861. Unfortunately some devices do not follow the standard and this configuration may be used to override the settings to get a perfect image with any source.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Selfview xCommand xStatus Appendices xConfiguration Video SelfviewDefault Mode Determine if the main video source (self view) shall be displayed on screen. Determine if the main video source (self view) shall be displayed on screen after a call.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video SelfviewDefault PIPPosition xCommand xStatus Appendices xConfiguration Video CamCtrlPip CallSetup Mode Determine the position on screen of the small self view picture-in-picture (PiP) after a call.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video PIP Presentation DefaultValue Position xCommand xStatus Appendices xConfiguration Video Layout LocalLayoutFamily Determine the position on screen of the presentation picture-in-picture (PiP). The setting only takes effect when the presentation is explicitly minimized to a PiP, for example using the remote control or the Touch controller.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Layout RemoteLayoutFamily xCommand xStatus Appendices xConfiguration Video OSD Mode Select which video layout family to be used for the remote participants. The Video OSD (On Screen Display) Mode lets you define if information and icons should be displayed on screen.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video OSD MenuStartupMode xCommand xStatus Appendices xConfiguration Video OSD MissedCallsNotification Configures the state of the OSD (On Screen Display) menu after a video system / codec boot. The setting only applies when the video system is operated by a remote control and the on-screen menu.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video OSD MyContactsExpanded xCommand xStatus Appendices xConfiguration Video OSD InputMethod Cyrillic Set how the local contacts will be displayed in the phone book dialog in the OSD (On Screen Display). Set the Cyrillic mode for the menu input language in the menus on screen.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Output HDMI [1,3] RGBQuantizationRange xCommand xStatus Appendices xConfiguration Video Output HDMI [1,3] MonitorRole All devices with HDMI outputs should follow the rules for RGB video quantization range defined in CEA-861.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xConfiguration Video Output DVI [2,4] RGBQuantizationRange xCommand xStatus Appendices xConfiguration Video Output DVI [2,4] Resolution All devices with DVI outputs should follow the rules for RGB video quantization range defined in CEA-861. Unfortunately some devices do not follow the standard and this configuration may be used to override the settings to get a perfect image with any display.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Experimental configuration xConfiguration Video Output Composite [5] Resolution Select the preferred resolution for the monitor connected to the video output Composite connector. This will force the resolution on the monitor. The Experimental settings are for testing only and should not be used unless agreed with Cisco.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Chapter 4 xCommand commands D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 81 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Description of the xCommand commands In this chapter, you can find a complete list of all xCommand type commands with parameters. We recommend you visit our web site regularly for updated versions of the manual. Go to: http://www.cisco.com/go/cseries-docs Audio commands..................................................................................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices CamCtrlPip commands.......................................................................................................................... 98 GPIO commands.................................................................................................................................. 106 xCommand CamCtrlPip........................................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Preset commands.................................................................................................................................116 xCommand SystemUnit OptionKey RemoveAll.........................................................................................120 xCommand Preset Activate................................................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Audio commands xCommand xStatus Appendices xCommand Audio Equalizer Update The system has eight user defined equalizers, each made up of six second order IIR sections. Each of the eight equalizers can be applied to one or more of the audio input and output connectors on the codec. Each IIR section can be modified independently.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration *r AudioEqualizerListResult Equalizer 1 Section 4 Q: "4" xCommand xStatus Appendices xCommand Audio LocalInput Add *r AudioEqualizerListResult Equalizer 1 Section 4 Gain: "0" Create a local input and generate the local input id. A local input is a mix of input connectors with the following settings: Name, MixerMode, AGC, Mute and Channels.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Audio LocalInput Update xCommand xStatus Appendices xCommand Audio LocalInput Remove Update the settings of the local input given by the input ID. Remove the local input given by the input ID. InputId: A unique identifier for the local input. InputId: A unique identifier for the local input. Name: Choose a name that describes the mix of input connectors.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Audio LocalInput RemoveConnector xCommand xStatus Appendices xCommand Audio LocalOutput Add Detach an input connector from the local input given by the input ID. A connector is defined by its type and ID. Create a local output and generate the local output id. A local output is a mix of local input and remote input signals.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Audio LocalOutput Update xCommand xStatus Appendices xCommand Audio LocalOutput AddConnector Update the settings of the local output given by the output ID. Attach an output connector to the local output given by the output ID. A connector is defined by its type and ID. OutputId: A unique identifier for the local output. Name: Choose a name that describes the local output.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Audio LocalOutput ConnectInput xCommand xStatus Appendices xCommand Audio LocalOutput DisconnectInput Connect a local or remote input to a local output by giving their IDs as parameters. Disconnect a local or remote input from a local output. OutputId: A unique identifier for the local output. OutputId: A unique identifier for the local output.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Audio RemoteOutput UpdateInputGain xCommand xStatus Appendices xCommand Audio Setup Clear Update the gain of a local or remote input connected to a remote output. Remove all local inputs and local outputs. OutputId: A unique identifier for the local output. Requires user role: ADMIN InputId: A unique identifier for the local or remote input.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Bookings commands xCommand Audio VUMeter Start Start collecting VU meter information for connector given by type and ID. Requires user role: USER xCommand Bookings List Parameters: List the stored bookings for the system. The list of booking details is received from the management system. All parameters are optional, and can be used to limit the search result.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration *r Bookings Booking 1 BookingStatusMessage: "" xCommand xStatus Appendices xCommand Bookings Clear *r Bookings Booking 1 Webex Enabled: True Clear the current stored list of bookings. *r Bookings Booking 1 Webex Url: "http://webex.url" Requires user role: USER *r Bookings Booking 1 Webex MeetingNumber: "webexNumber@cisco.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Boot commands Call commands xCommand Boot xCommand Call Accept Reboot system. xStatus Appendices Action: As a default the system restarts after a reboot. By selecting Shutdown, the system will not restart. Accept an incoming call. If no CallId is specified, all incoming calls are accepted. The CallID is returned when the xCommand Dial command is run.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Call Disconnect xCommand xStatus Appendices xCommand Call Join Disconnect a call. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId. Join all existing calls, active and on hold.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Call ExtendConference xCommand xStatus xCommand Call HoldAll Request to extend the conference for the call with the specified CallId. Puts all ongoing calls on hold.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration CallLog commands xCommand xStatus Appendices xCommand CallLog Outgoing Delete Delete the call log of outgoing calls. If a logtag is given as argument, that specific call is deleted from the log. If no logtag is given the system deletes the complete outgoing calls log. The LogTag values for outgoing calls are found by issuing the xHistory CallLog Outgoing command.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices CamCtrlPip commands xCommand CallLog Missed Dismiss Review the call log of dismissed calls. If a logtag is given as argument, that specific call is deleted from the log. If no logtag is given the system deletes the complete missed calls log. The LogTag values for missed calls are found by issuing the xHistory CallLog Missed command.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Camera commands xCommand xStatus Appendices xCommand Camera PositionSet Position the camera by defining the pan, tilt, zoom and focus parameters. If the camera is placed in a daisy chain you need to know the CameraId for the camera you want to address. xCommand Camera PanTiltReset Requires user role: USER The camera is reset to its default values for pan and tilt.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Camera Ramp xCommand xStatus Appendices xCommand Camera ReconfigureCameraChain Move the camera in a specified direction. The camera moves at specified speed until a stop command is issued. In a daisy chain, you need to know the CameraId for the camera you want to address. Be aware that pan and tilt can be operated simultaneously, but no other combinations.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Camera Preset Activate xCommand xStatus Appendices xCommand Camera Preset List Activate one of the stored camera preset. List information about available camera presets. Note: The xCommand Camera Preset commands applies to an individual camera.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Conference commands xCommand Camera Preset Store Store the current position of the chosen camera. The camera is identified by the CameraId parameter. xCommand Conference DoNotDisturb Activate Note: The xCommand Camera Preset commands applies to an individual camera.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Dial commands xCommand Conference ActiveSpeaker Set For manually setting the active speaker in a conference. Overrides normal voice switching. Target: Identifies local or remote participant. xCommand Dial CallId: Identifies CallID for remote participant. Only relevant if Target is set to "remote". Requires user role: USER Dial out from the system.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus DTMFSend commands FacilityService commands xCommand DTMFSend xCommand FacilityService Dial Send DTMF tones to the far end. Appendices Dial out from the system to a facility service. A maximum of five facility services can be defined; which one of these five to dial to is identified by the ServiceId (ref.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration FarEndControl commands xCommand xStatus Appendices xCommand FarEndControl Preset Activate While in a call, this command is used to activate a preset on the far end codec. The preset covers the far end codec’s camera positions and input video switcher settings. xCommand FarEndControl Camera Move Move the far end camera (the remote camera).
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices GPIO commands xCommand FarEndControl Preset Store While in a call, this command is used to store a preset on the far end codec. The preset covers the far end codec’s camera positions and input video switcher settings.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand HttpFeedback commands Key commands xCommand HttpFeedback Register xCommand Key Click xStatus Register the system to a HTTP(S) server to return XML feedback over HTTP(S) to specific URLs. Emulates a remote control key press, followed by a key release. FeedbackSlot: You can have from 1 to 4 slots for feedback.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Message commands xCommand Key Release Emulates a remote control key release. The Key Release command is issued after a Key Press command. xCommand Message Alert Display Requires user role: ADMIN Display a message on screen, for a specified duration of time (in seconds). NOTE: If Duration is not set, the command must be followed by xCommand Message Alert Clear.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Message TextLine Display xCommand xStatus Appendices xCommand Message Prompt Display Display a text line on screen. Optionally you can place the text line at a specified location and for a specified duration of time (in seconds). NOTE: If Duration is not set, the command must be followed by xCommand Message TextLine Clear.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Message Prompt Clear xCommand xStatus xCommand Message Echo Remove the window displayed using the xCommand Message Alert Display command. Issuing the command makes the API raise a message-echo event. The command has no other impact on the codec. Usage can be to poll the codec from a control system or any external device/ system to check for connectivity.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Phonebook commands xCommand xStatus Appendices xCommand Phonebook Folder Modify Modify an existing phonebook folder. FolderId: The unique identifier for the folder. The identifier will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Phonebook Contact Add xCommand xStatus Appendices xCommand Phonebook Contact Modify Add a new contact to the local phonebook. The command returns the ContactId, which is a unique string that identifies the contact; typically the format is “localContactId-n”. Modify contact details of an existing contact in the local phonebook.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Phonebook Contact Delete xCommand xStatus Appendices xCommand Phonebook ContactMethod Add Delete an existing contact from the local phonebook. Add contact details for an existing contact in the local phonebook. The command returns the ContactMethodId, which is a unique string that identifies the contact method; typically the format is “n”.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Phonebook ContactMethod Modify xCommand xStatus Appendices xCommand Phonebook ContactMethod Delete Modify details about the contact method for an existing contact in the local phonebook. Delete a contact method from an existing contact in the local phonebook. ContactId: The unique identifier for the contact. The identifier will be returned by an xCommand Phonebook Search command.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices *r ResultSet Contact 1 ContactId: "localContactId-3" xCommand Phonebook Search The search command lets you search in both the local and corporate phone books. A search gives a ResultSet. More examples can be found on the Cisco Developer Network at http://developer.cisco. com/web/telepresence-developer/howtos/cseries-api/phonebook.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Presentation commands Preset commands xCommand Presentation Start xCommand Preset Store Open a media stream from the selected presentation source. xStatus Appendices Store the connector selections for all video input sources and the current position for all cameras. Note that information about all video input sources and all camera positions are included in the same preset.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Provisioning commands xCommand Preset Clear Delete a preset. PresetId: The ID of the preset you want to delete. xCommand Provisioning StartUpgrade Requires user role: USER The codec software can be upgraded from the provisioning server. When starting the upgrade the software is automatically downloaded and installed.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Security commands xCommand Provisioning CUCM CAPF OperationStart Starts a pending CAPF (Certificate Authority Proxy Function) operation toward the CUCM. When the CUCM administrator initiates an operation that the endpoint should perform (like installing, updating or deleting certificates), this command can be used to start the CAPF operation.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand SStringSend commands Standby commands xCommand SStringSend xCommand Standby Activate Send data to the far end, e.g. for control systems. Uses the H.224 data channel (UDP). xStatus Appendices Set the system in standby mode, which turns off the video outputs and put the camera into sleep mode. Message: Enter the message to be sent to the far end.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration SystemUnit commands xCommand xStatus Appendices xCommand SystemUnit ReleaseKey RemoveAll Removes all Release keys. Requires user role: ADMIN xCommand SystemUnit OptionKey Add Parameters: Add an option key to support additional features.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand SystemUnit MenuPassword Set xCommand xStatus Appendices xCommand SystemUnit DateTime Set Set a menu password to restrict access to Administrator Settings menu. If you have a remote control the password can also be set from the on screen menu. If you have a Cisco TelePresence Touch controller the menu password is set from the command line interface.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand SystemUnit FactoryReset xCommand xStatus Appendices xCommand SystemUnit ConfigurationProfile Change Reset the codec to factory default settings. The call logs are deleted and all system parameters are reset to default values. All files that have been uploaded to the codec are deleted. The Release key and Option key are not affected. Select a previously saved configuration profile.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand SystemUnit ConfigurationProfile List xCommand xStatus Appendices xCommand SystemUnit ReleaseKey List List configuration profiles that has been stored in the system. List all software versions that the system has a valid release key for.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand TStringSend commands Video commands xCommand TStringSend xCommand Video PictureLayoutSet xStatus Appendices Send data to far end, e.g. for TelePresence control systems. Uses the H.245 control channel (TCP). Works with H.323 calls only. Select the screen layout mode. Message: Enter the message to be sent to the far end.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Video Layout Remove xCommand xStatus Appendices xCommand Video Layout Frame Add Remove an existing video layout. Add a Video frame to an existing layout. Returns the FrameId. Select size and position of the frame, and the video source to be shown in the frame. LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xCommand Video Layout Frame Update FrameId: <1..65535> PositionX(o): <0..10000> Change the details of an existing frame in a video layout. PositionY(o): <0..10000> LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued. Width(o): <1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xCommand Video Layout AssignLocalOutput FrameId(r): <1..65535> PositionX: <0..10000> Assign an existing layout to a local output. The defined video composition appears on the specified local output. PositionY: <0..10000> LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued. Width: <1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Video Layout AssignPresentation xCommand xStatus Appendices xCommand Video Layout UnAssignLocalOutput Assign the presentation layout (dual stream) to the remote output. The defined video composition appears on the remote dual video stream. Remove the defined video layout, and go back to default.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Video Layout SetPresentationView xStatus Appendices xCommand Video Layout Frame List Set the presentation view mode. Lists the data related to all layout frames created by command 'xCommand Video Layout Frame Add' for a specific layout identified by 'LayoutId' View: Select Default when you want the presentation to be viewed with the default settings for the codec.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Video OSD Close xCommand xStatus Appendices xCommand Video PIP Presentation Set Closes all menus on the on-screen display. Sets position for the presentation PiP (picture in picture). Element: The on–screen menu. Position: Predefined positions. Requires user role: ADMIN CenterLeft: The presentation PiP appears on the left side of the screen, in center.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Video Selfview Set xCommand xStatus xCommand Video PIP Presentation Set Sets self-view on/off and specifies its size and position. If the parameter is not specified, current value is used. Sets position for the presentation PiP (picture in picture). Mode: Selfview on/off CenterLeft: The presentation PiP appears on the left side of the screen, in center.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus 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. D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 132 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Chapter 5 xStatus commands D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 133 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Description of the xStatus commands In this chapter, you can find all of the xStatus commands and the responses. Status type commands return information about the system and system processes. You can query all information or just some of it. We recommend you visit our web site regularly for updated versions of the manual. Go to: http://www.cisco.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Conference status............................................................................................................................... 149 xStatus Conference Site [1..n] SoftwareID................................................................................................ 151 xStatus Conference...........................................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xStatus Diagnostics Call [1..n] Channels OutgoingAudioChannel [1..n] Netstat 1 LastIntervalReceived..157 xStatus H323 Gatekeeper Port................................................................................................................. 161 xStatus Diagnostics Call [1..n] Channels OutgoingAudioChannel [1..n] Netstat 1 Loss............................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Network status.................................................................................................................................... 173 xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Transport RCTP Remote Port...............168 xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Transport RTCP Local IpAddress.........
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xStatus Preset [1..15] Description..............................................................................................................178 xStatus SIP Profile 1 DirectoryURI Primary URI........................................................................................187 xStatus Preset [1..15] Type.......................................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xStatus SystemUnit Hardware Module SerialNumber..............................................................................189 xStatus Video Input HDMI [1..4] Connected..............................................................................................196 xStatus SystemUnit Hardware Monitoring Fan [1..n] Status............................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices xStatus Video Output HDMI [1, 3] Resolution RefreshRate.......................................................................198 xStatus Video Output HDMI [1, 3] Resolution Width.................................................................................198 xStatus Video Output Legacy [5] Resolution Height.........................................................
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Audio status xCommand xStatus Appendices xStatus Audio Input LocalInput [1..n] MixerMode Shows how the local input connectors have been mixed together. You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input. xStatus Audio Auto: The microphone with the strongest speaker is active and the others are strongly attenuated.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Audio Input LocalInput [1..n] AGC xCommand xStatus Appendices xStatus Audio Output LocalOutput [1..n] Name Shows the AGC (Automatic Gain Control) mode on the local input. Shows the name of the local output. You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input. You can run the command xStatus Audio Output LocalOutput to find the identity [1.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Audio Output LocalOutput [1..n] Connector xCommand xStatus Appendices xStatus Audio Output RemoteOutput [1..n] Input [1..n] Gain Lists the connectors that are attached to the local output. Shows the gain (dB) on the input, when input is connected to the remote output. Range from -54 dB to 15 dB, where -54 dB equals Off.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Call status xStatus Audio Module [0] HardwareID Shows the DNAM HardwareID. Value space of the result returned: xStatus Call Shows the top level overview of the call status. The call identity is used when query for additional information about the call. Example: xStatus Audio Module 0 HardwareID xStatus Call [1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Call [1..n] CallType xCommand xStatus Appendices xStatus Call [1..n] DisplayName Shows the call type of the incoming or outgoing call. You can run the command xStatus Call to find the call identity. Shows the name of the remote (far end) participant in an incoming or outgoing call. You can run the command xStatus Call to find the call identity.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Call [1..n] FacilityServiceId xCommand xStatus Appendices xStatus Call [1..n] Duration When calling a facility service, the facility service id is shown. Otherwise the value 0 is returned. Shows the duration of a call (in seconds). You can run the command xStatus Call to find the call identity. Value space of the result returned: Value space of the result returned: <0..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Camera status xStatus Call [1..n] DeviceType Indicates whether the remote system is a single endpoint or a MCU. Some Cisco endpoints (EX90, C40, C60, C90, SX20) have built-in MCU capabilities. xStatus Camera Value space of the result returned: Shows the top level overview of the camera status. Example: xStatus Camera [1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Camera [1..7] Model xCommand xStatus Appendices xStatus Camera [1..7] MacAddress Shows the camera model. Shows the MAC (Media Access Control) address for the camera.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Conference status xStatus Camera [1..7] Position Zoom Shows the current zoom (zoom in and out) position of the camera. The value range depends on camera type. xStatus Conference Value space of the result returned: Shows the top level overview of the conference status. The identity of the Conference Site can only be read during a call. <0..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Conference Presentation Resolution Width xCommand xStatus xStatus Conference Presentation LastLocalSource Shows the width of the the presentation. Identifies the last used local presentation source. Value space of the result returned: Value space of the result returned: <0..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Conference Site [1..n] Capabilities FECC Source [1..n] Name xCommand xStatus Appendices xStatus Conference Site [1..n] Capabilities Presentation Shows the name of an input source that can be connected at a far end site. Lists the presentation capabilities for other participants in the conference.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Conference Site [1..n] BlackScreenCause xCommand xStatus Appendices xStatus Conference Site [1..n] BookingId Shows the reason why the screen is black while in a CTMS (Cisco TelePresence Multipoint Switch) managed conference. Shows the booking ID of a conference (if assigned). The booking ID can be used for easy identification of a call or conference.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Conference Site [1..n] AttendedTransfer xCommand xStatus xStatus Conference Site [1..n] Hold Indicates whether Attended Transfer is available for the call. Indicates whether the far-end site can be placed on hold or not.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Conference Line [1..n] Appearance URI xCommand xStatus Appendices xStatus Conference DoNotDisturb Returns the URI of the shared line call. Not visible for a private call. Shows whether DoNotDisturb mode is switched on or not.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Diagnostics status xCommand xStatus Appendices xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 Packets xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..n] Netstat 1 Packets xStatus Diagnostics Shows the top level overview of the diagnostics. The example shows the status for an ongoing call.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 Loss xCommand xStatus Appendices xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 LastIntervalLost xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..n] Netstat 1 Loss xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 LastIntervalReceived xCommand xStatus Appendices xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 Drop xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..n] Netstat 1 Drop xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 Bytes xCommand xStatus Appendices xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 ChannelRate xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..n] Netstat 1 Bytes xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 MaxJitter GPIO status xStatus Diagnostics Call [1..n] Channels IncomingVideoChannel [1..n] Netstat 1 MaxJitter xStatus GPIO Pin [1..4] State xStatus Appendices Shows the current state of each GPIO pin. The default state is High (+12V). When activated the state is Low (0V). xStatus Diagnostics Call [1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration H320 status xCommand xStatus Appendices xStatus H320 Gateway Mode Returns information on the type of calls the ISDN Gateway is configured for, if the codec is paired with an ISDN Link. xStatus H320 Gateway Status Value space of the result returned: Returns the state of the H320 Gateway, if the codec is paired with an ISDN Link.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration H323 status xCommand xStatus Appendices xStatus H323 Gatekeeper Reason Shows the reason for rejected registration. Value space of the result returned: xStatus H323 Shows the top level overview of the H323 status. Example: xStatus H323 Gatekeeper Reason xStatus H323 Gatekeeper Status *s H323 Gatekeeper Reason: "" Shows the gatekeeper registration status.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand HttpFeedback status ICE status xStatus HttpFeedback xStatus ICE Configured Shows the top level overview of the HTTP status. xStatus Appendices Shows the ICE configuration status. ICE (Interactive Connectivity Establishment, RFC 5245) is a NAT traversal solution that the endpoints can use to discover the optimized media path.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus ICE Turn Hostname xCommand xStatus Appendices xStatus ICE Call Local Candidate Returns the hostname, or IP address, that is configured as the TURN server. Returns the network interface type the local system is using to send media. Value space of the result returned: HOST: The endpoint sends media from its own IP address.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices MediaChannels status xStatus ICE Call Remote IP Returns the IP address the remote system is using for media routing in the present call. Value space of the result returned: xStatus MediaChannels Shows the top level overview of the media channel status. The example shows the status for an ongoing call.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] IncomingAudioChannel [1..n] Audio Mute xCommand xStatus Appendices xStatus MediaChannels Call [1..n] IncomingAudioChannel [1..n] Transport RTP Local Port Audio mute status of incoming audio. Shows the local UDP port number of the Real-time Transport Protocol (RTP) port for the incoming audio in the media channel.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] IncomingAudioChannel [1..n] Transport RTCP Local IpAddress xCommand xStatus Appendices xStatus MediaChannels Call [1..n] IncomingAudioChannel [1..n] Transport RCTP Remote Port Shows the local IP address of the Real-time Transport Control Protocol (RTCP) port for the incoming audio in the media channel.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Video Protocol xCommand xStatus Appendices xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Video ResolutionY Shows the video algorithm for the incoming video channel. Shows the height (resolution in direction Y) of the incoming video. H264: The H.264 algorithm is an ITU-T standard for video compression.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Transport RTP Remote IpAddress xCommand xStatus Appendices xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Transport RTCP Local Port Shows the remote IP address of the Real-time Transport Protocol (RTP) port for the incoming video in the media channel.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] OutgoingAudioChannel [1..n] Encryption Status xCommand xStatus Appendices xStatus MediaChannels Call [1..n] OutgoingAudioChannel [1..n] Transport RTP Local IpAddress Shows the encryption status on the outgoing channel. Shows the local IP address of the Real-time Transport Protocol (RTP) port for the outgoing audio in the media channel.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] OutgoingAudioChannel [1..n] Transport RTP Remote Port xCommand xStatus Appendices xStatus MediaChannels Call [1..n] OutgoingAudioChannel [1..n] Transport RTCP Remote IpAddress Shows the remote UDP port number of the Real-time Transport Protocol (RTP) port for the outgoing audio in the media channel.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] OutgoingVideoChannel [1..n] ChannelRole xCommand xStatus Appendices xStatus MediaChannels Call [1..n] OutgoingVideoChannel [1..n] Video ResolutionX Shows if the outgoing channel is the main video channel or presentation channel. Shows the width (resolution in direction X) of the outgoing video.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus MediaChannels Call [1..n] OutgoingVideoChannel [1..n] Transport RTP Local Port xCommand xStatus Appendices xStatus MediaChannels Call [1..n] OutgoingVideoChannel [1..n] Transport RTCP Local IpAddress Shows the local UDP port number of the Real-time Transport Protocol (RTP) port for the outgoing video in the media channel.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Network status xStatus MediaChannels Call [1..n] OutgoingVideoChannel [1..n] Transport RCTP Remote Port Shows the remote UDP port number of the Real-time Transport Control Protocol (RTCP) port for the outgoing video in the media channel. xStatus Network Shows the top level overview of the network status.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Network 1 IPv4 SubnetMask xCommand xStatus Appendices xStatus Network 1 IPv4 DHCP TftpServerAddress Shows the subnet mask which determines which subnet an IPv4 address belongs to. Returns the IP address of the TFTP server (provisioning server) as assigned by DHCP, provided that the DHCP server supports option 150. This status is used only when xConfiguration Provisioning Mode is CUCM.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Network 1 IPv4 DHCP ProvisioningDomain xStatus Appendices xStatus Network 1 IPv6 Gateway Returns the SIP domain of the VCS provisioning server as assigned by DHCP, provided the provisioning server address is defined as a vendor encapsulated option in the DHCP server. This status is used only when xConfiguration Provisioning Mode is VCS. Shows the address of the IPv6 gateway.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Network CDP Platform xCommand xStatus Appendices xStatus Network CDP DeviceId Returns the hardware platform name of the switch connected to the endpoint. Identifies the name of the switch in form of a character string.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Network CDP Address xCommand xStatus Appendices xStatus Network CDP VoIPApplianceVlanID Returns the first network address of both receiving and sending devices. Identifies the VLAN used for VoIP traffic from the endpoint to the switch. For more information see documentation of the IEEE 802.1Q protocol.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand NetworkServices status Preset status xStatus NetworkServices NTP Address xStatus Preset Returns the address of the NTP server(s) the codec is using. xStatus Appendices Shows the top level overview of the camera presets status. Value space of the result returned: xStatus Preset [1..15] Defined Shows if a camera preset is stored at this position.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Provisioning status xCommand xStatus Appendices xStatus Provisioning Server Identifies the server the system is provisioned to. This address may either be defined in the xConfiguration ExternalManager Address setting, or provided by DHCP. xStatus Provisioning Value space of the result returned: Shows the top level overview of the provisioning status.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Provisioning Software UpgradeStatus Phase xCommand xStatus Appendices xStatus Provisioning Software UpgradeStatus SecondsUntilUpgrade Shows the phase of the software upgrade. Indicates how many seconds remain before the software upgrade is automatically installed.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Provisioning Software Current CompletedAt xCommand xStatus Appendices xStatus Provisioning CUCM CAPF ServerPort Shows date and time for when the current software upgrade was completed. Shows the port number to be used for CAPF operations.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices *s Provisioning CUCM CAPF OperationResult: NotSet xStatus Provisioning CUCM CAPF OperationResult ** end Shows the result of the last CAPF operation. NotSet: No CAPF operation has been executed yet. xStatus Provisioning CUCM ProvisionSecurity CAPFUnknown: Unknown CAPF failure. CAPFInvalidAuthStrLen: Invalid length of authentication string (should be 4-10 digits).
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand Security status SIP status xStatus Security FIPS Mode xStatus SIP Shows the FIPS mode status. xStatus Appendices Shows the top level overview of the SIP status. Value space of the result returned: xStatus SIP Proxy [1] Status Shows the status of the communication between the endpoint and the SIP Proxy server.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SIP Proxy [1] Secure xCommand xStatus Appendices xStatus SIP Registration [1..n] Status Shows the encryption status of the signaling with the SIP Proxy server. Shows the status of the registration to the SIP Proxy Server. Value space of the result returned: Deregister: The system is in the process of de-registering to the SIP Proxy.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SIP Registration [1..n] Authentication xCommand xStatus Appendices xStatus SIP Profile 1 Secure Shows which authentication mechanism is used when registering to the SIP Proxy Server. Shows the encryption status of the signaling with the SIP Proxy server. Digest: Uses the Digest access authentication method, as specified by RFC 2069.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SIP Profile 1 Mailbox MessagesWaiting xCommand xStatus xStatus SIP Profile 1 Registration [1..n] Status Indicates how many new messages are in the mailbox. Shows the status of the registration to the SIP Proxy Server. Value space of the result returned: Deregister: The system is in the process of de-registering to the SIP Proxy. Failed: The system failed to register to the SIP Proxy.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Standby status xStatus SIP Profile 1 DirectoryURI Primary URI Returns the primary directory URI set for the endpoint in UCM. Directory URI is associated with a directory number, and can be used to make calls and identify callers. Up to five directory URIs can be set, but only one of them can be set as primary.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration SystemUnit status xCommand xStatus Appendices xStatus SystemUnit Uptime Shows the number of seconds since the last restart of the codec. Value space of the result returned: xStatus SystemUnit Shows the top level overview of the system unit status. Example: xStatus SystemUnit Uptime xStatus SystemUnit ProductType *s SystemUnit Uptime: 597095 Shows the product type.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SystemUnit Software ReleaseDate xCommand xStatus Appendices xStatus SystemUnit Software OptionKeys NaturalPresenter Shows the release date of the software installed on the codec. Shows if the system has the option key installed that supports the NaturalPresenter functionality.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SystemUnit Hardware Module Identifier xCommand xStatus Appendices xStatus SystemUnit Hardware MainBoard Identifier Shows the revision of the hardware module in the codec. Shows the revision of the main board in the codec.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SystemUnit Hardware AudioBoard Identifier xCommand xStatus Appendices xStatus SystemUnit Hardware Temperature Shows the revision of the audio board in the codec. The feedback shows the current maximum temperature (degree Celsius) measured in the codec/ system.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SystemUnit State MaxNumberOfCalls xCommand xStatus Appendices xStatus SystemUnit State NumberOfInProgressCalls Shows the the maximum number of simultaneous calls. Shows the number of calls in progress. Value space of the result returned: Value space of the result returned: <0..5> <0..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus SystemUnit ContactName xCommand xStatus Appendices xStatus SystemUnit Notifications Notification [1..n] Text Returns the system's active contact name. The result depends on which protocol, if any, the system is registered on. Unlike Contact Info, Contact Name is not configurable and is automatically set by the system. Lists text related to important system notifications.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Time status xStatus SystemUnit Diagnostics Message Level Returns information on the level of the diagnostics message. Error: There is an error in the system. The system can still be used, but there can be some restrictions. xStatus Time ZoneOlson Warning: A problem is detected and a more specific report follows indicating the exact problem.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Video status xCommand xStatus Appendices xStatus Video Input Source [1..5] Resolution RefreshRate Shows the resolution refresh rate (Hz) for the video input source. Value space of the result returned: xStatus Video Input <0..300> Shows the top level overview of the video input status.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Video Input Source [1..5] MediaChannelId xCommand xStatus xStatus Video Input HDSDI [1..4] Connected Not in use in this release. Shows if there is something connected to the HD-SDI connector. Not all connections can be detected.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Video Input YPbPr [1..2] SignalState xCommand xStatus Appendices xStatus Video Input Legacy [5] Connected Shows the signal state for the YPbPr input. Unknown: The signal format is unknown. Shows if there is something connected to the Legacy, which are the Y/Comp and C connectors. Not all connections can be detected. OK: A signal is detected and the signal format is supported.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Video Output HDMI [1, 3] Resolution Width xCommand xStatus Appendices xStatus Video Output DVI [2, 4] Resolution Height Shows the resolution width (in pixels) for the video output HDMI. Shows the resolution height (in pixels) for the video output DVI. Value space of the result returned: Value space of the result returned: <176..4000> <120..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Video Output DVI [2, 4] Connected xCommand xStatus Appendices xStatus Video Output Legacy [5] Resolution RefreshRate Indicates whether a display is connected to the DVI video output or not. NOTE: When a display enters standby mode, the endpoint may not be able to detect it. The connector status will then return False/Unknown even if the display is physically connected.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Video Layout Site [1..n] Output [1..5] FamilyName xCommand xStatus Appendices xStatus Video Layout Site [1..n] Output [1..5] Frame [1..6] PositionX Shows the name of the video layout family. Shows the horizontal position of the upper left corner of the frame. Value space of the result returned: Value space of the result returned: <0..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Video Layout Site [1..n] Output [1..5] Frame [1..6] Layer xCommand xStatus Appendices xStatus Video Layout Site [1..n] Output [1..5] Frame [1..6] Filename Shows the layer of the frame. Shows the filename of the layout frame. Value space of the result returned: Value space of the result returned: <1..
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xStatus Video Layout Site Output Frame VideoSourceContent xCommand xStatus xStatus Video Selfview FullscreenMode Shows the video source content type of each layout frame. Shows whether selfview is set on full screen mode or not. noSource: There is no source. Value space of the result returned: black: The frame is black.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Experimental status xStatus Video PIP Presentation Position Shows the position of the presentation image on the screen. The Experimental status is for testing only and should not be used unless agreed with Cisco. These settings are not documented and WILL change in later releases.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices Chapter 6 Appendices D14641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. 204 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices The Video Input Matrix The video input matrix is found on the back of the codec and illustrates the combinations in which the video inputs can be connected. Video input matrix Input Sources About the matrix Only one video input source from each row can be active at any time. The numbers in the left column represents the Video Input Sources 1–5.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand About startup scripts Adding a startup script You can add a startup script on the codec to execute certain commands from the API during boot up. The startup script can be used to execute certain commands from the API during boot up. To enable this feature one must log in to the codec as root and follow the steps below. xStatus Appendices Login to the codec 1.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API Cisco TelePresence Remote Control xConfiguration xCommand xStatus Function keys: Represents shortcuts and advanced functions. Each key reflects a soft key on screen. Presentation: Press the Microphone: Press the Zoom: Press the + or – on the and out. Mute the ringtone: Press minus (-) on the volume key to mute the ringtone on an incoming call.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration Remote control key map The Cisco TelePresence Remote Control 5 has the following button codes and IR signal parameters.
Cisco TelePresence System Codec C90 Contents Introduction The SystemTools commands Note: The systemtools commands are used for administrative control of the codec and is only available from a command line interface. Systemtools should not be used to program the codec. Required parameters in angle brackets: Optional parameters in square brackets: [text] To get an overview of the supported commands type “systemtools ?”.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand systemtools rootsettings on [password] systemtools securitysettings ask Command to control the root user access. Query for the separate configurations. When issuing this command you can see each policy separately. Enable access to the system for the root user on all ports. password: The root user password.
Cisco TelePresence System Codec C90 Contents Introduction About disconnect cause types The following parameters are logged when a call is disconnected. The disconnect cause types are used in disconnect events (xEvent) and also logged in xHistory CallLogs. API Reference Guide About the API xConfiguration xCommand xStatus Appendices CauseValue Proprietary. We recomend the use of CauseType and CauseCode. CauseType Describes why the call was disconnected.
Cisco TelePresence System Codec C90 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices On our web site you will find an overview of the worldwide Cisco contacts. Go to: http://www.cisco.com/web/siteassets/contacts Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Dr. San Jose, CA 95134 USA THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE.
