manualshive.com logo in svg

Cisco TelePresence DX70, Reference Manual

Share
Download
Cisco TelePresence DX70 Reference Manual Download Page 91

D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017. 

Copyright © 2017 Cisco Systems, Inc. All rights reserved. 

91

Cisco TelePresence DX70 and DX80

API Reference Guide

xCommand Audio Diagnostics MeasureDelay ...........................................................................................95
xCommand Audio Microphones Mute ........................................................................................................95
xCommand Audio Microphones ToggleMute .............................................................................................95
xCommand Audio Microphones Unmute ...................................................................................................95
xCommand Audio Select ...........................................................................................................................95
xCommand Audio Sound Play ................................................................................................................... 96
xCommand Audio Sound Stop .................................................................................................................. 96
xCommand Audio SoundsAndAlerts Ringtone List .................................................................................. 96
xCommand Audio SoundsAndAlerts Ringtone Play ................................................................................. 96
xCommand Audio Volume Decrease ........................................................................................................ 96
xCommand Audio Volume Increase ...........................................................................................................97
xCommand Audio Volume Mute .................................................................................................................97
xCommand Audio Volume Set ...................................................................................................................97
xCommand Audio Volume SetToDefault ....................................................................................................97
xCommand Audio Volume ToggleMute ..................................................................................................... 98
xCommand Audio Volume Unmute ........................................................................................................... 98
xCommand Audio VuMeter Start .............................................................................................................. 98
xCommand Audio VuMeter Stop ............................................................................................................... 98
xCommand Audio VuMeter StopAll ........................................................................................................... 98

Bookings commands ............................................................................................................................ 99

xCommand Bookings Clear ....................................................................................................................... 99
xCommand Bookings Get ......................................................................................................................... 99
xCommand Bookings List ......................................................................................................................... 99

Call commands ................................................................................................................................... 100

xCommand Call Accept........................................................................................................................... 100
xCommand Call Disconnect .................................................................................................................... 100
xCommand Call DTMFSend .................................................................................................................... 100
xCommand Call FarEndControl Camera Move ....................................................................................... 100
xCommand Call FarEndControl Camera Stop ..........................................................................................101
xCommand Call FarEndControl RoomPreset Activate .............................................................................101
xCommand Call FarEndControl Source Select ........................................................................................101
xCommand Call Forward ..........................................................................................................................101
xCommand Call Hold ................................................................................................................................102
xCommand Call Ignore .............................................................................................................................102
xCommand Call Join ................................................................................................................................102
xCommand Call Reject .............................................................................................................................102
xCommand Call Resume ..........................................................................................................................102
xCommand Call UnattendedTransfer .......................................................................................................102

CallHistory commands ........................................................................................................................ 103

xCommand CallHistory AcknowledgeAllMissedCalls ..............................................................................103
xCommand CallHistory AcknowledgeMissedCall ....................................................................................103
xCommand CallHistory DeleteAll .............................................................................................................103
xCommand CallHistory DeleteEntry .........................................................................................................103
xCommand CallHistory Get ......................................................................................................................104
xCommand CallHistory Recents ..............................................................................................................104

Conference commands ...................................................................................................................... 105

xCommand Conference DoNotDisturb Activate ......................................................................................105
xCommand Conference DoNotDisturb Deactivate ..................................................................................105

Description of the xCommand commands

In this chapter, you can find a complete list of all xCommand type commands with parameters.
We recommend you visit our web site regularly for updated versions of the manual.  

Go to: 

http://www.cisco.com/go/dx-docs

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

Summary of Contents for TelePresence DX70

Page 1: ...Cisco Systems Inc All rights reserved 1 Cisco TelePresence DX70 and DX80 API Reference Guide Collaboration Endpoint Software 9 2 NOVEMBER 2017 Application Programming Interface API Reference Guide Cisco TelePresence DX70 and DX80 Introduction About the API xConfiguration Appendices xCommand xStatus ...

Page 2: ...ut 24 The output modes 24 Using the command line 25 API commands 25 Other commands 25 Command line shortcuts 26 Searching 26 Value types and formats 26 Commands 27 Configurations 27 Status 27 Multiline commands 28 Synchronous API calls 29 Events 30 Feedback mechanism 31 Feedback expressions 31 Terminal connections 32 HTTP XMLAPI Authentication 33 HTTP XMLAPI Session Authentication 33 Getting statu...

Page 3: ...Reference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 3 Cisco TelePresence DX70 and DX80 API Reference Guide Chapter 1 Introduction Introduction About the API xConfiguration Appendices xCommand xStatus Introduction ...

Page 4: ...ration Endpoint software version 8 2 CE8 2 all DX80 and DX70 units can run CE software which is the same software that runs on the Cisco TelePresence SX MX and Room Kit Series Cisco DX80 and Cisco DX70 were originally shipped with Android based software Before migrating to CE software it is important to carefully consider the conversion requirements and the functionality changes compared to Androi...

Page 5: ...f the password is blank anyone can access the Settings and factory reset the system If you select the Russian language on the user interface you can choose between a Russian keyboard and a keyboard with a Latin character set Arabic and Hebrew languages are added to the user interface Also localized keyboards are included Basic IEEE 802 1x settings are added to the Settings panel in the user interf...

Page 6: ...pane displays both the widget values when inter acted with and control system feedback messages Intelligent Proximity changes A Proximity indicator is displayed on the screen middle right to inform that one or more clients are paired to the system with Cisco Proximity The old indicator top left which was always shown when Proximity was enabled has been removed You can no longer disable the Proximi...

Page 7: ...kServices HTTP Proxy Password NetworkServices HTTP Proxy Url Standby WakeupOnMotionDetection UserInterface CustomMessage UserInterface OSD HalfwakeMessage UserInterface SettingsMenu Mode Configurations that are removed Conference MultiStream Mode Configurations that are modified Audio Input MicrophoneMode OLD User role ADMIN NEW User role ADMIN INTEGRATOR UserInterface Language NEW Arabic and Hebr...

Page 8: ...ecurity Certificates Services Activate Security Certificates Services Add Security Certificates Services Deactivate Security Certificates Services Delete Security Certificates Services Show Standby Halfwake UserInterface Branding Delete UserInterface Branding Get UserInterface Branding Updated UserInterface Branding Upload UserInterface Extensions Widget Action UserInterface Message TextInput Clea...

Page 9: ...oneCall VideoCall VolumeAdjust WakeUp NEW Sound Alert Bump Busy CallDisconnect CallInitiate CallWaiting Dial KeyInput KeyInputDelete KeyTone Nav NavBack Notification OK Pairing PresentationConnect Ringing SignIn SpecialInfo TelephoneCall VideoCall VolumeAdjust WakeUp OLD User role INTEGRATOR USER NEW User role ADMIN INTEGRATOR USER Audio Sound Stop OLD User role INTEGRATOR USER NEW User role ADMIN...

Page 10: ...ystemUnit Boot OLD User role INTEGRATOR USER NEW User role ADMIN INTEGRATOR USER SystemUnit FirstTimeWizard Stop OLD User role INTEGRATOR USER NEW User role ADMIN INTEGRATOR USER UserInterface Extensions List OLD User role INTEGRATOR ROOMCONTROL USER NEW User role ADMIN INTEGRATOR ROOMCONTROL USER UserInterface Message Prompt Display Added Duration Integer 0 3600 Video Input SetMainVideoSource Add...

Page 11: ...Diagnostics Message n Type Removed from valuespace CamerasDetectedNoIr UdpPortRangeViolation Added to valuespace CameraDetected CertificateExpiry MacrosRuntimeStatus MediaPortRangeNegative MediaPortRangeOdd MediaPortRangeOverlap MediaPortRangeTooSmall MediaPortRangeValueSpace MicrophonesConnected SparkActivationRequired VideoPortRangeNegative VideoPortRangeOdd VideoPortRangeTooSmall VideoPortRange...

Page 12: ... the video system now supports the WPA EAP authentication framework for Wi Fi connections In total the following methods are supported Open WPA PSK AES WPA2 PSK AES EAP TLS EAP TTLS EAP FAST PEAP EAP MSCHAPv2 EAP GTC Network port 2 can be disabled You can connect a computer to the network through the video system s second network port Then you only need one network wall socket to support both the ...

Page 13: ... 1 New configurations NetworkPort 2 Mode Configurations that are removed None Configurations that are modified Network 1 IEEE8021X Password OLD Valuespace String 0 32 NEW Valuespace String 0 50 Video Input Connector n PresentationSelection OLD Valuespace AutoShare Desktop Hidden Manual OnConnect NEW Valuespace AutoShare Desktop Manual OnConnect Introduction About the API xConfiguration Appendices ...

Page 14: ...uetooth HeadsetUSB HeadsetAnalog HandsetUSB Audio Volume Increase OLD Device Internal HeadsetUSB HeadsetAnalog HandsetUSB NEW Device Internal HeadsetBluetooth HeadsetUSB HeadsetAnalog HandsetUSB Audio Volume Set OLD Device Internal HeadsetUSB HeadsetAnalog HandsetUSB NEW Device Internal HeadsetBluetooth HeadsetUSB HeadsetAnalog HandsetUSB Audio Volume SetToDefault OLD Device Internal HeadsetUSB He...

Page 15: ...rotocol SipOrH323ButNotBothEnabled PresentationSourceSelection SoftwareUpgrade PlatformSanity ContactInfoMismatch MicrophoneReinforcement FirstTimeWizardNotCompleted CaptivePortalDetected MonitorDelay NEW Value space CAPFOperationState CTLinstallation CUCMVendorConfigurationFile CallProtocolDualStackConfig CallProtocolIPStackPlatformCompatibility CallPr otocolVcsProvisioningCompatibility CameraId ...

