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 C90 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 2: Table Of Contents
Status ..................14 About disconnect cause types ...........224 Events ................... 15 Call history ................16 Feedback mechanism............17 Feedback expressions ............17 Terminal connections ............18 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 3: January
Cisco TelePresence System Codec C90 API Reference Guide Contents Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 4: About This Guide
• Regulatory compliance and safety information guides • Licensing information for the TC software To download the user documentation go to: http://www.cisco.com/go/cseries-docs Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 7: About The Api
Cisco TelePresence System Codec C90 API Reference Guide Contents Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 8: Api Fundamentals
Telnet you have to enable it. xCommand SystemUnit AdminPassword Set Password: <password> Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 9: Api Output
To set ouput mode to XML, issue the command: <LayoutId>1</LayoutId> xPreferences outputmode xml </AssignCall> </Layout> </Video> To revert to terminal mode, issue the command: </Command> xPreferences outputmode terminal Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 10: Using The Command Line
<CTRL-r>: Incremental command history search. returned. Refer to ”Feedback mechanism” on page session. Refer to ”Feedback mechanism” on page • <CTRL-w>: Erase the current line. Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 11: Searching
*? xConfiguration Video Output Composite [5] OverscanLevel: <Medium/High/None> xcommand dial number: foo@bar.org *? xConfiguration Video Output Composite [5] MonitorRole: <First/Second/PresentationOnly/ xCommand Dial Number: foo@bar.org Recorder/Third/Fourth> ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 13: Configurations
*? xConfiguration Video Output Composite[5] Resolution: <PAL/NTSC> *? xConfiguration Video Output Composite[5] OverscanLevel: <Medium/High/None> *? xConfiguration Video Output Composite[5] MonitorRole: <Auto/First/Second/PresentationOnly/Recorder/Third/ Fourth> Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 14: Status
*s Call 3 FacilityServiceId: 0 *s Call 3 Encryption Type: “None” *s Call 3 PlacedOnHold: False *s Call 3 Duration: 9 *s Call 3 AnswerState: Answered Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 15: Events
** end *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 17: Feedback Mechanism
Video Input Source 3 Connector *c xConfiguration Video Input Source 3 Connector: ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Source[@item=’3’]/Connector Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 18: Terminal Connections
Write in: xFeedback deregister /Status/Audio ** end Result: D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 19: Using Http
Content-Length: 91 Example 3: Changing multiple configurations in one go. Connection: close <?xml version=”1.0”?> http://<ip-address>/formputxml?xmldoc= <Command> <Configuration><Audio><Volume>80</Volume></Audio> <CameraPositionSetResult item=”1” status=”OK”/> <Video><OSD><TodaysBookings>On</TodaysBookings> </Command> </OSD></video></Configuration> Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 20: Feedback From Codec Over Http
Identification node with children that specify the Cisco TelePresence Management Suite (TMS) is used as TMS codec from which the notification originated. This means that uses this feedbackslot to register its expressions. you can handle multiple codecs with a single HTTP server URI.
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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 23: Xconfiguration Commands
Cisco TelePresence System Codec C90 API Reference Guide Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 24: Description Of The Xconfiguration Commands
Audio Output HDMI [1,3] Level ...................32 xConfiguration Cameras Camera [1..7] DHCP ................... 36 xConfiguration Audio Output HDMI [1,3] Mode ..................32 xConfiguration Audio Output Line [1..6] Channel ..................32 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 25 H323 configuration ..........................42 xConfiguration Network [1..1] IEEE8021X TlsVerify ..................48 xConfiguration H323 NAT Mode ........................42 xConfiguration Network [1..1] IEEE8021X UseClientCertificate ..............49 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 26 Security Session ShowLastLogon ..................59 xConfiguration NetworkServices SNMP Host [1..3] Address ..............54 xConfiguration Security Session InactivityTimeout ................... 59 xConfiguration NetworkServices SNMP CommunityName ...............54 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 27 Video Input HDMI [1..4] RGBQuantizationRange ..............71 xConfiguration Standby Delay ........................64 xConfiguration Video Input DVI [3,5] RGBQuantizationRange ..............71 xConfiguration Standby BootAction ......................64 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 28 Video OSD LanguageSelection ..................76 xConfiguration Video WallPaper ........................ 81 xConfiguration Video OSD MenuStartupMode ..................76 Experimental configuration ........................82 xConfiguration Video OSD VirtualKeyboard ....................76 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 29 Requires user role: ADMIN Value space: <1/2/3/4/5> Range: Select one of the video input sources. Example: xConfiguration Audio Input HDMI 3 VideoAssociation VideoInputSource: 1 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 30 On: The Noise Reduction should be enabled in the presence of low frequency noise. Example: xConfiguration Audio Input Line 3 LoopSuppression: On Example: xConfiguration Audio Input Microphone 1 EchoControl NoiseReduction: On Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 31 Line: Select Line when you have a standard balanced line input. The phantom voltage and MuteOnInactiveVideo: On pre-amplification is Off. Example: xConfiguration Audio Input Microphone 1 Type: Line Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 32 Audio Output Line [1..6] Equalizer ID Determine if the Audio Line output will be analog or digital type output. The digital output on the Cisco TelePresence Profile systems are identified as DNAM (Digital Natural Audio Module). Select the audio output line equalizer ID.
Page 33 -34.5 dB to 15 dB (0.5 dB steps). The value 0 means that the audio is switched off. Example: xConfiguration Audio Volume: 70 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 34 Cameras Camera [1..7] Brightness Level Applies to cameras which support gamma mode. Gamma describes the nonlinear relationship between image pixels and monitor brightness. The Cisco TelePresence PrecisionHD 720p camera Set the brightness level. Requires the Camera Brightness Mode to be set to Manual.
Page 35 By setting the Gamma Level you can select which gamma correction table to use. This setting may This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. be useful in difficult lighting conditions, where changes to the brightness setting does not provide If adjusting the camera position by hand you can configure whether the camera should keep its new satisfactory results.
Page 36: Conference Configuration
Off: The incoming call will not be muted. On: The incoming call will be muted when automatically answered. Example: xConfiguration Conference 1 AutoAnswer Mute: Off Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 37 Conference DoNotDisturb DefaultTimeout. Example: xConfiguration Conference 1 FarEndControl SignalCapability: On Example: xConfiguration Conference 1 DoNotDisturb Mode: Timed Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 38 Sip: Sip ensures that calls are set up as SIP calls. The maximum transmit bit rate for each individual call is defined in the Conference H320: H320 ensures that calls are set up as H.320 calls (only applicable if connected to a Cisco MaxTransmitCallRate setting.
Page 39 Value space: <1..10> Example: xConfiguration Conference 1 Presentation RelayQuality: Sharpness Range: 1 to 10. Example: xConfiguration Conference 1 VideoBandwidth MainChannel Weight: 5 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 40 (MCU). If registered to a Cisco Unified Communications Manager (CUCM) version 8.6.2 or newer, the video system can use either the CUCM conference bridge, or the video system's own built-in MultiSite feature.
Page 41 Requires user role: ADMIN Value space: <S: 0, 255> Format: String with a maximum of 255 characters. Example: xConfiguration FacilityService Service 1 Name: "" Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 42: 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 43 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 44 Static: When set to Static the ports are given within a static predefined range [5555-6555]. Example: xConfiguration H323 Profile 1 PortAllocation: Dynamic Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 45: Network Configuration
Format: A valid IPv4 address. mines which method to use. Example: xConfiguration Network 1 IPv4 Address: "192.0.2.2" Example: xConfiguration Network 1 IPv6 Assignment: Autoconf Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 46 Format: A valid IPv6 address. be set manually using the Provisioning ExternalManager Address setting. If the Network VLAN Voice Mode setting is Auto and the Cisco Discovery Protocol (CDP) assigns an Example: xConfiguration Network 1 IPv6 Address: "2001:0DB8:0000:0000:0000:0000:0000:000 ID to the voice VLAN, then a request for option 150 will always be sent. That is, the Network DHCP 2"...
Page 47 0 (best effort). Example: xConfiguration Network 1 QoS Diffserv Audio: 0 Example: xConfiguration Network 1 QoS Diffserv Data: 0 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 48 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 49 Requires user role: ADMIN Value space: <S: 0, 64> Format: String with a maximum of 64 characters. Example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 50 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 51 NetworkPort [2] Mode xConfiguration NetworkServices H323 Mode Define if the network port 2 shall be enabled for direct pairing with a Cisco TelePresence Touch Determine whether the system should be able to place and receive H.323 calls or not.
Page 52 Requires user role: ADMIN Value space: <Off/On> Off: The HTTPS protocol is disabled. On: The HTTPS protocol is enabled. Example: xConfiguration NetworkServices HTTPS Mode: On Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 53 Format: A valid IPv4 address, IPv6 address or DNS name. Example: xConfiguration NetworkServices HTTPS OCSP Mode: Off Example: xConfiguration NetworkServices NTP Address: "1.ntp.tandberg.com" Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 54 Secure Shell (SSH) public key authentication can be used to access the codec. you have the Cisco TelePresence Management Suite (TMS) you must make sure the same SNMP Community is configured there too. NOTE: The SNMP Community password is case sensitive.
Page 55 Appendices Phonebook configuration xConfiguration NetworkServices CTMS Mode This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence Multipoint Switch (CTMS). xConfiguration Phonebook Server [1..1] ID Video systems running software TC5.0 or later are able to initiate or join non-encrypted multiparty conferences controlled by CTMS version 1.8 or later.
Page 56 Off: The video system will not be configured by a provisioning system. Value space: <GET/POST> TMS: The video system will be configured using TMS (Cisco TelePresence Management System). GET: Select GET when the provisioning server supports GET. VCS: The video system will be configured using VCS (Cisco TelePresence Video Communication POST: Select POST when the provisioning server supports POST.
Page 57 Provisioning ExternalManager AlternateAddress Format: String with a maximum of 64 characters. Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager Example: xConfiguration Provisioning ExternalManager Domain: "any.domain.com" (CUCM) and an alternate CUCM is available for redundancy. Enter the address of the alternate CUCM.
Page 58 Ignore: The system will continue its normal operation, and rotate internal logs when full. When the connection is restored it will again send its audit logs to the syslog server. Example: xConfiguration Security Audit OnError Action: Ignore Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 59 TCP port number 6514 when the Security Audit Logging Mode is set to ExternalSecure. Manual: Will use the port value defined in the Security Audit Server Port setting. Example: xConfiguration Security Audit Server PortAssignment: Auto Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 60: Sip Configuration
IPv4: The preferred IP version for media is IPv4. IPv6: The preferred IP version for media is IPv6. Example: xConfiguration SIP PreferredIPMedia: IPv4 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 61 Thus the shortest route for audio and video is always Example: xConfiguration SIP Profile Turn DiscoverMode: On secured between the endpoints. NOTE: ICE is not supported when registered to CUCM (Cisco Unified Communication Manager).
Page 62 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 63 Requires user role: ADMIN Value space: <Standard/Cisco> Value space: <Off/On> Standard: Use this when registering to standard SIP Proxy (tested with Cisco TelePresence VCS Off: Connect to the single proxy configured first in Proxy Address list. and Broadsoft) On: Set up multiple outbound connections to servers in the Proxy Address list.
Page 64 Standby configuration xConfiguration SIP Profile [1..1] Line When registered to a Cisco Unified Communications Manager (CUCM) the endpoint may be part of a shared line. This means that several devices share the same directory number. The different devices sharing the same number receive status from the other appearances on the line as defined xConfiguration Standby Control in RFC 4235.
Page 65 Requires user role: ADMIN Value space: <Off/On> Off: Disable logging. On: Enable logging. Example: xConfiguration SystemUnit CallLogging Mode: On Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 66 Off: Disable the IR sensor on the codec. Lisbon, London)" On: Enable the IR sensor on the codec. Example: xConfiguration SystemUnit IrSensor: Auto Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 67 On: The user preferences are available from the Settings menu on the Touch screen control panel. Example: xConfiguration UserInterface UserPreferences: On Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 68 Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. Example: xConfiguration Video CamCtrlPip CallSetup Duration: 10 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 69 HDSDI: Select HDSDI when you want to use the HD-SDI 3 as input source 3. Example: xConfiguration Video Input Source 3 Connector: DVI Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 70 Document_Camera: Select Document_Camera when you have a document camera connected to Example: xConfiguration Video Input Source 1 Visibility: IfSignal the selected video input. Example: xConfiguration Video Input Source 1 Type: PC Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 71 Rather high resolutions will be used. Example: xConfiguration Video Input Source 1 OptimalDefinition Profile: Normal Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 72 Requires user role: USER Value space: <1/2/3/4/5> Range: Select the source to be used as the main video source. Example: xConfiguration Video MainVideoSource: 1 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 73 Maximized: The presentation starts up in full screen mode. Example: xConfiguration Video Layout Scaling: On Example: xConfiguration Video Layout PresentationDefault View: Default Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 74 LowerRight: The presentation PiP will appear in the lower right corner of the screen. Example: xConfiguration Video PIP Presentation DefaultValue Position: Current Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 75 On: self-view is switched on when leaving a call. Example: xConfiguration Video SelfviewDefault Mode: Current Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 76 Off: The language settings will be available from within the SystemUnit settings in the Administrator Settings. On: The Language menu will be available from the Settings menu. Example: xConfiguration Video OSD LanguageSelection: On Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 77 AlwaysOff: The encryption indicator is never displayed on screen. This applies to both encrypted and non-encrypted calls for all Conference Encryption Mode settings. Example: xConfiguration Video OSD EncryptionIndicator: Auto Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 78 The codec can be enabled for Cyrillic input characters in the menus on screen. Requires that Video This requires that the system is bookable by an external booking system, like for example the Cisco OSD InputMethod Cyrillic is set to On.
Page 79 Example: xConfiguration Video Output HDMI 1 OverscanLevel: None Off: Disable CEC control. On: Enable CEC control. Example: xConfiguration Video Output HDMI 1 CEC Mode: Off Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 80 Example: xConfiguration Video Output DVI 2 OverscanLevel: None the extremes (16 - 235). This is defined in CEA-861-E. Example: xConfiguration Video Output DVI 2 RGBQuantizationRange: Full Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 81 The maximum supported resolution is 1920x1200. Summersky, Growing, Waves: The chosen background image is shown on the screen. Example: xConfiguration Video Wallpaper: Summersky Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 82 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
Page 83: Xcommand Commands
Cisco TelePresence System Codec C90 API Reference Guide Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 84: Description Of The Xcommand Commands
Audio VUMeter Stop .......................95 xCommand CallHistory Get ........................101 xCommand Audio VUMeter StopAll ......................95 xCommand CallHistory Recents ......................102 xCommand Audio SoundsAndAlerts Ringtone List ...................95 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 85 Phonebook Folder Delete ..................... 117 xCommand DTMFSend ..........................109 xCommand Phonebook Contact Add ...................... 117 FacilityService commands ........................110 xCommand Phonebook Contact Modify ....................118 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 86 Video Layout AssignCall .......................134 SystemUnit commands ........................126 xCommand Video Layout AssignPresentation ..................134 xCommand SystemUnit OptionKey Add ....................126 xCommand Video Layout UnAssign ......................135 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 87 Video PreviewFilmstrip Set ....................138 xCommand Video Layout Frame List .......................136 Experimental commands ........................138 xCommand Video Layout List ........................136 xCommand Video OSD Close ........................136 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 88 *r AudioEqualizerListResult Equalizer 1 Section 3 Gain: "0" *r AudioEqualizerListResult Equalizer 1 Section 4 FilterType: "Peaking" *r AudioEqualizerListResult Equalizer 1 Section 4 Frequency: "1000" Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 89 Requires user role: USER xCommand Audio LocalInput Add Example: *r AudioInputGroupAddResult (status=OK): xCommand Audio Microphones Unmute InputId: 2 *r AudioMicrophonesUnmuteResult (status=OK): ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 90 ConnectorId(r): <1..8> Example: *r AudioInputGroupUpdateResult (status=OK): xCommand Audio LocalInput AddConnector InputId: 3 ConnectorType: Line ** end ConnectorId: 1 *r AudioInputGroupAddConnectorResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 91 ConnectorId: 1 Loudspeaker: <On/Off> Channels: <1..2> *r AudioInputGroupRemoveConnectorResult (status=OK): Example: ** end xCommand Audio LocalOutput Add *r AudioOutputGroupAddResult (status=OK): OutputId: 47 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 92 Audio LocalOutput Remove OutputId: 6 Example: xCommand Audio LocalOutput RemoveConnector OutputId:5 ConnectorType: Line *r AudioOutputGroupRemoveResult (status=OK): ConnectorId:1 ** end *r AudioOutputGroupRemoveConnectorResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 93 Audio RemoteOutput ConnectInput OutputId:10 InputId:8 InputGain: <-54..15> Example: *r AudioRemoteOutputGroupConnectInputResult (status=OK): xCommand Audio LocalOutput UpdateInputGain OutputId:6 InputId:3 ** end *r AudioOutputGroupUpdateInputGainResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 94 Example: Example: xCommand Audio Sound Stop xCommand Audio RemoteOutput DisconnectInput OutputId:10 InputId:8 *r AudioSoundStopResult (status=OK): ** end *r AudioRemoteOutputGroupDisconnectInputResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 95 Stop collecting VU meter information for all connectors. Requires user role: USER Example: xCommand Audio VUMeter StopAll *r AudioVumeterStopResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 96 *r Bookings Booking 1 Time EndTimeBuffer: 0 ** end *r Bookings Booking 1 MaximumMeetingExtension: 30 *r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed *r Bookings Booking 1 BookingStatus: OK Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 97 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 98: 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 99 ** end Parameters: CallId(r): <0..65534> Number(r): <S: 0, 255> Example: xCommand Call UnattendedTransfer CallId: 2 Number: destination@example. *r TransferUriResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 100 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 101 *r CallHistoryGetResult Entry 1 OccurrenceType: Received *r CallHistoryGetResult Entry 1 IsAcknowledged: Acknowledged *r CallHistoryGetResult ResultInfo Offset: 3 *r CallHistoryGetResult ResultInfo Limit: 65534 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 102 *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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 103 CallLog Missed command. Requires user role: USER Parameters: LogTag: <0..2147483647> Example: xCommand CallLog Missed Delete LogTag:119 *r DeleteResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 104 Reset the camera position the the default position. Requires user role: USER Parameters: CameraId(r): <1..7> Example: xCommand Camera PositionReset CameraId:1 *r CameraPositionResetResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 105 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 106 Camera Preset Edit PresetId: 1 ListPosition: 1 Name: "" xCommand Camera PositionActivateFromPreset CameraId:1 PresetID:1 *r CameraPresetEditResult (status=OK) *r PositionActivateFromPresetResult (status=OK): ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 107 Requires user role: USER *r CameraPresetStoreResult (status=OK) Parameters: ** end PresetId(r): <1..35> Example: xCommand Camera Preset Remove PresetId: 1 *r CameraPresetRemoveResult (status=OK) ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 108 Resets ActiveSpeaker. Normal voice switching is switched back on. Requires user role: USER Example: xCommand Conference ActiveSpeaker Reset *r ConferenceActiveSpeakerResetResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 109 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 110 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 111 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 112 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 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 113 Key Release command to emulate releasing the key. Requires user role: ADMIN Parameters: 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 Press Key:Home *r KeyPressResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 114 Message TextLine Clear Requires user role: ADMIN Example: *r MessageTextLineClearResult (status=OK): xCommand Message Alert Clear ** end *r MessageAlertClearResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 115 FeedbackId: <S: 0, 255> *r MessagePromptDisplayResult (status=OK): OptionId(r): <1..5> ** end Example: xCommand Message Prompt Response OptionId: 1 *r MessagePromptResponseResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 116 LocalEcho(o): <On/Off> Example: xCommand Message FarendMessage CallId: 3 Type: 3 Text: Hello *r FarendMessageResult (status=Error): Reason: Generic Message mode not enabled ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 117 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 Name(r): The name of the contact.
Page 118 ImageURL: <S: 0, 255> Title: <S: 0, 255> Example: xCommand Phonebook Contact Modify ContactId:localContactId-1 Name: "John Doe - office" *r PhonebookContactModifyResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 119 You can add several contact methods to a contact. Note that only the first contact method will command was issued to make the contact. appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact method ContactMethodId: The unique identifier for the contact method you want to modify. The identifier may have been created when issuing the xCommand Phonebook Contact Add command to make will be returned by an xCommand Phonebook Search command.
Page 120 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 121 Requires user role: USER "SIP:John.Doe.Home@company.com" Example: *r PhonebookSearchResult ResultSet Contact 2 ContactMethod 2 Protocol: SIP xCommand Presentation Stop ** end *r PresentationStopResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 122 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 123 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 124 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 125 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 126 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 127 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 128 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 129 ** end Parameters: Name(r): <S: 0, 255> Example: xCommand SystemUnit ConfigurationProfile Remove Name: "My _ ConfigurationProfile _ 1" *r ConfigurationProfileRemoveResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 130 ** end *r SystemUnit ReleaseKey 3 Version: "TC3" *r SystemUnit ReleaseKey 4 Version: "TC4" *r SystemUnit ReleaseKey 5 Version: "TC5" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 131: Video Commands
Requires user role: ADMIN *r VideoLayoutResetResult (status=OK): Parameters: ** end LayoutId: <1..2147483647> Example: xCommand Video Layout Add *r VideoLayoutAddResult (status=OK): LayoutId: 1 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 132 *r VideoLayoutFrameRemoveResult (status=OK): If the VideoSourceType is set to LocalInput the VideoSourceId is the video input SourceId. ** end Otherwise set to 1. Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 133 If the VideoSourceType is set to RemoteMain the VideoSourceId is the CallId of the remote site. If the VideoSourceType is set to LocalInput the VideoSourceId is the video input SourceId. Otherwise set to 1. Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 134 Parameters: *r VideoLayoutAssignPresentationResult (status=OK): LayoutId(r): <1..2147483647> ** end OutputId(r): <0..65534> Example: xCommand Video Layout AssignLocalOutput OutputId:1 LayoutId:2 *r VideoLayoutAssignLocalOutputResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 135 Minimized when you want the presentation to be displayed in a small picture on screen. ** end Requires user role: ADMIN Parameters: View(r): <Default/Maximized/Minimized> Example: xCommand Video Layout SetPresentationView View:Default *r VideoLayoutSetPresentationViewResult (status=OK): ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 136 Loads and starts using the specified video layout database. The default video layout database Lists all identification numbers for layouts created by command 'xCommand Video Layout Add'. is initially provided by the system. The custom database is generated by the Cisco TC Console Requires user role: ADMIN tool and is made available to the codec from within the TC Console tool.
Page 137 Video Selfview Set FullscreenMode: On OnMonitorRole: Second Example: xCommand Video PIP Presentation Set Position: LowerLeft *r SelfviewSetResult (status=OK): *r PresentationPipSetResult (status=OK): ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 138 Video PIP Presentation Set Sets position for the presentation PiP (picture in picture). The Experimental commands are for testing only and should not be used unless agreed with Cisco. Position: Predefined positions. These commands are not documented and WILL change in later releases.
Page 139: Xstatus Commands
Cisco TelePresence System Codec C90 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 140: Description Of The Xstatus Commands
Call [n] Direction ..........................150 xStatus Camera [1..7] Position Zoom .......................155 xStatus Call [n] Protocol ...........................150 xStatus Camera [1..7] Position Focus .......................155 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 141 Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 LastIntervalReceived ..164 xStatus Conference Line [n] Mode ......................160 xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 LastIntervalReceived ..164 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 142 MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Local IpAddress ....172 xStatus H320 Gateway Number .......................167 xStatus MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Local Port ......173 xStatus H320 Gateway Mode........................167 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 143 MediaChannels Call [n] OutgoingVideoChannel [n] Video ResolutionY ........179 xStatus Network CDP SysObjectID ......................184 xStatus Network CDP VoIPApplianceVlanID ....................185 xStatus MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTP Local IpAddress ....179 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 144 SIP Profile 1 Registration [n] URI ....................196 xStatus Provisioning CUCM ExtensionMobility LoggedIn ................190 xStatus SIP Profile 1 DirectoryURI Primary URI ..................196 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 145 Video Input DVI [3, 5] SignalState ....................208 xStatus SystemUnit State MaxNumberOfActiveCalls ................202 xStatus Video Input Legacy [5] Connected ..................... 208 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 146 Video Layout Site [n] Output [1..5] Frame [1..6] Height ..............212 Experimental status ..........................216 xStatus Video Layout Site [n] Output [1..5] Frame [1..6] Layer ..............212 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 147 Audio Input LocalInput 1 Name *s Audio Input LocalInput 1 Channels: 1 *s Audio Input LocalInput 1 Name: "Microphone" ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 148 Audio Output LocalOutput 4 Loudspeaker *s Audio Input RemoteInput 8 CallId: 28 *s Audio Output LocalOutput 4 Loudspeaker: "Off" ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 149 Audio Output LocalOutput 4 Input 2 Gain *s Audio Module 0 Type: DigitalNAM *s Audio Output LocalOutput 4 Input 2 Gain: 0 ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 150: Call Status
Value space of the result returned: <H323/SIP/H320> Example: xStatus Call 27 Protocol *s Call 27 Protocol: "h323" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 151 Call 27 CallbackNumber xStatus Call 27 ReceiveCallRate *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" *s Call 27 ReceiveCallRate: 4000 ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 152 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 153 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 154 Shows the camera IP address. Value space of the result returned: <String> Example: xStatus Camera 1 IpAddress *s Camera 1 IpAddress: "" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 155 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 156 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 157 Conference Presentation LocalSendingMode *s Conference Site 2 Capabilities FECC Source 1 SourceId: 6 *s Conference Presentation LocalSendingMode: Off ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 158 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 159 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 identifica- managed conference.
Page 160 Conference Line 1 Appearance Status *s Conference Site 14 CalText: "" *s Conference Line 1 Appearance 5464 Status: Held ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 161 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 162 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter: ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 163 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost: 0 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 164 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived: 84 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 165 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes: *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 129920 ChannelRate: 128000 ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 166 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter: 0 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 167 H320 Gateway Id Example: *s H320 Gateway Id: "00:50:60:0B:EF:11" xStatus H320 Gateway Number ** end *s H320 Gateway Number: "" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 168 Shows the port which is used when connecting to on the gatekeeper. Value space of the result returned: <Integer> Example: xStatus H323 Gatekeeper Port *s H323 Gatekeeper Port: 1719 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 169 Returns the IP address of the TURN server that is currently in use. Value space of the result returned: <String> Example: xStatus ICE Turn IP *s ICE Turn IP: "192.0.1.20" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 170 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 171 Off: Turn discovery mode is set to Off. ** end Value space of the result returned: <Verified/NotVerified/Failed/Off> Example: xStatus ICE Turn Discovermode *s ICE Turn Discovermode: "Verified" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 172 IpAddress: "192.168.24.190" xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol ** end *s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol: AACLD ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 173 *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port: 50932 *s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress: "192.168.136.130" ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 174 MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX *s MediaChannels Call 27 IncomingVideoChannel 330 ChannelRole: Main *s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768 ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 175 MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP ** end Local IpAddress *s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local IpAddress: "192.168.24.190" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 176 MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels Port: 50933 *s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1 ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 177 *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port: 16405 *s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress: "192.168.136.130" ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 178 Example: ** end xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status *s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 179 MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port: 50932 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 180 MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress: "192.168.136.130" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 181 ** end Example: xStatus Network 1 IPv4 DNS Server 1. Address *s Network 1 IPv4 DNS Server 1 Address: "192.0.2.60" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 182 Network 1 IPv4 DHCP ProvisioningServer *s Network 1 IPv6 Address: "" *s Network 1 IPv4 DHCP ProvisioningServer: "192.0.2.0" ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 183 Network 1 IPv6 Gateway xStatus Network CDP Version *s Network 1 IPv6 Gateway: "" *s Network 1 CDP Version: "Cisco IOS Software, C3750E Software (C3750E- UNIVERSALK9-M), Version 15.0(1)SE2, RELEASE SOFTWARE (fc3)*Technical ** end 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 184 Returns the first network address of both receiving and sending devices. Value space of the result returned: <String> Example: xStatus Network CDP Address *s Network 1 CDP Address: "192.0.1.20" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 185 Discarded: The NTP result has been discarded. Value space of the result returned: <Unknown/Synced/Discarded> Example: xStatus NetworkServices NTP Status *s NetworkServices NTP Status: Synced ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 186 Value space of the result returned: *s Provisioning Reason: "" <String> ** end Example: xStatus Preset 1 Description *s Preset 1 Description: "Zoom in" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 187 Provisioning Software UpgradeStatus URL *s Provisioning Software UpgradeStatus Status: None *s Provisioning Software UpgradeStatus URL: "http:// .../s52000tc5 _ 1 _ 0.pkg" ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 188 Value space of the result returned: ** end <IgnoreAuth/NullAuth/StringAuth/LSCAuth/MICAuth> Example: xStatus Provisioning CUCM CAPF ServerName *s Provisioning CUCM CAPF ServerName: "192.168.0.1" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 189 Value space of the result returned: *s Provisioning CUCM CAPF OperationState: NonPending <NotSet/CAPFUnknown/CAPFInvalidAuthStrLen/CAPFInvalidInitReason/CAPFInvalidAuthMode/ ** end 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 Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 190 *s Provisioning CUCM CTL State: Installed <String> ** end Example: xStatus Provisioning CUCM TVS Proxy 1 Server *s Provisioning CUCM TVS Proxy 1 Server: "192.0.2.0" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 191 *s Provisioning CUCM TVS Proxy 1 Priority: 0 ** end <NonPersistent/Persistent> Example: xStatus Security Persistency CallHistory *s Security Persistency CallHistory: Persistent ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 192 Shows whether DHCP logging is set to persistent or non-persistent mode. Persistent is the default mode. Value space of the result returned: <NonPersistent/Persistent> Example: xStatus Security Persistency DHCP *s Security Persistency DHCP: Persistent ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 193 Timeout: The attempt to establish communication to the SIP Proxy timed out. ter to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or CUCM. UnableTCP: The system is unable to use TCP as the transport method.
Page 194 *s SIP Profile 1 Proxy 1 Status: Active <String> ** end Example: xStatus SIP Registration 1 URI *s SIP Registration 1 URI: "firstname.lastname@company.com" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 195 Shows whether or not the SSL certificate of the server that the video system / codec tries to regis- ter to 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 xStatus SIP Profile 1 CallForward Mode valid.
Page 196 *s SIP Profile 1 DirectoryURI Primary URI: "123456@company.com" <Deregister/Failed/Inactive/Registered/Registering> ** end Example: xStatus SIP Profile 1 Registration 1 Status *s SIP Profile 1 Registration 1 Status: Registered ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 197 SIP Profile DirectoryURI Primary URI Example: *s SIP Profile 1 DirectoryURI Primary URI: "123456@company.com" xStatus Standby Active ** end *s Standby Active: Off ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 198 Value space of the result returned: *s SystemUnit ProductPlatform: "C90" <String> ** end Example: xStatus SystemUnit Software Name *s SystemUnit Software Name: "s52000" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 199 SystemUnit Software ReleaseKey xStatus SystemUnit Hardware Module SerialNumber *s SystemUnit Software ReleaseKey: "true" *s SystemUnit Hardware Module SerialNumber: "F9AA99A00090" ** end ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 200 SystemUnit Hardware Module CompatibilityLevel xStatus SystemUnit Hardware VideoBoard SerialNumber The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The Shows the serial number of the video board in the codec. endpoints running TC software 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 201 ** end Example: xStatus SystemUnit Hardware Monitoring Fan 1 Status *s SystemUnit Hardware Monitoring Fan 1 Status: "locked on 1096 rpm" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 202 Shows the number of suspended calls. Value space of the result returned: <0..5> Example: xStatus SystemUnit State NumberOfSuspendedCalls *s SystemUnit State NumberOfSuspendedCalls: 0 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 203 CallProtocolIPStackPlatformCompatability/CameraStatus/CameraPairing/ CameraSoftwareVersion/SelectedVideoInputSourceConnected/OSDVideoOutput/ ** end VideoFromInternalCamera/H323GatekeeperStatus/SipIceAndAnatConflict/ UdpPortRangeViolation/ProvisioningStatus/CallProtocolVcsProvisioningCompatibility/ CallProtocolDualStackConfig> Example: xStatus SystemUnit Diagnostics Message type *s SystemUnit Diagnostics Message 1 Type: InvalidAdminPassword ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 204 Value space of the result returned: <String> Example: xStatus SystemUnit Diagnostics Message References *s SystemUnit DiagnosticsResult Message 1 References: "" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 205 Shows the last connected video input source. Value space of the result returned: <1..5> Example: xStatus Video Input LastConnectedSource *s Video Input LastConnectedSource: 0 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 206 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 207 *s Video Input HDSDI 1 Connected: False ** end Example: xStatus Video Input YPbPr 1 SignalState *s Video Input YPbPr 1 SignalState: OK ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 208 <First/ Second/ Third/ Fourth/ PresentationOnly/ Recorder/ InternalSetup> Example: xStatus Video Output HDMI 1 MonitorRole *s Video Output HDMI 1 MonitorRole: First ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 209 *s Video Output HDMI 1 Resolution RefreshRate: 60 xStatus Video Output DVI 2 MonitorRole ** end *s Video Output DVI 2 MonitorRole: First ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 210 <First/ Second/ Third/ Fourth/ PresentationOnly/ Recorder/ InternalSetup> ** end Example: xStatus Video Output Legacy 5 MonitorRole *s Video Output Legacy 5 MonitorRole: First ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 211 Value space of the result returned: <String> Example: xStatus Video Layout Site 1 Output 1 FullFamilyName *s Video Layout Site 1 Output 1 FullFamilyName: "fullscreen-local-single-camctrl" ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 212 Video Layout Site 1 Output 1 Frame 1 PositionY *s Video Layout Site 1 Output 1 Frame 1 PositionY: 0 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 213 Video Layout Site 1 Output 1 Frame 1 VideoSourceId *s Video Layout Site 1 Output 1 Frame 1 VideoSourceId: 0 ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 214 Video Layout Prediction Site [n] FrameContainer OutputRole [n] PositionY <Integer> For internal use only. Value space of the result returned: <Integer> Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 215 Value space of the result returned: ** end <UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight> Example: xStatus Video PIP ActiveSpeaker Position *s Video PIP ActiveSpeaker Position: UpperCenter ** end Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 216 Video PIP Presentation Position Shows the position of the presentation image on the screen. The Experimental status is for testing only and should not be used unless agreed with Cisco. These Value space of the result returned: settings are not documented and WILL change in later releases.
Page 217: Appendices
Cisco TelePresence System Codec C90 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 218: The Video Input Matrix
• xConfiguration Video DefaultPresentationSource: • Video MainVideoSource: 1 (which is the main camera) <1..5> • Video DefaultPresentationSource: 3 (which is the PC) Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 219: About Startup Scripts
3. Put an executable file (permission must be changed to executable) in this directory. Example of the text in such a file: #!/usr/bin/env tsh xCommand Audio LocalInput Update InputId: 1 MixerMode:Fixed Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 220: 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 221: 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 left Number 1 Arrow right Number 2...
Page 222: The Systemtools Commands
Shows the content of a license file, define by the name. [comment] | delete <id> | list | clear> name(r): The name of the license file. Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 223 Minimum time between PIN renewals (hours) [0]? Shows the security status for the codec. • The user can only change PIN once within this limit. Codec C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 224: 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 C90 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. D14641.15...
Page 225 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 operat- ing system.

Cisco TelePresence System Codec C90 Reference Manual

Quick Links

Need help?

Questions and answers

Related Manuals for Cisco TelePresence System Codec C90

Summary of Contents for Cisco TelePresence System Codec C90

Table of Contents