Cisco TelePresence SX20 Reference Manual Download Page 25

Page: 25 / 218

D14949.13

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

Cisco TelePresence SX20 Codec

API Reference Guide

Chapter 3

xConfiguration commands

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xConfiguration

Summary of Contents for TelePresence SX20

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

Page 2: ...ack expressions 19 Terminal connections 20 Using HTTP 21 Getting status and configurations 21 Sending commands and configurations 21 Using HTTP POST 21 Feedback from codec over HTTP 22 Registering for feedback 22 Translating from terminal mode to XML 23 Dos and don ts 24 xConfiguration commands 25 Description of the xConfiguration commands 26 xCommand commands 83 Description of the xCommand comman...

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

Page 4: ...ence 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 User guide for the TelePresence systems Remote Control Quick reference guides for the TelePresence systems Administrator guides for the Tele...

Page 5: ... page on the system s web interface now requires an option key to be installed on the endpoint The remote monitoring option key can only be added to systems that are upgraded to TC7 3 3 and above Remote monitoring is enabled once the option key is added and the system rebooted Once this feature is enabled the only way to disable it is to remove the option key This feature does not display warning ...

Page 6: ...rvices CDP Mode NetworkServices UPnP Mode TC7 3 4 NetworkServices UPnP Timeout TC7 3 4 Configurations that are removed H323 Profile 1 1 Encryption MinKeySize Video AllowWebSnapshots TC7 3 3 Configurations that are modified FacilityService Service 1 5 Name OLD S 0 255 NEW S 0 1024 FacilityService Service 1 5 Number OLD S 0 255 NEW S 0 1024 Video AllowWebSnapshots removed in TC7 3 3 OLD Off On defau...

Page 7: ... 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 Rejected UnacknowledgedMissed Camera Preset Store NEW TakeSnapsh...

Page 8: ...allProtocolIPStackPlatformCompatibility CallProtocolVcsProvisioningCompatibility CameraPairing CameraSoftwareVersion CameraStatus CamerasDetected DefaultCallProtocolRegistered EthernetDuplexMatches H320GatewayStatus H323GatekeeperStatus HasValidReleaseKey IPv4Assignment IPv6Assignment IPv6Mtu ISDNLinkCompatibility ISDNLinkIpStack NTPStatus NetSpeedAutoNegotiated OSDVideoOutput ProvisioningStatus S...

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

Page 10: ...login is required or not A reboot of the codec is required for these settings to take effect xConfiguration SerialPort BaudRate 9600 19200 38400 57600 115200 xConfiguration SerialPort LoginRequired Off On Connecting For the SX20 codec you need a USB to RS 232 adapter to connect to the USB port Note For security reasons the password prompting is turned on by default but it can be turned off if pref...

Page 11: ...rol 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...

Page 12: ...ck mechanism 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 11 Echo on off If echo is set to On the key inputs are displayed when entering 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 in...

Page 13: ...llowing commands will work XCOMMAND DIAL NUMBER foo bar org xcommand dial number foo bar org xCommand Dial Number foo bar org Example 1 List all configurations that include a word that starts with DVI xConfiguration dvi c xConfiguration Video Input DVI 2 RGBQuantizationRange Full c xConfiguration Video Input DVI 2 Type AutoDetect end Example 2 Get the resolution width of all connected sources for ...

Page 14: ...FSend Peripherals UserInterface Call Experimental Phonebook UserManagement CallHistory FacilityService Presentation Video CallLog FarEndControl Preset CamCtrlPip HttpFeedback Provisioning Camera Key Security 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 x...

Page 15: ...eft LowerRight xConfiguration Video SelfviewPosition UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight xConfiguration Video Wallpaper None Custom Growing Summersky Waves Blue OK xConfiguration User Configurations Audio Logging RTP Time Cameras Network Security UserInterface Conference NetworkServices SerialPort Video Experimental Peripherals SIP FacilityService Phonebook...

Page 16: ... 4 PlacedOnHold False s Call 4 Protocol sip s Call 4 ReceiveCallRate 1920 s Call 4 RemoteNumber name company com s Call 4 TransmitCallRate 1920 end Example 2 Query the protocol for a call xStatus Call Protocol s Call 4 Protocol sip OK xStatus Status Audio H320 NetworkServices SystemUnit Call H323 Peripherals Time Camera HttpFeedback Preset UserInterface Cameras ICE Provisioning Video Conference Lo...

Page 17: ...goingCallIndication CallId x end Example 2 Call Disconnect Call Disconnect is an event reported when a call is disconnected Returns the CallId of the disconnected call and reason for the call s disconnection e CallDisconnect CallId x CauseValue 0 CauseString CauseType LocalDisconnect OrigCallDirection outgoing end Example 3 Call Successful Call Succesful is an event reported when a call is connect...

Page 18: ...auseCode 0 h xHistory CallLogs Call 1 DisconnectCauseOrigin Internal h xHistory CallLogs Call 1 DisconnectCauseType LocalDisconnect h xHistory CallLogs Call 1 DisconnectCauseValue 1 h xHistory CallLogs Call 1 Dismissed True h xHistory CallLogs Call 1 DisplayName Name h xHistory CallLogs Call 1 Duration 13 h xHistory CallLogs Call 1 Encryption Aes 128 h xHistory CallLogs Call 1 Protocol Sip h xHist...

Page 19: ...g through some examples we can see how this information can be used to build feedback expressions A good way to verify the expressions is to point your browser to http ip address getxml location path or to execute xgetxml path from the terminal and check that the output matches the nodes you want feedback on Example 1 Microphones Mute status Terminal query xStatus Audio Microphones Mute s Audio Mi...

Page 20: ...he 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...

Page 21: ...mands and configurations 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 h...

Page 22: ...to register its expressions ServerUrl 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 Refer to Feedback mechanism on page 19 Example Registering feedback on configuration changes disconnect events and call status changes Command HttpFeedback Register command True FeedbackSlot 1 FeedbackSlot ServerUrl htt...

Page 23: ... Protocol H323 Protocol Dial 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...

Page 24: ...necessary 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 present one screen to the end user Avoid making the user look at two menus one on the control panel and one on the video screen Do not make the control panel a substitute for the remote con...

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

Page 26: ... 1 Whitebalance Level 35 xConfiguration Cameras Camera 1 DHCP 36 Conference configuration 36 xConfiguration Conference 1 1 ActiveControl Mode 36 xConfiguration Conference 1 1 CallProtocolIPStack 36 xConfiguration Conference 1 1 AutoAnswer Mode 36 xConfiguration Conference 1 1 AutoAnswer Mute 37 xConfiguration Conference 1 1 AutoAnswer Delay 37 xConfiguration Conference 1 1 MicUnmuteOnDisconnect Mo...

Page 27: ...ion Network 1 1 QoS Diffserv Audio 47 xConfiguration Network 1 1 QoS Diffserv Video 47 xConfiguration Network 1 1 QoS Diffserv Data 47 xConfiguration Network 1 1 QoS Diffserv Signalling 48 xConfiguration Network 1 1 QoS Diffserv ICMPv6 48 xConfiguration Network 1 1 QoS Diffserv NTP 48 xConfiguration Network 1 1 IEEE8021X Mode 48 xConfiguration Network 1 1 IEEE8021X TlsVerify 48 xConfiguration Netw...