Page 16: ...s feature is enabled Updated In Room Control Editor The In Room Control editor is updated with a new look improved logic and usability for producing a control interface more efficiently In addition a new directional pad widget and an In Room Control simulator is added Added language support We have added support for Potuguese Portugal to the on screen display and Touch controller menus Other chang...

Page 17: ...Audio DefaultVolume Audio Microphones Mute Enabled Audio SoundsAndAlerts Conference DefaultCall Rate Conference DoNotDisturb DefaultTimeout SerialPort Mode Standby SystemUnit Name Time Zone UserInterface OSD Output Video Input Connector n CameraControl CameraId Video Input Connector n CameraControl Mode Video Input Connector n InputSourceType Video Input Connector n Name Video Input Connector n Pr...

Page 18: ...als Connect Peripherals List Standby Activate Standby Deactivate SystemUnit Boot UserInterface Extensions Clear UserInterface Extensions List UserInterface Extensions Widget SetValue UserInterface Extensions Widget UnsetValue UserInterface Message Alert Clear UserInterface Message Alert Display UserInterface Message Prompt Clear UserInterface Message Prompt Display UserInterface Message Prompt Res...

Page 19: ...allProtocolIPStackPlatformCompatibility CallP rotocolVcsProvisioningCompatibility CameraId CameraPairing CameraSerial CameraSoftwareVersion CameraStatus CamerasDetected ConfigurationFile DefaultCallProtocolRegistered EthernetDuplexMatches FanStatus PresenterTrack H320GatewayStatus H323GatekeeperStatus HasValidReleaseKey IpCameraStatus IPv4Assignment IPv6Assignment IPv6Mtu ISDNLinkCompatibility ISD...

Page 20: ... Extensions Widget n WidgetId Video ActiveSpeaker PIPPosition Video Input Connector n Connected Video Input Connector n SignalState Video Input Connector n SourceId Video Input Connector n Type Video Input Source n ConnectorId Video Input Source n FormatStatus Video Input Source n FormatType Video Input Source n Resolution Height Video Input Source n Resolution RefreshRate Video Input Source n Res...

Page 21: ...ference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 21 Cisco TelePresence DX70 and DX80 API Reference Guide Chapter 2 About the API Introduction About the API xConfiguration Appendices xCommand xStatus About the API ...

Page 22: ...admin user in order to restrict access to system configuration You should in addition set a password for any other user with similar credentials You can set the password on the codec s web interface Open a web browser and enter the IP address of the video system in the address bar and log in Click your user name in the upper right corner and choose Change password in the drop down menu SSH SSH is ...

Page 23: ...ser should possess the ADMIN USER and AUDIT roles These are the user roles ADMIN A user with this role can create new users change most settings make calls and search the contact lists The user cannot upload audit certificates and change the security audit settings USER A user with this role can make calls and search the contact lists The user can modify a few settings for example adjust the ringt...

Page 24: ...s XML XML output for use with control systems that understand XML JSON JSON format is convenient when integrating with web based systems The default output mode is terminal To change this you have to define your preferences for each session individually Examples in this guide are in terminal mode To set output mode to XML issue the command xPreferences outputmode xml To revert to terminal mode iss...

Page 25: ...k is only issued on the RS 232 Telnet or SSH session for which it is specified If you are connecting to the codec with multiple sessions you have to define feedback individually for each session Refer to Feedback mechanism on page 31 xPreferences The xPreferences command is used to set preferences for the RS 232 Telnet and SSH sessions Refer to API output on page 24 Echo on off If echo is set to O...

Page 26: ...l connected sources for both inputs and outputs xStatus vid res wid s Video Input Source 1 Resolution Width 1920 s Video Input Source 2 Resolution Width 0 s Video Input Source 3 Resolution Width 0 s Video Input Source 4 Resolution Width 0 s Video Output Connector 1 Resolution Width 1920 s Video Output Connector 2 Resolution Width 1280 s Video Output Connector 3 Resolution Width 1280 end Value type...

Page 27: ...onfigurations are system settings that are persistent across boots Like commands also configurations are structured in a hierarchy Writing xConfiguration on the command line lists all the top level configurations Writing xConfiguration lists all configurations and their value spaces Writing xConfiguration lists all configurations and their current values To list out only some of the configurations...

Page 28: ...r this is treated as input to that command including line breaks You now enter the payload for this command in accordance to the input format expected by this command When done finish with a line break n and a separate line containing just a period ending with a line break n The command will now be executed and you will get a command result with an OK or ERROR depending on the command being execut...

Page 29: ...es xcommand xconfiguration and xstatus A typical use of this would be to create a command queue in your application and assign unique IDs to every command sent to the codec A listener then listens to all feedback from the codec and matches the ID on the response with the corresponding ID in the command queue This enables matching the original request with the specific response Example xcommand Vid...

Page 30: ... RemoteURI h223 integratorHQ company com EncryptionIn Off EncryptionOut Off end Example 4 FECC Action request FECC Action request is an event reported when far end is sending FECC commands e FeccActionInd Id 132 Req 1 Pan 1 PanRight 1 Tilt 0 TiltUp 0 Zoom 0 ZoomIn 0 Focus 0 FocusIn 0 Timeout 300 VideoSrc 0 m 0 end Example 5 TString message received TString message received is an event reported whe...

Page 31: ...ou can subscribe to the feedback by registering feedback expressions How you register feedback expressions varies according to the connection method used When using HTTP the method of handling feedback differs slightly from what is presented in this section See the Feedback from codec over HTTP on page 35 for more information Feedback expressions The expression used when registering for feedback i...

Page 32: ...andby Active on the command line the result is s Standby Active On end If you have registered for feedback on status changes the feedback you get when the system goes to standby mode will be exactly the same s Standby Active On end This means that when you are programming against the device you only need to handle one format Example Managing feedback subscriptions A Register feedback expressions W...

Page 33: ...available and they do not time out automatically Example Starting a HTTP XMLAPI session Request POST xmlapi session begin HTTP 1 1 Authorization Basic Base64 encoded authentication string Response HTTP 1 1 204 No Content Server nginx 1 8 0 Connection keep alive Set Cookie SessionId f08102c8ce5aaf8fba23a7238 cc2ef464b990e18bfbb7fb048820c0e28955c54 Path HttpOnly This session counts toward the system...

Page 34: ...nds and configurations Using HTTP POST When sending configurations and commands to the codec it is important that the HTTP header Content Type is set to text xml i e Content Type text xml The body of the POST should contain the XML content Example 1 Changing the system name Request POST putxml HTTP 1 1 Content Type text xml Configuration SystemUnit Name newName Name SystemUnit Configuration Exampl...

Page 35: ...st the HTTP feedback messages to Format Set the format for the feedback from the HTTP server to XML or JSON Expression 1 15 The XPath expression specifies which parts of the Status Configuration or Event documents are monitored You can have from 1 to 15 XPath expressions Register the expressions you want to receive feedback on See the Feedback mechanism on page 31 section for more information abou...

Page 36: ...rue Number 12345 Number Protocol H323 Protocol Dial Command Example 2 Assigning volume level Terminal xCommand Audio Volume Set Level 50 XML Command Audio Volume Set command True Level 50 Level Set Volume Audio Command Translating configurations Translating from xConfiguration to XML is similar to commands but with the addition of a special attribute item NN for specifying the index in arrays Exam...

Page 37: ...s use xConfiguration Video instead of xconf vid The shortcuts can be used for searches in the API on the command line but not for programming The reason for this is that you might end up with ambiguous code when additional commands are added to the API DO NOT subscribe to unnecessary feedback Subscribing to too much feedback may congest the control application Although the amount of feedback may s...

Page 38: ...ce Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 38 Cisco TelePresence DX70 and DX80 API Reference Guide Chapter 3 xConfiguration commands Introduction About the API xConfiguration Appendices xCommand xStatus xConfiguration ...

Page 39: ...xConfiguration H323 CallSetup Mode 48 xConfiguration H323 Encryption KeySize 48 xConfiguration H323 Gatekeeper Address 48 xConfiguration H323 H323Alias E164 49 xConfiguration H323 H323Alias ID 49 xConfiguration H323 NAT Mode 49 xConfiguration H323 NAT Address 50 Macros configuration 50 xConfiguration Macros Mode 50 xConfiguration Macros AutoStart 50 Network configuration 51 xConfiguration Network ...

Page 40: ...PS Server MinimumTLSVersion 63 xConfiguration NetworkServices HTTPS StrictTransportSecurity 63 xConfiguration NetworkServices HTTPS VerifyServerCertificate 64 xConfiguration NetworkServices HTTPS VerifyClientCertificate 64 xConfiguration NetworkServices NTP Mode 64 xConfiguration NetworkServices NTP Server 1 3 Address 64 xConfiguration NetworkServices SIP Mode 65 xConfiguration NetworkServices SNM...

Page 41: ...uration UserInterface Language 80 xConfiguration UserInterface OSD HalfwakeMessage 80 xConfiguration UserInterface OSD Output 80 xConfiguration UserInterface OSD SettingsMenu Mode 81 UserManagement configuration 81 xConfiguration UserManagement LDAP Mode 81 xConfiguration UserManagement LDAP Server Address 81 xConfiguration UserManagement LDAP Server Port 82 xConfiguration UserManagement LDAP Encr...

Page 42: ...lePresence DX70 and DX80 API Reference Guide xConfiguration Video Selfview Default OnMonitorRole 88 xConfiguration Video Selfview Default PIPPosition 88 xConfiguration Video Selfview OnCall Mode 89 xConfiguration Video Selfview OnCall Duration 89 Audio commands 95 Introduction About the API xConfiguration Appendices xCommand xStatus xConfiguration ...

Page 43: ...iguration Audio Microphones Mute Enabled Enabled where Enabled True InCallOnly True Muting of audio is always available InCallOnly Muting of audio is only available when the device is in a call When Idle it is not possible to mute the microphone This is useful when an external telephone service audio system is connected via the codec and is to be available when the codec is not in a call When set ...

