Cisco SX80 Reference Manual Download Page 137 | Manualshive

Page: 137 / 231

background image

D15107.05

Codec SX80 API Reference Guide TC7.3, OCTOBER 2015.

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

137

Cisco TelePresence SX80

API Reference Guide

xCommand Video Layout LoadDb

Loads and starts using the specified video layout database. The default video layout database

is initially provided by the system. The custom database is generated by the Cisco TC Console

tool and is made available to the codec from within the TC Console tool. The TC Console

software is found at the Developer Zone web page. Go to: http://developer.cisco.com/web/

telepresence-developer/tools/integrators/tc-console.
Custom: The system uses the custom video layout database which generated by the Cisco TC

Console tool.
CustomAutoModes: The system uses the auto mode part of the custom video layout database.
Default: The system use the default video layout database which is provided by the system.

Requires user role:

ADMIN

Parameters:

Type(r): <Custom/CustomAutoModes/Default>

Example:

xCom mand Video Layout LoadDb Type: Default

xCommand Video Layout Remove

Remove an existing video layout.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout

Add command was issued.

Requires user role:

ADMIN

Parameters:

LayoutId(r): <1..2147483647>

Example:

xCom mand Video Layout Remove LayoutId: 1

xCommand Video Layout RemoveAll

Remove all existing video layouts.

Requires user role:

ADMIN

Example:

xCom mand Video Layout RemoveAll

xCommand Video Layout Reset

Reset all layout compositions to factory default.

Requires user role:

ADMIN

Example:

xCom mand Video Layout Reset

xCommand Video Layout SetPresentationView

Set the presentation view mode.
View: Select Default when you want the presentation to be viewed with the default settings for the

codec. Select Maximized when you want the presentation to be displayed in full screen. Select

Minimized when you want the presentation to be displayed in a small picture on screen.

Requires user role:

ADMIN

Parameters:

View(r): <Default/Maximized/Minimized>

Example:

xCom mand Video Layout SetPresentationView View:Default

xCommand Video Layout UnAssign

Remove the defined video layout, and go back to default.
CallId: A unique identifier for the call. 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.
OutputId: A unique identifier for the local output, which was created when the xCommand Audio

LocalOutput Add command was issued.

Requires user role:

ADMIN

Parameters:

CallId(r): <0..65534>
OutputId(r): <0..65534>

Example:

xCom mand Video Layout UnAssign CallId: 1 OutputId: 1

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

«
...
135
136
137
138
139
...
»

Summary of Contents for SX80

Page 1: ... Cisco Systems Inc All rights reserved 1 Cisco TelePresence SX80 API Reference Guide Software version TC7 3 OCTOBER 2015 Application Programmer Interface API Reference Guide Cisco TelePresence SX80 Contents Introduction About the API xConfiguration Appendices xCommand xStatus ...

Page 2: ...anslating from terminal mode to XML 23 Dos and don ts 24 xConfiguration commands 25 Description of the xConfiguration commands 26 Audio configuration 31 Cameras configuration 36 Conference configuration 40 FacilityService configuration 44 GPIO configuration 45 H323 configuration 45 Logging configuration 48 Network configuration 48 NetworkServices configuration 55 Peripherals configuration 59 Phone...

Page 3: ...ds 130 UserManagement commands 131 Video commands 132 Experimental commands 141 xStatus commands 142 Description of the xStatus commands 143 Audio status 151 Call status 154 Camera status 157 Cameras status 160 Conference status 161 Diagnostics status 168 GPIO status 172 H320 status 173 H323 status 174 HttpFeedback status 175 ICE status 175 Logging status 178 MediaChannels status 178 Network statu...

Page 4: ...uide TC7 3 OCTOBER 2015 Copyright 2015 Cisco Systems Inc All rights reserved 4 Cisco TelePresence SX80 API Reference Guide Chapter 1 Introduction Contents Introduction About the API xConfiguration Appendices xCommand xStatus Introduction ...

Page 5: ...user groups Video conference room primer Video conference room acoustics guidelines Installation guides for the TelePresence systems Software release notes for the TC software Getting started guide for the TelePresence systems User guide for the TelePresence systems Touch controller Quick reference guides for the TelePresence systems Administrator guides for the TelePresence systems Camera user gu...

Page 6: ...address the request was initiated from It is possible to allow and disallow snapshots remotely but not to observe the room without the users being notified TC7 3 3 and later Remote Monitoring option key Due to security reasons taking snapshots of local and far end video streams from the call control page on the system s web interface now requires an option key to be installed on the endpoint The r...

Page 7: ...ociation VideoInputSource OLD 1 2 3 4 NEW 1 2 3 4 5 Audio Input Line n VideoAssociation VideoInputSource OLD 1 2 3 NEW 1 2 3 4 5 Audio Input Microphone n VideoAssociation VideoInputSource OLD 1 2 3 NEW 1 2 3 4 5 Cameras SpeakerTrack TrackingMode TC7 3 3 OLD Default Fast NEW Default Conservative Conference 1 1 Multipoint Mode OLD Auto Off MultiSite CUCMMediaResourceGroupList NEW Auto Off MultiSite ...

Page 8: ... OLD Filter All Missed AnsweredElsewhere Forwarded Placed NoAnswer Received UnacknowledgedMissed NEW Filter All Missed AnsweredElsewhere Forwarded Placed NoAnswer Received Rejected UnacknowledgedMissed CallHistory Recents OLD Filter All Missed AnsweredElsewhere Forwarded Placed NoAnswer Received UnacknowledgedMissed NEW Filter All Missed AnsweredElsewhere Forwarded Placed NoAnswer Received Rejecte...

Page 9: ...rStatus Statuses that are modified SystemUnit Diagnostics Message n Type OLD CUCMVendorConfigurationFile CallProtocolDualStackConfig CallProtocolIPStackPlatformCompatibility CallProtocolVcsProvisioningCompatibility CameraPairing CameraSoftwareVersion CameraStatus CamerasDetected DefaultCallProtocolRegistered EthernetDuplexMatches H320GatewayStatus H323GatekeeperStatus HasValidReleaseKey IPv4Assign...

Page 10: ...ide TC7 3 OCTOBER 2015 Copyright 2015 Cisco Systems Inc All rights reserved 10 Cisco TelePresence SX80 API Reference Guide Chapter 2 About the API Contents Introduction About the API xConfiguration Appendices xCommand xStatus About the API ...

Page 11: ...lPort BaudRate 9600 19200 38400 57600 115200 xConfiguration SerialPort LoginRequired Off On Connecting Connect a standard 9 pin serial cable 115200 N 8 1 to the COM port on the SX80 codec Note For security reasons the password prompting is turned on by default but it can be turned off if preferred The default baud rate is set to 115200 The codec can give very much feedback We therefore recommend k...

Page 12: ... systems XML XML output for use with control systems that understand XML 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 ouput mode to XML issue the command xPreferences outputmode xml To revert to terminal mode issue the command xPreferences outputmode terminal Example Layout co...

Page 13: ...nism on page 19 xPreferences The xPreferences command is used to set preferences for the RS 232 Telnet and SSH sessions Refer to API output on page 12 Echo on off If echo is set to On the key inputs are displayed when enter ing text in a command line interface If echo is set to Off no user input is displayed when entering text in a command line interface xEvent the xEvent command returns informati...

Page 14: ...ple 1 List all configurations that include words that starts with OUT and HDMI xconfiguration out hdmi c xConfiguration Audio Output HDMI 1 Level 0 c xConfiguration Audio Output HDMI 1 Mode On c xConfiguration Audio Output HDMI 2 Level 0 c xConfiguration Audio Output HDMI 2 Mode Off end OK Example 2 Get the resolution width of all connected sources for both inputs and outputs xStatus vid res wid s...

Page 15: ...CallHistory FacilityService Phonebook TStringSend CamCtrlPip FarEndControl Presentation UserInterface Camera GPIO Preset UserManagement Cameras HttpFeedback Provisioning Video OK Commands Commands instruct the codec to execute actions such as to dial a number or to search the phone book All commands start with the prefix xCommand followed by a command path Writing xCommand on the command line will...

Page 16: ...urrent UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight xConfiguration Video Wallpaper None Custom DEPRECATED OK xConfiguration User Configurations Audio H323 Provisioning SystemUnit Cameras Logging RTP Time Conference Network Security UserInterface Experimental NetworkServices SerialPort Video FacilityService Peripherals SIP GPIO Phonebook Standby OK Configurations Con...

Page 17: ...d False s Call 2 Protocol sip s Call 2 ReceiveCallRate 6000 s Call 2 RemoteNumber name company com s Call 2 TransmitCallRate 4000 end Example 2 Query the protocol for a call xStatus Call Protocol s Call 2 Protocol sip OK xstatus Status Audio GPIO Network Standby Call H320 NetworkServices SystemUnit Camera H323 Peripherals Time Cameras HttpFeedback Preset UserInterface Conference ICE Provisioning V...

Page 18: ...gratorHQ 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 when far end has sent a...

Page 19: ...ck the application needs This is done by registering feedback expressions The way of registering 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 Feedback from codec over HTTP on page 22 for more information Feedback expressions The expression used when registering for fee...

Page 20: ...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 Write in xFeedback re...

Page 21: ...onfigurations Using HTTP GET It is possible to use HTTP GET when sending commands or configurations to the codec This makes it easy to test commands using your browser Example 1 Setting the camera position http ip address formputxml xmldoc Command Camera PositionSet command True CameraId 1 CameraId Pan 200 Pan Tilt 200 Tilt PositionSet Camera Command Example 2 Changing the system name http ip addr...

Page 22: ...erUrl The URL that you want the codec to post the HTTP feedback messages to Expression 1 15 Register the expressions you want to receive feedback on See the Feedback mechanism on page 19 section for more information about the expression formats Example Registering feedback on configuration changes disconnect events and call status changes Command HttpFeedback Register command True FeedbackSlot 1 F...

Page 23: ...Command Example 2 Assigning video layout to a call Terminal xCommand Video Layout AssignCall CallId 2 LayoutId 1 XML Command Video Layout AssignCall command True CallId 2 CallId LayoutId 1 LayoutId AssignCall Layout Video 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 ...

Page 24: ...ogramming 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 seem fine in the current version the amount of feedback may grow in future releases DO NOT use the experimental section in production...

Page 25: ...7 3 OCTOBER 2015 Copyright 2015 Cisco Systems Inc All rights reserved 25 Cisco TelePresence SX80 API Reference Guide Chapter 3 xConfiguration commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xConfiguration ...

