Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Software version TC6.3 NOVEMBER 2013 Application Programmer Interface (API) Reference Guide Cisco TelePresence System Codec C40/C60 D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. 1 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C40/C60 Contents Introduction What’s in this guide? TA - ToC - Hidden text anchor The top menu bar and the entries in the table of contents are all hyperlinks, just click on them to go to the topic. We recommend you 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 C40/C60 Contents Introduction Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Chapter 1 Introduction D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. 3 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C40/C60 Contents Introduction 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 gro
Cisco TelePresence System Codec C40/C60 Contents Introduction Introduction API Reference Guide About the API xConfiguration xCommand xStatus Appendices What’s newin this version This section provides an overview of the new and changed system settings and new features in the TC6.3 software version. Software release notes For a complete overview of new features and changes, we recommend reading the Software Release Notes (TC6). Go to: http://www.cisco.
Cisco TelePresence System Codec C40/C60 Contents Introduction Introduction API Reference Guide About the API Extended logging mode for troubleshooting xConfiguration You can switch on extended logging from the web interface. Extended logging may help diagnose network issues and problems during call setup.
Cisco TelePresence System Codec C40/C60 Contents Introduction Introduction xConfiguration Video Output Composite[n] MonitorRole (only C60) OLD: NEW: API Reference Guide About the API xConfiguration xCommand xCommand xStatus Appendices remotePresentation/videoFile> New commands xCommand CallHistory AcknowledgeAllMissedCalls xCommand CallHistory AcknowledgeMissedCall NEW: VideoSourceType:(o)![]()
Cisco TelePresence System Codec C40/C60 Contents Introduction Introduction xStatus New Statuses xStatus Audio Input Connectors Microphone [n] EcReferenceDelay API Reference Guide About the API xConfiguration xCommand xStatus Video OSD Mode xStatus Video Output HDMI [n] MonitorRole xStatus Video Output DVI [n] MonitorRole xStatus Video Output Legacy [n] MonitorRole xStatus Video Layout Site [n] Output [n] FrameContainer [n] PositionX xStatus Camera [n] UpgradeStatus xStatus Camera [n] DownloadProgres
Cisco TelePresence System Codec C40/C60 Contents Introduction Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices H320GatewayStatus/ISDNLinkCompatibility/ SIPProfileRegistration/SIPListenPortAndOutboundMode/ TLSVerifyRequiredCerts/DefaultCallProtocolRegistered/ NetSpeedAutoNegotiated/HasValidReleaseKey/ EthernetDuplexMatches/IPv4Assignment/ IPv6Assignment/SIPProfileType/ CallProtocolIPStackPlatformCompatibility/ CameraStatus/CameraPairing/CameraSoftwareVersion/ S
Cisco TelePresence System Codec C40/C60 Contents Introduction About About the API API API Reference Guide xConfiguration xCommand xStatus Appendices Chapter 2 About the API D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. 10 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C40/C60 Contents Introduction API Reference Guide About About the API 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 C40/C60 Contents Introduction API output The xPreferences is used to set preferences for the RS-232, Telnet and SSH sessions. API Reference Guide About About the API 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 C40/C60 Contents Introduction Using the command line Help API Reference Guide About About the API 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 C40/C60 Contents Introduction API Reference Guide About About the API 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 C40/C60 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.
Cisco TelePresence System Codec C40/C60 Contents Introduction Configurations Configurations are system settings that are persistent across boots. Like commands, also configurations are structured in a hierarchy. Writing xConfiguration ? on the command line lists all the top level configurations. Writing xConfiguration ?? lists all configurations and their value spaces. Writing xConfiguration lists all configurations and their current values.
Cisco TelePresence System Codec C40/C60 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 C40/C60 Contents Introduction Events 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. To get an overview of the supported events type ?, ?? or help after xEvent: • xEvent ? Lists the top level events • xEvent ?? List all of the available events • xEvent help Lists the top level events The result for events depends on the state of the codec.
Cisco TelePresence System Codec C40/C60 Contents Introduction Call history The xHistory command returns the call logs. API Reference Guide About About the API API xConfiguration xCommand xStatus Appendices Example with xHistory CallLogs xHistory *h xHistory CallLogs Call 1 CallId: 2 *h xHistory CallLogs Call 1 Protocol: “H323” *h xHistory CallLogs Call 1 Direction: Outgoing *h xHistory CallLogs Call 1 CallType: Video *h xHistory CallLogs Call 1 RemoteNumber: “h323:name@company.
Cisco TelePresence System Codec C40/C60 Contents Introduction API Reference Guide About About the API API xConfiguration xCommand The API supports notifications on the following: • Configuration changes • • Terminal query Feedback expressions The expression used when registering for feedback is a variant of the XPath language. This language describes a way to select nodes from an XML document.
Cisco TelePresence System Codec C40/C60 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 C40/C60 Contents Introduction API Reference Guide About About the API 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 C40/C60 Contents Introduction API Reference Guide About About the API 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 IPaddress. This means that you have to have a HTTP server running for your application to receive updates from the codec.
Cisco TelePresence System Codec C40/C60 Contents Introduction API Reference Guide About About the API 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 C40/C60 Contents Introduction API Reference Guide About About the API 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. 26 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices xConfiguration Conference [1..1] DoNotDisturb DefaultTimeout.................................................................40 xConfiguration H323 Profile [1..1] H323Alias ID...........................................................................................47 xConfiguration Conference [1..1] FarEndControl Mode.............................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices Provisioning configuration..................................................................................................................... 59 xConfiguration Network [1..1] TrafficControl Mode......................................................................................53 xConfiguration Network [1..1] RemoteAccess Allow.................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices xConfiguration Time DateFormat................................................................................................................70 xConfiguration SIP Profile [1..1] Ice Mode....................................................................................................64 xConfiguration SIP Profile [1..1] Ice DefaultCandidate......
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices xConfiguration Video Layout LocalLayoutFamily........................................................................................77 xConfiguration Video Layout PresentationDefault View..............................................................................77 xConfiguration Video Layout RemoteLayoutFamily....................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration Audio configuration xCommand xStatus Appendices xConfiguration Audio Input Line [1..2] Equalizer ID Select the audio input line equalizer ID. Requires user role: ADMIN xConfiguration Audio Input HDMI [2] Mode Determine if the audio channels on the HDMI input shall be enabled. The HDMI input 2 has two audio channels. Value space: <1..
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Audio Input Line [1..2] Channel xCommand xStatus Appendices xConfiguration Audio Input Microphone [1..2]/[1..4] EchoControl Mode Define whether the Audio Line input is a mono signal or part of a multichannel signal. NOTE: Codec C40 has two microphone connectors. Codec C60 has four microphone connectors.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Audio Input Microphone [1..2]/[1..4] Equalizer ID xCommand xStatus Appendices xConfiguration Audio Input Microphone [1..2]/[1..4] VideoAssociation VideoInputSource NOTE: Codec C40 has two microphone connectors. Codec C60 has four microphone connectors. NOTE: Codec C40 has two microphone connectors. Codec C60 has four microphone connectors.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Audio Input Microphone [1..2]/[1..4] Type xCommand xStatus Appendices xConfiguration Audio Output Line [1..2] Channel NOTE: Codec C40 has two microphone connectors. Codec C60 has four microphone connectors. Define whether the Audio Line output is a mono signal or part of a multichannel signal.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Audio Output Line [1..2] Mode xCommand xStatus Appendices xConfiguration Audio SoundsAndAlerts KeyTones Mode Set the audio output line mode. The system can be configured to make a keyboard click sound effect (key tone) when pressing a key on the remote control, or when typing text or numbers on a Touch controller.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration Cameras configuration xCommand xStatus Appendices xConfiguration Cameras Camera [1..7] Flip With Flip mode (vertical flip) you can flip the image upside down. Requires user role: ADMIN xConfiguration Cameras Camera [1..7] Backlight Value space: This configuration turns backlight compensation on or off.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Cameras Camera [1..7] Gamma Level xCommand xStatus Appendices xConfiguration Cameras Camera [1..7] MotorMoveDetection By setting the Gamma Level you can select which gamma correction table to use. This setting may be useful in difficult lighting conditions, where changes to the brightness setting does not provide satisfactory results.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices Conference configuration xConfiguration Cameras Camera [1..7] DHCP Applies to cameras which support DHCP (for example the Cisco TelePresence PrecisionHD 1080p 12X camera). The camera must be connected to a LAN. When set, the command enables support for SW upgrade of daisy chained cameras.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Conference [1..1] AutoAnswer Delay xCommand xStatus Appendices xConfiguration Conference [1..1] DoNotDisturb DefaultTimeout Define how long (in seconds) an incoming call has to wait before it is answered automatically by the system. NOTE: Requires that AutoAnswer Mode is switched on.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Conference [1..1] Encryption Mode xCommand xStatus Appendices xConfiguration Conference [1..1] MaxTransmitCallRate Set the conference encryption mode. A padlock with the text "Encryption On" or "Encryption Off" displays on screen for a few seconds when the conference starts. Specify the maximum transmit bit rate to be used when placing or receiving calls.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Conference [1..1] MaxTotalReceiveCallRate xCommand xStatus Appendices xConfiguration Conference [1..1] VideoBandwidth PresentationChannel 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Conference [1..1] Presentation OnPlacedOnHold xCommand xStatus Appendices xConfiguration Conference [1..1] IncomingMultisiteCall Mode Define whether or not to continue sharing a presentation after the remote site has put you on hold. Select whether or not to allow incoming calls when already in a call/conference.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand GPIO configuration H323 configuration xConfiguration GPIO Pin [1..4] Mode xConfiguration H323 NAT Mode NOTE: This command is not supported on Codec C40. xStatus Appendices 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).
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices Logging 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 Logging Mode Not applicable in this version.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration Network configuration xStatus Appendices xConfiguration Network [1..1] IPv4 Gateway Define the IPv4 network gateway. This setting is only applicable when the Network Assignment is set to Static. xConfiguration Network [1..1] IPStack Requires user role: ADMIN Select if the sFystem should use IPv4, IPv6, or dual IP stack, on the network interface.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Network [1..1] IPv6 Address xCommand xStatus Appendices xConfiguration Network [1..1] DHCP RequestTFTPServerAddress 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Network [1..1] QoS Mode xCommand xStatus Appendices xConfiguration Network [1..1] QoS Diffserv Video The QoS (Quality of Service) is a method which handles the priority of audio, video and data in the network. The QoS settings must be supported by the infrastructure.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Network [1..1] QoS Diffserv Signalling xCommand xStatus Appendices xConfiguration Network [1..1] QoS Diffserv NTP 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.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Network [1..1] IEEE8021X UseClientCertificate xCommand xStatus Appendices xConfiguration Network [1..1] IEEE8021X Eap Md5 Authentication using a private key/certificate pair during an IEEE802.1x connection. The authentication X.509 certificate must be uploaded to the video system. This can be done from the web interface.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Network [1..1] IEEE8021X Eap Peap xCommand xStatus Appendices xConfiguration Network [1..1] TrafficControl Mode Set the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus NetworkPort configuration NetworkServices configuration xConfiguration NetworkPort [2] Mode xConfiguration NetworkServices H323 Mode Define if the network port 2 shall be enabled for direct pairing with a Cisco TelePresence Touch controller. Appendices Determine whether the system should be able to place and receive H.323 calls or not.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration NetworkServices Telnet Mode xCommand xStatus Appendices xConfiguration NetworkServices MultiWay Address Telnet is a network protocol used on the Internet or Local Area Network (LAN) connections. Requires user role: ADMIN The MultiWay address must be equal to the Conference Factory Alias, as configured on the Video Communication Server.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration NetworkServices SNMP Mode xCommand xStatus Appendices xConfiguration NetworkServices SNMP SystemContact SNMP (Simple Network Management Protocol) is used in network management systems to monitor network-attached devices (routers, servers, switches, projectors, etc) for conditions that warrant administrative attention.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices Phonebook configuration xConfiguration NetworkServices CTMS Mode This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence Multipoint Switch (CTMS). xConfiguration Phonebook Server [1..1] ID Video systems running software TC5.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration Provisioning configuration xCommand xStatus Appendices xConfiguration Provisioning LoginName 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Provisioning ExternalManager Address xCommand xStatus Appendices xConfiguration Provisioning ExternalManager Path Enter the IP Address or DNS name of the external manager / provisioning system. Set the Path to the external manager / provisioning system. This setting is required when several management services reside on the same server, i.e.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus RTP configuration Security configuration xConfiguration RTP Ports Range Start xConfiguration Security Audit Logging Mode Specify the first port in the range of RTP ports. Also see the H323 Profile [1..1] PortAllocation setting. Appendices Determine where to record or transmit the audit logs. The audit logs are sent to a syslog server.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Security Audit Server Address xCommand xStatus Appendices xConfiguration Security Session ShowLastLogon The audit logs are sent to a syslog server. Enter the IP address of the syslog server. Only valid IPv4 or IPv6 address formats are accepted. Host names are not supported.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand SerialPort configuration SIP configuration xConfiguration SerialPort Mode xConfiguration SIP ANAT Enable/disable the serial port (COM port). xStatus Appendices ANAT (Alternative Network Address Types) enables media negotiation for multiple addresses and address types, as specified in RFC 4091.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration SIP PreferredIPSignaling xCommand xStatus Appendices xConfiguration SIP Profile [1..1] Ice DefaultCandidate Define the preferred IP version for signaling (audio, video, data). Only applicable when both Network IPStack and Conference CallProtocolIPStack are set to Dual, and the network does not have a mechanism for choosing the preferred IP version.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration SIP Profile [1..1] Turn Server xCommand xStatus Appendices xConfiguration SIP Profile [1..1] DisplayName This is the address of the TURN (Traversal Using Relay NAT) server that the endpoints will use. It is used as a media relay fallback and it is also used to discover the endpoint’s own public IP address.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices Time configuration xConfiguration SystemUnit ContactInfo Type 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices UserInterface configuration xConfiguration Time TimeFormat Set the time format. Requires user role: USER xConfiguration UserInterface TouchPanel DefaultPanel Value space: <24H/12H> 24H: Set the time format to 24 hours.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration Video configuration xCommand xStatus Appendices xConfiguration Video Input Source [3] Connector NOTE: Codec C40 has one DVI input (DVI-I 3). Codec C60 has two DVI inputs (in this context, use DVI-I 3). xConfiguration Video Input Source [1..3] Name Select which video input connector to be active on video input source 3. Enter a name for the video input source.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Video Input Source [1..3] PresentationSelection xCommand xStatus Appendices xConfiguration Video Input Source [1..3] OptimalDefinition Profile In general, any input source can be used as a presentation source; normally, the main camera (self view) will not be used as a presentation source.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Video Input Source [1..3] 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Video Input DVI [3]/[2,3] RGBQuantizationRange xCommand xStatus Appendices xConfiguration Video Layout Scaling NOTE: Codec C40 has one DVI input (DVI-I 3). Codec C60 has two DVI inputs (DVI-I 2 and 3). Define how the system shall adjust the aspect ratio for images or frames when there is a difference between the image and the frame it is to be placed in.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Video OSD TodaysBookings xCommand xStatus Appendices xConfiguration Video OSD InputMethod InputLanguage This setting can be used to display the system's bookings for today on the main OSD menu. This requires that the system is bookable by an external booking system, like Cisco TelePresence Management Suite (TMS).
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Video AllowWebSnapshots xCommand xStatus Appendices xConfiguration Video Output HDMI [1] CEC Mode Allow or disallow snapshots being taken of the local input sources, remote sites and presentation channel. If allowed, the web interface Call Control page will show snapshots both when idle and in a call.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Video Output HDMI [1] OverscanLevel xCommand xStatus Appendices xConfiguration Video Output DVI [2] RGBQuantizationRange Some TVs or other monitors may not display the whole image sent out on the systems video output, but cuts the outer parts of the image. In this case this setting can be used to let the system not use the outer parts of video resolution.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xConfiguration Video Output DVI [2] OverscanLevel xCommand xStatus Appendices xConfiguration Video Output Composite [3] MonitorRole Some TVs or other monitors may not display the whole image sent out on the systems video output, but cuts the outer parts of the image. In this case this setting can be used to let the system not use the outer parts of video resolution.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xConfiguration xCommand xStatus Appendices Experimental configuration xConfiguration Video WallPaper Select a background image (wallpaper) for the video screen when idle. The Experimental settings are for testing only and should not be used unless agreed with Cisco. These settings are not documented and WILL change in later releases.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Chapter 4 xCommand commands D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. 85 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide 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 Bookings commands............................................................................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration CallLog commands.............................................................................................................................. 104 xCommand xStatus Appendices xCommand FacilityService Dial................................................................................................................. 111 xCommand CallLog Clear................................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xCommand Phonebook Contact Delete....................................................................................................120 xCommand SystemUnit OptionKey RemoveAll.........................................................................................128 xCommand Phonebook ContactMethod Add...........................................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xCommand Video Layout UnAssignLocalOutput......................................................................................136 xCommand Video PIP ActiveSpeaker Set.................................................................................................138 xCommand Video Layout UnAssignCall..............................................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration Audio commands 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration *r AudioEqualizerListResult Equalizer 1 Section 4 Q: "4" 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Audio LocalInput Update 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Audio LocalInput RemoveConnector 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Audio LocalOutput Update 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Audio LocalOutput ConnectInput 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Audio RemoteOutput UpdateInputGain 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration *r Bookings Booking 1 BookingStatusMessage: "" 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Call Disconnect 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Call ExtendConference 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xStatus Appendices CallHistory commands Example: xCommand CallHistory AcknowledgeAllMissedCalls xCommand CallHistory DeleteAll Filter: Missed Turns off the missed calls indicator on the touch controller for all missed calls.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand CallHistory Get xStatus Appendices xCommand CallHistory Recents Retrieve all information on previous calls made on the video system. Retrieve aggregated information on previous calls made on the video system. Filter: You can filter which calls to retrieve; either all, missed, placed or received calls.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration CallLog commands 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration Camera commands 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Camera Ramp 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Camera Preset Activate 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration FarEndControl commands 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Message TextLine Display 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Message Prompt Clear 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration Phonebook commands 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Phonebook Contact Add 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Phonebook Contact Delete 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Phonebook ContactMethod Modify 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.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Provisioning CUCM CAPF OperationStart xStatus Appendices xCommand Provisioning CUCM ExtensionMobility Login Starts a pending CAPF (Certificate Authority Proxy Function) operation toward the CUCM.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration Security commands xStatus Appendices xCommand Security Persistency Set the following features to persistent or non-persistent mode. In non-persistent mode the information gathered by the specified feature does not persist a reboot of the system. Persistent mode is the default. This command reboots the system.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration SystemUnit commands 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 C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand SystemUnit Diagnostics ExtendedLogging Start xStatus Appendices xCommand SystemUnit MenuPassword Validate Turns on the extended logging, which stores more information than regular logging in the log files. You can determine the duration in seconds. Note that extended logging uses more of your video system’s resources, and should only be used when troubleshooting an issue.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand SystemUnit DateTime Get xStatus Appendices xCommand SystemUnit SoftwareUpgrade Read the time and date from the system. Initiate a software upgrade by fetching the software on a given URL. If the server requires username and password these parameters must be included.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand SystemUnit ConfigurationProfile Remove xStatus Appendices xCommand SystemUnit ConfigurationProfile CancelChange Delete a configuration profile that has been stored in the system. Cancel the "ConfigurationProfile Change" command, that would otherwise take effect after next system boot.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand Video Layout Remove xCommand xStatus Appendices xCommand Video Layout Frame Add NOTE: This command is not supported on Codec C40. NOTE: This command is not supported on Codec C40. Removes 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.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xCommand Video Layout Frame Update Requires user role: ADMIN NOTE: This command is not supported on Codec C40. Parameters: LayoutId(r): <1..2147483647> Change the details of an existing frame in a video layout. FrameId: <1..65535> LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xStatus Appendices xCommand Video Layout Assign Requires user role: ADMIN NOTE: This command is not supported on Codec C40. Parameters: Assign an existing layout to any local or remote output. The defined video composition appears on the specified local output or in the specified remote video stream. LayoutId(r): <1..2147483647> FrameId(r): <1..
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Video Layout AssignCall xStatus Appendices xCommand Video Layout UnAssign NOTE: This command is not supported on Codec C40. NOTE: This command is not supported on Codec C40. Assign the call layout (main stream) to the remote output. The defined video composition appears on the remote main video stream. Remove the defined video layout, and go back to default.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Video Layout UnAssignCall xStatus Appendices xCommand Video Layout SetPresentationView NOTE: This command is not supported on Codec C40. Set the presentation view mode. Remove the defined video layout, and go back to default. CallId: A unique identifier for the call. The CallID is returned when the xCommand Dial command is run.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Video Layout Frame List xStatus xCommand Video OSD Close Lists the data related to all layout frames created by command 'xCommand Video Layout Frame Add' for a specific layout identified by 'LayoutId' Closes all menus on the on-screen display. Requires user role: ADMIN Requires user role: ADMIN Parameters: Parameters: Element: The on–screen menu. LayoutId(o): <1..
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xCommand xConfiguration xCommand Video PIP Presentation Set xStatus Appendices xCommand Video Selfview Set Sets position for the presentation PiP (picture in picture). Sets self-view on/off and specifies its size and position. If the parameter is not specified, current value is used. Position: Predefined positions.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Experimental commands xCommand Video PIP Presentation Set Sets position for the presentation PiP (picture in picture). The Experimental commands are for testing only and should not be used unless agreed with Cisco. Position: Predefined positions. CenterLeft: The presentation PiP appears on the left side of the screen, in center.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Chapter 5 xStatus commands D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. 141 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xStatus Camera [1..7] Capabilities Options...............................................................................................157 xStatus Conference Line [n] Appearance Status......................................................................................162 xStatus Camera [1..7] Flip..............................................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xStatus Diagnostics Call [n] Channels IncomingDataChannel [n] Netstat 1 LastIntervalReceived............166 xStatus H320 Gateway Reason.................................................................................................................169 xStatus Diagnostics Call [n] Channels OutgoingAudioChannel [n] Netstat 1 LastIntervalReceived..........
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xStatus MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Remote Port.........................175 xStatus MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTP Remote IpAddress...............181 xStatus MediaChannels Call [n] IncomingAudioChannel [n] Transport RTCP Local IpAddress.................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices NetworkServices status....................................................................................................................... 187 xStatus Provisioning CUCM TVS Proxy [n]Server.....................................................................................192 xStatus NetworkServices NTP Address.................................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Standby status..................................................................................................................................... 199 xStatus SystemUnit State Subsystem Application....................................................................................204 xStatus Standby Active........................................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xStatus Video Output DVI [2] Resolution Height........................................................................................ 211 xStatus Video PIP ActiveSpeaker Position................................................................................................216 xStatus Video Output DVI [2] Resolution Width........................................
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration Audio status xStatus xCommand Appendices xStatus Audio Input LocalInput [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 [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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Audio Input LocalInput [n] AGC xStatus xCommand Appendices xStatus Audio Input Connectors Microphone [n] EcReferenceDelay Shows the AGC (Automatic Gain Control) mode on the local input. Returns the detected latency for each loudspeaker to microphone path. The result is in milliseconds. You can run the command xStatus Audio Input LocalInput to find the identity [n] of the input.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Audio Output LocalOutput [n] Channels xStatus xCommand Appendices xStatus Audio Output RemoteOutput [n] CallId States if the local output channels are mixed into into a mono signal (1) or stereo signal (2). Shows the CallId for the remote audio output. You can run the command xStatus Audio Output LocalOutput to find the identity [n] of the output.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Call status xStatus Audio Module [0] SoftwareID Shows the SoftwareID of the DNAM dsp software. 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 SoftwareID xStatus Call [1..
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Call [n] CallType xCommand xStatus Appendices xStatus Call [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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Call [n] FacilityServiceId xStatus xCommand Appendices xStatus Call [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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus xCommand Appendices Camera status xStatus Call [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 C40/C60 Contents Introduction About the API API Reference Guide 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Camera [1..7] Position Zoom xStatus xCommand Appendices xStatus Camera [n] UpgradeStatus Shows the current zoom (zoom in and out) position of the camera. The value range depends on camera type. Returns the status of the camera software upgrade. Value space of the result returned: Downloading: Downloading the upgrade. None: No upgrade going on at the moment. <0..
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus xCommand Appendices Conference status Value space of the result returned: xStatus Conference Shows the top level overview of the conference status. The identity of the Conference Site can only be read during a call.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Conference Presentation Resolution Width xStatus xCommand 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Conference Site [n] Capabilities FECC Source [n] Name xStatus xCommand Appendices xStatus Conference Site [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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Conference Site [n] BlackScreenCause xStatus xCommand Appendices xStatus Conference Site [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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Conference Site [n] AttendedTransfer xStatus xCommand xStatus Conference Site [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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Conference Line [n] Appearance URI xStatus xCommand 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration Diagnostics status xCommand xStatus Appendices xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 Packets xStatus Diagnostics Call [n] Channels IncomingVideoChannel [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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 Loss xCommand xStatus Appendices xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 LastIntervalLost xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 Loss xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 LastIntervalLost xStatus Diagnostics Call [
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 LastIntervalReceived xCommand xStatus Appendices xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 Drop xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 Drop xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 LastIntervalReceived xStatus Diagnostics
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 Bytes xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 ChannelRate xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 Bytes xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 ChannelRate xStatus Diagnostics Call [n] Chann
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices GPIO status xStatus Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 MaxJitter xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 MaxJitter xStatus GPIO Pin [1..4] State NOTE: This command is not supported on Codec C40.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration H320 status xStatus xCommand 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 C40/C60 Contents Introduction About the API API Reference Guide 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 C40/C60 Contents Introduction About the API API Reference Guide 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus ICE Turn Hostname xStatus xCommand 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices xStatus ICE Call Remote IP Returns the IP address the remote system is using for media routing in the present call.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration MediaChannels status xStatus xCommand Appendices xStatus MediaChannels Call [n] IncomingAudioChannel [n] Audio Mute Audio mute status of incoming audio. 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Local Port xCommand xStatus Appendices xStatus MediaChannels Call [n] IncomingAudioChannel [n] Transport RTCP Local IpAddress 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] IncomingAudioChannel [n] Transport RCTP Remote Port xStatus xCommand xStatus MediaChannels Call [n] IncomingVideoChannel [n] Video Protocol Shows the video algorithm for the incoming video channel. Shows the remote UDP port number of the Real-time Transport Control Protocol(RTCP) port for the incoming audio in the media channel. H264: The H.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] IncomingVideoChannel [n] Video ResolutionY xCommand xStatus Appendices xStatus MediaChannels Call [n] IncomingVideoChannel [n] Transport RTP Remote IpAddress Shows the height (resolution in direction Y) of the incoming video. 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] IncomingVideoChannel [n] Transport RTCP Local Port xStatus xCommand Appendices xStatus MediaChannels Call [n] OutgoingAudioChannel [n] Encryption Status Shows the local UDP port number of the Real-time Transport Control Protocol (RTCP) port for the incoming video in the media channel. Shows the encryption status on the outgoing channel.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] OutgoingAudioChannel [n] Transport RTP Local IpAddress xCommand xStatus Appendices xStatus MediaChannels Call [n] OutgoingAudioChannel [n] Transport RTP Remote Port 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] OutgoingAudioChannel [n] Transport RTCP Remote IpAddress xStatus xCommand Appendices xStatus MediaChannels Call [n] OutgoingVideoChannel [n] ChannelRole Shows if the outgoing channel is the main video channel or presentation channel. Shows the remote IP address of the Real-time Transport Control Protocol(RTCP) port for the outgoing audio in the media channel.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] OutgoingVideoChannel [n] Video ResolutionX xCommand xStatus Appendices xStatus MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTP Local Port Shows the width (resolution in direction X) of the outgoing video. 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTCP Local IpAddress xCommand xStatus Appendices xStatus MediaChannels Call [n] OutgoingVideoChannel [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.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration Network status xStatus xCommand Appendices xStatus Network 1 IPv4 SubnetMask Shows the subnet mask which determines which subnet an IPv4 address belongs to. Value space of the result returned: xStatus Network Shows the top level overview of the network status. Example: xStatus Network 1 IPv4 SubnetMask xStatus Network 1 Ethernet MacAddress *s Network 1 IPv4 SubnetMask: "255.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Network 1 IPv4 DHCP TftpServerAddress xStatus xCommand Appendices xStatus Network 1 IPv4 DHCP ProvisioningDomain 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Network 1 IPv6 Gateway xCommand xStatus Appendices xStatus Network CDP Version Shows the address of the IPv6 gateway. Returns information about the software release version the switch is running.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Network CDP PortID xStatus xCommand Appendices xStatus Network CDP PrimaryMgmtAddress Returns the identification the switch uses of the port the endpoint is connected to. Returns the management address used to configure and monitor the switch the endpoint is connected to.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus xCommand Appendices NetworkServices status xStatus Network CDP VoIPApplianceVlanID Identifies the VLAN used for VoIP traffic from the endpoint to the switch. For more information see documentation of the IEEE 802.1Q protocol. xStatus NetworkServices NTP Address Value space of the result returned: Returns the address of the NTP server(s) the codec is using.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration Preset status Provisioning status xStatus Preset xStatus Provisioning Shows the top level overview of the camera presets status. xStatus xCommand Appendices Shows the top level overview of the provisioning status. xStatus Preset [1..15] Defined xStatus Provisioning Status Shows if a camera preset is stored at this position. Shows the status of the provisioning.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Provisioning Server xCommand xStatus Appendices xStatus Provisioning Software UpgradeStatus Phase Identifies the server the system is provisioned to. This address may either be defined in the xConfiguration ExternalManager Address setting, or provided by DHCP. Shows the phase of the software upgrade.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Provisioning Software UpgradeStatus SecondsUntilUpgrade xStatus xCommand Appendices xStatus Provisioning Software Current CompletedAt Indicates how many seconds remain before the software upgrade is automatically installed.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Provisioning CUCM CAPF ServerPort xStatus xCommand Appendices xStatus Provisioning CUCM CAPF OperationResult Shows the port number to be used for CAPF operations. Shows the result of the last CAPF operation. Value space of the result returned: NotSet: No CAPF operation has been executed yet. CAPFUnknown: Unknown CAPF failure.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration *s Provisioning CUCM CAPF OperationResult: NotSet xCommand xStatus Appendices xStatus Provisioning CUCM ExtensionMobility LoggedIn ** end Indicates whether you are logged in to Extension Mobility or not. Value space of the result returned: xStatus Provisioning CUCM ProvisionSecurity Shows the provisioned configuration file type.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus xCommand Appendices Security status xStatus Provisioning CUCM TVS Proxy [n] Port Returns the number of the port the TVS is running on. Value space of the result returned: xStatus Security FIPS Mode Shows the FIPS mode status.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Security Persistency InternalLogging xStatus xCommand Appendices xStatus Security Audit Server Port Shows whether internal logging is set to persistent or non-persistent mode. Persistent is the default mode. Returns information on which syslog server port the audit logs are configured to be sent to.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration SIP status xCommand xStatus Appendices xStatus SIP Proxy [1] Secure Shows the encryption status of the signaling with the SIP Proxy server. Value space of the result returned: xStatus SIP Shows the top level overview of the SIP status.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SIP Registration [n] Status xStatus xCommand Appendices xStatus SIP Registration [n] Authentication Shows the status of the registration to the SIP Proxy Server. Shows which authentication mechanism is used when registering to the SIP Proxy Server. Deregister: The system is in the process of de-registering to the SIP Proxy.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SIP Profile 1 Proxy [1] Address xStatus xCommand Appendices xStatus SIP Profile 1 Authentication Shows the address of the SIP Proxy that the system communicates with. Shows which authentication mechanism is used when registering to the SIP Proxy Server. Value space of the result returned: Digest: Uses the Digest access authentication method, as specified by RFC 2069.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SIP Profile 1 CallForward URI xStatus xCommand Appendices xStatus SIP Profile 1 Registration [n] Reason Indicates the address the incoming calls are directed to when call forward mode is set on. Shows a message to explain the reason why the SIP registration failed.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration SystemUnit status xStatus xCommand 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 C40/C60 Contents Introduction About the API API Reference Guide 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SystemUnit Hardware Module SerialNumber xStatus xCommand Appendices xStatus SystemUnit Hardware MainBoard SerialNumber Shows the serial number of the hardware module in the codec. Shows the serial number of the main board in the codec.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SystemUnit Hardware BootSoftware xStatus xCommand Appendices xStatus SystemUnit Hardware TemperatureThreshold Shows the version of the boot software that is installed on the codec. Returns information on the maximum temperature for the codec. If this temperature is exceeded the system automatically shuts down.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SystemUnit State MaxNumberOfActiveCalls xStatus xCommand Appendices xStatus SystemUnit State Subsystem Application Shows the the maximum number of simultaneous active calls. Calls that are set on hold/transfer are not counted as active. Shows the status of the sub system application. Value space of the result returned: Initializing: The sub-system application is initializing.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SystemUnit Notifications Notification [n] Type xCommand xStatus Appendices xStatus SystemUnit Diagnostics LastRun Lists the system notification types. Notifications are issued e.g. when a system is rebooted because of a software upgrade, or when a factory reset is performed. Shows when the SystemUnit diagnostics was last run on the codec.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus SystemUnit Diagnostics Message Level xCommand xStatus Appendices xStatus SystemUnit Diagnostics ExtendedLogging Mode Returns information on the level of the diagnostics message. Indicates whether extended logging of diagnostics is turned on or off. Error: There is an error in the system. The system can still be used, but there can be some restrictions.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration Time status Video status xStatus Time ZoneOlson xStatus Video Input Shows the current time zone in Olson format. xStatus xCommand Appendices Shows the top level overview of the video input status. Value space of the result returned: xStatus Video Monitors Returns the monitor layout mode. Example: Single: The same layout is shown on all monitors.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Input Source [1..3] Resolution Height xStatus xCommand Appendices xStatus Video Input Source [1..3] Resolution FormatStatus Shows the resolution height (in pixels) for the video input source. Shows the resolution format status for the video input source. Value space of the result returned: Value space of the result returned: <0..
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Input HDMI [1..2] SignalState xStatus xCommand Appendices xStatus Video Input Legacy [3] Connected Shows the signal state for the HDMI 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Output HDMI [n] MonitorRole xStatus xCommand Appendices xStatus Video Output HDMI [1] Resolution RefreshRate Describes which video stream is shown on the monitor connected to the video output HDMI connector. Shows the resolution refresh rate (Hz) for the video output HDMI.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Output DVI [n] MonitorRole xStatus xCommand Appendices xStatus Video Output DVI [2] Resolution RefreshRate Describes which video stream is shown on the monitor connected to the video output DVI connector. Shows the resolution refresh rate (Hz) for the video output DVI.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Output Legacy [n] MonitorRole xStatus xCommand Appendices xStatus Video Output Legacy [3] Resolution RefreshRate Describes which video stream is shown on the monitor connected to the video output Legacy connector. Shows the resolution refresh rate (Hz) for the video output Legacy (Composite).
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Layout Site [n] Output [1..3] FamilyName xCommand xStatus Appendices xStatus Video Layout Site [n] Output [1..3] 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Layout Site [n] Output [1..3] Frame [1..6] Layer xCommand xStatus Appendices xStatus Video Layout Site [n] Output [1..3] 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Layout Site [n] Output [n] Frame [n] VideoSourceContent xCommand xStatus Appendices xStatus Video Layout Site [n] Output [n] FrameContainer [n] PositionY Shows the video source content type of each layout frame. For internal use only. noSource: There is no source. Value space of the result returned: black: The frame is black.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xStatus Video Layout Prediction Site [n] FrameContainer OutputRole [n] Width xStatus xCommand Appendices xStatus Video Selfview PIPPosition For internal use only. Shows the position of the selfview image on the screen.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Experimental status xStatus Video OSD Output Indicates which monitor is used for on-screen display output. 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 C40/C60 Contents Introduction About the API API Reference Guide xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. 218 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Cisco TelePresence System Codec C40/C60 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 Appendices Login to the codec 1.
Cisco TelePresence System Codec C40/C60 Contents Introduction About the API Cisco TelePresence Remote Control Microphone: Press the API Reference Guide xConfiguration Presentation: Press the key to mute/unmute the microphones. Home: Press the key to confirm your choice or selection. key to display the local Phone book. key to key to show the menu on screen. • Up/Down: Use the menu.
Cisco TelePresence System Codec C40/C60 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 C40/C60 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 C40/C60 Contents Introduction API Reference Guide About the API xConfiguration xCommand xStatus systemtools rootsettings on [password] systemtools securitysettings ask Maximum time between logins (days) [0]? Command to control the root user availability. Query for the separate configurations. When issuing this command you can see each policy separately. • • Press enter to keep the current value.
Cisco TelePresence System Codec C40/C60 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 Appendices CauseValue Proprietary. We recomend the use of CauseType and CauseCode. CauseType Describes why the call was disconnected.
Cisco TelePresence System Codec C40/C60 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.