Page 44: ...Intelligent Proximity feature Set the maximum volume of the ultra sound pairing message Requires user role ADMIN INTEGRATOR Default value DX80 70 DX70 60 USAGE xConfiguration Audio Ultrasound MaxVolume MaxVolume where MaxVolume DX80 Integer 0 90 DX70 Integer 0 60 Select a value in the specified range If set to 0 the ultrasound is switched off Conference configuration xConfiguration Conference Auto...

Page 45: ...2 H323 If the system cannot register the auto selection chooses H323 H320 Not supported H323 All calls are set up as H 323 calls Sip All calls are set up as SIP calls Spark Reserved for Spark registered systems Do not use xConfiguration Conference DefaultCall Rate Define the Default Call Rate to be used when placing calls from the system Requires user role ADMIN INTEGRATOR Default value 3072 USAGE...

Page 46: ... ADMIN Default value On USAGE xConfiguration Conference FarEndControl Mode Mode where Mode Off On Off The far end is not allowed to select your video sources or to control your local camera pan tilt zoom On Allows the far end to be able to select your video sources and control your local camera pan tilt zoom You will still be able to control your camera and select your video sources as normal xCon...

Page 47: ...he maximum transmit call rate kbps H323 configuration xConfiguration H323 Authentication Mode Define the authenticatin mode for the H 323 profile Requires user role ADMIN Default value Off USAGE xConfiguration H323 Authentication Mode Mode where Mode Off On Off The system will not try to authenticate itself to a H 323 Gatekeeper but will still try a normal registration On If an H 323 Gatekeeper in...

Page 48: ... Gatekeeper Requires user role ADMIN Default value Gatekeeper USAGE xConfiguration H323 CallSetup Mode Mode where Mode Direct Gatekeeper Direct You can only make an H 323 call by dialing an IP address directly Gatekeeper The system uses a Gatekeeper to make an H 323 call When choosing this option the H323 Gatekeeper Address must also be configured xConfiguration H323 Encryption KeySize Define the ...

Page 49: ... com My H 323 Alias ID xConfiguration H323 NAT Mode The firewall traversal technology creates a secure path through the firewall barrier and enables proper exchange of audio video data when connected to an external video conferencing system when the IP traffic goes through a NAT router NOTE NAT does not work in conjunc tion with gatekeepers Requires user role ADMIN Default value Off USAGE xConfigu...

Page 50: ... the codec Use this setting when you want to manually enable or to permanently disable the use of macros on the codec You can disable the use of macros within the Macro Editor But this will not permanently disable macros from running because every time the codec is reset the macros will be re enabled automatically Requires user role ADMIN Default value Off USAGE xConfiguration Macros Mode Mode whe...

Page 51: ...EEE8021X Mode The system can be connected to an IEEE 802 1X LAN network with a port based network access control that is used to provide authenticated network access for Ethernet networks Requires user role ADMIN USER Default value Off USAGE xConfiguration Network n IEEE8021X Mode Mode where n Index that identifies the network Range 1 1 Mode Off On Off The 802 1X authentication is disabled default...

Page 52: ...ole ADMIN USER Default value USAGE xConfiguration Network n IEEE8021X Identity Identity where n Index that identifies the network Range 1 1 Identity String 0 64 The user name for 802 1X authentication xConfiguration Network 1 IEEE8021X Password Define the password for 802 1X authentication Requires user role ADMIN USER Default value USAGE xConfiguration Network n IEEE8021X Password Password where ...

Page 53: ...hat identifies the network Range 1 1 Ttls Off On Off The EAP TTLS protocol is disabled On The EAP TTLS protocol is enabled default xConfiguration Network 1 IEEE8021X Eap Tls Enable or disable the use of EAP TLS Transport Layer Security for IEEE802 1x connec tions The EAP TLS protocol defined in RFC 5216 is considered one of the most secure EAP standards LAN clients are authenticated using client c...

Page 54: ... applies only to systems on IPv4 networks Requires user role ADMIN USER Default value DHCP USAGE xConfiguration Network n IPv4 Assignment Assignment where n Index that identifies the network Range 1 1 Assignment Static DHCP Static The addresses must be configured manually using the Network IPv4 Address Network IPv4 Gateway and Network IPv4 SubnetMask settings static addresses DHCP The system addre...

Page 55: ...etwork IPv6 DHCPOptions setting determines which method to use DHCPv6 All IPv6 addresses including options will be obtained from a DHCPv6 server See RFC 3315 for a detailed description The Network IPv6 DHCPOptions setting will be ignored Autoconf Enable IPv6 stateless autoconfiguration of the IPv6 network interface See RFC 4862 for a detailed description The options for example NTP and DNS server ...

Page 56: ...GE xConfiguration Network n MTU MTU where n Index that identifies the network Range 1 1 MTU Integer 576 1500 Set a value for the MTU bytes xConfiguration Network 1 QoS Mode The QoS Quality of Service is a method which handles the priority of audio video and data in the network The QoS settings must be supported by the infrastructure Diffserv Differentiated Services is a computer networking archite...

Page 57: ... packets in the IP network the higher the number the higher the priority The default value is 0 best effort xConfiguration Network 1 QoS Diffserv Video This setting will only take effect if Network QoS Mode is set to Diffserv Define which priority Video packets should have in the IP network The packets on the presentation channel shared content are also in the Video packet category The priority fo...

Page 58: ...e IP network the higher the number the higher the priority The default value is 0 best effort xConfiguration Network 1 QoS Diffserv Signalling This setting will only take effect if Network QoS Mode is set to Diffserv Define which priority Signalling packets that are deemed critical time sensitive for the real time operation should have in the IP network The priority for the packets ranges from 0 t...

Page 59: ...ity for the packets ranges from 0 to 63 the higher the number the higher the prior ity The recommended value for NTP is 0 which means best effort If in doubt contact your network administrator The priority set here might be overridden when packets are leaving the network controlled by the local network administrator Requires user role ADMIN USER Default value 0 USAGE xConfiguration Network n QoS D...

Page 60: ...ode Define the VLAN voice mode The VLAN Voice Mode will be set to Auto automatically if you have Cisco UCM Cisco Unified Communications Manager as provisioning infrastructure Note that Auto mode will NOT work if the NetworkServices CDP Mode setting is Off Requires user role ADMIN USER Default value Auto USAGE xConfiguration Network n VLAN Voice Mode Mode where n Index that identifies the network R...

Page 61: ...uration NetworkPort n Mode Mode where n Unique ID that identifies the network port Range 2 2 Mode Off On Off The computer network port is disabled On The computer network port is available for use NetworkServices configuration xConfiguration NetworkServices CDP Mode Enable or disable the CDP Cisco Discovery Protocol daemon Enabling CDP will make the endpoint report certain statistics and device id...

Page 62: ...s provisioned to Cisco Spark The HTTP proxy settings makes it possible to onboard a video system behind a HTTP proxy to Spark Requires user role ADMIN USER Default value True USAGE xConfiguration NetworkServices HTTP Proxy Allowed Allowed where Allowed False True False The HTTP proxy settings are not available from the Cisco Spark setup wizard True The HTTP proxy settings are available from the Ci...

Page 63: ...roxy Url Url where Url String 0 255 The URL for the HTTP proxy server xConfiguration NetworkServices HTTPS Server MinimumTLSVersion Set the lowest version of the TLS Transport Layer Security protocol that is allowed Requires user role ADMIN Default value TLSv1 1 USAGE xConfiguration NetworkServices HTTPS Server MinimumTLSVersion MinimumTLSVersion where MinimumTLSVersion TLSv1 1 TLSv1 2 TLSv1 1 Sup...

Page 64: ...A This requires that a list of trusted CAs are uploaded to the system in advance xConfiguration NetworkServices NTP Mode The Network Time Protocol NTP is used to synchronize the system s time and date to a refer ence time server The time server will be queried regularly for time updates Requires user role ADMIN Default value Auto USAGE xConfiguration NetworkServices NTP Mode Mode where Mode Auto M...

Page 65: ...e ReadOnly Enable the SNMP network service for queries only ReadWrite Enable the SNMP network service for both queries and commands xConfiguration NetworkServices SNMP Host 1 3 Address Define the address of up to three SNMP Managers The system s SNMP Agent in the codec responds to requests from SNMP Managers a PC program etc for example about system location and system contact SNMP traps are not s...

Page 66: ...ed communication between the codec and your local computer Requires user role ADMIN Default value On USAGE xConfiguration NetworkServices SSH Mode Mode where Mode Off On Off The SSH protocol is disabled On The SSH protocol is enabled xConfiguration NetworkServices Telnet Mode Telnet is a network protocol used on the Internet or Local Area Network LAN connections Requires user role ADMIN Default va...

Page 67: ...onfiguration Peripherals Profile ControlSystems ControlSystems where ControlSystems 1 NotSet 1 One third party control system should be connected to the video system NotSet No check for a third party control system is performed Phonebook configuration xConfiguration Phonebook Server 1 ID Define a name for the external phone book Requires user role ADMIN Default value USAGE xConfiguration Phonebook...

Page 68: ...guration Provisioning Connectivity This setting controls how the device discovers whether it should request an internal or external configuration from the provisioning server Requires user role ADMIN USER Default value Auto USAGE xConfiguration Provisioning Connectivity Connectivity where Connectivity Internal External Auto Internal Request internal configuration External Request external configur...

Page 69: ...ified Communications Manager The system connects to CUCM via the Collaboration Edge infrastructure In order to register over Edge the encryption option key must be installed on the video system Spark Push configurations to the video system from Spark TMS Push configurations to the video system from TMS Cisco TelePresence Management System VCS Push configurations to the video system from VCS Cisco ...