Page 26: ...ration Audio Output Line 1 6 Channel 34 xConfiguration Audio Output Line 1 6 Equalizer ID 34 xConfiguration Audio Output Line 1 6 Equalizer Mode 34 xConfiguration Audio Output Line 1 6 Level 34 xConfiguration Audio Output Line 1 6 Mode 34 xConfiguration Audio Microphones Mute Enabled 35 xConfiguration Audio SoundsAndAlerts KeyTones Mode 35 xConfiguration Audio SoundsAndAlerts RingTone 35 xConfigur...

Page 27: ...erence 1 1 IncomingMultisiteCall Mode 43 FacilityService configuration 44 xConfiguration FacilityService Service 1 5 Type 44 xConfiguration FacilityService Service 1 5 Name 44 xConfiguration FacilityService Service 1 5 Number 44 xConfiguration FacilityService Service 1 5 CallType 44 GPIO configuration 45 xConfiguration GPIO Pin 1 4 Mode 45 H323 configuration 45 xConfiguration H323 NAT Mode 45 xCon...

Page 28: ... VerifyClientCertificate 56 xConfiguration NetworkServices HTTPS OCSP Mode 56 xConfiguration NetworkServices HTTPS OCSP URL 57 xConfiguration NetworkServices Medianet Metadata 57 xConfiguration NetworkServices NTP Mode 57 xConfiguration NetworkServices NTP Address 57 xConfiguration NetworkServices SNMP Mode 57 xConfiguration NetworkServices SNMP Host 1 3 Address 57 xConfiguration NetworkServices S...

Page 29: ...ntication 1 1 LoginName 67 xConfiguration SIP Profile 1 1 Authentication 1 1 Password 67 xConfiguration SIP Profile 1 1 DefaultTransport 67 xConfiguration SIP Profile 1 1 TlsVerify 67 xConfiguration SIP Profile 1 1 Outbound 67 xConfiguration SIP Profile 1 1 Proxy 1 4 Address 67 xConfiguration SIP Profile 1 1 Proxy 1 4 Discovery 68 xConfiguration SIP Profile 1 1 Type 68 xConfiguration SIP Profile 1...

Page 30: ...onfiguration Video Layout PresentationDefault View 78 xConfiguration Video Layout RemoteLayoutFamily 78 xConfiguration Video Layout Scaling 78 xConfiguration Video Layout ScaleToFrame 78 xConfiguration Video Layout ScaleToFrameThreshold 78 xConfiguration Video PIP ActiveSpeaker DefaultValue Position 79 xConfiguration Video PIP Presentation DefaultValue Position 79 xConfiguration Video SelfviewDefa...

Page 31: ...dio Input HDMI 3 VideoAssociation VideoInputSource 1 xConfiguration Audio Input HDMI 1 3 VideoAssociation MuteOnInactiveVideo It is possible to associate an audio source with a video source and further to determine whether to play or mute audio depending on whether the video source is presented or not By default audio is not muted Use the Audio Input HDMI n VideoAssociation VideoInputSource settin...

Page 32: ...rce is presented The audio will be muted when the video source is not presented Example xConfiguration Audio Input Line 1 VideoAssociation MuteOnInactiveVideo Off xConfiguration Audio Input Line 1 4 Channel Define whether the Audio Line input is a mono signal or part of a multichannel signal Requires user role ADMIN Value space Right Left Mono Right The Audio Line input signal is the right channel...

Page 33: ...io input microphone equalizer mode Requires user role ADMIN Value space Off On Off No equalizer On Enable the equalizer for the audio input microphone Example xConfiguration Audio Input Microphone 1 Equalizer Mode Off xConfiguration Audio Input Microphone 1 8 VideoAssociation MuteOnInactiveVideo Enable association of a video source to a microphone audio input Requires user role ADMIN Value space O...

Page 34: ...part of a multichannel signal Requires user role ADMIN Value space Right Left Mono Right The Audio Line output signal is the right channel of a stereo signal Left The Audio Line output signal is the left channel of a stereo signal Mono The Audio Line output signal is a mono signal Example xConfiguration Audio Output Line 1 Channel left xConfiguration Audio Output Line 1 6 Equalizer ID Select the a...

Page 35: ...vailable ringtones the following ways Web interface On the Configuration Personalization page Touch controller On the Ringtone Sound panel of the Settings menu This panel is either in the open part of the Settings menu or included in the password protected Administrator menu The UserInterface UserPreference setting defines which panels will be in the password protected area Requires user role USER...

Page 36: ...be overridden Example xConfiguration Cameras Preset TriggerAutofocus Auto xConfiguration Cameras SpeakerTrack Mode This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera The SpeakerTrack 60 camera assembly consists of two cameras and uses an audio tracking technique that finds and captures a close up of the active speaker When a change of speaker is detected the system ca...

Page 37: ... 2 Requires user role USER Value space 1 5 Format Select a valid video input number Example xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight 2 xConfiguration Cameras SpeakerTrack Whiteboard Mode This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to the codec Determine whether to enable the Snap to Whiteboard feature or not The Snap to Whiteboa...

Page 38: ...deo that is transmitted to the far end Requires user role USER Value space Auto Off On Auto If the camera detects that it is mounted upside down the image is automatically flipped If the camera cannot auto detect whether it is mounted upside down or not the image is not changed Off Display the image on screen the normal way On Display the image flipped upside down This setting is used when a camer...

Page 39: ...u can configure whether the camera should keep its new position or return to the preset or position it had before Requires user role ADMIN Value space Off On Off When the camera position is adjusted manually the camera will keep this position until adjusted again WARNING If moving the camera by hand the camera will not register the new pan and tilt values since there is no position feedback This w...

Page 40: ...ers incoming calls except if you are already in a call You must always answer or decline incoming calls manually when you are already engaged in a call Example xConfiguration Conference 1 AutoAnswer Mode Off xConfiguration Conference 1 1 AutoAnswer Mute Determine if the microphone shall be muted when an incoming call is automatically answered Requires that AutoAnswer Mode is switched on Requires u...

Page 41: ...upports encryption AES 128 the call will be encrypted If not the call will proceed without encryption In MultiSite calls In order to have encrypted MultiSite conferences all sites must support encryption If not the conference will be unencrypted Example xConfiguration Conference 1 Encryption Mode BestEffort xConfiguration Conference 1 1 DefaultCall Protocol Set the Default Call Protocol to be used...

Page 42: ...or enters a multipoint conference or when a call is put on hold suspended or resumed The maximum receive bit rate for each individual call is defined in the Conference MaxReceiveCallRate setting Requires user role ADMIN Value space 64 10000 Range Select a value between 64 and 10000 Example xConfiguration Conference 1 MaxTotalReceiveCallRate 10000 xConfiguration Conference 1 1 VideoBandwidth Mode S...

Page 43: ...e either the CUCM conference bridge or the video system s built in MultiSite feature Which one to use is set up by CUCM Both MultiWay and the CUCM conference bridge allows you to set up conferences with many participants The built in MultiSite allows up to five participants yourself included plus one additional audio call Note that the built in MultiSite feature is optional and may not be availabl...

Page 44: ...he Touch controller The name will show on the facility service call button which appears when you tap the question mark icon in the top bar The other services are available for system integrators using the API Application Programming Interface command set Requires user role ADMIN Value space S 0 1024 Format String with a maximum of 1024 characters Example xConfiguration FacilityService Service 1 N...

Page 45: ...12 V the microphones are unmuted Example xConfiguration GPIO Pin 1 Mode InputNoAction H323 configuration 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 conju...

Page 46: ...er Authentication Mode to be enabled Requires user role ADMIN Value space S 0 50 Format String with a maximum of 50 characters Example xConfiguration H323 Profile 1 Authentication Password xConfiguration H323 Profile 1 1 CallSetup Mode The H 323 Call Setup Mode defines whether to use a Gatekeeper or Direct calling when establishing H323 calls NOTE Direct H 323 calls can be made even though the H 3...

Page 47: ...H 323 Gatekeeper and will be displayed in the call lists Example firstname lastname company com My H 323 Alias ID Requires user role ADMIN Value space S 0 49 Format String with a maximum of 49 characters Example xConfiguration H323 Profile 1 H323Alias ID firstname lastname company com xConfiguration H323 Profile 1 1 PortAllocation The H 323 Port Allocation setting affects the H 245 port numbers us...

Page 48: ...tem will use IPv6 on the network interface Example xConfiguration Network 1 IPStack Dual xConfiguration Network 1 1 IPv4 Assignment Define how the system will obtain its IPv4 address subnet mask and gateway address This setting only applies to systems on IPv4 networks Requires user role ADMIN Value space Static DHCP Static The addresses must be configured manually using the Network IPv4 Address Ne...

Page 49: ...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 addresses must either be set manually or obtained from a DHCPv6 server The Network IPv6 DHCPOptions setting deter mines which method to use Examp...

Page 50: ...1 DNS Server 1 3 Address Define the network addresses for DNS servers Up to 3 addresses may be specified If the network addresses are unknown contact your administrator or Internet Service Provider Requires user role ADMIN Value space S 0 64 Format A valid IPv4 address or IPv6 address Example xConfiguration Network 1 DNS Server 1 Address xConfiguration Network 1 1 QoS Mode The QoS Quality of Servi...

Page 51: ...he higher the number the higher the priority The default value is 0 best effort Example xConfiguration Network 1 QoS Diffserv Data 0 xConfiguration Network 1 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...

Page 52: ... against the local CA list This should typically be selected if no CA list has been uploaded to the codec On When set to On the server side X 509 certificate will be validated against the local CA list for all TLS connections Only servers with a valid certificate will be allowed Example xConfiguration Network 1 IEEE8021X TlsVerify Off xConfiguration Network 1 1 IEEE8021X UseClientCertificate Authe...

Page 53: ... EAP standards LAN clients are authenticated using client certificates Requires user role ADMIN Value space Off On Off The EAP TLS protocol is disabled On The EAP TLS protocol is enabled default Example xConfiguration Network 1 IEEE8021X Eap Tls On xConfiguration Network 1 1 IEEE8021X Eap Peap Set the Peap Protected Extensible Authentication Protocol mode Authenticates LAN clients without the need...

Page 54: ...pace S 0 255 Format String with a maximum of 255 characters Example xConfiguration Network 1 RemoteAccess Allow 10 11 2 3 192 168 0 0 24 2001 0db8 0000 0000 0000 ff00 0042 8329 2001 db8 abcd 0012 0 64 xConfiguration Network 1 1 VLAN Voice Mode Set 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 inf...