Page 28: ...nager Domain 58 RTP configuration 59 xConfiguration RTP Ports Range Start 59 xConfiguration RTP Ports Range Stop 59 Security configuration 59 xConfiguration Security Audit Logging Mode 59 xConfiguration Security Audit OnError Action 59 xConfiguration Security Audit Server Address 60 xConfiguration Security Audit Server Port 60 xConfiguration Security Audit Server PortAssignment 60 xConfiguration S...

Page 29: ...deo Input Source 1 2 PresentationSelection 72 xConfiguration Video Input Source 1 2 Visibility 72 xConfiguration Video Input Source 1 2 CameraControl Mode 72 xConfiguration Video Input Source 1 2 CameraControl CameraId 72 xConfiguration Video Input Source 1 2 OptimalDefinition Profile 73 xConfiguration Video Input Source 1 2 OptimalDefinition Threshold60fps 73 xConfiguration Video Input Source 1 2...

Page 30: ...nfiguration Video Output HDMI 1 2 Location HorizontalOffset 80 xConfiguration Video Output HDMI 1 2 Location VerticalOffset 80 xConfiguration Video Output HDMI 1 2 RGBQuantizationRange 80 xConfiguration Video Output HDMI 1 2 CEC Mode 81 xConfiguration Video Output HDMI 1 2 MonitorRole 81 xConfiguration Video Output HDMI 1 2 OverscanLevel 81 xConfiguration Video Output HDMI 1 2 Resolution 81 xConfi...

Page 31: ...Association VideoInputSource setting to define which video source to associate the audio source with Use the Audio Input Line n VideoAssociation MuteOnInactiveVideo setting to define whether to play or mute audio when not presenting the video source Requires user role ADMIN Value space Off On Off The audio source is not associated with a video source The audio will be played locally and to far end...

Page 32: ...hen set to InCallOnly this will prevent the audio system from being muted by mistake Example xConfiguration Audio Microphones Mute Enabled True xConfiguration Audio SoundsAndAlerts KeyTones Mode The system can be configured to make a keyboard click sound effect key tone when pressing a key on the remote control or when typing text or numbers on the Touch controller Requires user role USER Value sp...

Page 33: ...a is able to compensate for any flicker noise from the electrical power supply You should set this camera configuration based on your power line frequency If your camera supports auto detection of line frequency you can select the Auto option in the configuration All Cisco Precision cameras support both anti flickering and auto detection of line frequency Auto is the default value so you should ch...

Page 34: ...ideo 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 came...

Page 35: ...uration Cameras Camera 1 Mirror Auto xConfiguration Cameras Camera 1 MotorMoveDetection This setting applies only when using a Cisco TelePresence PrecisionHD 1080p12x camera If adjusting the camera position by hand you 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 posit...

Page 36: ...nce Video Communication Server VCS version X8 1 or newer Change this setting if you want to disable the active control features Requires user role ADMIN Value space Auto Off Auto Active control is enabled when supported by the infrastructure Off Active control is disabled Example xConfiguration Conference ActiveControl Mode Auto xConfiguration Conference 1 1 CallProtocolIPStack Select if the syste...

Page 37: ...gistered as missed calls The calling side will receive a busy signal A message telling that Do Not Disturb is switched on will display on the Touch controller or main display NOTE This setting is not recommended as all calls will be rejected until the setting is manually turned off The recommended option is Timed Timed When set to timed default the system will revert back and allow incoming calls ...

Page 38: ... of the call protocol based on which protocols are available If multiple protocols are available the order of priority is 1 SIP 2 H323 3 H320 If the system cannot register or the call protocol is not enabled the auto selection chooses H323 H323 All calls are set up as H 323 calls Sip All calls are set up as SIP calls H320 All calls are set up as H 320 calls only applicable if connected to a Cisco ...

Page 39: ...e the bandwidth of the presentation channel Static The available transmit bandwidth is assigned to each video channel even if it is not active Example xConfiguration Conference 1 VideoBandwidth Mode Dynamic xConfiguration Conference 1 1 VideoBandwidth MainChannel Weight The available transmit video bandwidth is distributed on the main channel and presentation channel according to MainChannel Weigh...

Page 40: ...Auto Off MultiSite MultiWay CUCMMediaResourceGroupList Auto The multipoint method available will be choosen automatically if none are available the Multipoint Mode will automatically be set to Off If both MultiWay and MultiSite are available the MultiWay service takes priority over the built in MultiSite Off Multiparty conferences are not allowed MultiSite Multiparty conferences are set up using t...

Page 41: ...s 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 The facility services are not available when using the remote control and on screen menu Requires user role ADMIN Value space S 0 1024 Format String with a maximum of 1024 characters Example xConfiguration FacilityService Service 1...

Page 42: ...le Requires user role ADMIN Value space Off On Off If the H 323 Gatekeeper Authentication Mode is set to Off the system will not try to authenticate itself to a H 323 Gatekeeper but will still try a normal registration On If the H 323 Gatekeeper Authentication Mode is set to On and a H 323 Gatekeeper indicates that it requires authentication the system will try to authenticate itself to the gateke...

Page 43: ...will automatically try to register to any available Gatekeeper If a Gatekeeper responds to the request sent from the codec within 30 seconds this specific Gatekeeper will be used This requires that the Gatekeeper is in auto discovery mode as well If no Gatekeeper responds the system will not use a Gatekeeper for making H 323 calls and hence an IP address must be specified manually Example xConfigu...

Page 44: ...e firewalls consider this as a sign of attack When Dynamic is selected the H 323 ports used are from 11000 to 20999 Once 20999 is reached they restart again at 11000 The ports are automatically selected by the system within the given range Firewall administrators should not try to deduce which ports are used when as the allocation schema within the mentioned range may change without any further no...

Page 45: ...Pv4 Address 192 0 2 2 xConfiguration Network 1 1 IPv4 Gateway Define the IPv4 network gateway This setting is only applicable when the Network Assignment is set to Static Requires user role ADMIN Value space S 0 64 Format A valid IPv4 address Example xConfiguration Network 1 IPv4 Gateway 192 0 2 1 xConfiguration Network 1 1 IPv4 SubnetMask Define the IPv4 network subnet mask This setting is only a...

Page 46: ...erver automatically If this setting is Off or the DHCP server does not support option 150 the TFTP server address must be set manually using the Provisioning ExternalManager Address setting If the Network VLAN Voice Mode setting is Auto and the Cisco Discovery Protocol CDP assigns an ID to the voice VLAN then a request for option 150 will always be sent That is the Network DHCP RequestTFTFServerAd...

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

Page 48: ...ll only take effect if Network QoS Mode is set to Diffserv Define which priority NTP packets should have in the IP network The priority for the packets ranges from 0 to 63 the higher the number the higher the priority The recommended value for NTP is 0 which means best effort If in doubt contact your network administrator The priority set here might be overridden when packets are leaving the netwo...

Page 49: ... identity like EAP PEAP and EAP TTLS If set the anonymous ID will be used for the initial unencrypted EAP Identity Request Requires user role ADMIN Value space S 0 64 Format String with a maximum of 64 characters Example xConfiguration Network 1 IEEE8021X AnonymousIdentity xConfiguration Network 1 1 IEEE8021X Eap Md5 Set the Md5 Message Digest Algorithm 5 mode This is a Challenge Handshake Authent...

Page 50: ...um 20 Mbps Can be used to smooth out bursts in the outgoing network traffic Example xConfiguration Network 1 TrafficControl On xConfiguration Network 1 1 RemoteAccess Allow Define which IP addresses IPv4 IPv6 are allowed for remote access to the codec from SSH Telnet HTTP HTTPS Multiple IP addresses are separated by a white space A network mask IP range is specified by ip address N where N is 1 32...

