Page 1 About the API xConfiguration xCommand xStatus Appendices Software version TC6.0 February 2013 Application Programmer Interface (API) Reference Guide Cisco TelePresence System Codec C20 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 2: Table Of Contents
Example 1: Outgoing Call Indication ......17 Example 2: Call Disconnect ...........17 Example 3: Call Successful ..........17 Example 4: FECC Action request ........17 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 3: February
Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 4: About This Guide
• Regulatory compliance and safety information guides • Legal & license information for the TC software To download the user documentation go to: http://www.cisco.com/go/quickset-docs Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 5: What's New In This Version
VCS or CUCM to allow encrypted calls. ISDN Link support You can pair a TelePresence system with a Cisco TelePresence ISDN Link. As from software versions TC6.0 and IL1.1 automatic pairing mode is supported. When making a call via ISDN Link, choose H320 (ISDN) as the call protocol.
Page 6 Appendices Localization Advanced configuration changes Settings that are removed The following new languages are supported on the Cisco xConfiguration Network DNS Server[4, 5] Address TelePresence Touch: New settings xConfiguration SystemUnit Type • Traditional Chinese xConfiguration Conference DoNotDisturb DefaultTimeout •...
Page 7: Xcommand Changes
Audio VUMeter StopAll XCommand Call Accept ADDED: CallType(o): <Audio/Video> xCommand CamCtrlPip ADDED: Duration: <0..60> xCommand Dial OLD: Protocol: <H323/SIP> NEW: Protocol: <SIP/H323/H320> Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 8: Xstatus Changes
Provisioning CUCM CAPF ServerPort xStatus Provisioning CUCM CAPF LSC xStatus Provisioning CUCM CAPF OperationState xStatus Provisioning CUCM CAPF OperationResult xStatus Provisioning CUCM ProvisionSecurity Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 9 Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 10: Connecting To The Api
GET methods are used to execute commands and get feedback <password> from the codec. This is described in the “Using HTTP” section later in this document. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 11: Api Output
To set ouput mode to XML, issue the command: <CallId>2</CallId> xPreferences outputmode xml <LayoutId>1</LayoutId> </AssignCall> To revert to terminal mode, issue the command: </Layout> xPreferences outputmode terminal </Video> </Command> Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 12: Using The Command Line
• <CTRL-w>: Erase the current line. ”Using sessions, you have to define feedback individually for each session. For more information see mechanism”. ”Feedback Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 13: Searching
All commands are case-insensitive. All of the following commands will work. XCOMMAND DIAL NUMBER: foo@bar.org xcommand dial number: foo@bar.org *? xConfiguration SystemUnit Name: <S: 0, 50> xCommand Dial Number: foo@bar.org Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 14: Commands
Audio Sound Stop xCommand Bookings List Days: <1..365> DayOffset: <0..365> Limit: <1..65534> Offset: <0..65534> xCommand Bookings Clear xCommand Boot Action: <Restart/Shutdown> Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 15: Configurations
*? xConfiguration Cameras Camera [1..1] Brightness Mode: <Auto/Manual> *? xConfiguration Cameras Camera [1..1] Brightness Level: <1..31> *? xConfiguration Cameras Camera [1..1] Whitebalance Mode: <Auto/Manual> Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 16: Status
*s Call 3 Duration: 9 ** end Example 2: Query the protocol for a call: xStatus Call Protocol *s Call 3 Protocol: “sip” Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 17: Events
1 Tilt: 0 TiltUp: 0 Zoom: 0 ZoomIn: 0 Focus: 0 FocusIn: 0 Timeout: 300 VideoSrc: 0 m: 0 ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 18: Call History
*h xHistory CallLogs Received 40 Counter: 1 *h xHistory CallLogs Missed 50 Counter: 2 *h xHistory CallLogs Missed 50 NewCounter: 0 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 19: Feedback Mechanism
Video Input Source 3 Connector *c xConfiguration Video Input Source 3 Connector: HDMI ** end equivalent feedback expression xFeedback register /Configuration/Video/Input/ Source[@item=’3’]/Connector Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 20: Terminal Connections
Write in: xFeedback deregister /Status/Audio Result: ** end D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 21: Using Http
3: Changing multiple configurations in one go. Content-Type: text/xml http://<ip-address>/formputxml?xmldoc= Content-Length: 91 <Configuration><Audio><Volume>80</Volume> Connection: close </Audio><Video><OSD><TodaysBookings>On <?xml version=”1.0”?> </TodaysBookings></OSD></video><Configuration> <Command> <CameraPositionSetResult item=”1” status=”OK”/> </Command> Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 22: Feedback From Codec Over Http
Avoid using FeedbackSlot 3 in an environment where There is however one small difference. The root-node contains application to receive updates from the codec. Cisco TelePresence Management Suite (TMS) is used as TMS Identification node with children that specify the codec from uses this feedbackslot to register its expressions.
Page 23: Translating From Terminal Mode To Xml
2: Assigning video layout to a call. Terminal xCommand Video Layout AssignCall CallId: 2 LayoutId: 1 <Command> <Video> <Layout> <AssignCall command=”True”> <CallId>2</CallId> <LayoutId>1</LayoutId> </AssignCall> </Layout> </Video> </Command> Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 24: Dos And Don'ts
The on-screen-display in is using the exact same API as you have access to through the command interface. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 25: Description Of The Xconfiguration Commands
Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 Description of the xConfiguration commands Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 26 Network [1..1] IEEE8021X Eap Peap ..................42 xConfiguration Conference [1..1] MaxTotalTransmitCallRate ................33 xConfiguration Network [1..1] IEEE8021X Eap Tls ..................... 42 xConfiguration Conference [1..1] MaxTransmitCallRate ..................33 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 27 SIP Profile [1..1] Authentication [1..1] Password ................ 52 xConfiguration NetworkServices SNMP Mode ....................46 xConfiguration SIP Profile [1..1] DefaultTransport ....................52 xConfiguration NetworkServices SNMP SystemContact ................. 46 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 28 Video Input Source [1..2] Quality ....................59 xConfiguration Video Input Source [1..2] Type ....................57 xConfiguration Video Input Source [1] Connector .................... 57 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 29 Range: The value goes in steps of 5 from 0 to 100 (from -34.5 dB to 15 dB). Volume 0 = Off. example: xConfiguration Audio SoundsAndAlerts RingVolume: 50 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013.
Page 30 Applies to cameras which support gamma mode. The Gamma Mode setting enables for gamma correc- tions. Gamma describes the nonlinear relationship between image pixels and monitor brightness. The Requires user role: ADMIN Cisco TelePresence PrecisionHD 720p camera supports gamma mode. The PrecisionHD 1080p camera Value space: <Auto/Manual> does not support gamma mode.
Page 31 Cameras Camera [1..1] DHCP example: xConfiguration Cameras Camera 1 IrSensor: On 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 xConfiguration Cameras Camera [1..1] Mirror...
Page 32 Off: If muted during a call, let the microphones remain muted after the call is disconnected. On: Unmute the microphones after the call is disconnected. example: xConfiguration Conference 1 MicUnmuteOnDisconnect Mode: On Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 33 Specify the maximum overall transmit bit rate allowed. The bit rate will be divided fairly among all active H320: H320 ensures that calls are set up as H.320 calls (only applicable if connected to a Cisco calls at any time. This means that the individual calls will be up-speeded or down-speeded as appropri- TelePresence ISDN Link gateway).
Page 34 Requires user role: ADMIN Not applicable in this version. Value space: <1..10> Range: 1 to 10. example: xConfiguration Conference 1 VideoBandwidth MainChannel Weight: 5 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 35 However, the call will appear as a missed call in the call history list. example: xConfiguration Conference 1 IncomingMultisiteCall Mode: Allow Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013.
Page 36 Authentication LoginName and Authentication Password to be defined on both the codec and the Gatekeeper. example: xConfiguration H323 Profile 1 Authentication Mode: Off Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 37 Requires user role: ADMIN Value space: <S: 0, 49> Format: String with a maximum of 49 characters. example: xConfiguration H323 Profile 1 H323Alias ID: "firstname.lastname@company.com" Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 38 Requires user role: ADMIN Value space: <S: 0, 64> Format: Only the valid IPv4 address format is accepted. example: xConfiguration Network 1 IPv4 Gateway: "192.0.2.0" Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 39 Value space: <S: 0, 64> Format: String with a maximum of 64 characters. example: xConfiguration Network 1 DNS Server 1 Address: "" Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 40 Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default example: xConfiguration Network 1 QoS Diffserv Audio: 0 value is 0 (best effort). example: xConfiguration Network 1 QoS Diffserv Data: 0 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 41 On: When set to On, the server-side X.509 certificate will be validated against the local CA-list for all TLS connections. Only servers with a valid certificate will be allowed. example: xConfiguration xConfiguration Network 1 IEEE8021X TlsVerify: Off Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 42 Set the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without Format: String with a maximum of 64 characters. the need for client certificates. Developed by Microsoft, Cisco and RSA Security. example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" Requires user role: ADMIN Value space: <Off/On>...
Page 43 Network [1..1] VLAN Voice Mode Set the Ethernet MTU (Maximum Transmission Unit). Set the VLAN voice mode. The VLAN Voice Mode will be set to Auto automatically if you choose Cisco UCM (Cisco Unified Communications Manager) as provisioning infrastructure via the Provisioning Wizard Requires user role: ADMIN on the Touch controller.
Page 44 2) When you are called by a 3rd party while already in a call and you want to include that person in the call. Requirements: The Codec C20 must run software version TC3.0 (or later), Video Communication Server xConfiguration NetworkServices HTTPS Mode (VCS) version X5 (or later) and Codian MCU version 3.1 (or later).
Page 45 Off: Disable the possibility to place and receive SIP calls. On: Enable the possibility to place and receive SIP calls (default). example: xConfiguration NetworkServices SIP Mode: On Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 46 Enter the name of the Network Services SNMP Community. SNMP Community names are used to authenticate SNMP requests. SNMP requests must have a password (case sensitive) in order to receive a response from the SNMP Agent in the codec. The default password is "public". If you have the Cisco xConfiguration NetworkServices SSH AllowPublicKey TelePresence Management Suite (TMS) you must make sure the same SNMP Community is configured Secure Shell (SSH) public key authentication can be used to access the codec.
Page 47 Format: String with a maximum of 64 characters. example: xConfiguration Phonebook Server 1 ID: "" xConfiguration NetworkServices CTMS Mode This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence xConfiguration Phonebook Server [1..1] Type Multipoint Switch (CTMS).
Page 48 Off: The video system will not be configured by a provisioning system. configurations/commands to the unit as a result. TMS: The video system will be configured using TMS (Cisco TelePresence Management System). When using CUCM or TMS provisioning, the DHCP server can be set up to provide the external manager VCS: Not applicable in this version.
Page 49 Requires user role: ADMIN Value space: <S: 0, 64> Format: String with a maximum of 64 characters. example: xConfiguration Provisioning ExternalManager Domain: "any.domain.com" Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 50 Requires user role: AUDIT Value space: <0..65535> Range: Select a value from 0 to 65535. example: xConfiguration Security Audit Server Port: 514 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 51 Value space: <S: 0, 128> Format: String with a maximum of 128 characters. example: xConfiguration SIP Profile 1 Authentication 1 LoginName: "" Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 52 CA-list, will be allowed. example: xConfiguration SIP Profile 1 Proxy 1 Discovery: Manual example: xConfiguration SIP Profile 1 TlsVerify: Off Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 53 Standby Control Determine whether the system should go into standby mode or not. Value space: <Standard/Alcatel/Avaya/Cisco/Microsoft/Nortel> Standard: To be used when registering to standard SIP Proxy (tested with Cisco TelePresence VCS Requires user role: ADMIN and Broadsoft) Value space: <Off/On>...
Page 54 SystemUnit MenuLanguage: English DefaultCameraPosition: When leaving standby the camera position will be set to the factory default position. example: xConfiguration Standby WakeupAction: RestoreCameraPosition Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 55 Requires user role: ADMIN Value space: <Off/On> Off: Disable logging. On: Enable logging. example: xConfiguration SystemUnit CallLogging Mode: On Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 56 Range: Select a time zone from the list time zones. If using a command line interface; watch up for typos. example: xConfiguration Time Zone: "GMT (Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London)" Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 57 Document_Camera: Select Document_Camera when you have a document camera connected to the selected video input. example: xConfiguration Video Input Source 1 Type: PC Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 58 Rather high resolutions will be used. example: xConfiguration Video Input Source 1 OptimalDefinition Profile: Normal Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013.
Page 59 Limited: Limited Quantization Range. R, G, B quantization range that excludes some code values at the extremes (16 - 235). This is defined in CEA-861-E. example: xConfiguration Video Input 1 DVI 2 RGBQuantizationRange: Full Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 60 The general limitation is that you cannot upscale in one direction and at the same time downscale in the other direction. In such situations the codec will apply letterboxing. example: xConfiguration Video Layout ScaleToFrame: MaintainAspectRatio Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 61 Current: When leaving the call, the self view picture will be kept on the same output as during the call. example: xConfiguration Video SelfviewDefault OnMonitorRole: Current Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013.
Page 62 LowerRight: The presentation PiP will appear in the lower right corner of the screen. example: xConfiguration Video PIP Presentation DefaultValue Position: Current Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 63 1080p30 at the same time as sharing a presentation. The C20 must then be controlled by a active speaker or presentation will be shown in full screen. Using this value is not recommended Cisco TelePresence Touch or an external control panel as the GUI will be disabled. as from TC6.0.
Page 64 The that the system is bookable by an external booking system, like Cisco TelePresence Management icon for encrypted calls is a locked padlock, and the icon for non-encrypted calls is a crossed out Suite (TMS).
Page 65 Latin: Latin characters can be entered when using the remote control (default). Value space: <Off/On> Cyrillic: Cyrillic characters can be entered using the remote control. NOTE: Requires a Cisco TelePresence Remote Control with Cyrillic fonts. Off: Capturing web snapshots is not allowed.
Page 66 Range: 640x480@60p, 800x600@60p, 1024x768@60p, 1280x1024@60p, 1280x720@50p, 1280x720@60p, 1920x1080@50p, 1920x1080@60p, 1280x768@60p, 1360x768@60p, 1366x768@60p, 1600x1200@60p, 1680x1050@60p, 1920x1200@60p example: xConfiguration Video Output HDMI 1 Resolution: Auto Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 67 Appendices experimental configuration 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. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Page 68 Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 Description of the xCommand commands Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 69: Description Of The Xcommands Commands
FarEndControl Preset Activate ...................... 83 The CamCtrlPip commands ....................76 xCommand FarEndControl Preset Store ......................83 xCommand CamCtrlPip............................. 76 xCommand FarEndControl Source Select ......................84 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 70 The Provisioning commands ....................94 xCommand Provisioning CUCM CAPF Delete ....................94 xCommand Provisioning CUCM CAPF OperationStart..................94 xCommand Provisioning StartUpgrade ......................94 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 71 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed xCommand Audio Sound Stop *r Bookings Booking 1 BookingStatus: OK *r AudioSoundStopResult (status=OK): *r Bookings Booking 1 BookingStatusMessage: "" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 72 Bookings Clear) xCommand Bookings List *r Bookings Error: "No bookings found." *r Bookings ResultInfo TotalRows: 0 *r Bookings LastUpdated: Never ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 73 Dial command is run. During the call you can run the xStatus Call command to see the CallId. Requires user role: USER Parameters: CallId: <0..65534> example: xCommand Call Reject CallId:20 *r CallRejectResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 74 Call command to see the CallId. Requires user role: USER Parameters: CallId(r): <0..65534> example: xCommand Call Hold CallId:19 *r CallHoldResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 75 CallLog Outgoing command. ** end Requires user role: USER Parameters: LogTag: <0..2147483647> example: xCommand CallLog Outgoing Delete LogTag:202 *r DeleteResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 76 CallLog Missed command. Requires user role: USER Parameters: LogTag: <0..2147483647> example: xCommand CallLog Missed Dimissed LogTag:119 *r DismissResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 77 Reset the camera position the the deafult position. Requires user role: USER Parameters: CameraId(r): <1..1> example: xCommand Camera PositionReset CameraId:1 *r CameraPositionResetResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 78 ** end xCommand Camera Ramp CameraId:1 Pan:left PanSpeed:1 *r RampResult (status=OK): ** end xCommand Camera Ramp CameraId:1 Pan:stop *r RampResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 79 Name: <S: 0, 255> *r CameraPresetRemoveResult (status=OK) example: ** end xCommand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: "" *r CameraPresetEditResult (status=OK) ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 80 Resets ActiveSpeaker. Normal voice switching is switched back on. Requires user role: USER example: xCommand Conference ActiveSpeaker Reset *r ConferenceActiveSpeakerResetResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 81 CallRate: <64..6000> CallType: <Audio/Video> BookingId: <S: 0, 255> example: xCommand Dial Number:543210 Protocol:h323 *r DialResult (status=OK): CallId: 2 ConferenceId: 1 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 82 FacilityService Dial ServiceId: 1 example: xCommand DTMFSend CallId:2 DTMFString:1234 *r FacilityServiceDialResult (status=OK): *r DTMFSendResult (status=OK): CallId: 2 ** end ConferenceId: 1 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 83 Requires user role: ADMIN Parameters: CallId: <0..65534> PresetId(r): <0..15> example: xCommand FarEndControl Preset Store CallId:3 PresetId:1 *r FECCPresetStoreResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 84 Deregister XML feedback over HTTP(S). Requires user role: USER Parameters: FeedbackSlot(r): <1..4> example: xCommand HttpFeedback Deregister FeedbackSlot:1 *r FeedbackDeregisterResult (status=OK): FeedbackSlot: 1 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 85 Requires user role: ADMIN *r MessageAlertClearResult (status=OK): Parameters: ** end Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/Mute/ MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/SrcDocCam/SrcPc/ SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut> example: xCommand Key Release Key:Home *r KeyReleaseResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 86 Clears the text line which was defined by the xCommand Message TextLine Display command. minutes" Requires user role: ADMIN *r MessagePromptDisplayResult (status=OK): example: xCommand Message TextLine Clear ** end *r MessageTextLineClearResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 87 Requires user role: ADMIN Parameters: FeedbackId: <S: 0, 255> OptionId(r): <1..5> example: xCommand Message Prompt Response OptionId: 1 *r MessagePromptResponseResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 88 Name: <S: 0, 255> ParentFolderId: <S: 0, 255> example: xCommand Phonebook Folder Modify FolderId:localGroupId-3 Name: "New York Head Office" *r PhonebookFolderModifyResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 89 *r PhonebookContactAddResult (status=OK): Name: localContactId-1 Parameters: ContactId(r): <S: 0, 255> ** end example: xCommand Phonebook Contact Delete ContactId:localContactId-1 *r PhonebookContactDeleteResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 90 Phonebook ContactMethod Add ContactId:localContactId-2 Number:54321 Protocol:H323 example: xCommand Phonebook ContactMethod Modify ContactMethodId:117 *r PhonebookContactMethodAddResult (status=OK): ContactId:localContactId-10 Number:"newnumber@cisco.com" Name: 1 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 91 *r ResultSet Contact 1 ContactId: "e _ 9664921" *r ResultSet Contact 1 ContactMethod 1 ContactMethodId: "1" *r ResultSet Contact 1 ContactMethod 1 Number: "H323:/John.Doe.Office@company. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 92 Presentation Stop Stop the media stream from the presentation source. Requires user role: USER example: xCommand Presentation Stop *r PresentationStopResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 93 PresetId: The ID of the preset you want to activate. Requires user role: USER Parameters: PresetId(r): <1..15> example: xCommand Preset Activate PresetId:3 *r PresetActivateResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 94 Delete the stored CTL and ITL files (CTL: Certificate Trust List, ITL: Identity Trust List). Requires user role: USER example: xCommand Provisioning CUCM CTL Delete *r DeleteResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 95 Key(r): <S: 16, 24> xCommand Standby ResetTimer Delay:10 *r ResetResult (status=OK): example: xCommand SystemUnit ReleaseKey Add Key:****************** ** end *r ReleaseKeyResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 96 Set a menu password to restrict access to Administrator Settings menu. If you have a remote control the password can also be set from the on screen menu. If you have a Cisco TelePresence Touch controller Requires user role: ADMIN the menu password is set from the command line interface.
Page 97 Requires user role: ADMIN Parameters: Name(r): <S: 0, 255> example: xCommand SystemUnit ConfigurationProfile Remove Name: "My _ ConfigurationProfile _ 1" *r ConfigurationProfileRemoveResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 98 Cancel the "ConfigurationProfile Change" command, that would otherwise take effect after next system boot. Requires user role: ADMIN example: xCommand SystemUnit ConfigurationProfile CancelChange *r ConfigurationProfileCancelChangeResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 99 Video Layout LoadDb Loads and starts using the specified video layout database. The default video layout database is initially provided by the system. The custom database is generated by the Cisco TC Console tool and xCommand Video PictureLayoutSet is made available to the codec from within the TC Console tool. The TC Console software is found Select the screen layout mode.
Page 100 Second Parameters: Position(r): <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight< example: *r SelfviewSetResult (status=OK): xCommand Video PIP Presentation Set Position: LowerLeft ** end *r PresentationPipSetResult (status=OK): ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 101 Appendices The experimental commands The Experimental commands are for testing only and should not be used unless agreed with Cisco. These commands are not documented and WILL change in later releases. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Page 102 Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 Description of the xStatus commands Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 103 Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 Loss ........119 xStatus Camera [1..1] SoftwareID ........................111 xStatus Diagnostics Call [1..n] Channels IncomingAudioChannel [1..n] Netstat 1 MaxJitter ......121 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 104 Diagnostics Call [1..n] Channels OutgoingVideoChannel [1..n] Netstat 1 Packets ......119 xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Video Protocol ..........129 xStatus MediaChannels Call [1..n] IncomingVideoChannel [1..n] Video ResolutionX ........129 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 105 SIP ..............................145 xStatus Network CDP PortID........................... 138 xStatus SIP Profile 1 Authentication ....................... 148 xStatus Network CDP PrimaryMgmtAddress ....................138 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 106 SystemUnit Software OptionKeys DualDisplay ...................151 xStatus Video Output ............................157 xStatus SystemUnit Software OptionKeys HighDefinition ................151 xStatus Video Output HDMI [1, 2] Resolution Height ..................158 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 107 Video Selfview FullscreenMode ......................161 xStatus Video Selfview Mode ..........................161 xStatus Video Selfview OnMonitorRole ......................161 xStatus Video Selfview PIPPosition .........................161 The experimental status ......................162 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 108 Audio Volume xStatus Call 27 Status *s Audio Volume: 70 *s Call 27 Status: Connected ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 109 Call to find the call identity. Value space of the result returned: <String> example: xStatus Call 27 RemoteNumber *s Call 27 RemoteNumber: "5585232" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 110 Shows the placed on hold status of the call. You can run the command xStatus Call to find the call identity. Value space of the result returned: <True/False> example: xStatus Call 27 PlacedOnHold *s Call 27 PlacedOnHold: False ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 111 ** end Value space of the result returned: <String> example: xStatus Camera 1 SoftwareID *s Camera 1 SoftwareID: "S01718-4.0FINAL [ID:40063] 2010-10-20" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 112 Camera 1 Capabilities Options xStatus Camera 1 Position Pan *s Camera 1 Capabilities Options: "ptzf" *s Camera 1 Position Pan: 412 ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 113 *s Conference Site 26 SoftwareID: "TC5" *s Conference Site 26 BlackScreenCause: None *s Conference Site 26 ConferenceExtended: NotExtended *s Conference Site 26 BookingId: "MyConference" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 114 Conference Presentation Resolution Width xStatus Conference Presentation LastLocalSource *s Conference Presentation Resolution Width: 0 *s Conference Presentation LastLocalSource: 2 ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 115 Conference Site 2 Capabilities FECC Source 1 Name *s Conference Site 2 Capabilities FECC Source 1 Name: "Main camera" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 116 Conference Site [1..n] BlackScreenCause Lists the audio mute status for other participants in the conference. Shows the reason why the screen is black while in a CTMS (Cisco TelePresence Multipoint Switch) managed conference. Value space of the result returned: FirstParticipant: You are the first and only participant in the meeting.
Page 117 Value space of the result returned: <Off/MultiWay/MultiSite/Auto> example: xStatus Conference Multipoint Mode *s Conference Multipoint Mode: "MultiWay" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 118 *s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Drop: 0 *s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Bytes: 0 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 119 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets: 405 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 120 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived: 84 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 121 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes: 129920 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter: 0 ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 122 ISDN Link. Value space of the result returned: <Unknown/PRI/BRI/External/G703> example: xStatus H320 Gateway Mode *s H320 Gateway Mode: Unknown ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 123 Displays the IP address of the gatekeeper where the system is registered. Value space of the result returned: <String> example: xStatus H323 Gatekeeper Address *s H323 Gatekeeper Address: "192.0.1.20" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 124 URL. Value space of the result returned: <String> example: xStatus HttpFeedback 1 URL *s HttpFeedback 1 URL: "http://tms.company.com/tms/public/feedback/code.aspx" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 125 *s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTCP Remote Port: 2337 *s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTP Remote Port: 2334 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 126 *s MediaChannels Call 4 OutgoingVideoChannel 52 Encryption Status: Off *s MediaChannels Call 4 OutgoingVideoChannel 52 ChannelRole: Legacy *s MediaChannels Call 4 OutgoingVideoChannel 52 Video Protocol: Off Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 127 MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port: 50932 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 128 MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress: "192.168.136.130" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 129 *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port: 16404 *s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768 ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 130 *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote Port: IpAddress 50933 *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local IpAddress: ** end "192.168.24.190" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 131 *s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1 *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress: "192.168.136.130" ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 132 *s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port: ** end 16405 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 133 "192.168.24.190" xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate ** end *s MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate: 30 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 134 MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote 50932 IpAddress ** end *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress: "192.168.136.130" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 135 *s Network 1 VLAN Native VlanId: "200" *s Network 1 CDP Platform: "cisco WS-C3750X-48P" *s Network 1 CDP Version: "Cisco IOS Software, C3750E Software (C3750E-UNIVERSALK9-M), Version 15.0(1)SE2, RELEASE SOFTWARE (fc3)*Technical Support: http://www.cisco. com/techsupport*Copyright (c) 1986-2011 by Cisco Systems, Inc.*Compiled Thu 22-Dec-11 00:05 by prod _ rel _ team"...
Page 136 Network 1 IPv4 SubnetMask xStatus Network 1 IPv6 Address *s Network 1 IPv4 SubnetMask: "255.255.255.0" *s Network 1 IPv6 Address: "" ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 137 Network 1 MTU xStatus Network CDP Version *s Network 1 MTU: 1500 *s Network 1 CDP Version: "Cisco IOS Software, C3750E Software (C3750E-UNIVERSALK9-M), Version 15.0(1)SE2, RELEASE SOFTWARE (fc3)*Technical Support: http://www.cisco. ** end com/techsupport*Copyright (c) 1986-2011 by Cisco Systems, Inc.*Compiled Thu 22-Dec-11 00:05 by prod _ rel _ team"...
Page 138 Network CDP SysObjectID xStatus Network CDP VTPMgmtDomain *s Network 1 CDP SysObjectID: "" *s Network 1 CDP VTPMgmtDomain: "anyplace" ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 139 *s Network 1 CDP VoIPApplianceVlanID: "300" xStatus NetworkServices NTP Address ** end *s NetworkServices NTP Address: "64.104.193.12 64.104.222.16 144.254.15.121" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 140 Shows the camera preset type. Value space of the result returned: <All/Camera> example: xStatus Preset 1 Type *s Preset 1 Type: All ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 141 Value space of the result returned: ** end <String> example: xStatus Provisioning Software UpgradeStatus SessionId *s Provisioning Software UpgradeStatus SessionId: "" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 142 Provisioning Software Current URL *s Provisioning Software UpgradeStatus Message: "" *s Provisioning Software Current URL: "http:// .../s52000tc5 _ 1 _ 0.pkg" ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 143 *s Provisioning CUCM CAPF OperationState: NonPending xstat Provisioning CUCM CAPF ServerName ** end *s Provisioning CUCM CAPF ServerName: "192.168.0.1" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 144 Value space of the result returned: <NotSet/CAPFUnknown/CAPFInvalidAuthStrLen/CAPFInvalidInitReason/CAPFInvalidAuthMode/ CAPFNotNone/CAPFNullClnt/CAPFNullClntcontext/CAPFInvalidUsageStartSession/CAPFNullSessiondata/ CAPFInvalidSession/CAPFNullParameters/CAPFNoStat/CAPFTimeout/CAPFConnLost/CAPFAbort/ CAPFKeyGenFailed/CAPFConnectFailed/CAPFFenceError/CAPFServerBusy/CAPFAuthRejected/ CAPFInvalidParms/CAPFCancelled/CAPFFailed/CAPFSuccess/CAPFLSCUpdated> example: xStatus Provisioning CUCM CAPF OperationResult *s Provisioning CUCM CAPF OperationResult: NotSet ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 145 *s SIP Profile 1 Registration 1 Status: Registered *s SIP Profile 1 Registration 1 Reason: "" *s SIP Profile 1 Registration 1 URI: "anyname@company.com" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 146 Shows whether or not the SSL certificate of the server that the video system / codec tries to register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or CUCM. Active: The communication between the endpoint and the SIP Proxy is active.
Page 147 Shows whether or not the SSL certificate of the server that the video system / codec tries to register to ** end is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or CUCM. True: The server’s SIP certificate is checked against the trusted CA-list on the codec and found valid.
Page 148 Value space of the result returned: <String> example: xStatus SIP Profile 1 Registration 1 Reason *s SIP Profile 1 Registration 1 Reason: "404 Not Found" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 149 *s SystemUnit State MaxNumberOfCalls: 2 *s SystemUnit State MaxNumberOfActiveCalls: 1 *s SystemUnit State NumberOfActiveCalls: 1 *s SystemUnit State NumberOfSuspendedCalls: 0 *s SystemUnit State NumberOfInProgressCalls: 0 Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 150 SystemUnit ProductPlatform <String> *s SystemUnit ProductPlatform: "C90" example: ** end xStatus SystemUnit Software Name *s SystemUnit Software Name: "s52000" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 151 SystemUnit Software ReleaseKey xStatus SystemUnit Software OptionKeys DualDisplay *s SystemUnit Software ReleaseKey: "true" *s SystemUnit Software OptionKeys DualDisplay: "true" ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 152 SystemUnit Hardware Module CompatibilityLevel xStatus SystemUnit Hardware BootSoftware The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The endpoints Shows the version of the boot software that is installed on the codec. running TC software are manufactured with a new version of the flash memory. Endpoints having the new Value space of the result returned: version of the flash memory must run software TC4.2.1 or later.
Page 153 *s SystemUnit Hardware TemperatureThreshold: "85" Value space of the result returned: ** end <0..5> example: xStatus SystemUnit State MaxNumberOfActiveCalls *s SystemUnit State MaxNumberOfActiveCalls: 3 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 154 SystemUnit Notifications Notification 1 Text *s SystemUnit State Subsystem Application: Initialized *s SystemUnit Notifications Notification 1 Text: "OK" ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 155 Value space of the result returned: <Error/Warning/Critical> example: xStatus SystemUnit Diagnostics Message Level *r Status (status=Error): Reason: No match on address expression XPath: Status/SystemUnit/Diagnostics/Message/Level ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 156 ** end <Unknown/AnalogCVTBlanking/AnalogCVTReducedBlanking/AnalogGTFDefault/AnalogGTFSecondary/ AnalogDiscreteTiming/AnalogDMTBlanking/AnalogCEABlanking/Digital> example: xStatus Video Input Source 1 Resolution FormatType *s Video Input Source 1 Resolution FormatType: Digital ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 157 *s Video Output HDMI 2 Resolution Height: 720 ** end *s Video Output HDMI 2 Resolution Width: 1280 *s Video Output HDMI 2 Resolution RefreshRate: 60 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 158 *s Video Output HDMI 1 Resolution RefreshRate: 60 example: ** end xStatus Video Layout PresentationView *s Video Layout PresentationView: "Default" ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 159 Video Layout Site 1 Output 1 Frame 1 Height *s Video Layout Site 1 Output 1 Frame 1 Height: 10000 ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 160 *s Video Layout Site 1 Output 5 Frame 1 VideoSourceContent: wallpaper *s Video Layout Site 1 Output 1 Frame 1 InputNumber: 0 ** end ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 161 Identifies which monitor(s) contains the selfview, if present. Value space of the result returned: <First/Second/Third/Fourth> example: xStatus Video Selfview OnMonitorRole *s Video Selfview OnMonitorRole: First ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 162 Appendices The experimental status The Experimental status is for testing only and should not be used unless agreed with Cisco. These settings are not documented and WILL change in later releases. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Page 163 Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 164: Startup Script
• For multiple commands you must use Unix end of line (LF). Windows end of line does not work. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 165: Cisco Telepresence Remote Control
• Short range (1 m): Move the DIP switch down. or: Touch any key on the remote control. • Longer range: Move the DIP switch up Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 166: Remote Control Key Map
Appendices Appendices Remote control key map Button codes - Remote control 5 Button codes - Remote control 5 The Cisco TelePresence Remote Control 5 has the following Address Button name Address Button name button codes and IR signal parameters.
Page 167: The Systemtools Commands
Delete the codec certificate and CA list if they exist. Lists all the licenses for the codec. cert-name(r): The name of the certificate. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 168 Revert to default security settings. • The user can only change PIN once within this limit. Shows the security status for the codec. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 169: About Disconnect Cause Types
DisconnectEvent *e CallDisconnect CauseValue: 1 CauseType: “LocalDisconnect” CauseString: “” OrigCallDirection: “outgoing” RemoteURI: “firstname.lastname@company.com” CallId: 89 CauseCode: 0 CauseOrigin: SIP ** end Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. Codec C20 API Reference Guide TC6.0 February 2013. D14869.05...
Page 170 INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system.

Cisco Codec C20 Reference Manual

Quick Links

Related Manuals for Cisco Codec C20

Summary of Contents for Cisco Codec C20

Table of Contents