Page 55: ...e On xConfiguration NetworkServices SIP Mode Determine whether the system should be able to place and receive SIP calls or not Requires user role ADMIN Value space Off On Off Disable the possibility to place and receive SIP calls On Enable the possibility to place and receive SIP calls default Example xConfiguration NetworkServices SIP Mode On xConfiguration NetworkServices Telnet Mode Telnet is a...

Page 56: ...tocol is disabled On The HTTPS protocol is enabled Example xConfiguration NetworkServices HTTPS Mode On xConfiguration NetworkServices HTTPS VerifyServerCertificate When the video system connects to an external HTTPS server like a phone book server or an external manager this server will present a certificate to the video system to identify itself Requires user role ADMIN Value space Off On Off Do...

Page 57: ...twork Services NTP Address setting will be ignored Example xConfiguration NetworkServices NTP Mode Auto xConfiguration NetworkServices NTP Address The address of the NTP server that will be used when NetworkServices NTP Mode is set to Manual and when NetworkServices NTP Mode is set to Auto and no address is supplied by a DHCP server Requires user role ADMIN Value space S 0 64 Format A valid IPv4 a...

Page 58: ... SSH public key authentication can be used to access the codec Requires user role ADMIN Value space Off On Off The SSH public key is not allowed On The SSH public key is allowed Example xConfiguration NetworkServices SSH AllowPublicKey On xConfiguration NetworkServices CTMS Mode This setting determines whether or not to allow multiparty conferences controlled by a Cisco TelePresence Multipoint Swi...

Page 59: ... to take any effect Requires user role ADMIN Value space 0 3600 Range Select a value between 0 and 3600 seconds Example xConfiguration NetworkServices UPnP Timeout 600 Peripherals configuration xConfiguration Peripherals Pairing CiscoTouchPanels RemotePairing In order to use Cisco Touch 10 touch panel as user interface for the video system Touch 10 must be either directly connected to the video sy...

Page 60: ...ing server Requires user role ADMIN Value space Internal External Auto Internal Request internal configuration External Request external configuration Auto Automatically discover using NAPTR queries whether internal or external configurations should be requested If the NAPTR responses have the e flag external configurations will be requested Otherwise internal configurations will be requested Exam...

Page 61: ...ernal manager provisioning system can return configurations commands to the unit as a result When using CUCM or TMS provisioning the DHCP server can be set up to provide the external manager address automatically DHCP Option 242 for TMS and DHCP Option 150 for CUCM An address set in the Provisioning ExternalManager Address setting will override the address provided by DHCP Requires user role ADMIN...

Page 62: ...ault the system is using the UDP ports in the range 2326 to 2487 for RTP and RTCP media data Each media channel is using two adjacent ports for RTP and RTCP The default number of ports required in the UDP port range is based on the number of simultaneous calls that the endpoint is capable of NOTE Restart the system for any change to this setting to take effect Requires user role ADMIN Value space ...

Page 63: ...t address or port to the syslog server TLS authentication failed if in use local backup re spooling log full Ignore The system will continue its normal operation and rotate internal logs when full When the connection is restored it will again send its audit logs to the syslog server Example xConfiguration Security Audit OnError Action Ignore xConfiguration Security Audit Server Address The audit l...

Page 64: ...out 0 SerialPort configuration xConfiguration SerialPort Mode Enable disable the serial port COM port Requires user role ADMIN Value space Off On Off Disable the serial port On Enable the serial port Example xConfiguration SerialPort Mode On xConfiguration SerialPort BaudRate Specify the baud rate data transmission rate bits per second for the serial port The default value is 115200 Other connecti...

Page 65: ...rred IP version for media is IPv4 IPv6 The preferred IP version for media is IPv6 Example xConfiguration SIP PreferredIPMedia IPv4 xConfiguration SIP PreferredIPSignaling Define the preferred IP version for signaling audio video data Only applicable when both Network IPStack and Conference CallProtocolIPStack are set to Dual and the network does not have a mechanism for choosing the preferred IP v...

Page 66: ...e same network Requires user role ADMIN Value space Off On Off Disable DropRflx On The system will force media through the Turn relay when the remote endpoint is on another network Example xConfiguration SIP Profile Turn DropRflx Off xConfiguration SIP Profile 1 1 Turn Server This is the address of the TURN Traversal Using Relay NAT server that the endpoints will use It is used as a media relay fa...

Page 67: ...P Example xConfiguration SIP Profile 1 DefaultTransport Auto xConfiguration SIP Profile 1 1 TlsVerify For TLS connections a SIP CA list can be uploaded to the video system This can be done from the web interface Requires user role ADMIN Value space Off On Off Set to Off to allow TLS connections without verifying them The TLS connections are allowed to be set up without verifying the x 509 certific...

Page 68: ...box When registered to a Cisco Unified Communications Manager CUCM you may be offered the option of having a private voice mailbox Enter the number address of the mailbox in this setting or leave the string empty if you do not have a voice mailbox Requires user role ADMIN Value space S 0 255 Format String with a maximum of 255 characters Example xConfiguration SIP Profile 1 Mailbox 12345678 xConfi...

Page 69: ...ined by the selected preset RestoreCameraPosition After a reboot the camera position will be set to the position it had before the last boot DefaultCameraPosition After a reboot the camera position will be set to the factory default position Example xConfiguration Standby BootAction DefaultCameraPosition xConfiguration Standby StandbyAction Define the camera position when going into standby mode R...

Page 70: ...field in the upper left corner of the main display and Touch controller The information can also be read with the command xStatus SystemUnit ContactInfo Requires user role ADMIN Value space Auto None IPv4 IPv6 H323Id E164Alias H320Number SipUri SystemName DisplayName Auto Show the address which another system can dial to reach this system The address depends on the default call protocol and system...

Page 71: ...ntina Ushuaia America Aruba America Asuncion America Atikokan America Atka America Bahia America Bahia_Banderas America Barbados America Belem America Belize America Blanc Sablon America Boa_Vista America Bogota America Boise America Buenos_Aires America Cambridge_Bay America Campo_Grande America Cancun America Caracas America Catamarca America Cayenne America Cayman America Chicago America Chihua...

Page 72: ...land Canada Pacific Canada Saskatchewan Canada Yukon Chile Continental Chile EasterIsland Cuba EET EST EST5EDT Egypt Eire Etc GMT Etc GMT 0 Etc GMT 1 Etc GMT 10 Etc GMT 11 Etc GMT 12 Etc GMT 2 Etc GMT 3 Etc GMT 4 Etc GMT 5 Etc GMT 6 Etc GMT 7 Etc GMT 8 Etc GMT 9 Etc GMT 0 Etc GMT 1 Etc GMT 10 Etc GMT 11 Etc GMT 12 Etc GMT 13 Etc GMT 14 Etc GMT 2 Etc GMT 3 Etc GMT 4 Etc GMT 5 Etc GMT 6 Etc GMT 7 Et...

Page 73: ...figuration UserInterface OSD EncryptionIndicator Auto xConfiguration UserInterface OSD LanguageSelection In cases where you want to prevent users from easily changing the language settings from the Settings menu the language settings can be made available from within the Administrator Settings menu The administrator settings can be password protected Requires user role ADMIN Value space Off On Off...

Page 74: ...input sources remote sites and presentation channel If snapshots are allowed the snapshots may be captured both when idle and in a call When snapshots are taken from a remote device e g the web interface a notification appears on the video system s screens to alert the users that remote monitoring is in operation Requires user role ADMIN Value space Off On LocalDeviceOnly Off It is not possible to...

Page 75: ... video input connector will only be visible when something is connected to the video input Example xConfiguration Video Input Connector 2 Visibility IfSignal xConfiguration Video Input Connector 1 5 CameraControl Mode Define whether the camera that is connected to this video input connector can be controlled or not Note that camera control is not available for Connector 4 DVI I and Connector 5 S v...

Page 76: ...080 Set the threshold to 1920x1080 Never Do not set a threshold for transmitting 60fps Example xConfiguration Video Input Connector 1 OptimalDefinition Threshold60fps 1280 _ 720 xConfiguration Video Input Connector 1 4 PresentationSelection Define how the video system will behave when you connect a presentation source to the video input If the video system is in standby mode it will wake up when y...

Page 77: ...ent YPbPr signal cannot be auto detected Example xConfiguration Video Input Connector 4 DviType AutoDetect xConfiguration Video Input Connector 5 SignalType Connector 5 can be used for either S Video or Composite video input format Use this setting to configure which video format the BNC connector s are used for Requires user role ADMIN Value space Composite YC Composite Connector 5 is configured ...

Page 78: ...Configuration Video Layout RemoteLayoutFamily Auto xConfiguration Video Layout Scaling Define how the system shall adjust the aspect ratio for images or frames when there is a difference between the image and the frame it is to be placed in Requires user role ADMIN Value space Off On Off No adjustment of the aspect ratio On Let the system automatically adjust aspect ratio Example xConfiguration Vi...

Page 79: ...e position of the presentation PiP will be kept unchanged when leaving a call UpperLeft The presentation PiP will appear in the upper left corner of the screen UpperCenter The presentation PiP will appear in the upper center position UpperRight The presentation PiP will appear in the upper right corner of the screen CenterLeft The presentation PiP will appear in the center left position CentreRigh...

Page 80: ... SelfviewDefault OnMonitorRole Current xConfiguration Video Monitors A role is assigned to each monitor using the Video Output Connector n MonitorRole setting The monitor role decides which layout call participants and presentation will appear on the monitor that is connected to this output Monitors with the same monitor role will get the same layout monitors with different monitor roles will have...

Page 81: ... Example xConfiguration Video Output Connector 2 Location HorizontalOffset 1 xConfiguration Video Output Connector 1 3 Location VerticalOffset HorizontalOffset and VerticalOffset settings are associated with each video output These settings are used to signal the relative position of the displays that are connected to these outputs HorizontalOffset 0 and VerticalOffset 0 indicates that the display...

Page 82: ...puts define which layout video streams will be shown on each monitor Requires user role ADMIN Value space Auto First Second Third PresentationOnly Recorder Auto The system will detect when a monitor is connected and a monitor role First Second Third that corresponds with the Video Monitors setting will be assigned automatically First Second Third Define the role of the monitor in a multi monitor s...

Page 83: ...ide TC7 3 OCTOBER 2015 Copyright 2015 Cisco Systems Inc All rights reserved 83 Cisco TelePresence SX80 API Reference Guide Chapter 4 xCommand commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