Page 51: ...IN Value space Off On Off The CDP daemon is disabled On The CDP daemon is enabled Example xConfiguration NetworkServices CDP Mode On xConfiguration NetworkServices H323 Mode Determine whether the system should be able to place and receive H 323 calls or not Requires user role ADMIN Value space Off On Off Disable the possibility to place and receive H 323 calls On Enable the possibility to place an...

Page 52: ...e xConfiguration NetworkServices XMLAPI Mode On xConfiguration NetworkServices MultiWay Address The MultiWay address must be equal to the Conference Factory Alias as configured on the Video Communication Server The MultiWay conferencing enables video endpoint users to introduce a 3rd party into an existing call MultiWay can be used in the following situations 1 When you want to add someone else in...

Page 53: ...ng certificate has been revoked then the HTTPS connection will not be used Requires user role ADMIN Value space Off On Off Disable OCSP support On Enable OCSP support Example xConfiguration NetworkServices HTTPS OCSP Mode Off xConfiguration NetworkServices HTTPS OCSP URL Specify the URL of the OCSP responder server that will be used to check the certificate status Requires user role ADMIN Value sp...

Page 54: ...d system contact SNMP traps are not supported Requires user role ADMIN Value space S 0 64 Format A valid IPv4 address IPv6 address or DNS name Example xConfiguration NetworkServices SNMP Host 1 Address xConfiguration NetworkServices SNMP CommunityName Enter the name of the Network Services SNMP Community SNMP Community names are used to authenticate SNMP requests SNMP requests must have a password...

Page 55: ...ted When participating in a best effort CTMS meeting the meeting will be downgraded to non secure not encrypted BestEffort The video system can negotiate encryption parameters with CTMS and participate in a secure CTMS meeting encrypted Do not use this value if the CTMS version is older than 1 9 1 Example xConfiguration NetworkServices CTMS Encryption Off xConfiguration NetworkServices UPnP Mode F...

Page 56: ...one touch panel should be connected to the video system 0 5 This number of Touch controllers should be connected to the video system Example xConfiguration Peripherals Profile TouchPanels NotSet Phonebook configuration xConfiguration Phonebook Server 1 1 ID Enter a name for the external phone book Requires user role ADMIN Value space S 0 64 Format String with a maximum of 64 characters Example xCo...

Page 57: ...ce Management System VCS The video system will be configured using VCS Cisco TelePresence Video Communication Server Callway The video system will be configured using the WebEx TelePresence subscription service formerly named Callway CUCM The video system will be configured using CUCM Cisco Unified Communications Manager Edge The system will connect to CUCM via the Collaboration Edge infrastructur...

Page 58: ... CUCM When the main CUCM is available again the endpoint will be provisioned by this CUCM Requires user role ADMIN Value space S 0 64 Format A valid IPv4 address IPv6 address or DNS name Example xConfiguration Provisioning ExternalManager AlternateAddress xConfiguration Provisioning ExternalManager Protocol Determine whether to use secure management or not Requires user role ADMIN Value space HTTP...

Page 59: ...d port number for the audit server in the Security Audit Server Address and Security Audit Server Port settings Requires user role AUDIT Value space Off Internal External ExternalSecure Off No audit logging is performed Internal The system records the audit logs to internal logs and rotates logs when they are full External The system sends the audit logs to an external syslog server The syslog ser...

Page 60: ... ExternalSecure To see which port number is used you can check the Security Audit Server Port status Navigate to Configuration System status on the web interface or if on a command line interface run the command xStatus Security Audit Server Port Requires user role AUDIT Value space Auto Manual Auto Will use UDP port number 514 when the Security Audit Logging Mode is set to External Will use TCP p...

Page 61: ...ion xConfiguration SIP ANAT ANAT Alternative Network Address Types enables media negotiation for multiple addresses and address types as specified in RFC 4091 Requires user role ADMIN Value space Off On Off Disable ANAT On Enable ANAT Example xConfiguration SIP ANAT Off xConfiguration SIP AuthenticateTransferror Not applicable in this version xConfiguration SIP ListenPort Turn on or off the listen...

Page 62: ...Auto xConfiguration SIP Profile 1 1 Ice DefaultCandidate This is the default IP address that the endpoint will receive media on until ICE has reached a conclusion about which media route to use up to the first 5 seconds of a call Requires user role ADMIN Value space Host Rflx Relay Host The endpoint will receive media on its own IP address Rflx The endpoint will receive media on its public IP addr...

Page 63: ... xConfiguration SIP Profile 1 URI sip firstname lastname company com xConfiguration SIP Profile 1 1 DisplayName When configured the incoming call will report the DisplayName instead of the SIP URI Requires user role ADMIN Value space S 0 255 Format String with a maximum of 255 characters Example xConfiguration SIP Profile 1 DisplayName xConfiguration SIP Profile 1 1 Authentication 1 1 LoginName Th...

Page 64: ... proxies can be addressed Requires user role ADMIN Value space S 0 255 Format If SIP Profile Outbound is enabled use a fully qualified domain name If SIP Profile Outbound is disabled you can also use a valid IPv4 address or IPv6 address Example xConfiguration SIP Profile 1 Proxy 1 Address xConfiguration SIP Profile 1 1 Proxy 1 4 Discovery Select if the SIP Proxy address is to be obtained manually ...

Page 65: ...e system will not enter standby mode On Enter standby mode when the Standby Delay has timed out Requires the Standby Delay to be set to an appropriate value Example xConfiguration Standby Control On xConfiguration Standby Delay Define how long in minutes the system shall be in idle mode before it goes into standby mode Requires the Standby Control to be enabled Requires user role ADMIN Value space...

Page 66: ...iguration xConfiguration SystemUnit Name Define the system name The system name will be sent as the hostname in a DHCP request and when the codec is acting as an SNMP Agent Define the system name The system name will be sent as the hostname in a DHCP request and when the codec is acting as an SNMP Agent Requires user role ADMIN Value space S 0 50 Format String with a maximum of 50 characters Examp...

Page 67: ...rofile 1 1 DisplayName setting Example xConfiguration SystemUnit ContactInfo Type Auto xConfiguration SystemUnit IrSensor The codec has a short range IR sensor underneath the power button It may be used with the remote control but it is not intended for regular operation It should be used only when required for troubleshooting or system recovery In regular operation the IR sensor on the camera sho...

Page 68: ...merica Thule America Thunder_Bay America Tijuana America Toronto America Tortola America Vancouver America Virgin America Whitehorse America Winnipeg America Yakutat America Yellowknife Antarctica Casey Antarctica Davis Antarctica DumontDUrville Antarctica Macquarie Antarctica Mawson Antarctica McMurdo Antarctica Palmer Antarctica Rothera Antarctica South_Pole Antarctica Syowa Antarctica Vostok Ar...

Page 69: ...ng list or dial pad the Touch controller will display on wake up Requires user role USER Value space None LastUsed ContactList MeetingList Dialpad None None of the below options will appear as default on the Touch controller LastUsed The last used contact list meeting list or dial pad will appear as default on the Touch controller ContactList The contact list favorites directory and history will a...

Page 70: ...CtrlPip CallSetup Mode setting is switched On In this case the number of seconds set here determines for how long self view is shown before it is automatically switched off Requires user role ADMIN Value space 1 60 Range Choose for how long self view remains on The valid range is between 1 and 60 seconds Example xConfiguration Video CamCtrlPip CallSetup Duration 10 xConfiguration Video DefaultPres...