Page 70: ...DHCP Requires user role ADMIN USER Default value USAGE xConfiguration Provisioning ExternalManager Address Address where Address String 0 64 A valid IPv4 address IPv6 address or DNS name xConfiguration Provisioning ExternalManager AlternateAddress Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager CUCM and an alternate CUCM is available for redundancy Define th...

Page 71: ...at they are close to the video system In order to use a client at least one of the Proximity services must be enabled refer to the Proximity Services settings In general Cisco recommends enabling all the Proximity services Requires user role ADMIN USER Default value Off USAGE xConfiguration Proximity Mode Mode where Mode Off On Off The video system does not emit ultrasound and Proximity services c...

Page 72: ...s view previous content and take snapshots This service is supported by mobile devices iOS and Android Proximity Mode must be On for this setting to take any effect Requires user role ADMIN USER Default value Disabled USAGE xConfiguration Proximity Services ContentShare ToClients ToClients where ToClients Enabled Disabled Enabled Content sharing to a Proximity client is enabled Disabled Content sh...

Page 73: ...nsport protocol to be used over the LAN Requires user role ADMIN Default value Auto USAGE xConfiguration SIP DefaultTransport DefaultTransport where DefaultTransport TCP UDP Tls Auto TCP The system will always use TCP as the default transport method UDP The system will always use UDP as the default transport method Tls The system will always use TLS as the default transport method For TLS connec t...

Page 74: ...date Host Rflx Relay Host Send media to the video system s private IP address Rflx Send media to the video system s public IP address as seen by the TURN server Relay Send media to the IP address and port allocated on the TURN server xConfiguration SIP ListenPort Turn on or off the listening for incoming connections on the SIP TCP UDP ports If turned off the endpoint will only be reachable through...

Page 75: ...r accessing the TURN server Requires user role ADMIN Default value USAGE xConfiguration SIP Turn UserName UserName where UserName String 0 128 A valid user name xConfiguration SIP Turn Password Define the password needed for accessing the TURN server Requires user role ADMIN Default value USAGE xConfiguration SIP Turn Password Password where Password String 0 128 A valid password xConfiguration SI...

Page 76: ...before it goes into standby mode Requires the Standby Control to be enabled Requires user role ADMIN INTEGRATOR Default value 10 USAGE xConfiguration Standby Delay Delay where Delay Integer 1 480 Set the standby delay minutes xConfiguration Standby WakeupOnMotionDetection Automatic wake up on motion detection is a feature that will sense when a person walks into the room The feature is based on ul...

Page 77: ... xConfiguration Time TimeFormat Define the time format Requires user role ADMIN USER Default value 24H USAGE xConfiguration Time TimeFormat TimeFormat where TimeFormat 24H 12H 24H Set the time format to 24 hours 12H Set the time format to 12 hours AM PM xConfiguration Time DateFormat Define the date format Requires user role ADMIN USER Default value DD_MM_YY USAGE xConfiguration Time DateFormat Da...

Page 78: ...os America Mazatlan America Mendoza America Menominee America Merida America Metlakatla America Mexico_City America Miquelon America Moncton America Monterrey America Montevideo America Montreal America Montserrat America Nassau America New_York America Nipigon America Nome America Noronha America North_ Dakota Beulah America North_Dakota Center America North_Dakota New_Salem America Ojinaga Ameri...

Page 79: ...te Mexico BajaSur Mexico General NZ NZ CHAT Navajo PRC PST8PDT Pacific Apia Pacific Auckland Pacific Bougainville Pacific Chatham Pacific Chuuk Pacific Easter Pacific Efate Pacific Enderbury Pacific Fakaofo Pacific Fiji Pacific Funafuti Pacific Galapagos Pacific Gambier Pacific Guadalcanal Pacific Guam Pacific Honolulu Pacific Johnston Pacific Kiritimati Pacific Kosrae Pacific Kwajalein Pacific Ma...

Page 80: ...sh Portuguese PortugueseBrazilian Russian Spanish SpanishLatin Swedish Turkish Select a language from the list xConfiguration UserInterface OSD HalfwakeMessage A custom message can be displayed in the middle of the main screen when the system is in the half wake state This will replace the default message Tap the touch panel to get started together with an illustration of a Touch panel You can als...

Page 81: ... No authentication is required UserManagement configuration xConfiguration UserManagement LDAP Mode The video system supports the use of an LDAP Lightweight Directory Access Protocol server as a central place to store and validate user names and passwords Use this setting to config ure whether or not to use LDAP authentication Our implementation is tested for the Microsoft Active Directory AD serv...

Page 82: ... UserManagement LDAP MinimumTLSVersion Set the lowest version of the TLS Transport Layer Security protocol that is allowed Requires user role ADMIN Default value TLSv1 2 USAGE xConfiguration UserManagement LDAP MinimumTLSVersion MinimumTLSVersion where MinimumTLSVersion TLSv1 0 TLSv1 1 TLSv1 2 TLSv1 0 Support TLS version 1 0 or higher TLSv1 1 Support TLS version 1 1 or higher TLSv1 2 Support TLS v...

Page 83: ... UserManagement LDAP Admin Group Members of this AD Active Directory group will be given administrator access This setting is a shorthand for saying memberOf 1 2 840 113556 1 4 1941 group name If UserManagement LDAP Admin Filter is set this setting is ignored Requires user role ADMIN Default value USAGE xConfiguration UserManagement LDAP Admin Group Group where Group String 0 255 The distinguishin...

Page 84: ...ras that are connected to the video input Requires user role ADMIN INTEGRATOR Default value 1 USAGE xConfiguration Video Input Connector n CameraControl CameraId CameraId where n Unique ID that identifies the video input connector Range 1 2 CameraId 1 The camera ID is fixed and cannot be changed xConfiguration Video Input Connector 1 2 InputSourceType Select which type of input source is connected...

Page 85: ...ection AutoShare Desktop Manual OnConnect AutoShare While in a call the content on the video input will automatically be presented to the far end as well as on the local screen when you connect the cable or when the source is activated otherwise for example when a connected computer wakes up from sleep mode You do not have to select Share on the user interface If a presentation source is already c...

Page 86: ...t Connector 1 2 Visibility Define the visibility of the video input connector in the menus on the user interface Note that Connector 1 is the system s integrated camera which is not available as a presenta tion source Requires user role ADMIN INTEGRATOR Default value Connector 1 Never Connector 2 Always Connector 3 OnConnect USAGE xConfiguration Video Input Connector n Visibility Visibility where ...

Page 87: ... 1920_1080_60 1920_1080_60 The resolution is 1920 x 1080 and the refresh rate is 60 Hz xConfiguration Video Presentation DefaultSource Define which video input source to use as a default presentation source This setting may be used by the API and 3rd party user interfaces It is not relevant when using the user interfaces provided by Cisco Requires user role ADMIN USER Default value 2 USAGE xConfig...

Page 88: ...First USAGE xConfiguration Video Selfview Default OnMonitorRole OnMonitorRole where OnMonitorRole First First The self view picture will be shown on the integrated screen xConfiguration Video Selfview Default PIPPosition Define the position on screen of the small self view picture in picture PiP after a call The setting only takes effect when self view is switched on see the Video Selfview Default...

Page 89: ...elfview OnCall Mode Mode where Mode Off On Off Self view is not shown automatically during call setup On Self view is shown automatically during call setup xConfiguration Video Selfview OnCall Duration This setting only has an effect when the Video Selfview OnCall Mode setting is switched On In this case the number of seconds set here determines for how long self view is shown before it is automat...

Page 90: ...eference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 90 Cisco TelePresence DX70 and DX80 API Reference Guide Chapter 4 xCommand commands Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

Page 91: ...commands 100 xCommand Call Accept 100 xCommand Call Disconnect 100 xCommand Call DTMFSend 100 xCommand Call FarEndControl Camera Move 100 xCommand Call FarEndControl Camera Stop 101 xCommand Call FarEndControl RoomPreset Activate 101 xCommand Call FarEndControl Source Select 101 xCommand Call Forward 101 xCommand Call Hold 102 xCommand Call Ignore 102 xCommand Call Join 102 xCommand Call Reject 10...

Page 92: ...HeartBeat 111 xCommand Peripherals List 111 xCommand Peripherals Pairing DeviceDiscovery Start 112 xCommand Peripherals Pairing Pair 112 xCommand Peripherals Pairing Unpair 112 xCommand Peripherals Purge 112 Phonebook commands 113 xCommand Phonebook Contact Add 113 xCommand Phonebook Contact Delete 113 xCommand Phonebook Contact Modify 114 xCommand Phonebook ContactMethod Add 114 xCommand Phoneboo...

Page 93: ...ng Get 127 xCommand UserInterface Branding Updated 127 xCommand UserInterface Branding Upload 128 xCommand UserInterface Extensions Clear 128 xCommand UserInterface Extensions List 128 xCommand UserInterface Extensions Set 128 xCommand UserInterface Extensions Widget Action 128 xCommand UserInterface Extensions Widget SetValue 129 xCommand UserInterface Extensions Widget UnsetValue 129 xCommand Us...

Page 94: ...ommand UserManagement User List 136 xCommand UserManagement User Modify 137 xCommand UserManagement User Passphrase Change 137 xCommand UserManagement User Passphrase Set 137 Video commands 138 xCommand Video ActiveSpeakerPIP Set 138 xCommand Video Input SetMainVideoSource 138 xCommand Video Layout LayoutFamily Set 138 xCommand Video PresentationPIP Set 138 xCommand Video PresentationView Set 139 ...

Page 95: ...ine Internal All HDMI Measure the delay of the device connected to the HDMI output Line Measure the delay of the device connected to the Line output only available on video systems that have a Line output Internal Measure the delay of the internal loudspeaker only available on video systems that have an internal loudspeaker All Will measure the maximum delay of all outputs The default is set to HD...