Page 84: ...Command Audio SoundsAndAlerts Ringtone List 95 xCommand Audio SoundsAndAlerts Ringtone Play 95 xCommand Audio Volume Decrease 96 xCommand Audio Volume Increase 96 xCommand Audio Volume Mute 96 xCommand Audio Volume Set 96 xCommand Audio Volume SetToDefault 96 xCommand Audio Volume UnMute 96 xCommand Audio VUMeter Start 96 xCommand Audio VUMeter Stop 97 xCommand Audio VUMeter StopAll 97 Bookings co...

Page 85: ...nPosition 107 xCommand Cameras SpeakerTrack Whiteboard SetDistance 108 xCommand Cameras SpeakerTrack Whiteboard StorePosition 108 Conference commands 108 xCommand Conference ActiveSpeaker Reset 108 xCommand Conference ActiveSpeaker Set 108 xCommand Conference DoNotDisturb Activate 108 xCommand Conference DoNotDisturb Deactivate 109 Dial commands 109 xCommand Dial 109 DTMFSend commands 110 xCommand...

Page 86: ...oning commands 125 xCommand Provisioning CUCM CAPF OperationStart 125 xCommand Provisioning CUCM CTL Delete 125 xCommand Provisioning CUCM CTL Show 125 xCommand Provisioning CUCM ExtensionMobility Login 125 xCommand Provisioning CUCM ExtensionMobility Logout 125 xCommand Provisioning CUCM ITL Show 125 xCommand Provisioning CompleteUpgrade 125 xCommand Provisioning PostponeUpgrade 126 xCommand Prov...

Page 87: ...and Video Layout Assign 133 xCommand Video Layout AssignCall 133 xCommand Video Layout AssignLocalOutput 134 xCommand Video Layout AssignPresentation 134 xCommand Video Layout Frame Add 134 xCommand Video Layout Frame List 135 xCommand Video Layout Frame Remove 135 xCommand Video Layout Frame Update 136 xCommand Video Layout List 136 xCommand Video Layout LoadDb 137 xCommand Video Layout Remove 13...

Page 88: ... to one or more of the audio input and output connectors on the codec Each IIR section can be modified independently There are five filter types and the frequency response variations dependent on some of the param eter variations The Q value for low pass high pass low shelf and high shelf filters should be set to 1 sqrt 2 in order to get maximally flat responses The Q value or Q factor is defined ...

Page 89: ...ically generates a start up script that makes the command persistent over a reboot To use this command outside of TC console you have to include it in a start up script in order to make the setting persis tent over a reboot For more information on star up scripts and TC console see the administrator guide for your codec InputId A unique identifier for the local input Name Choose a name that descri...

Page 90: ... up script that makes the command persistent over a reboot To use this command outside of TC console you have to include it in a start up script in order to make the setting persis tent over a reboot For more information on star up scripts and TC console see the administrator guide for your codec InputId A unique identifier for the local input Requires user role ADMIN Parameters InputId r 0 65534 ...

Page 91: ...xerMode GainShared AGC Off Mute Off Channels 1 xCommand Audio LocalOutput Add Create a local output and generate the local output id A local output is a mix of local input and remote input signals All connectors attached to the local output receive the same signal This command is mainly intended for internal use by the TC console TC console automatically generates a start up script that makes the ...

Page 92: ...l output InputId A unique identifier for the local input InputGain Set a gain on the input signal in the range from 54dB to 15dB The value 54dB equals Off Requires user role ADMIN Parameters OutputId r 0 65534 InputId r 0 65534 InputGain 54 15 Example xCommand Audio LocalOutput ConnectInput OutputId 6 InputId 3 xCommand Audio LocalOutput DisconnectInput Disconnect a local or remote input from a lo...

Page 93: ...omatically generates a start up script that makes the command persistent over a reboot To use this command outside of TC console you have to include it in a start up script in order to make the setting persis tent over a reboot For more information on star up scripts and TC console see the administrator guide for your codec OutputId A unique identifier for the local output Name Choose a name that ...

Page 94: ...de a remote input and remote output pair is created This command is mainly intended for internal use by the TC console TC console automatically generates a start up script that makes the command persistent over a reboot To use this command outside of TC console you have to include it in a start up script in order to make the setting persis tent over a reboot For more information on star up scripts...

Page 95: ...tiate CallWaiting Dial KeyInput KeyTone Nav NavBack Notification OK PresentationConnect Ringing SpecialInfo TelephoneCall VideoCall Volume Loop On Off Example xCommand Audio Sound Play Sound Ringing xCommand Audio Sound Stop Stop playing audio sound Requires user role USER Example xCommand Audio Sound Stop xCommand Audio SoundsAndAlerts Ringtone List Lists all available ringtones that can be confi...

Page 96: ...ume Set Level 30 xCommand Audio Volume SetToDefault Set the current volume level as the default for the endpoint Requires user role USER Example xCommand Audio Volume SetToDefault xCommand Audio Volume UnMute Unmute the volume on the endpoint Requires user role USER Example xCommand Audio Volume SetToDefault xCommand Audio VUMeter Start Start collecting VU meter information for the connector ident...

Page 97: ...pe Identifies whether it is an HDMI input connector an audio line input connector or a microphone connector Requires user role USER Parameters ConnectorType r HDMI Line Microphone ConnectorId r 1 8 Example xCommand Audio VUMeter Stop ConnectorType Microphone ConnectorId 1 xCommand Audio VUMeter StopAll Stop collecting VU meter information for all connectors Requires user role USER Example xCommand...

Page 98: ... MaximumMeetingExtension 30 r Bookings Booking 1 MeetingExtensionAvailability Guaranteed r Bookings Booking 1 BookingStatus OK r Bookings Booking 1 BookingStatusMessage r Bookings Booking 1 Webex Enabled True r Bookings Booking 1 Webex Url http webex url r Bookings Booking 1 Webex MeetingNumber webexNumber cisco com r Bookings Booking 1 Webex Password r Bookings Booking 1 Webex HostKey r Bookings ...

Page 99: ...g calls are accepted 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 CallType parameter is not in use Requires user role USER Parameters CallId 0 65534 CallType Audio Video Not in use Example xCommand Call Accept CallId 19 xCommand Call Disconnect Disconnect a call The CallID is returned when the xCommand Dial comm...

Page 100: ...ommand Call Join CallId 34 xCommand Call Reject Reject incoming call If no call id is specified all incoming calls are rejected 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 Requires user role USER Parameters CallId 0 65534 Example xCommand Call Reject CallId 20 xCommand Call Resume Resume a call that have been p...

Page 101: ...CallHistoryId r 1 2147483647 AcknowledgeConsecutiveDuplicates False True Example xCommand CallHistory AcknowledgeMissedCalls CallHistoryId 5 xCommand CallHistory DeleteAll Deletes all information on previous calls Filter You can filter which calls to delete either all missed placed or received calls Requires user role USER Parameters Filter All Missed Placed Received Example xCommand CallHistory D...

Page 102: ...Entry 0 IsAcknowledged Acknowledged r CallHistoryGetResult Entry 1 CallHistoryId 1 r CallHistoryGetResult Entry 1 CallbackNumber sip name company com r CallHistoryGetResult Entry 1 DisplayName name r CallHistoryGetResult Entry 1 StartTime 2013 04 09T10 53 53 r CallHistoryGetResult Entry 1 DaysAgo 182 r CallHistoryGetResult Entry 1 OccurrenceType Received r CallHistoryGetResult Entry 1 IsAcknowledg...

Page 103: ... for pan and tilt If the camera is daisy chained the CameraId is given by its place in the chain Requires user role USER Parameters CameraId r 1 7 Example xCommand Camera PanTiltReset CameraId 1 xCommand Camera PositionActivateFromPreset Selects pan tilt zoom and focus parameters for the given camera id from the selected preset CameraId Give the camera id PresetId Select preset 1 to 15 Requires us...

Page 104: ...e the name of the camera preset and its position in the list that is returned by the xCommand Camera Preset List command Note that the xCommand Camera Preset commands applies to an individual camera This is in contrast to the xCommand Preset commands where a single preset covers ALL connected cameras plus the Video Input switcher settings PresetId The ID of the camera preset you want to edit ListP...

Page 105: ...ser role ADMIN Parameters PresetId r 1 35 Example xCommand Camera Preset Snapshot Store PresetId 1 xCommand Camera Preset Store Store the current position pan and tilt zoom and focus of the chosen camera The camera is identified by the CameraId parameter Note that the xCommand Camera Preset commands applies to an individual camera This is in contrast to the xCommand Preset commands where a single ...

Page 106: ...oom Zoom the camera In or Out followed by Stop ZoomSpeed Set the zoom speed Focus Focus the camera Far or Near followed by Stop Requires user role USER Parameters CameraId r 1 7 Pan Left Right Stop PanSpeed 1 15 Tilt Down Up Stop TiltSpeed 1 15 Zoom In Out Stop ZoomSpeed 1 15 Focus Far Near Stop Example xCommand Camera Ramp CameraId 1 Pan left PanSpeed 1 xCommand Camera Ramp CameraId 1 Pan stop xC...

Page 107: ...d the system can switch automatically between the two cameras to always show the best camera view Requires user role USER Example xCommand Cameras SpeakerTrack Deactivate xCommand Cameras SpeakerTrack Whiteboard ActivatePosition Moves the specified camera in a SpeakerTrack 60 to the position stored with xCommand Cameras SpeakerTrack Whiteboard StorePosition Camera Select either right or left camer...

Page 108: ...ly id that can be used is 1 Requires user role ADMIN Parameters Camera r Left Right WhiteboardId 0 65534 Example xCommand Cameras SpeakerTrack Whiteboard StorePosition Camera Left WhiteboardId 123 Conference commands xCommand Conference ActiveSpeaker Reset Resets ActiveSpeaker Normal voice switching is switched back on Requires user role USER Example xCommand Conference ActiveSpeaker Reset xComman...

Page 109: ... some other commands Number Enter the number or address Protocol Select the Auto SIP H323 or H320 protocol CallRate Set a call rate CallType Select the audio or video call type BookingId Any identifier that an external booking system e g TMS CTS MAN can use for its own references to match placed calls with the booking systems internal identifier for a meeting This can be any string e g a GUID The ...

Page 110: ...ing r S 0 32 Example xCommand DTMFSend CallId 2 DTMFString 1234 FacilityService commands xCommand FacilityService Dial Dial out from the system to a facility service A maximum of five facility services can be defined which one of these five to dial to is identified by the ServiceId ref xConfiguration Facility Service ServiceId Type Name Number CallType The command returns information about the Cal...

