Cisco TelePresence System Codec C40 Reference Manual
  1. Manuals
  2. Brands
  3. Cisco Manuals
  4. Conference System
  5. TelePresence System Codec C40
  6. Reference manual

Cisco TelePresence System Codec C40 Reference Manual

Software version tc7.0
Hide thumbs Also See for TelePresence System Codec C40:
Table of Contents

Advertisement

Quick Links

See also: Troubleshooting Manual , Administrator's Manual
Cisco TelePresence System Codec C40/C60
Contents
Introduction
Software version TC7.0
JANUARY 2014
Application Programmer Interface (API)
Reference Guide
Cisco TelePresence System Codec C40/C60
D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014.
About the API
xConfiguration
1
xCommand
xStatus
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices

Advertisement

Table of Contents
loading

Related Manuals for Cisco TelePresence System Codec C40

Summary of Contents for Cisco TelePresence System Codec C40

  • 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 C40/C60 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 2: Table Of Contents

    Configurations ..............13 Status ..................14 Events ................... 15 Call history ................16 Feedback mechanism............17 Feedback expressions ............17 Terminal connections ............18 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 3: Introduction

    Cisco TelePresence System Codec C40/C60 API Reference Guide Contents Introduction Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 4: About This Guide

    Regulatory compliance and safety information guides • Legal & license information for TC software To download the user documentation go to: http://www.cisco.com/go/cseries-docs D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 7: About The Api

    Cisco TelePresence System Codec C40/C60 API Reference Guide Contents Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 8: Api Fundamentals

    This is described in xCommand SystemUnit AdminPassword Set Password: “Using HTTP” on page 19 in this document. <password> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 11: Searching

    *? xConfiguration Video Output Composite[3] OverscanLevel: <Medium/High/None> xcommand dial number: foo@bar.org *? xConfiguration Video Output Composite[3] MonitorRole: <Auto/First/Second/PresentationOnly/ xCommand Dial Number: foo@bar.org Recorder> ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 13: Configurations

    *? xConfiguration Audio Input Microphone[1] Equalizer Mode: <Off/On> *? xConfiguration Video Output Composite[3] Resolution: <PAL/NTSC> *? xConfiguration Video Output Composite[3] OverscanLevel: <Medium/High/None> *? xConfiguration Video Output Composite[3] MonitorRole: <Auto/First/Second/PresentationOnly/Recorder> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 14: Status

    *s Call 3 Duration: 123 *s Call 3 AnswerState: Answered *s Call 3 ModifyState: Idle *s Call 3 DeviceType: Endpoint ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 15: Events

    *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 17: Feedback Mechanism

    Video Input Source 3 Connector sluggish or unpredictable behavior. *c xConfiguration Video Input Source 3 Connector: ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Source[@item=’3’]/Connector D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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> <CameraPositionSetResult item=”1” status=”OK”/> </Audio><Video><OSD><TodaysBookings>On </Command> </TodaysBookings></OSD></Video></Configuration> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 20: Feedback From Codec Over Http

    </HttpFeedback> Expression: <S: 1, 255> </Command> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 23: Xconfiguration Commands

    Cisco TelePresence System Codec C40/C60 API Reference Guide Contents Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 24: Description Of The Xconfiguration Commands

    Conference [1..1] DoNotDisturb Mode ................37 xConfiguration Audio Output Line [1..2] Level ....................32 xConfiguration Conference [1..1] DoNotDisturb DefaultTimeout ..............37 xConfiguration Audio Output Line [1..2] Mode ....................33 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 25 H323 Profile [1..1] H323Alias E164 ..................44 xConfiguration Network [1..1] Speed ......................50 xConfiguration H323 Profile [1..1] H323Alias ID ..................44 xConfiguration Network [1..1] TrafficControl Mode ..................50 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 26 Phonebook Server [1..1] Type ....................55 xConfiguration Phonebook Server [1..1] URL .....................55 xConfiguration SIP OCSP Mode .........................61 xConfiguration SIP OCSP DefaultResponder .....................61 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 27 Time Zone ..........................66 xConfiguration Video PIP ActiveSpeaker DefaultValue Position ..............74 xConfiguration Time TimeFormat .......................67 xConfiguration Video PIP Presentation DefaultValue Position ..............74 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 28 Video WallPaper .........................81 xConfiguration Video OSD MyContactsExpanded ..................77 Experimental configuration ........................82 xConfiguration Video OSD Output ......................77 xConfiguration Video OSD InputMethod InputLanguage ................78 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 29 Requires user role: ADMIN Value space: <1/2/3> Range: Select one of the video input sources. Example: xConfiguration Audio Input HDMI 2 VideoAssociation VideoInputSource: 1 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 30 On: Enable the Audio Line input. Example: xConfiguration Audio Input Microphone 1 EchoControl Dereverberation: On Example: xConfiguration Audio Input Line 1 Mode: On D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 31 On: Enable the microphone connector. displayed. Example: xConfiguration Audio Input Microphone 1 Mode: On Example: xConfiguration Audio Input Microphone 1 VideoAssociation MuteOnInactiveVideo: On D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 32 Requires user role: ADMIN Value space: <-24..0> Range: Select a value from -24 to 0 dB. Example: xConfiguration Audio Output Line 1 Level: -10 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 33 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). When using the Touch screen control panel: Choose a ringtone from the list. If the setting...
  • Page 34 Requires user role: ADMIN Value space: <1..31> Range: Select a value from 1 to 31. Example: xConfiguration Cameras Camera 1 Brightness Level: 1 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 35 Applies to cameras which support gamma mode. Gamma describes the nonlinear relationship Value space: <Auto/Off/On> between image pixels and monitor brightness. The Cisco TelePresence PrecisionHD 720p camera Auto: When the camera is placed upside down the image is automatically mirrored. Use this supports gamma mode.
  • Page 36 Cameras Camera [1..7] MotorMoveDetection xConfiguration Cameras Camera [1..7] DHCP This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera. Applies to cameras which support DHCP over LAN. When set, the command enables support for software upgrade of daisy chained cameras.

  • Page 37: Conference Configuration

    On: The incoming call will be muted when automatically answered. Example: xConfiguration Conference 1 DoNotDisturb Mode: Timed Example: xConfiguration Conference 1 AutoAnswer Mute: Off D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 38 Sip: Sip ensures that calls are set up as SIP calls. Requires user role: ADMIN H320: H320 ensures that calls are set up as H.320 calls (only applicable if connected to a Cisco Value space: <Off/On> TelePresence ISDN Link gateway).
  • Page 39 Range: Select a value between 64 and 10000. Value space: <1..10> Example: xConfiguration Conference 1 MaxTotalTransmitCallRate: 10000 Range: 1 to 10. Example: xConfiguration Conference 1 VideoBandwidth MainChannel Weight: 5 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 40 (MCU). LocalOnly: The presentation will only be shown locally. 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 Example: xConfiguration Conference 1 Presentation Policy: LocalRemote 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: "" D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 42 InputMuteMicrophones: When the pin is activated (0 V), the microphones will be muted. When deactivated (+ 12 V), the microphones are unmuted. Example: xConfiguration GPIO Pin 1 Mode: InputNoAction D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 43: H323 Configuration

    Example: xConfiguration H323 NAT Address: "" Value space: <S: 0, 50> Format: String with a maximum of 50 characters. Example: xConfiguration H323 Profile 1 Authentication Password: "" D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 44 Static: When set to Static the ports are given within a static predefined range [5555-6555]. Example: xConfiguration H323 Profile 1 Gatekeeper Address: "192.0.2.0" Example: xConfiguration H323 Profile 1 PortAllocation: Dynamic D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 45: Network Configuration

    Assignment is set to Static. Requires user role: ADMIN Value space: <S: 0, 64> Format: A valid IPv4 address. Example: xConfiguration Network 1 IPv4 Address: "192.0.2.2" D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 46 DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. Example: xConfiguration Network 1 IPv6 Assignment: Autoconf D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 47 Provisioning ExternalManager Address setting. Requires user role: ADMIN If the Network VLAN Voice Mode setting is Auto and the Cisco Discovery Protocol (CDP) assigns an Value space: <Off/Diffserv> ID to the voice VLAN, then a request for option 150 will always be sent. That is, the Network DHCP Off: No QoS method is used.
  • Page 48 Range: Select a value between 0 to 63 - the higher the number, the higher the priority. The default value is 0 (best effort). Example: xConfiguration Network 1 QoS Diffserv Data: 0 Example: xConfiguration Network 1 QoS Diffserv ICMPv6: 0 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 49 TLS connections. Only servers with a valid certificate will be allowed. Example: xConfiguration Network 1 IEEE8021X AnonymousIdentity: "" Example: xConfiguration Network 1 IEEE8021X TlsVerify: Off D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 50 Set the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients Protocol that relies on a shared secret. Md5 is a Weak security. without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Requires user role: ADMIN Requires user role: ADMIN Value space: <Off/On>...
  • Page 51 Requires user role: ADMIN Value space: <Auto/Manual/Off> Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. If CDP is not available, VLAN is not enabled. Manual: The VLAN ID is set manually using the Network VLAN Voice VlanId setting. If CDP is available, the manually set value will be overruled by the value assigned by CDP.
  • Page 52 Example: xConfiguration NetworkServices XMLAPI Mode: On On: Enable the possibility to place and receive SIP calls (default). Example: xConfiguration NetworkServices SIP Mode: On D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 53 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 54 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 55 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 56 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 57 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 58 Requires user role: ADMIN Value space: <1056..65535> Range: Select a value from 1056 to 65535. Example: xConfiguration RTP Ports Range Stop: 2486 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 59 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 60 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 61: 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 62 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 63 Auto: The system will try to connect using transport protocols in the following order: TLS, TCP, UDP. Example: xConfiguration SIP Profile 1 DefaultTransport: Auto D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 64 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 65 DefaultCameraPosition: After a reboot the camera position will be set to the factory default position. Example: xConfiguration Standby BootAction: DefaultCameraPosition D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 66 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 67 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)" D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 69 Limited: Limited Quantization Range. R, G, B quantization range that excludes some code values at the extremes (16 - 235). This is defined in CEA-861-E. Example: xConfiguration Video Input 1 HDMI 1 RGBQuantizationRange: Auto D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 70 YC: Select YC when you want to use the S-Video (YC) as input source 3. Connect to the two connectors marked Y/Comp and C. Example: xConfiguration Video Input Source 3 Connector: DVI D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 71 Rather high resolutions will be used. Example: xConfiguration Video Input Source 1 OptimalDefinition Profile: Normal D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 72 Requires user role: USER Value space: <1/2/3> Range: Select the source to be used as the main video source. Example: xConfiguration Video MainVideoSource: 1 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 73 Maximized: The presentation starts up in full screen mode. Example: xConfiguration Video Layout Scaling: On Example: xConfiguration Video Layout PresentationDefault View: Default D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 74 LowerRight: The presentation PiP will appear in the lower right corner of the screen. Example: xConfiguration Video PIP Presentation DefaultValue Position: Current D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 75 On: self-view is switched on when leaving a call. Example: xConfiguration Video SelfviewDefault Mode: Current D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 76 Off: Hide the on-screen menus, icons and indicators. Example: xConfiguration Video OSD MenyStartUpMode: Home On: Display the on-screen menus, icons and indicators. Example: xConfiguration Video OSD Mode: On D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 77 Off: The call settings will be available from within the Conference settings in the Administrator Settings. On: The Call Settings menu will be available from the Settings menu. Example: xConfiguration Video OSD CallSettingsSelection: Off D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014.

  • Page 83: Xcommand Commands

    Cisco TelePresence System Codec C40/C60 API Reference Guide Contents Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 85 Phonebook Folder Delete ..................... 117 xCommand DTMFSend ..........................109 xCommand Phonebook Contact Add ....................... 117 FacilityService commands ........................110 xCommand Phonebook Contact Modify ....................118 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 86 Video Layout AssignCall .......................134 SystemUnit commands ........................126 xCommand Video Layout AssignPresentation ..................134 xCommand SystemUnit OptionKey Add....................126 xCommand Video Layout UnAssign ......................135 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 87 Video PreviewFilmstrip Set ....................138 xCommand Video Layout Frame List .......................136 Experimental commands ........................139 xCommand Video Layout List ........................136 xCommand Video OSD Close ........................137 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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" D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 95 Stop collecting VU meter information for all connectors. Requires user role: USER Example: xCommand Audio VUMeter StopAll *r AudioVumeterStopResult (status=OK): ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 114 Message TextLine Clear Requires user role: ADMIN Example: *r MessageTextLineClearResult (status=OK): xCommand Message Alert Clear ** end *r MessageAlertClearResult (status=OK): ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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)" D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 129 Example: xCommand SystemUnit ConfigurationProfile List *r ConfigurationProfileListResult (status=OK): Profile: My _ ConfigurationProfile _ 1 Profile: My _ ConfigurationProfile _ 2 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 130 *r SystemUnit ReleaseKey 2 Version: "TC2" *r SystemUnit ReleaseKey 3 Version: "TC3" *r SystemUnit ReleaseKey 4 Version: "TC4" *r SystemUnit ReleaseKey 5 Version: "TC5" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 131: Video Commands

    Video Layout Reset LayoutId: <1..2147483647> *r VideoLayoutResetResult (status=OK): Example: ** end xCommand Video Layout Add *r VideoLayoutAddResult (status=OK): LayoutId: 1 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 134 Parameters: LayoutId(r): <1..2147483647> *r VideoLayoutAssignPresentationResult (status=OK): OutputId(r): <0..65534> ** end Example: xCommand Video Layout AssignLocalOutput OutputId:1 LayoutId:2 *r VideoLayoutAssignLocalOutputResult (status=OK): ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 135 Requires user role: ADMIN *r VideoLayoutUnAssignPresentationResult (status=OK): Parameters: ** end OutputId(r): <0..65534> Example: xCommand Video Layout UnAssignLocalOutput OutputId:1 *r VideoLayoutUnAssignLocalOutputResult (status=OK): ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 136 Loads and starts using the specified video layout database. The default video layout database is *r VideoLayoutFrameListResult LayoutId 1 FrameId 1 VideoSourceType: initially provided by the system. The custom database is generated by the Cisco TC Console tool localInput and is made available to the codec from within the TC Console tool. The TC Console software *r VideoLayoutFrameListResult LayoutId 1 FrameId 1 VideoSourceId: 1 is found at the Developer Zone web page.
  • Page 137 UpperRight: The ActiveSpeaker PiP appears in the upper right corner of the screen. Requires user role: ADMIN Parameters: Position(r): <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight> Example: xCommand Video PIP ActiveSpeaker Set Position: UpperRight *r ActiveSpeakerPipSetResult (status=OK): ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 138 Video Selfview Set FullscreenMode: On OnMonitorRole: Second xCommand Video PreviewFilmstrip Set Position: LowerCenter *r PreviewFilmstripSetResult (status=OK): *r SelfviewSetResult (status=OK): ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 139 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014.

  • Page 140: Xstatus Commands

    Cisco TelePresence System Codec C40/C60 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 141: Description Of The Xstatus Commands

    Call [n] Direction ........................... 151 xStatus Camera [1..7] Position Zoom......................156 xStatus Call [n] Protocol ..........................151 xStatus Camera [1..7] Position Focus .......................156 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 142 Diagnostics Call [n] Channels IncomingAudioChannel [n] Netstat 1 LastIntervalReceived ..165 xStatus Conference Line [n] Mode ......................161 xStatus Diagnostics Call [n] Channels IncomingVideoChannel [n] Netstat 1 LastIntervalReceived ..165 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 143 MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Local Port ......174 xStatus H320 Gateway Mode ........................168 xStatus MediaChannels Call [n] IncomingAudioChannel [n] Transport RTP Remote IpAddress ....174 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 144 MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTP Local IpAddress ....180 xStatus Network CDP VoIPApplianceVlanID ....................186 xStatus MediaChannels Call [n] OutgoingVideoChannel [n] Transport RTP Local Port ......180 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 145 SIP Profile 1 Registration [n] URI ....................197 xStatus Provisioning CUCM ExtensionMobility LoggedIn ................191 xStatus SIP Profile 1 DirectoryURI Primary URI ..................197 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 146 SystemUnit State MaxNumberOfActiveCalls ................203 xStatus Video Output HDMI [n] MonitorRole.....................209 xStatus SystemUnit State NumberOfActiveCalls ..................203 xStatus Video Output HDMI [1] Resolution Height ..................209 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 147 Video Layout Site [n] Output [1..3] Frame [1..6] MediaChannelId ..........213 xStatus Video Layout Site [n] Output [1..3] Frame [1..6] VideoSourceType ..........213 Experimental status ..........................216 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 148 Audio Input LocalInput 1 Name *s Audio Input LocalInput 1 Channels: 1 *s Audio Input LocalInput 1 Name: "Microphone" ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 149 Audio Output LocalOutput 4 Loudspeaker *s Audio Input RemoteInput 8 CallId: 28 *s Audio Output LocalOutput 4 Loudspeaker: "Off" ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 150 Audio Output LocalOutput 4 Input 2 Gain *s Audio Module 0 Type: DigitalNAM *s Audio Output LocalOutput 4 Input 2 Gain: 0 ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 151: Call Status

    Value space of the result returned: <H323/SIP/H320> Example: xStatus Call 27 Protocol *s Call 27 Protocol: "h323" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 152 Call 27 CallbackNumber xStatus Call 27 ReceiveCallRate *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" *s Call 27 ReceiveCallRate: 4000 ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 153 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 154 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 155 Shows the camera IP address. Value space of the result returned: <String> Example: xStatus Camera 1 IpAddress *s Camera 1 IpAddress: "" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 156 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 157 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 158 Conference Presentation LocalSendingMode *s Conference Site 2 Capabilities FECC Source 1 SourceId: 6 *s Conference Presentation LocalSendingMode: Off ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 159 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 160 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 161 Conference Line 1 Appearance Status *s Conference Site 14 CalText: "" *s Conference Line 1 Appearance 5464 Status: Held ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 162 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 163 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter: ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 164 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost: 0 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 165 Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived *s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived: 84 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 166 *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes: *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 129920 ChannelRate: 128000 ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 167 Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter *s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter: 0 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 168 H320 Gateway Id Example: *s H320 Gateway Id: "00:50:60:0B:EF:11" xStatus H320 Gateway Number ** end *s H320 Gateway Number: "" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 169 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 170 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 171 Value space of the result returned: <HOST/PRFLX/SRFLX/RELAY> Example: xStatus ICE Call Remote Candidate *s ICE Call 1 Remote Candidate: “SRFLX” ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 172 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 173 IpAddress: "192.168.24.190" xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol ** end *s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol: AACLD ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 174 *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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 175 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 176 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 177 MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels Port: 50933 *s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1 ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 178 *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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 179 Example: ** end xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status *s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 180 MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port: 50932 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 181 MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress *s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress: "192.168.136.130" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 182 ** end Example: xStatus Network 1 IPv4 DNS Server 1. Address *s Network 1 IPv4 DNS Server 1 Address: "192.0.2.60" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 183 Network 1 IPv4 DHCP ProvisioningServer *s Network 1 IPv6 Address: "" *s Network 1 IPv4 DHCP ProvisioningServer: "192.0.2.0" ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 184 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 185 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 186 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 187 Value space of the result returned: *s Provisioning Reason: "" <String> ** end Example: xStatus Preset 1 Description *s Preset 1 Description: "Zoom in" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 188 Provisioning Software UpgradeStatus URL *s Provisioning Software UpgradeStatus Status: None *s Provisioning Software UpgradeStatus URL: "http:// .../s52000tc5 _ 1 _ 0.pkg" ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 189 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 190 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 191 *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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 192 *s Provisioning CUCM TVS Proxy 1 Priority: 0 ** end <NonPersistent/Persistent> Example: xStatus Security Persistency CallHistory *s Security Persistency CallHistory: Persistent ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 193 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 194 Timeout: The attempt to establish communication to the SIP Proxy timed out. register 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 195 *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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 196 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. 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 197 *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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 198 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 199 Value space of the result returned: *s SystemUnit ProductPlatform: "C90" <String> ** end Example: xStatus SystemUnit Software Name *s SystemUnit Software Name: "s52000" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 200 SystemUnit Software ReleaseKey xStatus SystemUnit Software OptionKeys DualDisplay *s SystemUnit Software ReleaseKey: "true" *s SystemUnit Software OptionKeys DualDisplay: "true" ** end ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 201 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 202 *s SystemUnit State MaxNumberOfCalls: 3 Value space of the result returned: ** end <String> Example: xStatus SystemUnit Hardware Temperature *s SystemUnit Hardware Temperature: "64.0" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 203 Value space of the result returned: xStatus SystemUnit ContactName: "1234@192.0.2.0" <0..5> Example: xStatus SystemUnit State NumberOfInProgressCalls *s SystemUnit State NumberOfInProgressCalls: 0 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 204 Value space of the result returned: <String> Example: xStatus SystemUnit Notifications Notification 1 Text *s SystemUnit Notifications Notification 1 Text: "OK" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 205 Value space of the result returned: <String> Example: xStatus SystemUnit Diagnostics Message References *s SystemUnit DiagnosticsResult Message 1 References: "" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 206 Shows the last connected video input source. Value space of the result returned: <1..3> Example: xStatus Video Input LastConnectedSource *s Video Input LastConnectedSource: 0 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 207 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 208 *s Video Input DVI 2 Connected: False <Unknown/OK/Unsupported> ** end Example: xStatus Video Input Legacy 3 SignalState *s Video Input Legacy 3 SignalState: OK ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 209 *s Video Output HDMI 1 Connected: False Example: ** end xStatus Video Output HDMI 1 Resolution Height *s Video Output HDMI 1 Resolution Height: 720 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 210 Value space of the result returned: <176..4000> Example: xStatus Video Output DVI 2 Resolution Width *s Video Output DVI 2 Resolution Width: 1280 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 211 *s Video Layout PresentationView: "Default" <176..4000> ** end Example: xStatus Video Output Legacy 3 Resolution Width *s Video Output Legacy 3 Resolution Width: 720 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 212 Video Layout Site 1 Output 1 Frame 1 Height *s Video Layout Site 1 Output 1 Frame 1 Height: 10000 ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 213 Video Layout Site 1 Output 1 Frame 1 VideoSourceType *s Video Layout Site 1 Output 1 Frame 1 VideoSourceType: "graphic" ** end D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 214 Video Layout Prediction Site [n] FrameContainer OutputRole [n] PositionY <Integer> For internal use only. Value space of the result returned: <Integer> D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • 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 C40/C60 API Reference Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 218: About Startup Scripts

    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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 219: 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 220: 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 221: 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. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 222 Minimum time between PIN renewals (hours) [0]? Shows the security status for the codec. • The user can only change PIN once within this limit. D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.

  • Page 223: 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 D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
  • Page 224 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.

This manual is also suitable for:

Telepresence codec c60

Table of Contents