Page 96: ...RATOR USER USAGE xCommand Audio SoundsAndAlerts Ringtone List xCommand Audio SoundsAndAlerts Ringtone Play Play one of the available ringtones Use the xCommand Audio SoundsAndAlerts Ringtone List command to get a list of the available ringtones Requires user role ADMIN INTEGRATOR USER USAGE xCommand Audio SoundsAndAlerts Ringtone Play RingTone RingTone where RingTone String 1 100 The name of the r...

Page 97: ... Audio Volume Mute xCommand Audio Volume Set Set the volume on one of the endpoint s audio devices built in loudspeakers headsets or handset to a specified level You can use the optional Device parameter to specify which device to address The most recently selected device is chosen if you don t specify a device see xStatus Audio SelectedDevice Also refer to xCommand Audio Select Requires user role...

Page 98: ...s the connector Microphone 1 refers to the selected audio device built in loudspeak ers headsets or handset Refer to the xStatus Audio SelectedDevice and xCommand Audio Select commends for more information about the selected device ConnectorType HDMI Microphone Select the connector type IncludePairingQuality Literal Off On The default is set to Off xCommand Audio VuMeter Stop Stop the VU meter on ...

Page 99: ...ystem The list of booking details is received from the management system All parameters are optional and can be used to limit the search result If no parameters are set past present and future bookings are all listed To avoid listing bookings from yesterday and before use DayOffset 0 Requires user role ADMIN USER USAGE xCommand Bookings List Days Days DayOffset DayOffset Limit Limit Offset Offset ...

Page 100: ... default is set to 0 xCommand Call DTMFSend Send DTMF tones to the far end Requires user role ADMIN USER USAGE xCommand Call DTMFSend CallId CallId DTMFString DTMFString where CallId Integer 0 65534 The CallID is returned when the xCommand Dial command is run During the call you can run the xStatus Call command to see the CallId The default is set to 1 DTMFString String 0 32 Enter the DTMF string ...

Page 101: ...PresetId where CallId Integer 0 65534 The CallId is required to identify the far end codec only when in a Multipoint call The CallId is returned when issuing the xCommand Dial command During a call you can run the xStatus Call command to see the CallId The default is set to 1 PresetId Integer 1 15 The ID of the preset that is stored on the far end codec xCommand Call FarEndControl Source Select Se...

Page 102: ...You can have from 1 to 10 CallId parameters in the same command xCommand Call Reject Reject incoming call If no call id is specified all incoming calls are rejected Requires user role ADMIN USER USAGE xCommand Call Reject CallId CallId where CallId Integer 0 65534 The CallID is returned when the xCommand Dial command is run During a call you can run the xStatus Call command to see the CallId The d...

Page 103: ...ude or exclude all surrounding calls with duplicate information The default is set to False xCommand CallHistory DeleteAll Deletes all information on previous calls Requires user role ADMIN USER USAGE xCommand CallHistory DeleteAll Filter Filter where Filter All Missed Placed Received You can filter which calls to delete The default is set to All xCommand CallHistory DeleteEntry Deletes all inform...

Page 104: ... number CallHistoryId Integer 0 65534 CallHistoryId for the call in question xCommand CallHistory Recents Retrieve aggregated information on previous calls made on the video system Requires user role ADMIN USER USAGE xCommand CallHistory Recents Filter Filter Offset Offset Limit Limit DetailLevel DetailLevel SearchString SearchString CallHistoryId CallHistoryId Order Order where Filter All Missed ...

Page 105: ... Conference DoNotDisturb Deactivate Switch off the Do Not Disturb mode When Do Not Disturb is switched off incoming calls come through as normal Requires user role ADMIN USER USAGE xCommand Conference DoNotDisturb Deactivate xCommand Conference SpeakerLock Release Releases locked speaker set by xCommand Conference SpeakerLock Set Default voice switching is switched back on Requires user role ADMIN...

Page 106: ...mands Requires user role ADMIN INTEGRATOR USER USAGE xCommand Dial Number Number Protocol Protocol CallRate CallRate CallType CallType BookingId BookingId Appearance Appearance DisplayName DisplayName where Number String 0 255 Enter the number or address Protocol H320 H323 Sip Spark Select the call protocol CallRate Integer 64 3072 Set the call rate CallType Audio Video Select the call type Bookin...

Page 107: ...ister FeedbackSlot FeedbackSlot Format Format ServerUrl ServerUrl Expression Expression where FeedbackSlot Integer 1 4 The codec can register up to 4 slots of servers requesting HTTP feedback Set the registering to one of them Note Avoid using FeedbackSlot 3 in an environment where Cisco TelePresence Management Suite TMS is used as TMS uses this feedbackslot to register its expressions Format XML ...

Page 108: ...cro Activate Name Name where Name String 0 255 Specifies the name of the macro to activate xCommand Macros Macro Deactivate Deactivates a macro currently running on this video system Requires user role ADMIN USAGE xCommand Macros Macro Deactivate Name Name where Name String 0 255 The name of the macro to deactivate xCommand Macros Macro Get Shows the details of a macro created on this video system...

Page 109: ...ng 0 255 The name of the macro that is set Role String 0 255 The name of the role that is set xCommand Macros Macro Save Saves the details of a macro This is a multiline command Requires user role ADMIN USAGE xCommand Macros Macro Save Name Name Overwrite Overwrite where Name String 0 255 The name of the macro that is saved Overwrite Literal False True Overwrites the existing content or not The de...

Page 110: ...ops all of the macros set up on this device Requires user role ADMIN USAGE xCommand Macros Runtime Stop Message commands xCommand Message Send Triggers a Message Send event which sends text to any listening clients Requires user role ADMIN INTEGRATOR USAGE xCommand Message Send Text Text where Text String 0 255 The text that the message contains Introduction About the API xConfiguration Appendices...

Page 111: ...e device you are connecting to SerialNumber String 0 100 The device s serial number SoftwareInfo String 0 100 Software version the device is running Type Byod ControlSystem Other TouchPanel Define the type of device you are connecting to xCommand Peripherals HeartBeat When a peripheral is registered as a connected device you can set it to send a heartbeat to the codec to let the codec know that it...

Page 112: ...ng Pair Pair an ISDN Link to an endpoint Requires user role ADMIN USAGE xCommand Peripherals Pairing Pair MacAddress MacAddress where MacAddress String 1 1450 Enter the MAC address for the ISDN Link you wish to pair to the endpoint xCommand Peripherals Pairing Unpair Unpair endpoint from an ISDN Link when the two have contact Requires user role ADMIN USAGE xCommand Peripherals Pairing Unpair MacAd...

Page 113: ... String 0 255 Currently not in use Title String 0 255 The title of the contact Number String 0 255 The phone number or address of the contact Protocol Auto H320 H323 SIP Spark Select the Auto Spark SIP H323 or H320 protocol CallRate Integer 0 6000 Set a call rate The default is set to 0 CallType Audio Video Select a call type audio or video Device Mobile Other Telephone Video Select the device typ...

Page 114: ...ontact as a Favorite or untag an already tagged contact xCommand Phonebook ContactMethod Add Add contact details for an existing contact in the local phonebook The command returns the ContactMethodId which is a unique string that identifies the contact method typically the format is n You can add several contact methods to a contact Note that only the first contact method will appear in the Favori...

Page 115: ...ils about the contact method for an existing contact in the local phonebook Requires user role ADMIN USER USAGE xCommand Phonebook ContactMethod Modify ContactId ContactId ContactMethodId ContactMethodId Device Device Number Number Protocol Protocol CallRate CallRate CallType CallType where ContactId String 0 255 The unique identifier for the contact The identifier will be returned by an xCommand ...

Page 116: ...ebook Requires user role ADMIN USER USAGE xCommand Phonebook Folder Delete FolderId FolderId where FolderId String 0 255 The unique identifier for the folder The identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder xCommand Phonebook Folder Modify Modify an existing phonebook folder Req...

Page 117: ...the string If no FolderId is specified all folders phonebook directories will be searched SearchField Name Number Currently not in use Offset Integer 0 65534 Get records starting with this offset in a search The default value is 0 Offset is used together with Limit to support paging The default is set to 0 FolderId String 0 255 Search only in the specified folder The FolderId string is listed in t...

Page 118: ...ADMIN USER USAGE xCommand Presentation Stop Instance Instance PresentationSource PresentationSource where Instance 1 2 3 4 5 6 Select which local presentation you wish to stop identified by presentation instance PresentationSource Integer 1 2 Select which local presentation you wish to stop identified by source number Provisioning commands xCommand Provisioning CompleteUpgrade Starts installing th...

Page 119: ...and Provisioning ExtensionMobility Login UserId UserId Pin Pin Profile Profile where UserId String 1 255 A valid user name as set up in CUCM Pin String 1 255 A valid pin code for the user as set up in CUCM Profile String 1 255 A valid profile for the user as set up in CUCM This parameter applies only if the user has multiple profiles xCommand Provisioning ExtensionMobility Logout This command will...

Page 120: ...es user role ADMIN USER USAGE xCommand Security Certificates CA Show Format Format where Format Literal PEM Text Specifies the format of the results The default is set to Text xCommand Security Certificates Services Activate Activates a security certificate on this device Requires user role ADMIN USAGE xCommand Security Certificates Services Activate Fingerprint Fingerprint Purpose Purpose where F...

Page 121: ...ies to this certificate xCommand Security Certificates Services Delete Deletes security certificates from this device Requires user role ADMIN USAGE xCommand Security Certificates Services Delete Fingerprint Fingerprint where Fingerprint String 0 128 The unique Identifier for the certificate that is deleted You can get the fingerprint ID by running xCommand Security Certificates Services Show xCom...

Page 122: ...de all configurations are set back to default when the system reboots CallHistory NonPersistent Persistent In non persistent mode call history is deleted when the system reboots InternalLogging NonPersistent Persistent In non persistent mode eventlog is deleted when the system reboots LocalPhonebook NonPersistent Persistent In non persistent mode local phone book is deleted when the system reboots...