Page 111: ...he far end codec or by using the xCommand FarEndControl Preset Store command from a remote codec Note The far end codec s xConfiguration Conference FarEndControl Mode setting must be switched On for the FarEndControl commands to work CallId 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 the ca...

Page 112: ... command to see the CallId 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 GPIO commands xCommand GPIO ManualState Set Set the status of a GPIO pin that is configured to OutputManualState mode ref xConfiguration GPIO Pin 1 4 Mode Requires user role USER Parameters ...

Page 113: ...rverUrl Define the URL for the HTTP S server Expression 1 15 What parts of the Status and Configuration XML documents to monitor are speci fied by XPath expressions You can have from 1 to 15 XPath expressions Requires user role USER Parameters FeedbackSlot 1 4 ServerUrl r S 1 2048 Expression 1 15 S 1 255 Example xCommand HttpFeedback Register FeedbackSlot 1 ServerUrl 10 47 19 41 Expression 1 Statu...

Page 114: ...Display command This is required when the Duration parameter is not set Requires user role ADMIN Example xCommand Message Alert Clear xCommand 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...

Page 115: ...bout the xFeed back commands in the API introduction section in this guide FeedbackId The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command Requires user role ADMIN Parameters FeedbackId S 0 255 Example xCommand Message Prompt Clear FeedbackId 24 xCommand Message Prompt Display Display a small window on screen with a title text and up to five options for...

Page 116: ...res user role ADMIN Example xCommand Message TextLine Clear xCommand Message TextLine Display Display a text line on screen Optionally you can place the text line at a specified location and for a specified duration of time in seconds NOTE If Duration is not set the command must be followed by xCommand Message TextLine Clear Text Enter the text line to be displayed The p and br HTML tags will resu...

Page 117: ...ls ConnectedDevice list If the peripheral is not set to send a heartbeat the device will disappear from the list after a while Note Does not apply for ISDN Link or cameras Requires user role USER Parameters ID r S 1 100 Timeout 1 65535 Example xCommand Peripherals HeartBeat ID 00 50 60 d8 7c e6 xCommand Peripherals List Lists all currently and previously connected peripherals Note Does not apply f...

Page 118: ...Address Enter the MAC address for the ISDN Link you wish to pair to the endpoint Requires user role ADMIN Parameters MacAddress r S 1 1450 Example xCommand Peripherals Pairing Pair MacAddress 1 2 3 4 xCommand Peripherals Pairing Unpair Unpair endpoint from an ISDN Link when the two have contact MacAddress Enter the MAC address for the ISDN Link you wish to unpair from the endpoint Requires user ro...

Page 119: ...ommand Phonebook Contact Add Name John Doe Number 12345 xCommand Phonebook Contact Delete Delete an existing contact from the local phonebook ContactId The unique identifier for the contact The identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Contact Add command was issued to make the contact Requires user role USER Parameters Con...

Page 120: ...ddress of the contact Protocol Select Auto SIP H323 or H320 protocol CallRate Set a call rate CallType Select a call type audio or video Requires user role USER Parameters ContactId r S 0 255 Device Mobile Other Telephone Video Number r S 0 255 Protocol Auto H320 H323 SIP CallRate 0 6000 CallType Audio Video Example xCommand Phonebook ContactMethod Add ContactId localContactId 2 Number 54321 Proto...

Page 121: ...5 Protocol Auto H320 H323 SIP CallRate 0 6000 CallType Audio Video Example xCommand Phonebook ContactMethod Modify ContactMethodId 117 ContactId localContactId 10 Number newnumber cisco com xCommand Phonebook Folder Add Phonebook entries can be stored in folders Use this command to add a folder to the local phone book The command returns the FolderId which is a unique string that identifies the fo...

Page 122: ...necessary to use PhonebookType Define whether to search the local phone book or the corporate phonebook SearchString Search for entries containing this string note that the entry does not have to begin with the string If no FolderId is specified all folders phonebook directories will be searched SearchField Currently not in use Offset Get records starting with this offset in a search The default v...

Page 123: ...od 1 Number H323 John Doe Home company com r ResultSet Contact 2 ContactMethod 1 Protocol H323 r ResultSet Contact 2 ContactMethod 2 ContactMethodId 4 r ResultSet Contact 2 ContactMethod 2 Number SIP John Doe Home company com r ResultSet Contact 2 ContactMethod 2 Protocol SIP Presentation commands xCommand Presentation Start Open a media stream from the selected presentation source PresentationSou...

Page 124: ...resetId r 1 15 Example xCommand Preset Clear PresetId 3 xCommand Preset Store Store the connector selections for all video input sources and the current position pan and tilt zoom and focus values for all cameras Note that information about all video input sources and pan tilt zoom and focus values for all cameras are included in the same preset The system may hold 15 such predefined video input p...

Page 125: ...USER Example xCommand Provisioning CUCM CTL Show xCommand Provisioning CUCM ExtensionMobility Login Login command for the Extension Mobility service You login to the Extension Mobility service with a user name and pin If there are multiple profiles available for that user a separate event will be sent with the available profiles for the user A new login command with the profile can then be submitt...

Page 126: ...lete the software upgrade Requires user role ADMIN Example xCommand Provisioning StartUpgrade Security commands xCommand Security FIPSMode Activate Activate FIPS 140 2 mode NOTE Activating FIPS mode implies a reset to factory defaults While in FIPS mode software upgrade is disabled and the following limitations apply All calls are encrypted unencrypted communication protocols like Telnet and HTTP ...

Page 127: ...ternalLogging r NonPersistent Persistent LocalPhonebook r NonPersistent Persistent DHCP r NonPersistent Persistent ConfirmAndReboot r Yes Example xCommand Security Persistency Configurations Persistent CallHistory Persistent InternalLogging Persistent LocalPhonebook Persistent DHCP Persistent ConfirmAndReboot Yes Standby commands xCommand Standby Activate Set the system in standby mode which turns...

Page 128: ...geResult status OK Warning New configuration profile will be active after next boot end xCommand SystemUnit ConfigurationProfile List List configuration profiles that has been stored in the system Requires user role ADMIN Example xCommand SystemUnit ConfigurationProfile List xCommand SystemUnit ConfigurationProfile Remove Delete a configuration profile that has been stored in the system Requires u...

Page 129: ...can be forced by select ing a different TrailingAction TrailingAction Select Shutdown or NoAction to override the default behavior Restart Requires user role ADMIN Parameters Confirm r Yes TrailingAction NoAction Restart Shutdown Example xCommand SystemUnit FactoryReset Confirm Yes xCommand SystemUnit Notifications RemoveAll Clears the list of system notifications that are reported by xStatus Syst...

Page 130: ... ip _ address s52000tc4 _ 0 _ 0 pkg UserName testDownload Password 1234 UserInterface commands xCommand UserInterface OSD Close Clear all messages and indicators from the monitor s Requires user role USER Parameters Element r Menu Example xCommand UserInterface OSD Close Element Menu xCommand UserInterface ScreenShot Get For internal use only Requires user role ADMIN Parameters ScreenShotId r S 0 ...

Page 131: ...access the system for troubleshooting You can set duration for the validity of the passphrase It expires in 7 days by default Requires user role ADMIN Parameters ExpiryDays 1 31 Example xCommand UserManagement RemoteSupportUser Create r UserCreate status OK Username remotesupport Expiry 2014 03 04 13 24 15 UTC Passphrase 1234567890 xCommand UserManagement RemoteSupportUser Delete Delete the remote...

Page 132: ...rt Enable xCommand Video Input SetMainVideoSource Set which input source is the main video source You can identify the source either by the identifier of the connector that it is connected to or by the identifier of the source itself This command requires the use of one and only one of these parameters ConnectorId or SourceId ConnectorId The identifier ID of the connector Connector n has ID n Run ...

Page 133: ...tion appears on the specified local output or in the specified remote video stream CallId A unique identifier for the call 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 OutputId A unique identifier for the local output which was created when the xCommand Audio LocalOutput Add command was issued LayoutId A unique ...

Page 134: ...ould have a border VideoSourceType Select the video source to be used as the content of the frame The parameter arguments are explained below Graphic Not in use LocalInput Select one of the local input sources LocalMain Select what is currently the main source on the local side LocalPresentation Select what is currently the default presentation source on the local side MostSpeaking Select the curr...

Page 135: ...1 Border off VideoSourceType localInput VideoSourceId 1 xCommand Video Layout Frame List Lists the data related to all layout frames created by command xCommand Video Layout Frame Add for a specific layout identified by LayoutId Requires user role ADMIN Parameters LayoutId 1 2147483647 Example xCommand Video Layout Frame List LayoutId 1 xCommand Video Layout Frame Remove Remove a video frame from ...

Page 136: ...e itself You can add several frames with otherMainRemote The source and the layout engine automatically populate the frame content with one of the other remote sites main video making sure that you do not see the same site more than once nor yourself OwnMain Select that each site can see its own self view Presentation Select what is currently the presentation source there is always only one active...

Page 137: ...Id r 1 2147483647 Example xCommand Video Layout Remove LayoutId 1 xCommand Video Layout RemoveAll Remove all existing video layouts Requires user role ADMIN Example xCommand Video Layout RemoveAll xCommand Video Layout Reset Reset all layout compositions to factory default Requires user role ADMIN Example xCommand Video Layout Reset xCommand Video Layout SetPresentationView Set the presentation vi...

Page 138: ...ommand Video Layout UnAssignPresentation xCommand Video Matrix Assign xCommand Video Matrix commands are a smart overlay to the xCommand Video Layout commands to make it easy to do simple video compositions Mode Choose whether to replace the existing source on that output rendered full screen or to add it Using Add the layout engine will recompose the multiple sources automatically Replace is the ...

Page 139: ...Position Predefined positions CenterLeft The ActiveSpeaker PiP appears on the left side of the screen in center CenterRight The ActiveSpeaker PiP appears on the right side of the screen in center LowerLeft The ActiveSpeaker PiP appears in the lower left corner of the screen LowerRight The ActiveSpeaker PiP appears in the lower right corner of the screen UpperCenter The ActiveSpeaker PiP appears on...

Page 140: ...le ADMIN Parameters Position r LowerCenter LowerLeft LowerRight UpperCenter UpperLeft UpperRight Example xCommand Video PreviewFilmstrip Set Position LowerCenter 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 Mode Selfview on off FullscreenMode Self view in fullscreen or pip PIPPosition Predefined PIP po...

Page 141: ... Cisco TelePresence SX80 API Reference Guide 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 Contents Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

