Page 1 About the API xConfiguration xCommand xStatus Appendices Software version TC7.0 JANUARY 2014 Application Programmer Interface (API) Reference Guide Cisco TelePresence System Codec C20 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 2: Table Of Contents
Status ..................14 Events ................... 15 Call history ................16 Feedback mechanism ............17 Feedback expressions ............17 Terminal connections ............18 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 3: January
Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 5: What's New In This Version
You can also detect if packets are lost (dropped or in error). This can help to identify network problems that may cause issues in calls. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 6: System Configuration Changes
<ValidAdminPassword/CamerasDetected/ TouchPanelConnection/H320GatewayStatus/ Video WallPaper ISDNLinkCompatibility/SIPProfileRegistration/ OLD: <None/Custom/Growing/Summersky/Waves> SIPListenPortAndOutboundMode/ NEW: <None/Custom/Growing/Summersky/Waves/Blue> TLSVerifyRequiredCerts/DefaultCallProtocolRegistered/ NetSpeedAutoNegotiated/HasValidReleaseKey/ EthernetDuplexMatches/IPv4Assignment/ IPv6Assignment7SIPProfileType/ CallProtocolIPStackPlatformCompatibility/ CameraStatus/CameraPairing/CameraSoftwareVersion/ SelectedVideoInputSourceConnected/ OSDVideoOutput/VideoFromInternalCamera/ H323GatekeeperStatus/SipIceAndAnatConflict/ UdpPortRangeViolation/ProvisioningStatus/ CallProtocolVcsProvisioningCompatibility/ CallProtocolDualStackConfig> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 7: About The Api
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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 8: Connecting To The Api
This is described in xCommand SystemUnit AdminPassword Set Password: "Using HTTP" on page 19 in this document. <password> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 9: Api Output
To set ouput mode to XML, issue the command: </AssignCall> xPreferences outputmode xml </Layout> </Video> To revert to terminal mode, issue the command: </Command> xPreferences outputmode terminal Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 10: Using The Command Line
Refer to "Feedback mechanism" on page for each session. Refer to "Feedback mechanism" on page • <CTRL-w>: Erase the current line. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 11: Searching
*? xConfiguration Video Output HDMI [1..2] CEC Mode: <Off/On> xcommand dial number: foo@bar.org *? xConfiguration Video Output HDMI[2] MonitorRole: <Auto/First/Second/PresentationOnly> xCommand Dial Number: foo@bar.org Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 12: Commands
PhonebookId: <S: 0, 255> PhonebookType: <Corporate/Local> SearchString: <S: 0, 255> SearchField: <Name/Number> ContactType: <Any/Folder/Contact> Offset: <0..65534> FolderId: <S: 0, 255> Limit: <0..65534> Recursive: <False/True> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 13: Configurations
*? xConfiguration Video Output HDMI [1..2] OverscanLevel: <Medium/High/None> *? xConfiguration Video Output HDMI [1..2] CEC Mode: <Off/On> *? xConfiguration Video Output HDMI[2] MonitorRole: <Auto/First/Second/PresentationOnly> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 14: Status
*s Call 2 Duration: 6 *s Call 2 AnswerState: Answered *s Call 2 ModifyState: Idle *s Call 2 DeviceType: Endpoint ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 15: Events
1 Tilt: 0 TiltUp: 0 Zoom: 0 ZoomIn: 0 Focus: 0 FocusIn: 0 Timeout: 300 VideoSrc: 0 m: 0 ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 16: Call History
*h xHistory CallLogs Received 40 Counter: 1 *h xHistory CallLogs Missed 50 Counter: 2 *h xHistory CallLogs Missed 50 NewCounter: 0 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 17: Feedback Mechanism
** end sluggish or unpredictable behavior. Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Source[@item=’3’]/Connector Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 18: Terminal Connections
Write in: xFeedback deregister /Status/Audio Result: ** end D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 19: Using Http
Content-Length: 91 Connection: close Example 3: Changing multiple configurations in one go. <?xml version=”1.0”?> http://<ip-address>/formputxml?xmldoc= <Command> <Configuration><Audio><Volume>80</Volume> <CameraPositionSetResult item=”1” status=”OK”/> </Audio><Video><OSD><TodaysBookings>On </Command> </TodaysBookings></OSD></Video></Configuration> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 20: Feedback From Codec Over Http
Expression: <S: 1, 255> </HttpFeedback> Expression: <S: 1, 255> </Command> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 21: Translating From Terminal Mode To Xml
</Video> </Configuration> 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> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 22: Dos And Don'ts
The on-screen- display in is using the exact same API as you have access to through the command interface. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 23: Xconfiguration Commands
Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 24: Description Of The Xconfiguration Commands
Conference [1..1] AutoAnswer Delay ..................32 xConfiguration H323 NAT Address ......................36 xConfiguration Conference [1..1] MicUnmuteOnDisconnect Mode ............32 xConfiguration H323 Profile [1..1] Authentication Mode ................37 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 25 Network [1..1] IEEE8021X Identity ..................43 xConfiguration NetworkServices CTMS Encryption ..................48 xConfiguration Network [1..1] IEEE8021X Password ...................43 xConfiguration Network [1..1] IEEE8021X AnonymousIdentity ..............43 Phonebook configuration ........................49 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 26 SystemUnit CallLogging Mode ..................59 xConfiguration SIP AuthenticateTransferror ....................54 xConfiguration SystemUnit ContactInfo Type ....................59 xConfiguration SIP ListenPort ........................54 xConfiguration SystemUnit IrSensor ......................59 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 27 Video SelfviewDefault Mode ....................66 xConfiguration Video WallPaper .........................72 xConfiguration Video SelfviewDefault FullscreenMode ................66 xConfiguration Video SelfviewDefault PIPPosition ..................66 Experimental configuration ........................73 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 28 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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 29 Manual: Enable manual control of the camera brightness. The brightness level is set using the Cameras Camera Brightness Level setting. Example: xConfiguration Cameras Camera 1 Brightness Mode: Auto Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 30 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 This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. satisfactory results. NOTE: Requires the Gamma Mode to be set to Manual.
Page 31: Conference Configuration
Cameras Camera [1..1] DHCP IPv4: When set to IPv4, the call protocol (SIP, H323) will use IPv4. Applies to cameras which support DHCP (for example the Cisco TelePresence PrecisionHD 1080p IPv6: When set to IPv6, the call protocol (SIP, H323) will use IPv6.
Page 32 Conference DoNotDisturb DefaultTimeout. Example: xConfiguration Conference 1 FarEndControl SignalCapability: On Example: xConfiguration Conference 1 DoNotDisturb Mode: Timed Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 33 This means that the individual calls will be up-speeded or down-speeded as appropriate when someone leaves or enters a multipoint conference, or when a call is put on hold H320: H320 ensures that calls are set up as H.320 calls (only applicable if connected to a Cisco (suspended) or resumed.
Page 34 Range: 1 to 10. Example: xConfiguration Conference 1 Presentation OnPlacedOnHold: NoAction Example: xConfiguration Conference 1 VideoBandwidth MainChannel Weight: 5 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 35 Conference [1..1] Multipoint Mode Define how the video system handles multiparty video conferences. If registered to a Cisco TelePresence Video Communication Server (VCS), the video system can xConfiguration FacilityService Service [1..5] Type use the MultiWay network solution. MultiWay requires that the video network includes a multipoint control unit (MCU).
Page 36: H323 Configuration
Requires user role: ADMIN Value space: <S: 0, 64> Format: A valid IPv4 address or IPv6 address. Example: xConfiguration H323 NAT Address: "" Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 37 Format: String with a maximum of 50 characters. Example: xConfiguration H323 Profile 1 Gatekeeper Address: "192.0.2.0" Example: xConfiguration H323 Profile 1 Authentication Password: "" Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 38 Static: When set to Static the ports are given within a static predefined range [5555-6555]. Example: xConfiguration H323 Profile 1 PortAllocation: Dynamic Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 39: Network Configuration
Format: A valid IPv4 address. determines which method to use. Example: xConfiguration Network 1 IPv4 Address: "192.0.2.2" Example: xConfiguration Network 1 IPv6 Assignment: Autoconf Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 40 Network [1..1] DHCP RequestTFTPServerAddress Enter the static IPv6 network address for the system. This setting is only applicable when the This setting is used only for video systems that are registered to a Cisco Unified Communications Network IPv6 Assignment is set to Static.
Page 41 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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 42 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 Network 1 IEEE8021X TlsVerify: Off Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 43 Requires user role: ADMIN Value space: <S: 0, 64> Format: String with a maximum of 64 characters. Example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 44 Value space: <Auto/Manual/Off> 10half: Force link to 10 Mbps half-duplex. Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. If CDP is 10full: Force link to 10 Mbps full-duplex. not available, VLAN is not enabled.
Page 45 Example: xConfiguration NetworkServices XMLAPI Mode: On On: Enable the possibility to place and receive SIP calls (default). Example: xConfiguration NetworkServices SIP Mode: On Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 46 Example: xConfiguration NetworkServices HTTPS OCSP Mode: Off Off: The HTTPS protocol is disabled. On: The HTTPS protocol is enabled. Example: xConfiguration NetworkServices HTTPS Mode: On Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 47 Enter the NTP Address to define the network time protocol server address. This address will be you have the Cisco TelePresence Management Suite (TMS) you must make sure the same SNMP used if NTP Mode is set to Manual, or if set to Auto and no address is supplied by a DHCP server.
Page 48 NetworkServices SNMP SystemContact xConfiguration NetworkServices CTMS Mode Enter the name of the Network Services SNMP System Contact. This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence Multipoint Switch (CTMS). Requires user role: ADMIN Video systems running software TC5.0 or later are able to initiate or join non-encrypted multiparty...
Page 49 Example: xConfiguration Provisioning Connectivity: Auto Value space: <VCS/TMS/Callway/CUCM> xConfiguration Provisioning Mode VCS: Select VCS if the phonebook is located on the Cisco TelePresence Video Communication Server. It is possible to configure a video system using a provisioning system (external manager). This allows video conferencing network administrators to manage many video systems simultaneously.
Page 50 Provisioning ExternalManager AlternateAddress Value space: <S: 0, 64> Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager Format: String with a maximum of 64 characters. (CUCM) and an alternate CUCM is available for redundancy. Enter the address of the alternate CUCM.
Page 51 Requires user role: ADMIN Value space: <1056..65535> Range: Select a value from 1056 to 65535. Example: xConfiguration RTP Ports Range Stop: 2486 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 52 Example: xConfiguration Security Audit Server PortAssignment: Auto connection is restored it will again send its audit logs to the syslog server. Example: xConfiguration Security Audit OnError Action: Ignore Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 53 Off: The user can access the codec via the serial port without any login. On: Login is required when connecting to the codec via the serial port. Example: xConfiguration SerialPort LoginRequired: On Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 54: Sip Configuration
Thus the shortest route for audio and video is always Requires user role: ADMIN secured between the endpoints. NOTE: ICE is not supported when registered to CUCM (Cisco Value space: <On/Off> Unified Communication Manager).
Page 55 Format: String with maximum 255 characters and compliant with the SIP URI syntax. network. Example: xConfiguration SIP Profile 1 URI: "sip:firstname.lastname@company.com" Example: xConfiguration SIP Profile Turn DropRflx: Off Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 56 Auto: The system will try to connect using transport protocols in the following order: TLS, TCP, UDP. Example: xConfiguration SIP Profile 1 DefaultTransport: Auto Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 57 SIP Profile [1..1] Line Select if the SIP Proxy address is to be obtained manually or by using Dynamic Host Configuration When registered to a Cisco Unified Communications Manager (CUCM) the endpoint may be part Protocol (DHCP). of a shared line. This means that several devices share the same directory number. The different...
Page 58 DefaultCameraPosition: After a reboot the camera position will be set to the factory default position. Example: xConfiguration Standby BootAction: DefaultCameraPosition Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 59 Example: xConfiguration SystemUnit CallLogging Mode: On Off: Disable the IR sensor on the codec. On: Enable the IR sensor on the codec. Example: xConfiguration SystemUnit IrSensor: Auto Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 60 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)" Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 61 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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 62 IfSignal: When set to IfSignal, the menu selection for the video input source will only be visible when a presentation source is connected to the video input. Example: xConfiguration Video Input Source 1 Visibility: IfSignal Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 63 Range: Select the source to be used as the main video source. Example: xConfiguration Video Input Source 1 OptimalDefinition Profile: Normal Example: xConfiguration Video MainVideoSource: 1 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 64 Value space: <Off/On> Off: No adjustment of the aspect ratio. On: Let the system automatically adjust aspect ratio. Example: xConfiguration Video Layout Scaling: On Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 65 Value space: <Off/On> Off: Do not display self view on screen. On: Display self view on screen. Example: xConfiguration Video Selfview: On Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 66 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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 67 DisabledPIPs: The built-in layout engine does not display any PIP frame in the layout on the local Example: xConfiguration Video PIP ActiveSpeaker DefaultValue Position: Current output. Example: xConfiguration Video Layout Engine LocalMode: Enabled Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 68 DualPresentationOnly: All participants in the call will be shown on the first monitor, while the presentation (if any) will be shown on the second monitor. Example: xConfiguration Video Monitors: Single Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 69 1080p30 at the same time as sharing a presentation. The C20 must then be controlled by a xConfiguration Video OSD VirtualKeyboard Cisco TelePresence Touch or an external control panel as the GUI will be disabled. Determine whether or not the virtual keyboard will automatically show on screen when text is to be Example: xConfiguration Video OSD Mode: On entered in an input field.
Page 70 When using the touch This requires that the system is bookable by an external booking system, like for example the Cisco screen control panel the notification dialog box will appear on the touch screen control panel, and TelePresence Management Suite (TMS).
Page 71 Touch control panel, or via the codec's serial port (Camera port and Y-cable). Latin: Latin characters can be entered when using the remote control (default). Requires user role: ADMIN Cyrillic: Cyrillic characters can be entered using the remote control. NOTE: Requires a Cisco Value space: <Off/On> TelePresence Remote Control with Cyrillic fonts.
Page 72 Medium: The system will not use the outer 3% of the output resolution. High: The system will not use the outer 6% of the output resolution. Example: xConfiguration Video Output HDMI 1 OverscanLevel: None Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 73 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. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
Page 74: Xcommand Commands
Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 75: Description Of The Xcommand Commands
Call Modify ..........................83 xCommand Camera Preset Edit .........................89 xCommand Camera Preset List .........................90 CallHistory commands .......................... 83 xCommand Camera Preset Remove ......................90 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 76 Message Alert Clear .......................96 xCommand Message TextLine Display ......................97 Security commands ..........................107 xCommand Message TextLine Clear ......................97 xCommand Security FIPSMode Activate ....................107 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 77 SystemUnit DateTime Set ..................... 110 xCommand Video PreviewFilmstrip Set ....................114 xCommand SystemUnit DateTime Get ..................... 110 xCommand SystemUnit FactoryReset ..................... 110 Experimental commands ........................115 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 78: Audio Commands
*r AudioRingtoneListResult Ringtone 12 Id: "Ringer" Loop: <On/Off> ** end Example: xCommand Audio Sound Play Sound: Ringing *r AudioSoundPlayResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 79 *r Bookings Booking 1 Time EndTimeBuffer: 0 *r Bookings Booking 1 MaximumMeetingExtension: 30 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed *r Bookings Booking 1 BookingStatus: OK Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 80 Requires user role: USER Parameters: Action: <Restart/Shutdown> Example: xCommand Boot *r BootResult (status=OK): ** end CUIL reboot request, restarting Connection closed by foreign host. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 81: Call Commands
Call Reject CallId:20 Parameters: *r CallRejectResult (status=OK): CallId(r): <0..65534> ** end Reason(o): <Conference/Transfer/Other> Example: xCommand Call Hold CallId:19 *r CallHoldResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 82 ** end Parameters: CallId(r): <0..65534> Number(r): <S: 0, 255> Example: xCommand Call UnattendedTransfer CallId: 2 Number: destination@example.com *r TransferUriResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 83 Call Modify CallType: Audio CallId: 16 Requires user role: USER *r CallModifyResult (status=Error): Reason: Callescalation not enabled Parameters: ** end Filter(o): <All/Missed/Placed/Received> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 84 *r CallHistoryGetResult Entry 1 OccurrenceType: Received *r CallHistoryGetResult Entry 1 IsAcknowledged: Acknowledged *r CallHistoryGetResult ResultInfo Offset: 3 *r CallHistoryGetResult ResultInfo Limit: 65534 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 85 *r CallHistoryRecentsResult ResultInfo Offset: 6 Parameters: *r CallHistoryRecentsResult ResultInfo Limit: 65534 LogTag: <0..2147483647> ** end Example: xCommand CallLog Recent Delete *r DeleteResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 86 CallLog Missed command. Requires user role: USER Parameters: LogTag: <0..2147483647> Example: xCommand CallLog Missed Delete LogTag:119 *r DeleteResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 87 Reset the camera position the the default position. Requires user role: USER Parameters: CameraId(r): <1..1> Example: xCommand Camera PositionReset CameraId:1 *r CameraPositionResetResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 88 Example: xCommand Camera Ramp CameraId:1 Pan:left PanSpeed:1 *r RampResult (status=OK): ** end xCommand Camera Ramp CameraId:1 Pan:stop *r RampResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 89 ListPosition: <1..35> Name: <S: 0, 255> Example: xCommand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: "" *r CameraPresetEditResult (status=OK) ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 90 Requires user role: USER *r CameraPresetStoreResult (status=OK) ** end Parameters: PresetId(r): <1..35> Example: xCommand Camera Preset Remove PresetId: 1 *r CameraPresetRemoveResult (status=OK) ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 91 Resets ActiveSpeaker. Normal voice switching is switched back on. Requires user role: USER Example: xCommand Conference ActiveSpeaker Reset *r ConferenceActiveSpeakerResetResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 92 BookingId: <S: 0, 255> Appearance(o): <1..999999999> DisplayName(o): <S: 0, 255> Example: xCommand Dial Number:543210 Protocol:h323 *r DialResult (status=OK): CallId: 2 ConferenceId: 1 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 93 Call command to see the CallId. Requires user role: USER Parameters: CallId: <0..65534> Example: xCommand FarEndControl Camera Stop CallId:3 *r FECCMoveResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 94 SourceId: Select a video input source on the far end. Requires user role: USER Parameters: CallId: <0..65534> SourceId(r): <0..15> Example: xCommand FarEndControl Source Select CallId:3 SourceId:1 *r FECCSelectSourceResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 95 Requires user role: USER *r KeyPressResult (status=OK): ** end Parameters: FeedbackSlot(r): <1..4> Example: xCommand HttpFeedback Deregister FeedbackSlot:1 *r FeedbackDeregisterResult (status=OK): FeedbackSlot: 1 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 96 This is required when the Duration parameter is not set. Requires user role: ADMIN Example: xCommand Message Alert Clear *r MessageAlertClearResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 97 Clears the text line which was defined by the xCommand Message TextLine Display command. Requires user role: ADMIN *r MessagePromptDisplayResult (status=OK): Example: ** end xCommand Message TextLine Clear *r MessageTextLineClearResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 98 Message Prompt Response OptionId: 1 *r FarendMessageResult (status=Error): Reason: Generic Message mode not enabled *r MessagePromptResponseResult (status=OK): ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 99 Requires user role: USER Parameters: FolderId(r): <S: 0, 255> Example: xCommand Phonebook Folder Delete FolderId:localGroupId-3 *r PhonebookFolderDeleteResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 100 You can add several contact methods to a contact using the xCommand Phonebook ContactMethod Protocol, CallRate, CallType and Device. Add command. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in the API, on the web interface ContactId: The unique identifier for the contact you want to modify.
Page 101 You can add several contact methods to a contact. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact method Requires user role: USER may have been created when issuing the xCommand Phonebook Contact Add command to make the contact.
Page 102 ** end Device: <Mobile/Other/Telephone/Video> Number: <S: 0, 255> Protocol: <Auto, H320/H323/SIP> CallRate: <0..6000> CallType: <Audio/Video> Example: xCommand Phonebook ContactMethod Modify ContactMethodId:117 ContactId:localContactId-10 Number:"newnumber@cisco.com" Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 103 Phonebook Search PhonebookType:Corporate Limit:2 FolderId:"corporate _ 001" *r PhonebookSearchResult ResultSet ResultInfo TotalRows: 25 *r PhonebookSearchResult ResultSet Contact 1 Name: "John Doe (office)" Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 104 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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 105 Postpones the installing of the software upgrade. Requires user role: USER Parameters: SecondsToPostpone(r): <0..65534> Example: xCommand Provisioning PostponeUpgrade SecondsToPostpone: 60 *r PostponeUpgradeResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 106 This command will log you out of your Extension Mobility profile. Requires user role: USER Example: xCommand Provisioning CUCM ExtensionMobility Logout *r NoResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 107 ConfirmAndReboot(r): <Yes> Example: xCommand Security Persistency Configurations: Persistent CallHistory: Persistent InternalLogging: Persistent LocalPhonebook: Persistent DHCP: Persistent ConfirmAndReboot: Yes *r Persistency (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 108 Key(r): <S: 16, 24> Example: Example: xCommand Standby ResetTimer Delay:10 xCommand SystemUnit ReleaseKey Add Key:****************** *r ResetResult (status=OK): *r ReleaseKeyResult (status=OK): ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 109 Set a menu password to restrict access to Administrator Settings menu. If you have a remote This command runs all self-diagnostics commands on the system. control the password can also be set from the on screen menu. If you have a Cisco TelePresence Touch controller the menu password is set from the command line interface.
Page 110 SystemUnit DateTime Set Year:2012 Month:7 Day:3 Hour:12 Minute:0 Second:0 Confirm(r): <Yes> *r DateTimeSetResult (status=OK): TrailingAction: <NoAction/Restart/Shutdown> ** end Example: xCommand SystemUnit FactoryReset Confirm: Yes *r FactoryResetConfirmResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 111 ** end Parameters: Name(r): <S: 0, 255> Example: xCommand SystemUnit ConfigurationProfile Remove Name: "My _ ConfigurationProfile _ 1" *r ConfigurationProfileRemoveResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 112: Video Commands
Minimized when you want the presentation to be displayed in a small picture on screen. Requires user role: ADMIN Parameters: View(r): <Default/Maximized/Minimized> Example: xCommand Video Layout SetPresentationView View:Default *r VideoLayoutSetPresentationViewResult (status=OK): ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 113 Loads and starts using the specified video layout database. The default video layout database is Sets position for the active speakers PiP (picture in picture). initially provided by the system. The custom database is generated by the Cisco TC Console tool Position: Predefined positions.
Page 114 Video Selfview Set FullscreenMode: On OnMonitorRole: Second xCommand Video PreviewFilmstrip Set Position: LowerCenter *r PreviewFilmstripSetResult (status=OK): *r SelfviewSetResult (status=OK): ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 115 Appendices Experimental commands The Experimental commands are for testing only and should not be used unless agreed with Cisco. These commands are not documented and WILL change in later releases. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
Page 116: Xstatus Commands
Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 117: Description Of The Xstatus Commands
Conference Site [n] Capabilities FECC Source [n] Name ............132 xStatus Camera [1..1] HardwareID ......................127 xStatus Conference Site [n] Capabilities FECC Source [n] Options ............132 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 118 Diagnostics Call [n] Channels OutgoingAudioChannel [n] Netstat 1 Packets ......136 xStatus Diagnostics Call [n] Channels OutgoingDataChannel [n] Netstat 1 ChannelRate ......139 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 119 MediaChannels Call [n] OutgoingAudioChannel [n] Audio Protocol ..........150 xStatus ICE Call Local IP ..........................144 xStatus MediaChannels Call [n] OutgoingAudioChannel [n] Audio Channels ...........150 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 120 Provisioning Software UpgradeStatus Message ................161 xStatus Network 1 IPv4 DHCP TftpServer ....................156 xStatus Provisioning Software UpgradeStatus VersionId ................161 xStatus Network 1 IPv6 Address ......................156 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 121 SIP Proxy [1] Secure ........................167 xStatus SystemUnit Software OptionKeys NaturalPresenter ..............173 xStatus SIP Proxy [1] Verified ........................167 xStatus SystemUnit Software OptionKeys PremiumResolution ...............173 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 122 Video Layout Site [n] Output [n] FrameContainer [n] Width ............185 xStatus Video Input MainVideoSource .....................179 xStatus Video Layout Site [n] Output [n] FrameContainer [n] Height ............185 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 123 Video Layout Prediction Site [n] Output [1..2] Frame [1..6] MediaChannelId .......185 Experimental status ..........................187 xStatus Video Selfview Mode ........................185 xStatus Video Selfview FullscreenMode ....................186 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 124: Call Status
<H323/SIP/H320> *s Audio Connectors Microphone 1 EcReferenceDelay: 120 Example: ** end xStatus Call 27 Protocol *s Call 27 Protocol: "h323" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 125 Call 27 CallbackNumber xStatus Call 27 ReceiveCallRate *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" *s Call 27 ReceiveCallRate: 4000 ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 126 Idle: No Call Modify operation is pending. Value space of the result returned: <Idle/Outgoing/Incoming> Example: xStatus Call ModifyState *s Call 11 ModifyState: Idle ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 127 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.
Page 128 Shows the camera IP address. Value space of the result returned: <String> Example: xStatus Camera 1 IpAddress *s Camera 1 IpAddress: "" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 129 In Flip mode (vertical flip) the image can be flipped upside down. Value space of the result returned: <"Auto"/"On"/"Off"> Example: xStatus Camera 1 Flip *s Camera 1 Flip: "Off" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 130 Shows the height of the the presentation. Value space of the result returned: <0..3000> Example: xStatus Conference Presentation Resolution Height *s Conference Presentation Resolution Height: 0 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 131 Conference Presentation LocalSendingMode *s Conference Site 2 Capabilities FECC Source 1 SourceId: 6 *s Conference Presentation LocalSendingMode: Off ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 132 Shows the ID of the software running of the video system at a far end site. Value space of the result returned: <String> Example: xStatus Conference Site 2 SoftwareID *s Conference Site 2 SoftwareID: "TC5" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 133 Conference Site [n] BlackScreenCause xStatus Conference Site [n] BookingId Shows the reason why the screen is black while in a CTMS (Cisco TelePresence Multipoint Switch) Shows the booking ID of a conference (if assigned). The booking ID can be used for easy managed conference.
Page 134 Conference Line 1 Appearance Status *s Conference Site 14 CalText: "" *s Conference Line 1 Appearance 5464 Status: Held ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 135 Indicates which call protocol is used as default. Value space of the result returned: <H323/SIP/H320> Example: xStatus Conference SelectedCallProtocol *s Conference SelectedCallProtocol: SIP ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 136 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter: 0 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 137 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost: 0 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 138 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived: 84 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 139 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes: 129920 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate: ** end 128000 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 140 Returns the IPv6 address of the ISDN Gateway if the endpoint is paired to one. Value space of the result returned: <String> Example: xStatus H320 Gateway Number *s H320 Gateway Number: "" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 141: H323 Status
*s H320 Gateway Id: "00:50:60:0B:EF:11" Value space of the result returned: ** end <Integer> Example: xStatus H323 Gatekeeper Port *s H323 Gatekeeper Port: 1719 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 142 Shows the feedback from the HTTP server. There can be up to 15 expressions for each URL. See the xCommand HttpFeedback commands for more information. Value space of the result returned: <String> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 143 ICE Call Result xStatus ICE Turn IP *s ICE Call 0 Result: "Unsupported" *s ICE Turn IP: "192.0.1.20" ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 144 Value space of the result returned: <HOST/PRFLX/SRFLX/RELAY> Example: xStatus ICE Call Remote Candidate *s ICE Call 1 Remote Candidate: “SRFLX” ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 145 Value space of the result returned: <AACLD/G722/G7221/G711Mu/G711A/G729/G729AB/Opus> Example: xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol *s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol: AACLD ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 146 MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port ** end *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port: 50932 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 147 MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress: "192.168.136.130" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 148 *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port: 16404 *s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768 ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 149 *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 Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 150 MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels "192.168.136.130" *s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1 ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 151 *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port: 16405 *s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 152 MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate "192.168.24.190" *s MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate: 30 ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 153 *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port: 50932 IpAddress ** end *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress: "192.168.136.130" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 154 Shows the IPv4 address that uniquely identifies this system. Value space of the result returned: <String> Example: xStatus Network 1 IPv4 Address *s Network 1 IPv4 Address: "192.0.2.149" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 155 ** end <String> Example: xStatus Network 1 IPv4 DNS Server 1. Address *s Network 1 IPv4 DNS Server 1 Address: "192.0.2.60" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 156 ** end Value space of the result returned: <String> Example: xStatus Network CDP Platform *s Network 1 CDP Platform: "cisco WS-C3750X-48P" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 157 Example: Example: xStatus Network CDP Version xStatus Network CDP PortID *s Network 1 CDP Version: "Cisco IOS Software, C3750E Software (C3750E- *s Network 1 CDP PortID: "GigabitEthernet1/0/23" UNIVERSALK9-M), Version 15.0(1)SE2, RELEASE SOFTWARE (fc3)*Technical Support: ** end 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 158 Returns the SysObjectID as configured in the switch the endpoint is connected to. Value space of the result returned: <String> Example: xStatus Network CDP SysObjectID *s Network 1 CDP SysObjectID: "" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 159 Preset 1 Description xStatus NetworkServices NTP Status *s Preset 1 Description: "Zoom in" *s NetworkServices NTP Status: Synced ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 160 Shows the status of the software upgrade. Value space of the result returned: <None/InProgress/Failed/InstallationFailed/Succeeded> Example: xStatus Provisioning Software UpgradeStatus Status *s Provisioning Software UpgradeStatus Status: None ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 161 Value space of the result returned: <String> Example: xStatus Provisioning Software UpgradeStatus URL *s Provisioning Software UpgradeStatus URL: "http://.../s52000tc5 _ 1 _ 0.pkg" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 162 *s Provisioning CUCM CAPF OperationState: NonPending Example: ** end xStatus Provisioning CUCM CAPF ServerName *s Provisioning CUCM CAPF ServerName: "192.168.0.1" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 163 Provisioning CUCM CTL State CAPFNullSessiondata/CAPFInvalidSession/CAPFNullParameters/CAPFNoStat/CAPFTimeout/ *s Provisioning CUCM CTL State: Installed CAPFConnLost/CAPFAbort/CAPFKeyGenFailed/CAPFConnectFailed/CAPFFenceError/ CAPFServerBusy/CAPFAuthRejected/CAPFInvalidParms/CAPFCancelled/CAPFFailed/ ** end CAPFSuccess/CAPFLSCUpdated> Example: xStatus Provisioning CUCM CAPF OperationResult Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 164 Value space of the result returned: <String> Example: xStatus Provisioning CUCM TVS Proxy 1 Server *s Provisioning CUCM TVS Proxy 1 Server: "192.0.2.0" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 165 Security Persistency DHCP Example: *s Security Persistency DHCP: Persistent xStatus Security Persistency CallHistory ** end *s Security Persistency CallHistory: Persistent ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 166 Shows the address of the SIP Proxy that the system communicates with. Value space of the result returned: <String> Example: xStatus SIP Proxy 1 Address *s SIP Proxy 1 Address: "192.0.2.50" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 167 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. *s SIP Registration 1 Status: Registered True: The server’s SIP certificate is checked against the trusted CA-list on the codec and found...
Page 168 Shows whether or not the SSL certificate of the server that the video system / codec tries to Unknown: The status of the communication is not known. register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or CUCM. AuthenticationFailed: Wrong user name or password.
Page 169 *s SIP Profile 1 CallForward Mode: Off Example: ** end xStatus SIP Profile 1 Registration 1 Status *s SIP Profile 1 Registration 1 Status: Registered ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 170 Value space of the result returned: <String> Example: xStatus SIP Profile DirectoryURI Primary URI *s SIP Profile 1 DirectoryURI Primary URI: "123456@company.com" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 171 SystemUnit ProductPlatform Shows the product platform. Value space of the result returned: <String> Example: xStatus SystemUnit ProductPlatform *s SystemUnit ProductPlatform: "C90" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 172 SystemUnit Software Name xStatus SystemUnit Software ReleaseKey *s SystemUnit Software Name: "s52000" *s SystemUnit Software ReleaseKey: "true" ** end ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 173 Shows if the system has the option key installed that supports the HighDefinition functionality. The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The endpoints running TC software are manufactured with a new version of the flash memory. Endpoints Value space of the result returned: having the new version of the flash memory must run software TC4.2.1 or later.
Page 174 The feedback shows the monitoring software id. Value space of the result returned: <String> Example: xStatus SystemUnit Hardware MonitoringSoftware *s SystemUnit Hardware MonitoringSoftware: "39" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 175 ** end Value space of the result returned: <0..5> Example: xStatus SystemUnit State MaxNumberOfActiveCalls *s SystemUnit State MaxNumberOfActiveCalls: 3 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 176 *s SystemUnit Notifications Notification 1 Text: "OK" Example: Not registered to a protocol ** end xStatus SystemUnit ContactName: "192.0.2.0" Example 2: Registered on SIP xStatus SystemUnit ContactName: "1234@192.0.2.0" Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 177 Value space of the result returned: <String> Example: xStatus SystemUnit Diagnostics Message References *s SystemUnit DiagnosticsResult Message 1 References: "" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 178 SystemUnit Diagnostics ExtendedLogging Mode <String> *s SystemUnit Diagnostics ExtendedLogging Mode: Off Example: ** end xStatus Time ZoneOlson *s Time ZoneOlson: Europe/Berlin ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 179 Value space of the result returned: <0..300> Example: xStatus Video Input Source 1 Resolution RefreshRate *s Video Input Source 1 Resolution RefreshRate: 50 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 180 *s Video Input Source 2 MediaChannelId: 3 xStatus Video Input DVI 2 Connected ** end *s Video Input DVI 2 Connected: False ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 181 <First/ Second/ Third/ Fourth/ PresentationOnly/ Recorder/ InternalSetup> Example: xStatus Video Output HDMI 1 MonitorRole *s Video Output HDMI 1 MonitorRole: First ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 182 *s Video Layout Site 1 Output 1 GraphicName: "full-pip" <Default/Maximized/Minimized> ** end Example: xStatus Video Layout PresentationView *s Video Layout PresentationView: "Default" ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 183 Video Layout Site 1 Output 1 Frame 1 Height *s Video Layout Site 1 Output 1 Frame 1 Height: 10000 ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 184 ** end xStatus Video Layout Site [n] Output [n] FrameContainer [n] PositionX For internal use only. Value space of the result returned: <Integer> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 185 ** end xStatus Video Layout Prediction Site [n] FrameContainer OutputRole [n] PositionY For internal use only. Value space of the result returned: <Integer> Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 186 Shows the position of the active speaker’s image on the screen. Value space of the result returned: <UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight> Example: xStatus Video PIP ActiveSpeaker Position *s Video PIP ActiveSpeaker Position: UpperCenter ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 187 Appendices 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. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
Page 188: Appendices
Cisco TelePresence System Codec C20 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 189: Startup Script
The file can have any name as long as it is placed in this directory. • For multiple commands you must use Unix end of line (LF). Windows end of line does not work. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 190: Cisco Telepresence Remote Control
Short range (1 m): Move the DIP switch down. or: Press any key on the remote control. • Longer range: Move the DIP switch up Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 191: Remote Control Key Map
Button codes - Remote control 5 Button codes - Remote control 5 Address Button name Address Button name The Cisco TelePresence Remote Control 5 has the following button codes and IR signal parameters. Arrow down Number 1 Arrow left Number 2...
Page 192: The Systemtools Commands
[comment] | delete <id> | list | clear> Shows the content of a license file, define by the name. name(r): The name of the license file. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 193 Minimum time between PIN renewals (hours) [0]? • The user can only change PIN once within this limit. Shows the security status for the codec. Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 194: About Disconnect Cause Types
DisconnectEvent *e CallDisconnect CauseValue: 1 CauseType: “LocalDisconnect” CauseString: “” OrigCallDirection: “outgoing” RemoteURI: “firstname.lastname@company.com” CallId: 89 CauseCode: 0 CauseOrigin: SIP ** end Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14869.11...
Page 195 INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system.

Cisco TelePresence System Codec C20 Reference Manual

Quick Links

Related Manuals for Cisco TelePresence System Codec C20

Summary of Contents for Cisco TelePresence System Codec C20

Table of Contents