Page 123: ...Halfwake state This state informs the user from the UI to pick up a remote or to tap the touch device to get started Requires user role ADMIN INTEGRATOR USAGE xCommand Standby Halfwake xCommand Standby ResetTimer Set a temporary standby delay If the system is in standby mode when the reset timer is set the system is brought out of standby mode When left idle for the given delay the system goes int...

Page 124: ...iour can be forced by selecting a different TrailingAction Requires user role ADMIN USER USAGE xCommand SystemUnit FactoryReset Confirm Confirm Keep Keep TrailingAction TrailingAction where Confirm Yes Include to confirm your choice Keep Certificates LocalSetup Network Provisioning SerialPort Spark Select which configurations to keep when you factory reset the system You can have up to 6 CallId pa...

Page 125: ...ts factory default settings Requires user role ADMIN INTEGRATOR USER USAGE xCommand SystemUnit FirstTimeWizard Stop xCommand SystemUnit Notifications RemoveAll Clears the list of system notifications that are reported by xStatus SystemUnit Notifications Text Type Requires user role ADMIN USAGE xCommand SystemUnit Notifications RemoveAll xCommand SystemUnit OptionKey Add Add an option key to suppor...

Page 126: ...res user role ADMIN USAGE xCommand SystemUnit SignInBanner Set xCommand SystemUnit SoftReset Reset most parameters to their default values This does not include parameters associated with room setup such as camera position language and volume Requires user role ADMIN USER USAGE xCommand SystemUnit SoftReset Confirm Confirm where Confirm Yes xCommand SystemUnit SoftwareUpgrade Initiate a software u...

Page 127: ...Requires user role ADMIN INTEGRATOR USER USAGE xCommand UserInterface Branding Delete Type Type where Type Literal Background Branding HalfwakeBackground HalfwakeBranding Specifies which image to delete from this device xCommand UserInterface Branding Get Shows the chosen image in base64 encoded format in the requested size if available Requires user role ADMIN INTEGRATOR USER USAGE xCommand UserI...

Page 128: ... Requires user role INTEGRATOR ROOMCONTROL USER USAGE xCommand UserInterface Extensions List xCommand UserInterface Extensions Set Set the configuration scheme you have chosen in the user interface extensions widgets for your room system Updates the UserInterface Extensions status tree This is a multiline command Requires user role ADMIN INTEGRATOR ROOMCONTROL USAGE xCommand UserInterface Extensio...

Page 129: ...lert Clear xCommand UserInterface Message Alert Display Display a message on screen for a specified duration of time in seconds NOTE If Duration is not set the command must be followed by xCommand Message Alert Clear Use the xFeedback commands to monitor the feedback from the user Read more about the xFeedback commands in the API introduction section in this guide Requires user role ADMIN INTEGRAT...

Page 130: ...indow is to be displayed on the screen If set to 0 zero the message window is displayed until a xCommand UserInterface Message Prompt Clear command has been sent The default is set to 0 Option 1 String 0 255 Enter the text to appear on the feedback options Option 2 String 0 255 Enter the text to appear on the feedback options Option 3 String 0 255 Enter the text to appear on the feedback options O...

Page 131: ... is focused SubmitText String 0 32 The text that is shown on the green Submit button on the keyboard The default is set to OK Text String 0 128 The message that is to be displayed to the user Title String 0 40 The title of the input dialog box xCommand UserInterface Message TextLine Clear Clears the text line which was defined by the xCommand Message TextLine Display command Requires user role ADM...

Page 132: ...mulates a remote control key release The Key Release command is issued after a Key Press command Requires user role ADMIN USAGE xCommand UserInterface OSD Key Release Key Key where Key 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...

Page 133: ...as created with the UserInterface Presentation ExternalSource Add command xCommand UserInterface Presentation ExternalSource RemoveAll Remove all input sources from the list of external input sources Requires user role ADMIN INTEGRATOR ROOMCONTROL USAGE xCommand UserInterface Presentation ExternalSource RemoveAll xCommand UserInterface Presentation ExternalSource Select Starts to present the input...

Page 134: ...inform the user about the reason for failure Hidden The input source will not be displayed in the user interface sharetray ErrorReason String 0 80 This string is displayed in the user interface sharetray given that the State parameter is set to Error UserManagement commands xCommand UserManagement RemoteSupportUser Create Create a remote support user passphrase that Technical Assistance Center TAC...

Page 135: ...ole Role ShellLogin ShellLogin Username Username YourPassphrase YourPassphrase where Active Literal False True Specifies whether this is an active user or not ClientCertificateDN String 0 255 Identifies a user who logs in with a client certificate instead of a username and password Passphrase String 0 255 Specifies a Passphrase for the user PassphraseChangeRequired Literal False True Specifies whe...

Page 136: ...s device Requires user role ADMIN USAGE xCommand UserManagement User Get ClientCertificateDN ClientCertificateDN Username Username where ClientCertificateDN String 0 255 Identifies a user who logs in with a client certificate instead of a username and password Username String 0 127 Specify a username to show the details of a particular user xCommand UserManagement User List Shows the list of users...

Page 137: ...e Specifies whether a user s PIN requires changing or not RemoveRole Literal Admin Audit Integrator RoomControl User Removes a role from the specified user ShellLogin Literal False True Specifies whether the user should have a shell login or not Username String 0 127 Specifies the user s username YourPassphrase String 0 255 The user s passphrase xCommand UserManagement User Passphrase Change Chang...

Page 138: ...ID xStatus Video Input Connector Layout Literal Equal PIP Not applicable SourceId Integer 1 4 The identifier ID of the input source Input Source n has ID n Run the following API command to find the ID xStatus Video Input Source xCommand Video Layout LayoutFamily Set Select the screen layout mode Requires user role ADMIN USER USAGE xCommand Video Layout LayoutFamily Set Target Target CallId CallId ...

Page 139: ...sentation to be displayed in a small picture on screen xCommand Video Selfview Set Sets self view on off and specifies its size and position If the parameter is not specified current value is used Requires user role ADMIN USER USAGE xCommand Video Selfview Set Mode Mode FullscreenMode FullscreenMode PIPPosition PIPPosition OnMonitorRole OnMonitorRole where Mode On Off Selfview is set to on or off ...

Page 140: ...eference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 140 Cisco TelePresence DX70 and DX80 API Reference Guide Chapter 5 xStatus commands Introduction About the API xConfiguration Appendices xCommand xStatus xStatus ...

Page 141: ...atus Audio VolumeMute 149 Bookings status 149 xStatus Bookings Current Id 149 Call status 150 xStatus Call n AnswerState 150 xStatus Call n AttendedTransferFrom 150 xStatus Call n CallbackNumber 150 xStatus Call n CallType 150 xStatus Call n DeviceType 150 xStatus Call n Direction 150 xStatus Call n DisplayName 151 xStatus Call n Duration 151 xStatus Call n Encryption Type 151 xStatus Call n Facil...

Page 142: ...ance n SendingMode 159 xStatus Conference Presentation LocalInstance n Source 159 xStatus Conference Presentation Mode 159 xStatus Conference SpeakerLock CallId 159 xStatus Conference SpeakerLock Mode 159 Diagnostics status 160 xStatus Diagnostics Message n Description 160 xStatus Diagnostics Message n Level 160 xStatus Diagnostics Message n References 160 xStatus Diagnostics Message n Type 161 H3...

Page 143: ...P Server n Address 172 xStatus NetworkServices NTP Status 172 Peripherals status 173 xStatus Peripherals ConnectedDevice n HardwareInfo 173 xStatus Peripherals ConnectedDevice n ID 173 xStatus Peripherals ConnectedDevice n Name 173 xStatus Peripherals ConnectedDevice n SoftwareInfo 173 xStatus Peripherals ConnectedDevice n Status 173 xStatus Peripherals ConnectedDevice n Type 173 xStatus Periphera...

Page 144: ...ware OptionKeys Encryption 185 xStatus SystemUnit Software OptionKeys RemoteMonitoring 185 xStatus SystemUnit Software ReleaseDate 186 xStatus SystemUnit Software Version 186 xStatus SystemUnit State NumberOfActiveCalls 186 xStatus SystemUnit State NumberOfInProgressCalls 186 xStatus SystemUnit State NumberOfSuspendedCalls 186 xStatus SystemUnit Uptime 186 Time status 187 xStatus Time SystemTime 1...

Page 145: ... 192 xStatus Video Output Connector n ConnectedDevice Name 192 xStatus Video Output Connector n ConnectedDevice PreferredFormat 193 xStatus Video Output Connector n ConnectedDevice ScreenSize 193 xStatus Video Output Connector n MonitorRole 193 xStatus Video Output Connector n Resolution Height 193 xStatus Video Output Connector n Resolution RefreshRate 194 xStatus Video Output Connector n Resolut...

Page 146: ... USER Value space of the result returned Connected NotConnected Example xStatus Audio Devices HeadsetAnalog Connection Status s Connected end xStatus Audio Devices HeadsetAnalog HasMicrophone Shows if an analog headset has a built in microphone DX70 only Requires user role ADMIN USER Value space of the result returned False True Example xStatus Audio Devices HeadsetAnalog HasMicrophone s True end ...

Page 147: ...rophone path The result is in milliseconds Requires user role ADMIN USER Value space of the result returned Integer Example xStatus Audio Input Connectors Microphone 1 EcReferenceDelay s Audio Connectors Microphone 1 EcReferenceDelay 120 end xStatus Audio Input RemoteInput n CallId Shows the CallId for the remote audio input You can run the command xStatus Audio Input RemoteInput to find the ident...