Page 142: ...uide TC7 3 OCTOBER 2015 Copyright 2015 Cisco Systems Inc All rights reserved 142 Cisco TelePresence SX80 API Reference Guide Chapter 5 xStatus commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xStatus ...

Page 143: ...tus Call n Protocol 154 xStatus Call n CallType 155 xStatus Call n RemoteNumber 155 xStatus Call n CallbackNumber 155 xStatus Call n DisplayName 155 xStatus Call n TransmitCallRate 155 xStatus Call n ReceiveCallRate 155 xStatus Call n FacilityServiceId 156 xStatus Call n Encryption Type 156 xStatus Call n PlacedOnHold 156 xStatus Call n Duration 156 xStatus Call n SecurityStatus 156 xStatus Call n...

Page 144: ... n Manufacturer 164 xStatus Conference Site n SoftwareID 164 xStatus Conference Site n BlackScreenCause 164 xStatus Conference Site n ConferenceExtended 164 xStatus Conference Site n BookingId 165 xStatus Conference Site n SecurityStatus 165 xStatus Conference Site n UnattendedTransfer 165 xStatus Conference Site n AttendedTransfer 165 xStatus Conference Site n Appearance 165 xStatus Conference Si...

Page 145: ...oChannel n Netstat 1 Bytes 171 xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 Bytes 171 xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 Bytes 171 xStatus Diagnostics Call n Channels OutgoingAudioChannel n Netstat 1 Bytes 171 xStatus Diagnostics Call n Channels OutgoingVideoChannel n Netstat 1 Bytes 171 xStatus Diagnostics Call n Channels OutgoingDataChanne...

Page 146: ...ress 183 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTP Local Port 183 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTP Remote IpAddress 183 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTP Remote Port 184 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTCP Local IpAddress 184 xStatus MediaChannels Call n OutgoingAudioChannel n Tr...

Page 147: ...dress 195 xStatus NetworkServices NTP Status 195 Peripherals status 196 xStatus Peripherals ConnectedDevice n HardwareInfo 196 xStatus Peripherals ConnectedDevice n ID 196 xStatus Peripherals ConnectedDevice n Name 196 xStatus Peripherals ConnectedDevice n SoftwareInfo 196 xStatus Peripherals ConnectedDevice n Status 196 xStatus Peripherals ConnectedDevice n Type 196 xStatus Peripherals ConnectedD...

Page 148: ...sagesWaiting 207 xStatus SIP Profile 1 CallForward Mode 207 xStatus SIP Profile 1 CallForward URI 207 xStatus SIP Profile 1 CallForward DisplayName 207 xStatus SIP Profile 1 Registration n Status 207 xStatus SIP Profile 1 Registration n Reason 207 xStatus SIP Profile 1 Registration n URI 207 xStatus SIP Profile 1 DirectoryURI Primary URI 208 Standby status 208 xStatus Standby Active 208 SystemUnit...

Page 149: ...ion RefreshRate 219 xStatus Video Output Connector n Type 219 xStatus Video Output DVI ConnectedDevice Name 219 xStatus Video Output DVI ConnectedDevice PreferredFormat 219 xStatus Video Output HDMI ConnectedDevice Name 219 xStatus Video Output HDMI ConnectedDevice PreferredFormat 219 xStatus Video Output HDMI ConnectedDevice CEC DeviceType 220 xStatus Video Output HDMI ConnectedDevice CEC PowerCo...

Page 150: ... Hidden 224 xStatus Video Selfview Mode 224 xStatus Video Selfview FullscreenMode 224 xStatus Video Selfview PIPPosition 224 xStatus Video Selfview OnMonitorRole 224 xStatus Video PIP ActiveSpeaker Position 224 xStatus Video PIP Presentation Position 224 xStatus Video OSD Output 224 xStatus Video OSD Mode 225 Experimental status 225 Contents Introduction About the API xConfiguration Appendices xCo...

Page 151: ...put to find the identity n of the input Value space of the result returned String Example xStatus Audio Input LocalInput 1 Name s Audio Input LocalInput 1 Name Microphone end xStatus Audio Input LocalInput n MixerMode Shows how the local input connectors have been mixed together You can run the command xStatus Audio Input LocalInput to find the identity n of the input Auto The microphone with the ...

Page 152: ...alue space of the result returned Microphone 1 Microphone 4 Line 1 Line 2 HDMI 2 Example xStatus Audio Input LocalInput 1 Connector s Audio Input LocalInput 1 Connector Microphone 1 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 identity n of the input Value space of the result returned 0 ...

Page 153: ...Audio Output LocalOutput to find the identity n of the output Value space of the result returned Line 1 Line 2 HDMI 1 HDMI 2 Example xStatus Audio Output LocalOutput 4 Connector s Audio Output LocalOutput 4 Connector Line 1 end xStatus Audio Output LocalOutput n Input n Gain Shows the gain dB on the input when it is connected to the local output Range from 54 dB to 15 dB where 54 dB equals Off You...

Page 154: ...rmation about the call xStatus Call n Status Shows the status of a call You can run the command xStatus Call to find the call identity Value space of the result returned Idle Dialling Ringing Connecting Connected Disconnecting OnHold EarlyMedia Preserved RemotePreserved Example xStatus Call 27 Status s Call 27 Status Connected end xStatus Call n Direction States the direction of the call initiatio...

Page 155: ...he call identity 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 DisplayName Shows the name of the remote far end participant in an incoming or outgoing call You can run the command xStatus Call to find the call identity Value space of the result returned String Example xStatus Call 27 ...

Page 156: ...ll in seconds You can run the command xStatus Call to find the call identity Value space of the result returned Integer Example xStatus Call 27 Duration s Call 27 Duration 2354 end xStatus Call n SecurityStatus Security status of a call represents the least of the security statuses of all the endpoints involved in a CUCM call Value space of the result returned Invalid Unknown NotAuthenticated Auth...

Page 157: ...d Integer Example xStatus Call 1 AttendedTransferFrom s Call 1 AttendedTransferFrom 1234 end Camera status xStatus Camera Shows the top level overview of the camera status xStatus Camera n Connected Shows if the camera is connected or not Value space of the result returned True False Example xStatus Camera 1 Connected s Camera 1 Connected True end xStatus Camera n HardwareID Shows the hardware ide...

Page 158: ...mera n IpAddress Shows the camera IP address Value space of the result returned String Example xStatus Camera 1 IpAddress s Camera 1 IpAddress end xStatus Camera n MacAddress Shows the MAC Media Access Control address for the camera Value space of the result returned String Example xStatus Camera 1 MacAddress s Camera 1 MacAddress end xStatus Camera n Position Pan Shows the current pan move left a...

Page 159: ...ns s Camera 1 Capabilities Options ptzf end xStatus Camera n Flip 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 xStatus Camera n UpgradeStatus Returns the status of the camera software upgrade None No upgrade going on at the moment Downloading Downloading the upgrade Installing In...

Page 160: ...he HDMI connector used for the right camera on a SpeakerTrack camera Value space of the result returned 0 1 2 3 Example xStatus Cameras SpeakerTrack RightCamera VideoInputConnector s Cameras SpeakerTrack RightCamera VideoInputConnector 0 end xStatus Cameras SpeakerTrack Status Shows whether speaker tracking is set to active or inactive Value space of the result returned Active Inactive Example xSt...

Page 161: ...kerTrack Whiteboard SetDistance for the specified whiteboard Value space of the result returned Integer Example xStatus Cameras SpeakerTrack Whiteboard 1 Distance s Cameras SpeakerTrack Whiteboard 1 Distance 1 end Conference status xStatus Conference Shows the top level overview of the conference status The identity of the Conference Site can only be read during a call xStatus Conference Presentat...

Page 162: ...own at all Value space of the result returned Off LocalRemote LocalOnly Example xStatus Conference Presentation LocalSendingMode s Conference Presentation LocalSendingMode Off end xStatus Conference Presentation LastLocalSource Identifies the last used local presentation source Value space of the result returned Integer Example xStatus Conference Presentation LastLocalSource s Conference Presentat...

Page 163: ...of an input source that can be connected at a far end site Value space of the result returned String Example xStatus Conference Site 2 Capabilities FECC Source 1 Name s Conference Site 2 Capabilities FECC Source 1 Name Main camera end xStatus Conference Site n Capabilities FECC Source n Options Shows available options for an input source that can be connected at a far end site for a camera p pan t...

Page 164: ...ipant in the meeting LastParticipant You are the only remaining participant in the meeting NoResources The conference started with insufficient resources EarlyJoin The scheduled conference hast not started yet HostNotJoined The conference is waiting for the host to join SecurityIssues The video is blocked due to security issues NoVideo It is a conference without video WebexOnly It is a Webex only ...

Page 165: ... SecurityStatus s Conference Site 21 SecurityStatus Unknown end xStatus Conference Site n UnattendedTransfer Indicates whether Unattended Transfer is available for the call Value space of the result returned True False Example xStatus Conference Site UnattendedTransfer s Conference Site 14 UnattendedTransfer True end xStatus Conference Site n AttendedTransfer Indicates whether Attended Transfer is...

Page 166: ...the result returned Idle Private Trying Progressing Alerting Active Held HeldPrivate Unknown Example xStatus Conference Line 1 Appearance Status s Conference Line 1 Appearance 5464 Status Held end xStatus Conference Line n Appearance URI Returns the URI of the shared line call Not visible for a private call Value space of the result returned String Example xStatus Conference Line 1 Appearance URI ...

Page 167: ...onference ActiveSpeaker SiteId Shows the SiteId CallId of the current active speaker Value space of the result returned Integer Example xStatus Conference ActiveSpeaker SiteId s Conference ActiveSpeaker SiteId 0 end xStatus Conference ActiveSpeaker Manual SiteId Shows the SiteId CallId for the participant locked as the active speaker in the conference Value space of the result returned Integer Exa...

Page 168: ...oming outgoing channel as specified by RFC 3550 Value space of the result returned Integer Example xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter 0 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 Packets xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1...

Page 169: ... s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Loss 96 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 LastIntervalLost xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 LastIntervalLost xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 LastIntervalLost xStatus Diagnostics Call n Channels OutgoingAudioChannel n Netsta...

Page 170: ...result returned Integer Example xStatus Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived 84 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 Drop xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 Drop xStatus Diagnostics Call n Channels...

Page 171: ...s OutgoingDataChannel 327 Netstat 1 Bytes s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes 129920 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 ChannelRate xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 ChannelRate xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 ChannelRate xStatus Diagnostics Call n Channel...