Page 71: ...foframe is available RGB quantization range is selected based on video format according to CEA 861 E Full Full quantization range The R G B quantization range includes all code values 0 255 This is defined in CEA 861 E Limited Limited Quantization Range R G B quantization range that excludes some code values at the extremes 16 235 This is defined in CEA 861 E Example xConfiguration Video Input 1 H...

Page 72: ...ect mode the content on the input source will be presented on screen when a cable is connected Otherwise the behavior is like when in manual mode Hidden In hidden mode the contents of the input source do not appear in the graphical user interface Example xConfiguration Video Input Source 1 PresentationSelection Manual xConfiguration Video Input Source 1 2 Visibility Define the visibility of the vi...

Page 73: ...e bandwidth is adequate Requires user role ADMIN Value space 512_288 768_448 1024_576 1280_720 1920_1080 Never 512_288 Set the threshold to 512x288 768_448 Set the threshold to 768x448 1024_576 Set the threshold to 1024x576 1280_720 Set the threshold to 1280x720 1920_1080 Set the threshold to 1920x1080 Never Do not set a threshold for transmitting 60fps Example xConfiguration Video Input Source 1 ...

Page 74: ...Example xConfiguration Video Layout LocalLayoutFamily Auto xConfiguration Video Layout PresentationDefault View Determine how the presentation will show on screen when you start sharing a presentation Requires user role ADMIN Value space Default Minimized Maximized Default The presentation is a part of the layout Minimized The presentation starts up in PIP mode Maximized The presentation starts up...

Page 75: ...etting only takes effect when using a video layout where the active speaker is a PiP i e the Overlay layout or possibly a Custom layout see the Video Layout LocalLayoutFamily setting The setting takes effect from the next call onwards if changed during a call it will have no effect on the current call Requires user role ADMIN Value space Current UpperLeft UpperCenter UpperRight CenterLeft CenterRi...

Page 76: ...if it was off during the call it remains off after the call On self view is switched on when leaving a call Example xConfiguration Video SelfviewDefault Mode Current xConfiguration Video SelfviewDefault FullscreenMode Determine if the main video source self view shall be shown in full screen or as a small picture in picture PiP after a call The setting only takes effect when self view is switched ...

Page 77: ...cipants in the call are shown on the monitor with monitor role First and the presentation is shown on the monitor with monitor role Second DualPresentationOnly All participants in the call are shown on the monitor with monitor role First If a presentation is part of the layout the presentation is shown on the monitor with monitor role Second Example xConfiguration Video Monitors Auto xConfiguratio...

Page 78: ...on indicator is not shown at all AlwaysOn The encryption indicator is displayed on screen during the entire call This applies to both encrypted and non encrypted calls for all Conference Encryption Mode settings AlwaysOff The encryption indicator is never displayed on screen This applies to both encrypted and non encrypted calls for all Conference Encryption Mode settings Example xConfiguration Vi...

Page 79: ...D to be sent to one specific output select 1 for HDMI output or select 2 for DVI I output Make sure you connect a monitor to the corresponding video output connector Example xConfiguration Video OSD Output Auto xConfiguration Video OSD InputMethod InputLanguage The codec can be enabled for Cyrillic input characters in the menus on screen Requires that Video OSD InputMethod Cyrillic is set to On Re...

Page 80: ...egative horizontal offset indicates that the monitor is left of center and a positive horizontal offset indicates that the monitor is right of center A negative vertical offset indicates that the monitor is below center and a positive vertical offset indicates that the monitor is above center The magnitude of the offset indicates how far the display is from center relative to other displays Exampl...

Page 81: ...s outputs with this monitor role are disregarded by the Video Monitors setting Example xConfiguration Video Output HDMI 1 MonitorRole First xConfiguration Video Output HDMI 1 2 OverscanLevel Some monitors may not present the entire image that they receive This means that the outer parts of the image that is sent from the video system may be cut off when displayed on the monitor Use this setting to...

Page 82: ...om Growing Summersky Waves Blue None There is no background image on the screen i e the background is black Custom Use the custom wallpaper as background image on the screen If no custom wallpaper is uploaded to the system the setting will revert to the default value Growing Summersky Waves Blue The chosen background image is shown on the screen Example xConfiguration Video Wallpaper Summersky Exp...

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

Page 84: ...sconnectAll 92 xCommand Call ExtendConference 92 xCommand Call Hold 92 xCommand Call HoldAll 92 xCommand Call Ignore 93 xCommand Call Join 93 xCommand Call Modify 93 xCommand Call Reject 93 xCommand Call Resume 93 xCommand Call UnattendedTransfer 93 CallHistory commands 94 xCommand CallHistory AcknowledgeAllMissedCalls 94 xCommand CallHistory AcknowledgeMissedCall 94 xCommand CallHistory DeleteAll...

Page 85: ...ra Stop 103 xCommand FarEndControl Preset Activate 103 xCommand FarEndControl Preset Store 103 xCommand FarEndControl Source Select 104 HttpFeedback commands 104 xCommand HttpFeedback Deregister 104 xCommand HttpFeedback Register 104 Key commands 105 xCommand Key Click 105 xCommand Key Press 105 xCommand Key Release 105 Logging commands 105 xCommand Logging ExtendedLogging Start 105 xCommand Loggi...

Page 86: ...et 119 xCommand SystemUnit ConfigurationProfile CancelChange 119 xCommand SystemUnit ConfigurationProfile Change 119 xCommand SystemUnit ConfigurationProfile List 119 xCommand SystemUnit ConfigurationProfile Remove 120 xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs 120 xCommand SystemUnit DateTime Get 120 xCommand SystemUnit DateTime Set 120 xCommand SystemUnit Diagnostics Run...

Page 87: ...eo Layout SetPresentationView 124 xCommand Video Matrix Assign 125 xCommand Video Matrix Reset 125 xCommand Video Matrix Swap 125 xCommand Video Matrix Unassign 125 xCommand Video OSD Close 125 xCommand Video PIP ActiveSpeaker Set 126 xCommand Video PIP Presentation Set 126 xCommand Video PictureLayoutSet 126 xCommand Video PreviewFilmstrip Set 126 xCommand Video Selfview Set 127 Experimental comm...

Page 88: ...uires user role USER Example xCommand Audio SoundsAndAlerts Ringtone List r AudioRingtoneListResult Ringtone 1 Id Sunrise r AudioRingtoneListResult Ringtone 2 Id Mischief r AudioRingtoneListResult Ringtone 3 Id Ripples r AudioRingtoneListResult Ringtone 4 Id Reflections r AudioRingtoneListResult Ringtone 5 Id Vibes r AudioRingtoneListResult Ringtone 6 Id Delight r AudioRingtoneListResult Ringtone ...

Page 89: ...ple 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 connector given by type and ID Requires user role USER Parameters ConnectorType r HDMI Line Microphone ConnectorId r 1 4 Example xCommand Audio VUMeter Start Co...

Page 90: ...res user role USER Parameters Days 1 365 DayOffset 0 365 Limit 1 65534 Offset 0 65534 Example Example 1 One booking in list xCommand Bookings List OK r Bookings ResultInfo TotalRows 1 r Bookings LastUpdated 2011 09 02T11 19 01Z r Bookings Booking 1 Id 273 r Bookings Booking 1 Title Sales meeting r Bookings Booking 1 Agenda Describe this command r Bookings Booking 1 Privacy Public r Bookings Bookin...