Page 148: ...dio SelectedDevice Internal end xStatus Audio Volume Shows the volume level dB of the loudspeaker output Requires user role ADMIN INTEGRATOR USER Value space of the result returned 0 100 Example xStatus Audio Volume s Audio Volume 70 end xStatus Audio VolumeHandsetUsb Shows the volume level of the USB handset Requires user role ADMIN USER Value space of the result returned Integer Example xStatus ...

Page 149: ...us Audio VolumeInternal s 6 end xStatus Audio VolumeMute Shows whether the endpoint volume is set to mute Requires user role ADMIN USER Value space of the result returned Off On Example xStatus Audio VolumeMute s Audio VolumeMute Off end Bookings status xStatus Bookings Current Id The ID of the on going booking event if any Requires user role ADMIN USER Value space of the result returned String Ex...

Page 150: ... USER Value space of the result returned String Example xStatus Call 27 CallbackNumber s Call 27 CallbackNumber h323 firstname lastname company com end xStatus Call n CallType Shows the call type of the incoming or outgoing call You can run the command xStatus Call to find the call identity Requires user role ADMIN USER Value space of the result returned Video Audio AudioCanEscalate ForwardAllCall...

Page 151: ...yption Type Shows the encryption type of the call You can run the command xStatus Call to find the call identity Requires user role ADMIN USER Value space of the result returned None Aes 128 Example xStatus Call 27 Encryption Type s Call 27 Encryption Type None end xStatus Call n FacilityServiceId When calling a facility service the facility service id is shown Otherwise the value 0 is returned Re...

Page 152: ... USER Value space of the result returned Integer Example xStatus Call 27 ReceiveCallRate s Call 27 ReceiveCallRate 4000 end xStatus Call n RemoteNumber Shows the remote far end number or URI of an incoming or outgoing call You can run the command xStatus Call to find the call identity Requires user role ADMIN USER Value space of the result returned String Example xStatus Call 27 RemoteNumber s Cal...

Page 153: ...re identity of the camera Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned String Example xStatus Cameras Camera 1 HardwareID s Camera 1 HardwareID 50000000 end xStatus Cameras Camera n Manufacturer Shows the manufacturer of the camera Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned String Example xStatus Cameras Camera...

Page 154: ...are not counted as active Requires user role ADMIN USER Value space of the result returned 0 5 Example xStatus Capabilities Conference MaxNumberOfActiveCalls s Capabilities Conference MaxNumberOfActiveCalls 3 end xStatus Capabilities Conference MaxAudioCalls Shows the the maximum number of simultaneous audio calls that is supported Requires user role ADMIN USER Value space of the result returned I...

Page 155: ...SER Value space of the result returned Integer Example xStatus Conference ActiveSpeaker CallId s Conference ActiveSpeaker CallId 3 end xStatus Conference Call n BookingId Shows the booking ID of a conference if assigned The booking ID can be used for easy identification of a call or conference Requires user role ADMIN USER Value space of the result returned String Example xStatus Conference Call 2...

Page 156: ...ue space of the result returned 1 5 Example xStatus Conference Call 2 Capabilities FECC NumberOfSources s Conference Call 2 Capabilities FECC NumberOfSources 5 end xStatus Conference Call n Capabilities FECC Source n Name Shows the name of an input source that can be connected at a far end site Requires user role ADMIN USER Value space of the result returned String Example xStatus Conference Call ...

Page 157: ...ference Requires user role ADMIN USER Value space of the result returned True False Example xStatus Conference Call 2 Capabilities Presentation s Conference Call 2 Capabilities Presentation True end xStatus Conference Call n Manufacturer Shows the manufacturer of the video system at a far end site Requires user role ADMIN USER Value space of the result returned String Example xStatus Conference Ca...

Page 158: ...t to Off If both MultiWay and MultiSite are available the MultiWay service takes priority over the built in MultiSite Off Multiparty conferences are not allowed MultiSite Multiparty conferences are set up using the built in MultiSite feature If MultiSite is chosen when the MultiSite feature is not available the Multipoint Mode will automatically be set to Off CUCMMediaResourceGroupList Multiparty ...

Page 159: ...e ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned Integer Example xStatus Conference Presentation LocalInstance 1 Source s Conference Presentation LocalInstance 1 Source 1 end xStatus Conference Presentation Mode Shows the status of the secondary video stream Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned On Off Example xStatus Conferen...

Page 160: ...sage Error There is an error in the system The system can still be used but there can be some restrictions Warning A problem is detected and a more specific report follows indicating the exact problem Critical The warning level is critical The system cannot be used Requires user role ADMIN USER Value space of the result returned Error Warning Critical Example xStatus Diagnostics Message 4 Level s ...

Page 161: ...ngeOverlap VideoPortRangeNegative VideoPortRangeTooSmall VideoPortRangeOdd VideoPortRangeValueSpace UltrasoundConfigSettings UltrasoundSpeakerAvailability ValidPasswords VideoFromInternalCamera VideoInputStability VideoInputSignalQuality SparkConnectivity SparkActivationRequired SpeakerTrackFrontPanelMountedCorrectly SpeakerTrackMicrophoneConnection SpeakerTrackVideoInputs SpeakerTrackEthernetConn...

Page 162: ...23 Mode Status When H 323 is set to On and there is no conflict between H 323 Mode configuration and the rest of the system settings SIP is enabled When H 323 Mode is set to On and SIP is enabled on a system that does not support the two simultaneously Not available When a system does not support H 323 Requires user role ADMIN USER Value space of the result returned String Example xStatus H323 Mod...

Page 163: ...m Resource Locator of the HTTP server There can be up to three HTTP servers specified by the URL Requires user role ADMIN USER Value space of the result returned String Example xStatus HttpFeedback 1 URL s HttpFeedback 1 URL http tms company com tms public feedback code aspx end MediaChannels status xStatus MediaChannels Call n Channel n Audio Channels Shows the number of incoming or outgoing audi...

Page 164: ... for audio compression Requires user role ADMIN USER Value space of the result returned AACLD G711A G711Mu G722 G7221 G7221C G723_1 G728 G729 G729A G729AB Off Opus Example xStatus MediaChannels Call 27 Channel 327 Audio Protocol s MediaChannels Call 27 Channel 327 Audio Protocol AACLD end xStatus MediaChannels Call n Channel n Direction Shows the direction of the call Incoming The call is an incom...

Page 165: ...returned Integer Example xStatus MediaChannels Call 27 Channel 327 NetStat LastIntervalLost s MediaChannels Call 27 Channel 327 NetStat LastIntervalLost 0 end xStatus MediaChannels Call n Channel n NetStat LastIntervalReceived Shows the number of packets received for audio video or data during the last interval on the incoming or outgoing channels Requires user role ADMIN USER Value space of the r...

Page 166: ...7 Channel 327 ParticipantId end xStatus MediaChannels Call n Channel n Type Shows the media type on the incoming or outgoing channel Audio The media type on the incoming or outgoing channel is audio Video The media type on the incoming or outgoing channel is video Data The media type on the incoming or outgoing channel is data Requires user role ADMIN USER Value space of the result returned Audio ...

Page 167: ...r video compression HEVC The HEVC H 265 algorithm MPEG H part 2 is an ITU T and ISE IEC standard for video compression JPEG The JPEG algorithm is an ISO IEC standard for video compression MP4V The MP4V format is an ISO IEC file format for video compression Off No video Requires user role ADMIN USER Value space of the result returned H261 H263 H263p H263pp H264 HEVC JPEG MP4V Off Example xStatus Me...

Page 168: ...role ADMIN USER Value space of the result returned String Example xStatus Network CDP DeviceId s Network 1 CDP DeviceId 123456 company com end xStatus Network 1 CDP Duplex Indicates the status duplex configuration of the CDP broadcast interface Used by network operators to diagnose connectivity problems between adjacent network elements Requires user role ADMIN USER Value space of the result retur...

Page 169: ...CDP SysObjectID end xStatus Network 1 CDP Version Returns information about the software release version the switch is running Requires user role ADMIN USER Value space of the result returned String Example xStatus Network 1 CDP Version s Network 1 CDP Version Cisco IOS Software C3560CX Software C3560CX UNIVERSALK9 M Version 15 2 3 E RELEASE SOFTWARE fc4 Technical Support http www cisco com techsu...

Page 170: ... role ADMIN USER Value space of the result returned String Example xStatus Network 1 Ethernet MacAddress s Network 1 Ethernet MacAddress 00 50 60 02 FD C7 end xStatus Network 1 Ethernet Speed Shows the Ethernet speed in Mbps The speed can be in full duplex or half duplex Requires user role ADMIN USER Value space of the result returned 10half 10full 100half 100full 1000full Example xStatus Network ...

Page 171: ...uely identifies this system Requires user role ADMIN USER Value space of the result returned String Example xStatus Network 1 IPv6 Address s Network 1 IPv6 Address end xStatus Network 1 IPv6 Gateway Shows the address of the IPv6 gateway Requires user role ADMIN USER Value space of the result returned String Example xStatus Network 1 IPv6 Gateway s Network 1 IPv6 Gateway end xStatus Network 1 VLAN ...

Page 172: ...Requires user role ADMIN USER Value space of the result returned String Example xStatus NetworkServices NTP Address s NetworkServices NTP Address 12 104 193 12 64 104 222 16 144 254 15 121 end xStatus NetworkServices NTP Status Returns the status of the endpoints synchronizing with the NTP server Discarded The NTP result has been discarded Synced The system is in sync with the NTP server NotSynced...

Page 173: ...me s Peripherals ConnectedDevice 1007 Name Cisco TelePresence Touch end xStatus Peripherals ConnectedDevice n SoftwareInfo Shows information of the software version running on the connected device Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned String Example xStatus Peripherals ConnectedDevice 1007 SoftwareInfo s Peripherals ConnectedDevice 1007 SoftwareInf...

Page 174: ... status xStatus Provisioning CUCM ExtensionMobility Enabled Shows if Extension Mobility is enabled for a CUCM registered device Requires user role ADMIN USER Value space of the result returned True False Example xStatus Provisioning CUCM ExtensionMobility Enabled s Provisioning CUCM ExtensionMobility Enabled False end xStatus Provisioning CUCM ExtensionMobility LastLoggedInUserId Returns the user ...

Page 175: ...ADMIN USER Value space of the result returned String Example xStatus Provisioning Software Current URL s Provisioning Software Current URL http s52020ce8 _ 0 _ 0 pkg end xStatus Provisioning Software Current VersionId Shows the version ID of the current software Requires user role ADMIN USER Value space of the result returned String Example xStatus Provisioning Software Current VersionId s Provisi...

Page 176: ...Software UpgradeStatus SessionId end xStatus Provisioning Software UpgradeStatus Status Shows the status of the software upgrade Requires user role ADMIN USER Value space of the result returned None InProgress Failed InstallationFailed Succeeded Example xStatus Provisioning Software UpgradeStatus Status s Provisioning Software UpgradeStatus Status None end xStatus Provisioning Software UpgradeStat...

Page 177: ...s Provisioning Status s Provisioning Status Provisioned end Proximity status xStatus Proximity Services Availability Shows whether proximity services are available on the endpoint Available Proximity mode has been enabled with the command xConfiguration Proximity Mode and one or more of the proximity services have been enabled with xConfiguration Proximity Services commands Disabled Proximity mode...

Page 178: ...igurations are set to persistent or non persistent mode Persistent is the default mode Requires user role ADMIN USER Value space of the result returned NonPersistent Persistent Example xStatus Security Persistency Configurations s Security Persistency Configurations Persistent end xStatus Security Persistency DHCP Shows whether DHCP logging is set to persistent or non persistent mode Persistent is...

Page 179: ...ace of the result returned String Example xStatus SIP AlternateURI Alias s SIP AlternateURI Alias URI end xStatus SIP AlternateURI Primary n URI Requires user role ADMIN USER Value space of the result returned String Example xStatus SIP AlternateURI Primary s SIP AlternateURI Primary URI end xStatus SIP Authentication Shows which authentication mechanism is used when registering to the SIP Proxy S...

Page 180: ...ncoming calls are directed to when call forward mode is set on Requires user role ADMIN USER Value space of the result returned String Example xStatus SIP CallForward URI s SIP CallForward URI end xStatus SIP Mailbox MessagesWaiting Indicates how many new messages are in the mailbox Requires user role ADMIN USER Value space of the result returned Integer Example xStatus SIP Mailbox MessagesWaiting...

Page 181: ... to the SIP Proxy Server Digest Uses the Digest access authentication method as specified by RFC 2069 NTLM Uses the NTLM authentication method which is a Microsoft authentication protocol Off No authentication mechanism is used Requires user role ADMIN USER Value space of the result returned Digest Off Example xStatus SIP Registration 1 Authentication s SIP Registration 1 Authentication Off end xS...

Page 182: ...SL 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 valid Additionally the fully qualified domain name of the server matches the valid certificate False A TLS connection is not set up because...

Page 183: ...new version of the flash memory must run software TC4 2 1 or later Some previous TC software versions are updated to support the new flash memory Please check the release note to find if the new version of the flash memory is supported If your endpoint does not have the CompatibilityLevel command it does not have the new flash memory installed The result returned when running the command is either...

Page 184: ...Notifications Notification 1 Text s SystemUnit Notifications Notification 1 Text OK end xStatus SystemUnit Notifications Notification n Type Lists the system notification types Notifications are issued e g when a system is rebooted because of a software upgrade or when a factory reset is performed FactoryResetOK This value is returned after a successful factory reset FactoryResetFailed This value ...

Page 185: ...e DisplayName Display Name end xStatus SystemUnit Software Name Shows the name of the software that is installed on the codec Requires user role ADMIN USER Value space of the result returned String Example xStatus SystemUnit Software Name s SystemUnit Software Name s52010 end xStatus SystemUnit Software OptionKeys Encryption Shows if the software on the system have support for encryption Requires ...

Page 186: ...INTEGRATOR USER ROOMCONTROL Value space of the result returned 0 5 Example xStatus SystemUnit State NumberOfActiveCalls s SystemUnit State NumberOfActiveCalls 0 end xStatus SystemUnit State NumberOfInProgressCalls Shows the number of calls in progress Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned 0 5 Example xStatus SystemUnit State NumberOfInProgressCalls...

Page 187: ...Status UserInterface ContactInfo Name Returns the system s active contact name The result depends on which protocol if any the system is registered on The automatically set contact name may have been overridden with the command xConfiguration UserInterface ContactInfo Type This results in a diagnostics warning about contact mismatch Requires user role ADMIN USER Value space of the result returned ...

Page 188: ...tion Shows the position of the active speaker s image on the screen Requires user role ADMIN INTEGRATOR USER Value space of the result returned UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Example xStatus Video ActiveSpeaker PIPPosition s Video PIP ActiveSpeaker Position UpperCenter end xStatus Video Input Connector n Connected Shows whether is something is connecte...

Page 189: ... ADMIN INTEGRATOR USER Value space of the result returned Composite DVI HDMI Unknown YC Example xStatus Video Input Connector 1 Type s Video Input Connector 1 Type HDMI end xStatus Video Input MainVideoSource Returns the local video input currently used as the main source The default main video source is set with the xConfiguration Video DefaultMainSource command Requires user role ADMIN USER Valu...

Page 190: ...ution height in pixels for the video input source Requires user role ADMIN INTEGRATOR USER Value space of the result returned 0 3000 Example xStatus Video Input Source 1 Resolution Height s Video Input Source 1 Resolution Height 1080 end xStatus Video Input Source n Resolution RefreshRate Shows the resolution refresh rate Hz for the video input source Requires user role ADMIN INTEGRATOR USER Value...

Page 191: ...utput Connector n Connected Describes whether a device for example a display is connected to the output connector or not When a display enters standby mode the endpoint may not be able to detect it The connector status will then return False Unknown even if the display is physically connected True A device is connected to the video output connector False Nothing is connected to the video output co...

Page 192: ...wer on Failed to standby Example xStatus Video Output Connector 1 ConnectedDevice CEC PowerControl s Video Output Connector 1 ConnectedDevice CEC PowerControl Ok end xStatus Video Output Connector n ConnectedDevice CEC PowerStatus Shows the state of the CEC enabled devise connected to the HDMI output This information is only available when the device connected to the HDMI output has the CEC featur...

Page 193: ...Connector 1 ConnectedDevice ScreenSize s Video Output Connector 1 ConnectedDevice ScreenSize 55 end xStatus Video Output Connector n MonitorRole Describes which video stream is shown on the device that is connected to the video output connector First Second Third The role of the monitor in a multimonitor setup In a singlemonitor setup there is no difference between First Second and Third Presentat...

Page 194: ... connector DVI It is an DVI connector Requires user role ADMIN USER Value space of the result returned HDMI DVI Example xStatus Video Output Connector 1 Type s Video Output Connector 1 Type HDMI end xStatus Video Presentation PIPPosition Shows the position of the presentation image on the screen Requires user role ADMIN USER Value space of the result returned UpperLeft UpperCenter UpperRight Cente...

Page 195: ... of the result returned First Second Third Fourth Example xStatus Video Selfview OnMonitorRole s Video Selfview OnMonitorRole First end xStatus Video Selfview PIPPosition Shows the position of the selfview image on the screen Requires user role ADMIN INTEGRATOR USER Value space of the result returned UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Example xStatus Video...

Page 196: ... Reference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 196 Cisco TelePresence DX70 and DX80 API Reference Guide Chapter 6 Appendices Introduction About the API xConfiguration Appendices xCommand xStatus Appendices ...

Page 197: ...ontains commands xCommand and configurations xConfiguration that will be executed as part of the start up procedure every time the codec boots A few commands and configurations cannot be placed in a startup script e g xCommand SystemUnit Boot Use the codec s web interface to create and manage startup scripts Read more about the web interface and startup scripts in the Administrator guide for your ...

Page 198: ...stemtools network ifconfig Network debug command systemtools pairing unpair Remove association with Cisco TelePresence Touch controller systemtools passwd Change the password for the logged in user systemtools pki list Lists the codec certificate and CA list if they exist systemtools pki delete cert name Delete the codec certificate and CA list if they exist cert name The name of the certificate s...

Page 199: ...rds 0 Minimum number of characters in passwords Maxmum number of characters in passwords 0 Maxmum number of characters in passwords Minimum number of lower case letters in passwords 0 Minimum number of lower case letters in passwords Minimum number of upper case letters in passwords 0 Minimum number of upper case letters in passwords Minimum number of numerical characters in passwords 0 Minimum nu...

Page 200: ...all was disconnected The value space is OtherLocal LocalDisconnect UnknownRemoteSite LocalBusy LocalReject InsufficientSecurity OtherRemote RemoteDisconnect RemoteBusy RemoteRejected RemoteNoAnswer CallForwarded NetworkRejected CauseString Describes the Cause Code CauseCode The disconnect Cause Codes are defined in SIP and Q 850 CauseOrigin SIP Q 850 internal Example xEvent DisconnectEvent e CallD...

Page 201: ... the system up and running RCSI guide Regulatory compliance and safety information Maintain and Operate Maintain and Operate Guides Getting started guide Initial configurations required to get the system up and running Administrator guide Information required to administer your product Maintain and Operate End User Guides User guides How to use the product Quick reference guides How to use the pro...

Page 202: ...USAGE OR TRADE PRACTICE IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT SPECIAL CONSEQUENTIAL OR INCIDENTAL DAMAGES INCLUDING WITHOUT LIMITATION LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES Any Internet Protocol IP addresses and phone numbers used...

Reviews:

No comments

Brands by name

Popular brands

Load more brands