Page 172: ...Status Diagnostics Call n Channels OutgoingDataChannel n Netstat 1 MaxJitter Shows the maximum jitter that has been measured during last time interval 5 seconds Value space of the result returned Integer Example xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter 0 end GPIO status xStatus GPIO P...

Page 173: ...the ISDN Gateway if the endpoint is paired to one Value space of the result returned String Example xStatus H320 Gateway Number s H320 Gateway Number end xStatus H320 Gateway Mode Returns information on the type of calls the ISDN Gateway is configured for if the codec is paired with an ISDN Link Value space of the result returned Unknown PRI BRI External G703 Example xStatus H320 Gateway Mode s H3...

Page 174: ...String Example xStatus H323 Gatekeeper Address s H323 Gatekeeper Address 192 0 1 20 end xStatus H323 Gatekeeper Port 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 xStatus H323 Gatekeeper Reason Shows the reason for rejected registration Value space of the result retur...

Page 175: ...on Value space of the result returned String ICE status xStatus ICE Configured Shows the ICE configuration status ICE Interactive Connectivity Establishment RFC 5245 is a NAT traversal solution that the endpoints can use to discover the optimized media path Thus the shortest route for audio and video is always secured between the endpoints Value space of the result returned On Off Example xStatus ...

Page 176: ...upported Mangled ICE cannot route the media because a server such as VCS is set to handle it Value space of the result returned Succeeded Failed Unsupported Mangled Example xStatus ICE Call Result s ICE Call 0 Result Unsupported end xStatus ICE Call Local Candidate Returns the network interface type the local system is using to send media HOST The endpoint sends media from its own IP address PRFLX...

Page 177: ...SIP Profile 1 Turn DiscoverMode is set to On Verified The server was reached and the user name and password were received NotVerified Configuration has been received but neither server or credentials has been verified Failed The server was not reached Off Turn discovery mode is set to Off Value space of the result returned Verified NotVerified Failed Off Example xStatus ICE Turn Discovermode s ICE...

Page 178: ...gAudioChannel 327 Encryption Status s MediaChannels Call 27 IncomingAudioChannel 327 Encryption Status Off end xStatus MediaChannels Call n IncomingAudioChannel n Audio Protocol Shows the audio algorithm for the incoming audio channel AACLD The AAC LD is an MPEG 4 Low Delay Audio Coder audio compression format G722 The G 722 algorithm is an ITU standard G7221 The G 722 1 algorithm is a licensed ro...

Page 179: ... 168 24 190 end xStatus MediaChannels Call n IncomingAudioChannel n Transport RTP Local Port Shows the local UDP port number of the Real time Transport Protocol RTP port for the incoming audio in the media channel Value space of the result returned Integer Example xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Local Port s MediaChannels Call 27 IncomingAudioChannel 327 Transp...

Page 180: ...edia channel Value space of the result returned String Example xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress 192 168 136 130 end xStatus MediaChannels Call n IncomingAudioChannel n Transport RCTP Remote Port Shows the remote UDP port number of the Real time Transport Control Pr...

Page 181: ...ncoming video Value space of the result returned Integer Example xStatus MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX 768 end xStatus MediaChannels Call n IncomingVideoChannel n Video ResolutionY Shows the height resolution in direction Y of the incoming video Value space of the result returned Integer Example x...

Page 182: ... 330 Transport RTCP Local IpAddress s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local IpAddress 192 168 24 190 end xStatus MediaChannels Call n IncomingVideoChannel n Transport RTCP Local Port Shows the local UDP port number of the Real time Transport Control Protocol RTCP port for the incoming video in the media channel Value space of the result returned Integer Example xStatu...

Page 183: ...ls Shows the number of outgoing audio channels Value space of the result returned Integer Example xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels 1 end xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTP Local IpAddress Shows the local IP address of the Real time Transport Protocol RTP port for the ...

Page 184: ...Integer Example xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port 16405 end xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTCP Remote IpAddress Shows the remote IP address of the Real time Transport Control Protocol RTCP port for the outgo ing audio in the media channel Value s...

Page 185: ...o FrameRate Shows the video frame rate of the outgoing channel Value space of the result returned Integer Example xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate s MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate 30 end xStatus MediaChannels Call n OutgoingVideoChannel n Video ResolutionX Shows the width resolution in direction X of the outgoing video Value spa...

Page 186: ...1 Transport RTP Remote Port s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port 50932 end xStatus MediaChannels Call n OutgoingVideoChannel n Transport RTCP Local IpAddress Shows the local IP address of the Real time Transport Control Protocol RTCP port for the outgoing video in the media channel Value space of the result returned String Example xStatus MediaChannels Call 27...

Page 187: ...rotocol s MediaChannels Call 2 IncomingAudioChannel 127 Transport RTCP Remote Protocol UDP end xStatus MediaChannels Call n IncomingAudioChannel n Transport RTP Local Protocol Shows the local transport protocol used for RTP for incoming audio The result Unknown is shown when an address is not available for example during call setup or for channels that are not supported by the far end Value space ...

Page 188: ...ncomingVideoChannel 127 Transport RTP Local Protocol s MediaChannels Call 2 IncomingVideoChannel 127 Transport RTP Local Protocol UDP end xStatus MediaChannels Call n IncomingVideoChannel n Transport RTP Remote Protocol Shows the remote transport protocol used for RTP for incoming video The result Unknown is shown when an address is not available for example during call setup or for channels that ...

Page 189: ...utgoingAudioChannel 127 Transport RTP Local Protocol s MediaChannels Call 2 OutgoingAudioChannel 127 Transport RTP Local Protocol UDP end xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTP Remote Protocol Shows the remote transport protocol used for RTP for outgoing audio The result Unknown is shown when an address is not available for example during call setup or for channels that ...

Page 190: ... for RTP for outgoing video The result Unknown is shown when an address is not available for example during call setup or for channels that are not supported by the far end Value space of the result returned UDP TCP Unknown Example xStatus MediaChannels Call 2 OutgoingVideoChannel 127 Transport RTP Local Protocol s MediaChannels Call 2 OutgoingVideoChannel 127 Transport RTP Local Protocol UDP end ...

Page 191: ...ystem Value space of the result returned String Example xStatus Network 1 IPv4 Address s Network 1 IPv4 Address 192 0 2 149 end xStatus Network 1 IPv4 SubnetMask Shows the subnet mask which determines which subnet an IPv4 address belongs to Value space of the result returned String Example xStatus Network 1 IPv4 SubnetMask s Network 1 IPv4 SubnetMask 255 255 255 0 end xStatus Network 1 IPv4 Gatewa...

Page 192: ...oning server as assigned by DHCP provided the provi sioning server address is defined as a vendor encapsulated option in the DHCP server This status is used only when xConfiguration Provisioning Mode is VCS Value space of the result returned String Example xStatus Network 1 IPv4 DHCP ProvisioningDomain s Network 1 IPv4 DHCP ProvisioningDomain 1234 company com end xStatus Network 1 IPv4 DHCP TftpSe...

Page 193: ...ware C3750E Software C3750E UNIVERSALK9 M Version 15 0 1 SE2 RELEASE SOFTWARE fc3 Technical Support http www cisco com techsupport Copyright c 1986 2011 by Cisco Systems Inc Compiled Thu 22 Dec 11 00 05 by prod _ rel _ team end xStatus Network 1 CDP Capabilities Describes the functional capability for the switch in form of a device type See documentation for CDP protocol for more information Value...

Page 194: ...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 xStatus Network 1 CDP PrimaryMgmtAddress Returns the management address used to configure and monitor the switch the endpoint is connected to Value space of the result returned String Example xStatus Network CDP PrimaryMgmtAddress s Network 1 CD...

Page 195: ...vices status xStatus NetworkServices Shows the top level overview of the network services status xStatus NetworkServices NTP Address Returns the address of the NTP server s the codec is using 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 CurrentAddress Re...

Page 196: ...sence Touch end xStatus Peripherals ConnectedDevice n SoftwareInfo Shows information of the software version running on the connected device Value space of the result returned String Example xStatus Peripherals ConnectedDevice 1007 SoftwareInfo s Peripherals ConnectedDevice 1007 SoftwareInfo TI7 2 0 end xStatus Peripherals ConnectedDevice n Status Shows peripheral devices that are currently connec...

Page 197: ...set status xStatus Preset Shows the top level overview of the camera presets status xStatus Preset 1 15 Defined Shows if a camera preset is stored at this position Value space of the result returned True False Example xStatus Preset 1 Defined s Preset 1 Defined True end xStatus Preset 1 15 Type Shows the camera preset type Value space of the result returned All Camera Example xStatus Preset 1 Type...

Page 198: ...stem is provisioned to This address may either be defined in the xConfiguration ExternalManager Address setting or provided by DHCP Value space of the result returned String Example xStatus Provisioning Server s Provisioning Server 192 0 2 0 end xStatus Provisioning NextRetry If provisioning has failed returns the date and time for the next automatic provisioning attempt Value space of the result ...

Page 199: ...gradeStatus SessionId Shows the ID of the session for the software upgrade Value space of the result returned String Example xStatus Provisioning Software UpgradeStatus SessionId s Provisioning Software UpgradeStatus SessionId end xStatus Provisioning Software UpgradeStatus LastChange Shows the date and time for the latest software upgrade Value space of the result returned String Example xStatus ...

Page 200: ...ftware UpgradeStatus URL http s52000tc5 _ 1 _ 0 pkg end xStatus Provisioning Software UpgradeStatus SecondsUntilUpgrade Indicates how many seconds remain before the software upgrade is automatically installed The upgrade installation can be started manually by issuing the command xCommand Provisioning CompleteUpgrade or postponed with the command xCommand Provisioning PostponeUpgrade Value space o...

Page 201: ... Mode IgnoreAuth end xStatus Provisioning CUCM CAPF ServerName Shows the CAPF server name This can be a hostname a FQDN or an IP address Value space of the result returned IgnoreAuth NullAuth StringAuth LSCAuth MICAuth Example xStatus Provisioning CUCM CAPF ServerName s Provisioning CUCM CAPF ServerName 192 168 0 1 end xStatus Provisioning CUCM CAPF ServerPort Shows the port number to be used for ...

Page 202: ...ion has succeeded Value space of the result returned NotSet CAPFUnknown CAPFInvalidAuthStrLen CAPFInvalidInitReason CAPFInvalidAuthMode CAPFNotNone CAPFNullClnt CAPFNullClntcontext CAPFInvalidUsageStartSession CAPFNullSessiondata CAPFInvalidSession CAPFNullParameters CAPFNoStat CAPFTimeout CAPFConnLost CAPFAbort CAPFKeyGenFailed CAPFConnectFailed CAPFFenceError CAPFServerBusy CAPFAuthRejected CAPF...