Page 91: ...kings Booking 1 Encryption BestEffort r Bookings Booking 1 Role Slave r Bookings Booking 1 Recording Disabled r Bookings Booking 1 DialInfo Calls Call 1 Number 91123456 conference id 2100170569 r Bookings Booking 1 DialInfo Calls Call 1 Protocol SIP r Bookings Booking 1 DialInfo Calls Call 1 CallRate 3000 r Bookings Booking 1 DialInfo Calls Call 1 CallType Video r Bookings Booking 1 DialInfo Conne...

Page 92: ... for the call with the specified CallId For this command to apply the following are required 1 The result from the xStatus Conference Site CallId ConferenceExtended must be NotExtended s Conference Site CallId ConferenceExtended NotExtended 2 The following tag from the bookings list command must have a value 0 r Bookings Booking bookingNumber MaximumMeetingExtension 30 Note The command returns the...

Page 93: ...CallId 16 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 put on hold The Ca...

Page 94: ...s 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...

Page 95: ...lt 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 IsAcknowl...

Page 96: ...og Missed command Requires user role USER Parameters LogTag 0 2147483647 Example xCommand CallLog Missed Dimissed LogTag 119 xCommand CallLog Outgoing Delete Delete the call log of outgoing calls If a logtag is given as argument that specific call is deleted from the log If no logtag is given the system deletes the complete outgoing calls log The LogTag values for outgoing calls are found by issui...

Page 97: ...ues 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 1 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...

Page 98: ...ange 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 Li...

Page 99: ... user 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 singl...

Page 100: ...nctionality If the camera is daisy chained the CameraId is given by its place in the chain Requires user role USER Parameters CameraId r 1 1 Example xCommand Camera TriggerAutofocus CameraId 1 Conference commands xCommand Conference ActiveSpeaker Reset Resets ActiveSpeaker Normal voice switching is switched back on Requires user role USER Example xCommand Conference ActiveSpeaker Reset xCommand Co...

Page 101: ...for 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 T...

Page 102: ...String 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 ...

Page 103: ...n the 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...

Page 104: ...ack over HTTP S Requires user role USER Parameters FeedbackSlot r 1 4 Example xCommand HttpFeedback Deregister FeedbackSlot 1 xCommand HttpFeedback Register Register the system to a HTTP S server to return XML feedback over HTTP S to specific URLs FeedbackSlot You can have from 1 to 4 slots for feedback ServerUrl Define the URL for the HTTP S server Expression 1 15 What parts of the Status and Con...

Page 105: ... ZoomIn ZoomOut Example xCommand Key Press Key Home xCommand Key Release Emulates a remote control key release The Key Release command is issued after a Key Press command Requires user role ADMIN Parameters Key r 0 1 2 3 4 5 6 7 8 9 C Call Disconnect Down F1 F2 F3 F4 F5 Grab Home Layout Left Mute MuteMic Ok PhoneBook Presentation Right Selfview Square SrcAux SrcCamera SrcDocCam SrcPc SrcVcr Star U...

Page 106: ...and Message Alert Clear message has been sent Requires user role ADMIN Parameters Title S 0 255 Text r S 0 255 Duration 0 3600 Example xCommand Message Alert Display Title Message Text The meeting will end in 5 minutes Duration 20 xCommand Message Echo Issuing the command makes the API raise a message echo event The command has no other impact on the codec Usage can be to poll the codec from a con...

Page 107: ...y other tags will appear as plain text FeedbackId To identify the feedback enter a FeedbackId Option 1 to Option 5 Enter the text to appear on the feedback options Requires user role ADMIN Parameters Title S 0 255 Text r S 0 255 FeedbackId S 0 255 Option 1 S 0 255 Option 2 S 0 255 Option 3 S 0 255 Option 4 S 0 255 Option 5 S 0 255 Example xCommand Message Prompt Display Title Meeting extension Tex...

Page 108: ...r peripherals that are connected to the codec such as control systems and touch panels The registered peripherals are displayed on the web interface under Configuration Peripherals This command should be used when the peripheral connects to the codec for the first time or when the software version on the peripheral has changed The list of connected devices is available with the command xStatus Per...

Page 109: ... URL r S 0 1024 Username S 0 64 Example xCommand Peripherals ManualUpgrade Product Precision 60 Camera URL http softwareupload company com xCommand Peripherals Pairing DeviceDiscovery Start Start device discovery to detect ISDN Links in the same network AutoPairing You can select to automatically pair the detected device to the endpoint DeviceType Only look for ISDN Link Timeout Set a maximum time...

Page 110: ... contact methods are available in the API on the web interface and when using the remote control Name The name of the contact FolderId The unique identifier for the folder that you want to store the contact in The identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder ImageURL Currently n...

Page 111: ...n already tagged contact Requires user role USER Parameters ContactId r S 0 255 Name S 0 255 FolderId S 0 255 ImageURL S 0 255 Title S 0 255 Tag Untagged Favorite Example xCommand Phonebook Contact Modify ContactId localContactId 1 Name John Doe office xCommand Phonebook ContactMethod Add Add contact details for an existing contact in the local phonebook The command returns the ContactMethodId whi...

Page 112: ...ls about the contact method for an existing contact in 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 ContactMethodId The unique identifier for the contact method you want to modify The identifier will be re...

Page 113: ...fier for the folder The identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder Requires user role USER Parameters FolderId r S 0 255 Example xCommand Phonebook Folder Delete FolderId localGroupId 3 xCommand Phonebook Folder Modify Modify an existing phonebook folder FolderId The unique id...

Page 114: ...earching the local phone book The setting determines whether a local phone book search should be limited to the given FolderId or also recursively search in its subfolders If not specified the search will be recursive When issuing the command without specifying any parameters all folders contacts and contact methods in the local phone book will be returned Tag Limits the search to either contacts ...

Page 115: ...USER Parameters Instance 1 2 3 4 5 6 Example xCommand Presentation Stop Preset commands xCommand Preset Activate Activate one of the stored local presets Note that information about all video input sources and pan tilt zoom and focus values for all cameras are included in the same preset In contrast the xCommand Camera Preset commands applies to individual cameras only PresetId The ID of the prese...

Page 116: ...All Camera Description S 0 255 Example xCommand Preset Store PresetId 3 Type Camera Description Left view Provisioning commands xCommand Provisioning CUCM CAPF OperationStart Starts a pending CAPF Certificate Authority Proxy Function operation toward the CUCM When the CUCM administrator initiates an operation that the endpoint should perform like installing updating or deleting certificates this c...

Page 117: ...ITL Show Shows the content of the installed Identity Trust List file ITL if it exists Each entry displayed contains the information about one specific certificate If a certificate has been deleted in CTL it is marked accordingly in the output Requires user role USER Example xCommand Provisioning CUCM ITL Show xCommand Provisioning CompleteUpgrade Starts installing the software upgrade if you wish ...

Page 118: ...cified feature does not persist a reboot of the system Persistent mode is the default This command reboots the system Configuration In non persistent mode all configurations are set back to default when the system reboots CallHistory In non persistent mode call history is deleted when the system reboots InternalLogging In non persistent mode eventlog is deleted when the system reboots LocalPhonebo...

Page 119: ...xCommand Standby ResetTimer Delay 10 SystemUnit commands xCommand SystemUnit AdminPassword Set Set a password for the user that is currently signed in Requires user role ADMIN Parameters Password r S 0 64 Example xCommand SystemUnit AdminPassword Set Password xCommand SystemUnit ConfigurationProfile CancelChange Cancel the ConfigurationProfile Change command that would otherwise take effect after ...

Page 120: ...the date and time for the system if not available from NTP Network Time Protocol Requires user role ADMIN Parameters Year 2008 2037 Month 1 12 Day 1 31 Hour 0 23 Minute 0 59 Second 0 59 Example xCommand SystemUnit DateTime Set Year 2012 Month 7 Day 3 Hour 12 Minute 0 Second 0 xCommand SystemUnit Diagnostics Run This command runs all self diagnostics commands on the system Requires user role ADMIN ...

Page 121: ...xCommand SystemUnit Notifications RemoveAll xCommand SystemUnit OptionKey Add Add an option key to support additional features Requires user role ADMIN Parameters Key r S 16 24 Example xCommand SystemUnit OptionKey Add Key xCommand SystemUnit OptionKey List List all option keys that have been added to the system Added in TC7 3 3 Requires user role ADMIN Example xCommand SystemUnit OptionKey List x...

Page 122: ...e S 0 255 Password S 0 255 Example xCommand SystemUnit SoftwareUpgrade URL ftp ftp _ server _ 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...

Page 123: ...to 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 rem...

Page 124: ...rt Disable xCommand Video AutoPresentationStart Enable Not in use in this software version Requires user role ADMIN Example xCommand Video AutoPresentationStart Enable 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 d...

Page 125: ...ample xCommand Video Matrix Reset Output 1 xCommand Video Matrix Swap Swap the content defined with xCommand Video Matrix Assign between two outputs xCommand Video Matrix commands are a smart overlay to the xCommand Video Layout commands to make it easy to do simple video compositions OutputA The output you are swapping from OutputB The output you are swapping to Requires user role USER Parameters...

Page 126: ...n the upper left corner of the screen UpperRight The presentation PiP appears in the upper right corner of the screen Requires user role ADMIN Parameters Position r CenterLeft CenterRight LowerLeft LowerRight UpperCenter UpperLeft UpperRight Example xCommand Video PIP Presentation Set Position LowerLeft xCommand Video PictureLayoutSet Select the screen layout mode Target Select if the target is th...

Page 127: ...iew PiP appears in the lower right corner of the screen UpperCenter The self view PiP appears on top of the screen in center UpperLeft The self view PiP appears in the upper left corner of the screen UpperRight The self view PiP appears in the upper right corner of the screen OnMonitorRole Displays self view on monitors with this role Requires user role ADMIN Parameters Mode On Off FullscreenMode ...

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

Page 129: ...rdwareID 142 xStatus Camera n Manufacturer 142 xStatus Camera n Model 143 xStatus Camera n SoftwareID 143 xStatus Camera n SerialNumber 143 xStatus Camera n IpAddress 143 xStatus Camera n MacAddress 143 xStatus Camera n Position Pan 143 xStatus Camera n Position Tilt 143 xStatus Camera n Position Zoom 144 xStatus Camera n Position Focus 144 xStatus Camera n Capabilities Options 144 xStatus Camera ...

Page 130: ...el n Netstat 1 Packets 152 xStatus Diagnostics Call n Channels OutgoingAudioChannel n Netstat 1 Packets 152 xStatus Diagnostics Call n Channels OutgoingVideoChannel n Netstat 1 Packets 152 xStatus Diagnostics Call n Channels OutgoingDataChannel n Netstat 1 Packets 152 xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 Loss 152 xStatus Diagnostics Call n Channels IncomingVideoChan...

Page 131: ...tus HttpFeedback 1 4 URL 158 xStatus HttpFeedback 1 4 Expression 1 15 158 ICE status 158 xStatus ICE Configured 158 xStatus ICE Defaultcandidate 158 xStatus ICE Turn IP 158 xStatus ICE Turn Hostname 159 xStatus ICE Turn Username 159 xStatus ICE Turn Transport 159 xStatus ICE Call Result 159 xStatus ICE Call Local Candidate 159 xStatus ICE Call Local IP 159 xStatus ICE Call Remote Candidate 160 xSt...

Page 132: ...gVideoChannel n Transport RTCP Local IpAddress 169 xStatus MediaChannels Call n OutgoingVideoChannel n Transport RTCP Local Port 169 xStatus MediaChannels Call n OutgoingVideoChannel n Transport RTCP Remote IpAddress 169 xStatus MediaChannels Call n OutgoingVideoChannel n Transport RCTP Remote Port 170 xStatus MediaChannels Call n IncomingAudioChannel n Transport RTCP Local Protocol 170 xStatus Me...

Page 133: ...reviousUpgrade URL 182 xStatus Provisioning Software UpgradeStatus SessionId 182 xStatus Provisioning Software UpgradeStatus LastChange 182 xStatus Provisioning Software UpgradeStatus Status 182 xStatus Provisioning Software UpgradeStatus Phase 182 xStatus Provisioning Software UpgradeStatus Message 183 xStatus Provisioning Software UpgradeStatus VersionId 183 xStatus Provisioning Software Upgrade...

Page 134: ...e 194 xStatus SystemUnit Software MaxVideoCalls 194 xStatus SystemUnit Software MaxAudioCalls 194 xStatus SystemUnit Software ReleaseKey 194 xStatus SystemUnit Software OptionKeys NaturalPresenter 195 xStatus SystemUnit Software OptionKeys MultiSite 195 xStatus SystemUnit Software OptionKeys PremiumResolution 195 xStatus SystemUnit Software OptionKeys HighDefinition 195 xStatus SystemUnit Software...

Page 135: ...05 xStatus Video Layout Mode 205 xStatus Video Layout PresentationView 205 xStatus Video Layout Site n Output n FamilyName 206 xStatus Video Layout Site n Output n FullFamilyName 206 xStatus Video Layout Site n Output n GraphicName 206 xStatus Video Layout Site n Output n Frame n PositionX 206 xStatus Video Layout Site n Output n Frame n PositionY 206 xStatus Video Layout Site n Output n Frame n W...

Page 136: ...c API Reference Guide xStatus Video Selfview OnMonitorRole 210 xStatus Video PIP ActiveSpeaker Position 210 xStatus Video PIP Presentation Position 210 xStatus Video OSD Output 210 xStatus Video OSD Mode 210 xStatus Video OSD Style 210 Experimental status 211 Contents Introduction About the API xConfiguration Appendices xCommand xStatus xStatus ...

Page 137: ... 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 65534 Example xStatus Audio Input RemoteInput 8 CallId s Audio Input RemoteInput 8 CallId 28 end xStatus Audio Input Connectors Microphone n ConnectionStatus Indicates whether a microphone is detected on the microphone input c...

Page 138: ...atus 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 initiation You can run the command ...

Page 139: ... the 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 2...

Page 140: ... call 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 A...

Page 141: ...rned 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 ...

Page 142: ... Camera 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 lef...

Page 143: ...tions 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...

Page 144: ...Resolution Height 0 end xStatus Conference Presentation Resolution Width Shows the width of the the presentation Value space of the result returned 0 4000 Example xStatus Conference Presentation Resolution Width s Conference Presentation Resolution Width 0 end xStatus Conference Presentation SiteId Shows the identity of the system that sends the presentation Value space of the result returned 0 65...

Page 145: ...Instance 1 LocalSource 1 end xStatus Conference Site n Capabilities FECC NumberOfPresets Shows the number of presets available for the input sources at a far end site Value space of the result returned 1 15 Example xStatus Conference Site 2 Capabilities FECC NumberOfPresets s Conference Site 2 Capabilities FECC NumberOfPresets 15 end xStatus Conference Site n Capabilities FECC NumberOfSources Show...

Page 146: ... end xStatus Conference Site n Capabilities Presentation Lists the presentation capabilities for other participants in the conference Value space of the result returned True False Example xStatus Conference Site 2 Capabilities Presentation s Conference Site 2 Capabilities Presentation True end xStatus Conference Site n MicrophonesMuted Lists the audio mute status for other participants in the conf...

Page 147: ... space of the result returned Unsupported NotExtended Extended Example xStatus Conference Site 2 ConferenceExtended s Conference Site 2 ConferenceExtended NotExtended end xStatus Conference Site n BookingId Shows the booking ID of a conference if assigned The booking ID can be used for easy identification of a call or conference Value space of the result returned String Example xStatus Conference ...

Page 148: ...P Value space of the result returned String Example xStatus Conference Site CalText s Conference Site 14 CalText end xStatus Conference Site n Hold Indicates whether the far end site can be placed on hold or not Value space of the result returned True False Example xStatus Conference Site Hold s Conference Site 2 Hold True end xStatus Conference Site n Preserved Indicates if the far end site is ha...

Page 149: ...ltiWay MultiSite Auto CUCMMediaResourceGroupList Example xStatus Conference Multipoint Mode s Conference Multipoint Mode MultiWay end xStatus Conference DoNotDisturb Shows whether DoNotDisturb mode is switched on or not Value space of the result returned Active Inactive Example xStatus Conference DoNotDisturb s Conference DoNotDisturb Inactive end xStatus Conference ActiveSpeaker Mode Shows whethe...

Page 150: ...ostics Call n Channels IncomingAudioChannel n Netstat 1 Jitter xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 Jitter xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 Jitter xStatus Diagnostics Call n Channels OutgoingAudioChannel n Netstat 1 Jitter xStatus Diagnostics Call n Channels OutgoingVideoChannel n Netstat 1 Jitter xStatus Diagnostics Call n Channel...

Page 151: ...tatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets 405 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 Loss xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 Loss xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 Loss xStatus Diagnostics C...

Page 152: ...nel 327 Netstat 1 LastIntervalLost s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost 0 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 LastIntervalReceived xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 LastIntervalReceived xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 LastIntervalReceived xStatus ...

Page 153: ... Call 27 Channels OutgoingDataChannel 327 Netstat 1 Drop s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Drop 0 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 Bytes xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 Bytes xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 Bytes xStatus Diagnostics Call n Channels Outgoin...

Page 154: ...ls OutgoingDataChannel 327 Netstat 1 ChannelRate s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate 128000 end xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 MaxJitter xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 MaxJitter xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 MaxJitter xStatus Diagnostics Call n ...

Page 155: ...of the ISDN Gateway if the endpoint is paired to one Value space of the result returned String Example xStatus H320 Gateway Number s H320 Gateway Number end 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...

Page 156: ...ed 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 re...

Page 157: ...ation 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 xStat...

Page 158: ...t supported 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 PR...

Page 159: ...on 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 ...

Page 160: ...mingAudioChannel 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...

Page 161: ...192 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 Tra...

Page 162: ...dia 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 Pro...

Page 163: ...ll n IncomingVideoChannel n Video ResolutionX Shows the width resolution in direction X of the incoming 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 reso...

Page 164: ...nel 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 xSt...

Page 165: ...nnels 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 t...

Page 166: ...ed 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 outgoing audio in the media channel Value...

Page 167: ...ue 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 space of the result returned Integer Example xStatus MediaChannels Ca...

Page 168: ... 331 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...

Page 169: ...e Protocol 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 spa...

Page 170: ...2 IncomingVideoChannel 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 th...

Page 171: ...2 OutgoingAudioChannel 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 th...

Page 172: ...sed 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 e...

Page 173: ...e 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 Gateway Shows the address of ...

Page 174: ...d only when xConfiguration Provisioning Mode is VCS Value space of the result returned String Example xStatus Network 1 IPv4 DHCP ProvisioningServer s Network 1 IPv4 DHCP ProvisioningServer 192 0 2 0 end xStatus Network 1 IPv4 DHCP ProvisioningDomain Returns the SIP domain of the VCS provisioning server as assigned by DHCP provided the provisioning server address is defined as a vendor encapsulate...

Page 175: ...e xStatus Network CDP Platform s Network 1 CDP Platform cisco WS C3750X 48P end xStatus Network 1 CDP Version Returns information about the software release version the switch is running Value space of the result returned String Example xStatus Network CDP Version s Network 1 CDP Version Cisco IOS Software C3750E Software C3750E UNIVERSALK9 M Version 15 0 1 SE2 RELEASE SOFTWARE fc3 Technical Suppo...

Page 176: ... VTPMgmtDomain s Network 1 CDP VTPMgmtDomain anyplace end xStatus Network 1 CDP Address Returns the first network address of both receiving and sending devices Value space of the result returned String Example xStatus Network CDP Address s Network 1 CDP Address 192 0 1 20 end xStatus Network 1 CDP PrimaryMgmtAddress Returns the management address used to configure and monitor the switch the endpoi...

Page 177: ...Services 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...

Page 178: ...Presence 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 con...

Page 179: ...Preset 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 T...

Page 180: ... system 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 resu...

Page 181: ... UpgradeStatus 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 xStat...

Page 182: ... Software 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 spac...

Page 183: ...APF 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 f...

Page 184: ...ration 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 C...

Page 185: ...member 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 Examp...

Page 186: ...e FIPS 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 Configuration...

Page 187: ...istent 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 xSta...

Page 188: ... Proxy that the system communicates with Value space of the result returned String Example xStatus SIP Proxy 1 Address s SIP Proxy 1 Address 192 0 2 50 end xStatus SIP Proxy 1 Secure Shows the encryption status of the signaling with the SIP Proxy server Value space of the result returned True False Example xStatus SIP Proxy 1 Secure s SIP Proxy 1 Secure True end xStatus SIP Proxy 1 Verified Shows ...

Page 189: ...nd xStatus SIP Registration n Authentication Shows which authentication mechanism is used when registering to the SIP Proxy Server Digest Uses the Digest access authentication method as specified by RFC 2069 NTLM Uses the NTLM authentication method which is a Microsoft authentication protocol Off No authentication mechanism is used Value space of the result returned Digest Off Example xStatus SIP ...

Page 190: ...h Note that the status also returns False when TLS is not used xConfiguration SIP Profile 1 DefaultTransport not set to TLS or certificate verification is switched off xConfiguration SIP Profile TlsVerify set to Off Value space of the result returned True False Example xStatus SIP Profile 1 Verified s SIP Profile 1 Verified False end xStatus SIP Profile 1 Authentication Shows which authentication ...

Page 191: ...tering to the SIP Proxy Value space of the result returned Deregister Failed Inactive Registered Registering Example xStatus SIP Profile 1 Registration 1 Status s SIP Profile 1 Registration 1 Status Registered end xStatus SIP Profile 1 Registration n Reason Shows a message to explain the reason why the SIP registration failed Value space of the result returned String Example xStatus SIP Profile 1 ...

Page 192: ...s SystemUnit ProductType Shows the product type Value space of the result returned String Example xStatus SystemUnit ProductType s SystemUnit ProductType Cisco TelePresence Codec end xStatus SystemUnit ProductId Shows the product identity Value space of the result returned String Example xStatus SystemUnit ProductId s SystemUnit ProductId Cisco TelePresence Codec C90 end xStatus SystemUnit Product...

Page 193: ...atus SystemUnit Software Name s SystemUnit Software Name s52010 end xStatus SystemUnit Software ReleaseDate Shows the release date of the software installed on the codec Value space of the result returned String Example xStatus SystemUnit Software ReleaseDate s SystemUnit Software ReleaseDate 2012 02 22 end xStatus SystemUnit Software MaxVideoCalls Shows the the maximum number of simultaneous vide...

Page 194: ... HighDefinition functionality Value space of the result returned String Example xStatus SystemUnit Software OptionKeys HighDefinition s SystemUnit Software OptionKeys HighDefinition true end xStatus SystemUnit Software OptionKeys DualDisplay Shows if the system has the option key installed that supports the DualDisplay functionality Value space of the result returned String Example xStatus SystemU...

Page 195: ...ware MonitoringSoftware The feedback shows the monitoring software id Value space of the result returned String Example xStatus SystemUnit Hardware MonitoringSoftware s SystemUnit Hardware MonitoringSoftware 39 end xStatus SystemUnit Hardware Monitoring Fan n Status The feedback shows the speed rpm for the specified fan Value space of the result returned String Example xStatus SystemUnit Hardware ...

Page 196: ...e 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 xStatus SystemUnit State NumberOfActiveCalls Shows the number of active calls Value space of the result returned...

Page 197: ...ypes 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 a...

Page 198: ...iolation 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 re...

Page 199: ...us xStatus Video Monitors Returns the monitor layout mode Single The same layout is shown on all monitors Dual The layout is distributed on two monitors DualPresentationOnly All participants in the call will be shown on the first monitor while the presentation if any will be shown on the second monitor Quadruple The layout is distributed on four monitors so that each remote participant and the pre...

Page 200: ...lution refresh rate Hz for the video input source Value space of the result returned 0 300 Example xStatus Video Input Source 1 Resolution RefreshRate s Video Input Source 1 Resolution RefreshRate 50 end xStatus Video Input Source n Resolution FormatType Shows the resolution format type for the video input source Value space of the result returned Unknown AnalogCVTBlanking AnalogCVTReducedBlanking...

Page 201: ...xample xStatus Video Input DVI 2 Connected s Video Input DVI 2 Connected False end xStatus Video Input DVI 2 SignalState Shows the signal state for the DVI I input Unknown The signal format is unknown OK A signal is detected and the signal format is supported Unsupported A signal is detected but the signal format is not supported Value space of the result returned Unknown OK Unsupported Example xS...

Page 202: ...tus xStatus Video Output HDMI n MonitorRole Describes which video stream is shown on the monitor connected to the video output HDMI connector First Second Third Fourth The role of the monitor in a multi monitor setup In a singlemonitor setup there is no difference between First Second Third and Fourth PresentationOnly Shows presentation video stream if active Recorder Shows all participants includ...

Page 203: ... the result returned HDMI DVI LCD Legacy Internal Example xStatus Video Output HDMI 1 Type s Video Output HDMI 1 Type HDMI end xStatus Video Output DVI ConnectedDevice Name Shows the name of the monitor connected to the DVI port as defined in the monitors EDID Value space of the result returned String Example xStatus Video Output DVI ConnectedDevice Name s Video Output DVI 2 ConnectedDevice Name s...

Page 204: ...MI 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 returned Unknown Ok In progress Failed to power on Failed to standby Example xStatus Video Output HDMI ConnectedDevice CEC PowerControl s Video Output HDMI 1 ConnectedDevice CEC 1 PowerControl Ok end xStatus Video Output HDMI ConnectedDevic...

Page 205: ...nce Value space of the result returned String Example xStatus Video Layout Site 1 Output 1 GraphicName s Video Layout Site 1 Output 1 GraphicName full pip end xStatus Video Layout Site n Output n Frame n PositionX Shows the horizontal position 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 Layo...

Page 206: ...he frame Value space of the result returned String Example xStatus Video Layout Site 1 Output 1 Frame 1 VideoSourceType 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 Valu...

Page 207: ...t 1 Frame 1 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 ...

Page 208: ...tus Video Layout Prediction Site n Family n OutputRole n Frame n ParticipantId For internal use only Value space of the result returned String xStatus Video Layout Prediction Site n Family n OutputRole n Frame n VideoSourceInstance For internal use only Value space of the result returned Integer xStatus Video Layout Prediction Site n StatusIndex Family n Hidden For internal use only Value space of...

Page 209: ...presentation image on the screen Value space of the result returned UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Example xStatus Video PIP Presentation Position s Video PIP Presentation Position CenterLeft end xStatus Video OSD Output Indicates which monitor is used for on screen display output Value space of the result returned Integer Example xStatus Video OSD Out...

Page 210: ... Cisco TelePresence SX20 Codec API Reference Guide 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 211: ...de TC7 3 OCTOBER 2015 Copyright 2015 Cisco Systems Inc All rights reserved 211 Cisco TelePresence SX20 Codec API Reference Guide Chapter 6 Appendices Contents Introduction About the API xConfiguration Appendices xCommand xStatus Appendices ...

Page 212: ...d 3 Put an executable file permission must be changed to executable in this directory Example of the text in such a file usr bin env tsh xCommand Audio LocalInput Update InputId 1 MixerMode Fixed The startup script file The file must start with the following sequence usr bin env tsh The file can contain any xCommand or xConfiguration command The system executes the commands and configurations in s...

Page 213: ... to zoom the camera in and out Arrows Up Down Use the and arrow keys to navigate in the menu Arrow Right Press the arrow key to expand the selected menu item or to move to the right in a text field Arrow Left Press the arrow key to go one step back in the menu or to move to the left in a text field Layout Press the key to display the Layout menu then select a view in the menu End call Standby Pres...

Page 214: ...10 17 11 0 Presenter 18 12 19 13 20 14 21 15 22 16 0 Zoom out 23 17 0 Zoom in 24 18 25 19 0 Volume down 26 1A 0 Volume up 27 1B 0 Microphone off 28 1C 29 1D 0 Arrow up 30 1E 0 Arrow down IR Signal parameters Name Description Protocol Siemens SDA2208 Reference frequency 485 kHz Address 4 and 7 IR wavelength 940 nm IR carrier frequency 30 kHz Button codes Remote control 5 Dec Hex Address Button name...

Page 215: ... the authorized keys list systemtools authorizedkeys list List the SSH keys on the codec systemtools authorizedkeys clear Clear all SSH keys on the codec systemtools boothalt allow Allow the user to stop the system during the boot loader startup sequence using a serial console systemtools boothalt prevent Prevent the user from stopping the system during the boot loader startup sequence using a ser...

Page 216: ...ll be set inactive Minimum time between password renewals hours 0 The user can only change password once within this limit Maximum time between PIN renewals days 0 If the user has not changed the PIN within the renewal time the user will be set inactive Minimum time between PIN renewals hours 0 The user can only change PIN once within this limit Maximum time between logins days 0 If the user has n...

Page 217: ...ect 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 1 xHistory CallLogs Call 694 h xHistory CallLogs Call 694 DisconnectCause Normal h xHistory C...

Page 218: ...ABLE 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 nu...

Search results

Summary of Contents for TelePresence SX20

Reviews:

Brands by name

Popular brands

Cisco TelePresence SX20, Reference Manual

Search results

Summary of Contents for TelePresence SX20

Reviews:

Brands by name

Popular brands