Page 203: ...ber the last logged in user on an endpoint Value space of the result returned String Example xStatus Provisioning CUCM ExtensionMobility LastLoggedInUserId s Provisioning CUCM ExtensionMobility LastLoggedInUserId User 1 end xStatus Provisioning CUCM TVS Proxy n Server Returns the address of the TVS server in form of a hostname FQDN or IPv4 address Value space of the result returned String Example ...

Page 204: ...IPS mode status Value space of the result returned On Off Example xStatus Security FIPS Mode s Security FIPS Mode Off end xStatus Security Persistency Configurations Shows whether the systems all configurations are set to persistent or non persistent mode Persistent is the default mode Value space of the result returned NonPersistent Persistent Example xStatus Security Persistency Configurations s...

Page 205: ...ent is the default mode Value space of the result returned NonPersistent Persistent Example xStatus Security Persistency LocalPhonebook s Security Persistency LocalPhonebook Persistent end xStatus Security Persistency DHCP 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...

Page 206: ...atus of the signaling with the SIP Proxy server Value space of the result returned True False Example xStatus SIP Profile 1 Secure s SIP Profile 1 Secure True end xStatus SIP Profile 1 Verified Shows whether or not the SSL certificate of the server that the video system codec tries to regis ter to is included in the codec s trusted CA list The server is typically a Cisco VCS or CUCM True The serve...

Page 207: ...1 CallForward DisplayName s SIP Profile 1 CallForward DisplayName end xStatus SIP Profile 1 Registration n Status Shows the status of the registration to the SIP Proxy Server Deregister The system is in the process of de registering to the SIP Proxy Failed The system failed to register to the SIP Proxy Inactive The system is not registered to any SIP Proxy Registered The system is registered to th...

Page 208: ... to make calls and identify callers Up to five directory URIs can be set but only one of them can be set as primary Value space of the result returned String Example xStatus SIP Profile DirectoryURI Primary URI s SIP Profile 1 DirectoryURI Primary URI 123456 company com end Standby status xStatus Standby Active Shows if the system is in standby or not Value space of the result returned On Off Exam...

Page 209: ...SystemUnit ProductPlatform C90 end xStatus SystemUnit Uptime Shows the number of seconds since the last restart of the codec Value space of the result returned Integer Example xStatus SystemUnit Uptime s SystemUnit Uptime 597095 end xStatus SystemUnit Software Application Shows which software application is running on the codec Value space of the result returned String Example xStatus SystemUnit S...

Page 210: ...temUnit Software OptionKeys MultiSite true end xStatus SystemUnit Software OptionKeys PremiumResolution Shows if the system has the option key installed that supports the PremiumResolution functionality Value space of the result returned String Example xStatus SystemUnit Software OptionKeys PremiumResolution s SystemUnit Software OptionKeys PremiumResolution true end xStatus SystemUnit Software Op...

Page 211: ...t Hardware MainBoard SerialNumber Shows the serial number of the main board in the codec Value space of the result returned String Example xStatus SystemUnit Hardware MainBoard SerialNumber s SystemUnit Hardware MainBoard SerialNumber F1234567 end xStatus SystemUnit Hardware MainBoard Identifier Shows the revision of the main board in the codec Value space of the result returned String Example xSt...

Page 212: ...le xStatus SystemUnit State MaxNumberOfCalls s SystemUnit State MaxNumberOfCalls 3 end xStatus SystemUnit State MaxNumberOfActiveCalls Shows the the maximum number of simultaneous active calls Calls that are set on hold transfer are not counted as active Value space of the result returned 0 5 Example xStatus SystemUnit State MaxNumberOfActiveCalls s SystemUnit State MaxNumberOfActiveCalls 3 end xS...

Page 213: ...s 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 is returned after a failed factory reset attempt SoftwareUpgradeOK This value is returned after a successful software upgrade SoftwareUpgradeFailed This value is returned afte...

Page 214: ...ation ValidPasswords VideoFromInternalCamera VideoInputStability TemperatureCheck Example xStatus SystemUnit Diagnostics Message type s SystemUnit Diagnostics Message 1 Type InvalidAdminPassword end xStatus SystemUnit Diagnostics Message n Level Returns information on the level of the diagnostics message Error There is an error in the system The system can still be used but there can be some restr...

Page 215: ...014 04 25T10 04 03Z end UserInterface status xStatus UserInterface OSD Output Indicates which monitor is used for on screen display output Value space of the result returned Integer Example xStatus UserInterface OSD Output s UserInterface OSD Output 1 end xStatus UserInterface OSD Mode Returns the status of the endpoint s on screen display Full The on screen display is set as the primary user inte...

Page 216: ... connections can be detected Value space of the result returned False True Unknown Example xStatus Video Input Connector 1 Connected s Video Input Connector 1 Connected True end xStatus Video Input Connector n SignalState Shows the signal state for the specified input Unknown The signal format is unknown OK A signal is detected and the signal format is supported Unsupported A signal is detected bu...

Page 217: ... Resolution Height 1080 end xStatus Video Input Source n Resolution Width Shows the resolution width in pixels for the video input source Value space of the result returned 0 4000 Example xStatus Video Input Source 1 Resolution Width s Video Input Source 1 Resolution Width 1920 end xStatus Video Input Source n Resolution RefreshRate Shows the resolution refresh rate Hz for the video input source V...

Page 218: ...deo 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 PresentationOnly Shows presentation video stream if active Recorder Shows all participants including the local main vid...

Page 219: ...Device Name end xStatus Video Output DVI ConnectedDevice PreferredFormat Shows the preferred input format of the monitor connected to the DVI port as defined in the monitors EDID This is not necessarily the format the codec is sending out Value space of the result returned String Example xStatus Video Output DVI ConnectedDevice PreferredFormat s Video Output DVI 2 ConnectedDevice PreferredFormat e...

Page 220: ...nectedDevice CEC 1 PowerControl Ok end xStatus Video Output HDMI 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 feature configured on and the codec has the configuration xConfiguration Video Output HDMI n CEC Mode set to on Value space of the result re...

Page 221: ...tion of the upper left corner of the frame Value space of the result returned 0 10000 Example xStatus Video Layout Site 1 Output 1 Frame 1 PositionX s Video Layout Site 1 Output 1 Frame 1 PositionX 0 end xStatus Video Layout Site n Output n Frame n PositionY Shows the vertical position of the upper left corner of the frame Value space of the result returned 0 10000 Example xStatus Video Layout Sit...

Page 222: ...e s Video Layout Site 1 Output 1 Frame 1 VideoSourceType graphic end xStatus Video Layout Site n Output n Frame n VideoSourceId Shows the video source Id which is used when adding or updating frames See the xCommand Video Layout Frame Add and xCommand Video Layout Frame Update Value space of the result returned Integer Example xStatus Video Layout Site 1 Output 1 Frame 1 VideoSourceId s Video Layo...

Page 223: ... VideoSourceContent wallpaper s Video Layout Site 1 Output 2 Frame 1 VideoSourceContent wallpaper s Video Layout Site 1 Output 3 Frame 1 VideoSourceContent wallpaper s Video Layout Site 1 Output 3 Frame 2 VideoSourceContent gui s Video Layout Site 1 Output 4 Frame 1 VideoSourceContent wallpaper s Video Layout Site 1 Output 5 Frame 1 VideoSourceContent wallpaper end xStatus Video Layout Site n Outp...

Page 224: ...tus Video Selfview PIPPosition s Video Selfview PIPPosition LowerRight end xStatus Video Selfview OnMonitorRole Identifies which monitor s contains the selfview if present Value space of the result returned First Second Third Fourth Example xStatus Video Selfview OnMonitorRole s Video Selfview OnMonitorRole First end xStatus Video PIP ActiveSpeaker Position Shows the position of the active speaker...

Page 225: ...atus Video OSD Mode Value space of the result returned Indicators Full Example xStatus Video OSD Mode s Video OSD Mode Indicators end Experimental status The Experimental status is for testing only and should not be used unless agreed with Cisco These settings are not documented and WILL change in later releases Contents Introduction About the API xConfiguration Appendices xCommand xStatus xStatus...

Page 226: ...Guide TC7 3 OCTOBER 2015 Copyright 2015 Cisco Systems Inc All rights reserved 226 Cisco TelePresence SX80 API Reference Guide Chapter 6 Appendices Contents Introduction About the API xConfiguration Appendices xCommand xStatus Appendices ...

Page 227: ...Command 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 Boot Use the web interface of the codec to create and manage startup scripts Read more about the web interface and startup scripts in the Administrator guide for your product Contents Introdu...

Page 228: ... systemtools authorizedkeys list List the SSH keys on the codec systemtools authorizedkeys clear Clear all SSH keys on the codec systemtools idefixversion Returns the software version of a Touch controller that is connected to the codec systemtools license list Lists all the licenses for the codec systemtools license show name Shows the content of a license file defined by the name name r The name...

Page 229: ...his limit the user will be set inactive Max consecutive equal digits in PINs 0 Maximum consecutive equal digits in PINs Minimum number of digits in PINs 0 Minimum number of digits in PINs Maximum number of digits in PINs 0 Maximum number of digits in PINs Max consecutive identical characters in passwords 0 Maximum consecutive identical characters in passwords Minimum number of characters in passwo...

Page 230: ... 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 CallDisconnect CauseValue...

Page 231: ...E 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 in this document are not intended to be actual addresses and phone numbe...

Reviews:

No comments

Related manuals for SX80

Mobile Multimedia AM/FM/DVD Receiver VM9311

Brand: Jensen Pages: 90

RealPresence Digital Brkout

Brand: Polycom Pages: 2

Studio 500 Series

Brand: JAMO Pages: 16

Brand: Ruida Technology Pages: 35

Brand: Teufel Pages: 20

Meridian Norstar

Brand: Nortel Pages: 18

Brand: 2VV Pages: 19

Brand: 2VV Pages: 24

Brand: Cirrus Logic Pages: 91

Brand: Pioneer Pages: 28

Premier DEH-P560MP

Brand: Pioneer Pages: 162

Brand: Samsung Pages: 11

SoundTower TW-H5500

Brand: Samsung Pages: 20

Brand: Samsung Pages: 34

Brand: Sanyo Pages: 22

Brand: Aastra Pages: 101

Brand: Sony Pages: 13

Brand: Sony Pages: 36

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands