manualshive.com logo in svg

Cisco TelePresence System Codec C90, Reference Manual

Share
Download
Cisco TelePresence System Codec C90 Reference Manual Download Page 3

D14641.15

 Codec C90 API Reference Guide TC7.0, JANUARY 2014. 

Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. 

3

Cisco TelePresence System Codec C90

API Reference Guide

Chapter 1

Introduction

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Introduction

Summary of Contents for TelePresence System Codec C90

Page 1: ...tems Inc All rights reserved 1 Cisco TelePresence System Codec C90 API Reference Guide Software version TC7 0 JANUARY 2014 Application Programmer Interface API Reference Guide Cisco TelePresence System Codec C90 Contents Introduction About the API xConfiguration Appendices xCommand xStatus ...

Page 2: ...connections 18 Using HTTP 19 Getting status and configurations 19 Sending commands and configurations 19 Using HTTP POST 19 Feedback from codec over HTTP 20 Registering for feedback 20 Translating from terminal mode to XML 21 Dos and don ts 22 xConfiguration commands 23 Description of the xConfiguration commands 24 xCommand commands 83 Description of the xCommand commands 84 xStatus commands 139 D...

Page 3: ...0 JANUARY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 3 Cisco TelePresence System Codec C90 API Reference Guide Chapter 1 Introduction Contents Introduction About the API xConfiguration Appendices xCommand xStatus Introduction ...

Page 4: ...oom 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 TelePresence systems Camera user guide ...

Page 5: ... version to prefer for signaling if both versions are supported on both ends Presentation will stop when the presentation source is disconnected If a presentation source is disconnected or goes into standby e g a PC the presentation will automatically be ended after 10 seconds If the source is connected or comes out of standby within 10 seconds the presenta tion will automatically be resumed When ...

Page 6: ...tus changes New Statuses xStatus Provisioning CUCM UserId xStatus Video Input MainVideoSource xStatus Video Input USB Type xStatus Video Layout Site Output Frame MediaChannelId xStatus Video Layout Prediction Site Family OutputRole Frame MediaChannelId Statuses that are modified xStatus SystemUnit Diagnostics Message Type OLD ValidAdminPassword CamerasDetected H320GatewayStatus ISDNLinkCompatibili...

Page 7: ... JANUARY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 7 Cisco TelePresence System Codec C90 API Reference Guide Chapter 2 About the API Contents Introduction About the API xConfiguration Appendices xCommand xStatus About the API ...

Page 8: ...hese settings to take effect xConfiguration SerialPort BaudRate 9600 19200 38400 57600 115200 xConfiguration SerialPort LoginRequired Off On Connecting On a C Series codec C90 connect a standard 9 pin serial cable 38400 N 8 1 to the COM port on the 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 38...

Page 9: ... control 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 L...

Page 10: ...dback mechanism on page 17 xPreferences The xPreferences command is used to set preferences for the RS 232 Telnet and SSH sessions Refer to API output on page 9 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...

Page 11: ...org Example 2 Get the resolution width of all connected sources for both inputs and outputs xStatus vid res wid s Video Input Source 1 Resolution Width 1920 s Video Input Source 2 Resolution Width 0 s Video Input Source 3 Resolution Width 0 s Video Input Source 4 Resolution Width 0 s Video Input Source 5 Resolution Width 0 s Video Output HDMI 1 Resolution Width 1280 s Video Output HDMI 3 Resolutio...

Page 12: ...vice FarEndControl GPIO HttpFeedback Key Message Phonebook Presentation Preset Provisioning Security SStringSend Standby SystemUnit TStringSend 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 list all the top level co...

Page 13: ...xConfiguration Video Output Composite 5 MonitorRole Auto First Second PresentationOnly Recorder Third Fourth OK xConfiguration User Configurations Audio Cameras Conference Experimental FacilityService GPIO H323 Logging Network NetworkPort NetworkServices Phonebook Provisioning RTP Security SerialPort SIP Standby SystemUnit Time UserInterface Video OK Configurations Configurations are system settin...

Page 14: ...lityServiceId 0 s Call 3 Encryption Type None s Call 3 PlacedOnHold False s Call 3 Duration 9 s Call 3 AnswerState Answered s Call 3 ModifyState Idle s Call 3 DeviceType Endpoint end OK Example 2 Query the protocol for a call xStatus Call Protocol s Call 3 Protocol sip OK xStatus Status Audio Call Camera 1 7 Conference Diagnostics Experimental GPIO H320 H323 HttpFeedback 1 4 ICE MediaChannels Netw...

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

Page 16: ...allLogs Call 1 CallRate 1920000 h xHistory CallLogs Call 1 CallPriority None h xHistory CallLogs Call 1 DisconnectCauseValue 2 h xHistory CallLogs Call 1 DisconnectCause Normal h xHistory CallLogs Call 1 DisconnectCauseType RemoteDisconnect h xHistory CallLogs Call 1 DisconnectCauseCode 16 h xHistory CallLogs Call 1 DisconnectCauseOrigin SIP h xHistory CallLogs Call 1 StartTime 2013 10 20 13 08 05...

Page 17: ... the feedback 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 20 for more information Feedback expressions The expression used when register...

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

Page 19: ...g commands 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 n...

Page 20: ...ons 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 See the Feedback mechanism on page 17 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 Feedback...

Page 21: ...umber 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 it...

Page 22: ... 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 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 remo...

Page 23: ...RY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 23 Cisco TelePresence System Codec C90 API Reference Guide Chapter 3 xConfiguration commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xConfiguration ...

Page 24: ...ophone 1 8 Type 31 xConfiguration Audio Output HDMI 1 3 Level 32 xConfiguration Audio Output HDMI 1 3 Mode 32 xConfiguration Audio Output Line 1 6 Channel 32 xConfiguration Audio Output Line 1 6 Equalizer ID 32 xConfiguration Audio Output Line 1 6 Equalizer Mode 32 xConfiguration Audio Output Line 1 6 Level 32 xConfiguration Audio Output Line 1 6 Mode 32 xConfiguration Audio Output Line 1 3 Type 3...

Page 25: ...1 5 Number 41 xConfiguration FacilityService Service 1 5 CallType 41 GPIO configuration 42 xConfiguration GPIO Pin 1 4 Mode 42 H323 configuration 42 xConfiguration H323 NAT Mode 42 xConfiguration H323 NAT Address 42 xConfiguration H323 Profile 1 1 Authentication Mode 43 xConfiguration H323 Profile 1 1 Authentication LoginName 43 xConfiguration H323 Profile 1 1 Authentication Password 43 xConfigura...

Page 26: ...orkServices NTP Mode 53 xConfiguration NetworkServices NTP Address 53 xConfiguration NetworkServices SNMP Mode 54 xConfiguration NetworkServices SNMP Host 1 3 Address 54 xConfiguration NetworkServices SNMP CommunityName 54 xConfiguration NetworkServices SNMP SystemContact 54 xConfiguration NetworkServices SNMP SystemLocation 54 xConfiguration NetworkServices SSH Mode 54 xConfiguration NetworkServi...

Page 27: ...y configuration 64 xConfiguration Standby Control 64 xConfiguration Standby Delay 64 xConfiguration Standby BootAction 64 xConfiguration Standby StandbyAction 65 xConfiguration Standby WakeupAction 65 SystemUnit configuration 65 xConfiguration SystemUnit Name 65 xConfiguration SystemUnit MenuLanguage 65 xConfiguration SystemUnit CallLogging Mode 65 xConfiguration SystemUnit ContactInfo Type 66 xCo...

Page 28: ...allpaperSelection 76 xConfiguration Video OSD LanguageSelection 76 xConfiguration Video OSD MenuStartupMode 76 xConfiguration Video OSD VirtualKeyboard 76 xConfiguration Video OSD EncryptionIndicator 76 xConfiguration Video OSD MissedCallsNotification 77 xConfiguration Video OSD AutoSelectPresentationSource 77 xConfiguration Video OSD CallSettingsSelection 77 xConfiguration Video OSD TodaysBooking...

Page 29: ...nput HDMI 3 4 VideoAssociation VideoInputSource Select the associated video input source Requires user role ADMIN Value space 1 2 3 4 5 Range Select one of the video input sources Example xConfiguration Audio Input HDMI 3 VideoAssociation VideoInputSource 1 xConfiguration Audio Input Line 1 4 Equalizer ID Select the audio input line equalizer ID Requires user role ADMIN Value space 1 8 Range Selec...

Page 30: ... Activate Loop Suppression Example xConfiguration Audio Input Line 3 LoopSuppression On xConfiguration Audio Input Line 1 4 Mode Set the audio input line mode Requires user role ADMIN Value space Off On Off Disable the Audio Line input On Enable the Audio Line input Example xConfiguration Audio Input Line 1 Mode On xConfiguration Audio Input Microphone 1 8 EchoControl Mode The echo canceller conti...

Page 31: ... displayed Example xConfiguration Audio Input Microphone 1 VideoAssociation MuteOnInactiveVideo On xConfiguration Audio Input Microphone 1 8 VideoAssociation VideoInputSource Select the associated video input source Requires user role ADMIN Value space 1 2 3 4 5 Range Select one of the video input sources Example xConfiguration Audio Input Microphone 1 VideoAssociation VideoInputSource 1 xConfigur...

Page 32: ...user role ADMIN Value space 1 8 Range Select EqualizerID 1 to 8 Example xConfiguration Audio Output Line 1 Equalizer ID 1 xConfiguration Audio Output Line 1 6 Equalizer Mode Set the audio output line equalizer mode Requires user role ADMIN Value space Off On Off No equalizer On Enable the equalizer for the audio output line Example xConfiguration Audio Output Line 1 Equalizer Mode Off xConfigurati...

Page 33: ...xConfiguration Audio SoundsAndAlerts RingTone When using the Touch screen control panel Choose a ringtone from the list If the setting UserInterface UserPreferences has been set to On the Ringtone setting is available from the Settings menu If the setting UserInterface UserPreferences has been set to Off the Ringtone setting is available from the Administrator settings and you must login with user...

Page 34: ...ue space Auto Off On Auto When the camera is placed upside down the image is automatically flipped upside down This setting will only take effect for a camera that automatically detects which way it is mounted Off Display the video on screen the normal way On When enabled the video on screen is flipped This setting is used when a camera is mounted upside down but cannot automatically detect which ...

Page 35: ...self view is as seeing yourself in a mirror Example xConfiguration Cameras Camera 1 Mirror Off xConfiguration Cameras Camera 1 7 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 ...

Page 36: ... user role ADMIN Value space Dual IPv4 IPv6 Dual Enables both IPv4 and IPv6 for H323 and SIP calls IPv4 When set to IPv4 the call protocol SIP H323 will use IPv4 IPv6 When set to IPv6 the call protocol SIP H323 will use IPv6 Example xConfiguration Conference 1 CallProtocolIPStack Dual xConfiguration Conference 1 1 AutoAnswer Mode Set the auto answer mode Requires user role ADMIN Value space Off On...

Page 37: ...stem will revert back and allow incoming calls after the specified timeout defined by the setting Conference DoNotDisturb DefaultTimeout Example xConfiguration Conference 1 DoNotDisturb Mode Timed xConfiguration Conference 1 1 DoNotDisturb DefaultTimeout This setting determines the default duration of a Do Not Disturb session i e the period when incom ing calls are rejected and registered as misse...

Page 38: ...n Conference 1 1 DefaultCall Rate Set the Default Call Rate to be used when placing calls from the system Requires user role ADMIN Value space 64 6000 Range Select a value between 64 and 6000 kbps Example xConfiguration Conference 1 DefaultCall Rate 1920 xConfiguration Conference 1 1 MaxTransmitCallRate Specify the maximum transmit bit rate to be used when placing or receiving calls Note that this...

Page 39: ... as the presentation channel Requires user role ADMIN Value space 1 10 Range 1 to 10 Example xConfiguration Conference 1 VideoBandwidth MainChannel Weight 5 xConfiguration Conference 1 1 VideoBandwidth PresentationChannel Weight The available transmit video bandwidth is distributed on the main channel and presentation channel according to MainChannel Weight and PresentationChannel Weight If the ma...

Page 40: ...le ADMIN Value space 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 conferenc...

Page 41: ...re properly set Only FacilityService Service 1 is available on the Touch screen control panel and the name will show on the facility service call button The facility services are not available when using the remote control and on screen menu Requires user role ADMIN Value space S 0 255 Format String with a maximum of 255 characters Example xConfiguration FacilityService Service 1 Name xConfigurati...

Page 42: ...tivated 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 ...

Page 43: ...the system will still try to register Requires the H 323 Gatekeeper 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 H...

Page 44: ...23 Profile 1 1 PortAllocation The H 323 Port Allocation setting affects the H 245 port numbers used for H 323 call signalling Requires user role ADMIN Value space Dynamic Static Dynamic The system will allocate which ports to use when opening a TCP connection The reason for doing this is to avoid using the same ports for subsequent calls as some firewalls consider this as a sign of attack When Dyn...

Page 45: ...k 1 IPv4 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 o...

Page 46: ...ing server 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 RequestTFTFSer...

Page 47: ... 63 the 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 Vide...

Page 48: ...g will 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 n...

Page 49: ...nneled 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 A...

Page 50: ...pace Off On Off Transmit video packets at link speed On Transmit video packets at maximum 20 Mbps Can be used to smooth out bursts in the outgo ing network traffic Example xConfiguration Network 1 TrafficControl On xConfiguration Network 1 1 RemoteAccess Allow Filter IP addresses for access to ssh telnet HTTP HTTPS Requires user role ADMIN Value space S 0 255 Format String with a maximum of 255 ch...

Page 51: ...he 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 and receive H 323 calls default Example xConfiguration NetworkServices H323 Mode On xConfiguration NetworkServices HTTP Mode Set the HTTP mode to enable disable access to the system through a web...

Page 52: ...munication 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 to your existing call 2 When you are called by a 3rd party while already in a call and you want to include that person in the call Requirements The Codec C90 must run software version TC4 0 or...

Page 53: ... 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 space S 0 255 Format String with a maximum of 255 characters Example xConfiguration NetworkServices HTTPS OCSP URL http ocspserver company com 81 xConfiguration...

Page 54: ...cate SNMP requests SNMP requests must have a password case sensitive in order to receive a response from the SNMP Agent in the codec The default password is public If you have the Cisco TelePresence Management Suite TMS you must make sure the same SNMP Community is configured there too NOTE The SNMP Community password is case sensitive Requires user role ADMIN Value space S 0 50 Format String with...

Page 55: ...ipating 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 Phonebook configuration xConfiguration Phonebook Server 1...

Page 56: ...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 Auto The provisioning server will automatically be selected by the video system Edge The system will be configured using CUCM via Expressway Exa...

Page 57: ...rnate 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...

Page 58: ...ds 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 server must support UDP ExternalSecure The system sends encrypted audit logs to an external syslog server that is verified by a certificate in the Audit CA list The Audit CA list file must be uploaded to the codec using the web interface The common...

Page 59: ...l or 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 T...

Page 60: ...guration 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 listening for in...

Page 61: ...Ice Mode 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 conclu sion about which media route to use up to the first 5 seconds of a call Requires user role ADMIN Value space Off On Host The endpoint will receive media on its own IP address Rflx The endpoint will receive media on its public IP add...

Page 62: ...ample 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 LoginNa...

Page 63: ... can be provided If SIP Profile Outbound is enabled multiple proxies can be addressed Requires user role ADMIN Value space S 0 255 Format A valid IPv4 address IPv6 address or DNS name 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 or by using Dynamic Host Configuration Protocol DHCP ...

Page 64: ... Off The 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 Valu...

Page 65: ...onfiguration xConfiguration SystemUnit Name Enter a System Name to define a name of the system unit If the H 323 Alias ID is configured on the system then this ID will be used instead of the system name The system name will be displayed 1 When the codec is acting as an SNMP Agent 2 Towards a DHCP server Requires user role ADMIN Value space S 0 50 Format String with a maximum of 50 characters Examp...

Page 66: ...rmat Requires user role USER Value space GMT 12 00 International Date Line West GMT 11 00 Midway Island Samoa GMT 10 00 Hawaii GMT 09 00 Alaska GMT 08 00 Pacific Time US Canada Tijuana GMT 07 00 Arizona GMT 07 00 Mountain Time US Canada GMT 07 00 Chihuahua La Paz Mazatlan GMT 06 00 Central America GMT 06 00 Saskatchewan GMT 06 00 Guadalajara Mexico City Monterrey GMT 06 00 Central Time US Canada G...

Page 67: ...s default on the Touch screen control panel LastUsed The last used contact list meeting list or dial pad will appear as default on the Touch screen control panel ContactList The contact list favorites directory and history will appear as default on the Touch screen control panel MeetingList The list of scheduled meetings will appear as default on the Touch screen control panel DialPad The dial pad...

Page 68: ...alid range is between 1 and 60 seconds Example xConfiguration Video CamCtrlPip CallSetup Duration 10 xConfiguration Video DefaultPresentationSource Define which video input source shall be used as the default presentation source when you press the Presentation key on the remote control If using the Touch screen control panel this setting has no effect The Video Input Source n Connector setting def...

Page 69: ...0 Q1 in the AVI infoframe If no AVI infoframe 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 ...

Page 70: ...ontrol Requires user role ADMIN Value space Manual Automatic OnConnect Hidden Manual In manual mode default value the contents of the input source will not be presented on the screen until you select it Use either the remote control or the Touch screen control panel to choose which input source to present Automatic In automatic mode the content on the input source will be presented on screen autom...

Page 71: ...e better the lighting conditions and video input the higher the profile Then in good lighting conditions the video encoder will provide better quality higher resolution or frame rate for a given call rate Generally we recommend using the Normal or Medium profiles However when the lighting condi tions are good the High profile can be set in order to increase the resolution for a given call rate Som...

Page 72: ...higher frame rates typically when a large number of participants are present or when there is a lot of motion in the picture Sharpness Gives the highest possible resolution Used when you want the highest quality of detailed images and graphics Example xConfiguration Video Input Source 1 Quality Motion xConfiguration Video MainVideoSource Define which video input source shall be used as the main vi...

Page 73: ...ation starts up in PIP mode Maximized The presentation starts up in full screen mode Example xConfiguration Video Layout PresentationDefault View Default xConfiguration Video Layout RemoteLayoutFamily Select which video layout family to be used for the remote participants Requires user role ADMIN Value space Auto FullScreen Equal PresentationSmallSpeaker PresentationLargeSpeaker Prominent Overlay ...

Page 74: ...etting 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 CenterRight LowerLeft LowerRight Current The position of the active speaker PiP will be kept unchanged when leaving a call UpperLeft The active speaker PiP will appear in the upper left corner of ...

Page 75: ...all 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 switc...

Page 76: ...mote participant and the presentation will be shown on separate monitors Example xConfiguration Video Monitors Single xConfiguration Video OSD Mode The OSD On Screen Display is where you find the menus dialogs icons and indicators and the navigation is done with a remote control Define which icons and information to be displayed on screen Requires user role ADMIN Value space Off On Off Hide the on...

Page 77: ...dicator 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 Video O...

Page 78: ...ic output select 1 for HDMI 1 output select 2 for DVI I 2 output select 3 for HDMI 3 output or select 4 for DVI I 4 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 Inp...

Page 79: ...ink Pioneer CE Link and Regza Link Toshiba RIHD Onkyo HDAVI Control EZ Sync VIERA Link Panasonic EasyLink Philips and NetCommand for HDMI Mitsubishi Requires user role ADMIN Value space Off On Off Disable CEC control On Enable CEC control Example xConfiguration Video Output HDMI 1 CEC Mode Off xConfiguration Video Output HDMI 1 3 MonitorRole The HDMI monitor role describes which video stream will ...

Page 80: ...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 Output DVI 2 RGBQuantizationRange Full xConfiguration Video Output DVI 2 4 MonitorRole The DVI monitor role describes which video stream will be shown on the monitor connected to the video outp...

Page 81: ...ing else Recorder Show all participants including the local main video If active also show the presentation Example xConfiguration Video Output Composite 5 MonitorRole Auto xConfiguration Video Output Composite 5 OverscanLevel Some TVs or other monitors may not display the whole image sent out on the systems video output but cuts the outer parts of the image In this case this setting can be used t...

Page 82: ...ePresence System Codec C90 API Reference Guide Experimental configuration The Experimental settings are for testing only and should not be used unless agreed with Cisco These settings are not documented and WILL change in later releases Contents Introduction About the API xConfiguration Appendices xCommand xStatus xConfiguration ...

Page 83: ... JANUARY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 83 Cisco TelePresence System Codec C90 API Reference Guide Chapter 4 xCommand commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

Page 84: ... Audio Sound Play 94 xCommand Audio Sound Stop 94 xCommand Audio VUMeter Start 95 xCommand Audio VUMeter Stop 95 xCommand Audio VUMeter StopAll 95 xCommand Audio SoundsAndAlerts Ringtone List 95 Bookings commands 96 xCommand Bookings List 96 xCommand Bookings Clear 97 Boot commands 97 xCommand Boot 97 Call commands 98 xCommand Call Accept 98 xCommand Call Reject 98 xCommand Call Disconnect 98 xCom...

Page 85: ...onference ActiveSpeaker Set 108 Dial commands 109 xCommand Dial 109 DTMFSend commands 109 xCommand DTMFSend 109 FacilityService commands 110 xCommand FacilityService Dial 110 FarEndControl commands 110 xCommand FarEndControl Camera Move 110 xCommand FarEndControl Camera Stop 110 xCommand FarEndControl Preset Activate 111 xCommand FarEndControl Preset Store 111 xCommand FarEndControl Source Select ...

Page 86: ... ReleaseKey Add 126 xCommand SystemUnit ReleaseKey RemoveAll 127 xCommand SystemUnit AdminPassword Set 127 xCommand SystemUnit Diagnostics Run 127 xCommand SystemUnit Diagnostics ExtendedLogging Start 127 xCommand SystemUnit Diagnostics ExtendedLogging Stop 127 xCommand SystemUnit MenuPassword Set 127 xCommand SystemUnit MenuPassword Validate 128 xCommand SystemUnit DateTime Set 128 xCommand Syste...

Page 87: ...sentation 135 xCommand Video Layout SetPresentationView 135 xCommand Video Layout LoadDb 136 xCommand Video Layout Frame List 136 xCommand Video Layout List 136 xCommand Video OSD Close 136 xCommand Video PIP ActiveSpeaker Set 137 xCommand Video PIP Presentation Set 137 xCommand Video Selfview Set 137 xCommand Video PIP Presentation Set 138 xCommand Video PreviewFilmstrip Set 138 Experimental comm...

Page 88: ...be applied 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 i...

Page 89: ...Command Audio Microphones Unmute r AudioMicrophonesUnmuteResult status OK end xCommand Audio LocalInput Add Create a local input and generate the local input id A local input is a mix of input connectors with the following settings Name MixerMode AGC Mute and Channels InputId A unique identifier for the local input Name Choose a name that describes the mix of input connectors MixerMode Auto The mi...

Page 90: ...Id r 0 65534 Name r S 0 255 MixerMode r Auto Fixed GainShared AGC r On Off Mute r On Off Channels r 1 2 Example xCommand Audio LocalInput Update InputId 2 Name Microphone MixerMode GainShared AGC Off Mute Off Channels 1 OK r AudioInputGroupUpdateResult status OK end xCommand Audio LocalInput Remove Remove the local input given by the input ID InputId A unique identifier for the local input Require...

Page 91: ...put 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 OutputId A unique identifier for the local output Name Choose a name that describes the local output Loudspeaker If one or more of the output connectors are connected to a loudspeaker this signal should be a reference signal to the...

Page 92: ...que identifier for the local output Requires user role ADMIN Parameters OutputId r 0 65534 Example xCommand Audio LocalOutput Remove OutputId 6 OK r AudioOutputGroupRemoveResult status OK end xCommand Audio LocalOutput AddConnector Attach an output connector to the local output given by the output ID A connector is defined by its type and ID OutputId A unique identifier for the local output Connec...

Page 93: ...ser role ADMIN Parameters OutputId r 0 65534 InputId r 0 65534 InputGain 54 15 Example xCommand Audio LocalOutput UpdateInputGain OutputId 6 InputId 3 OK r AudioOutputGroupUpdateInputGainResult status OK end xCommand Audio LocalOutput DisconnectInput Disconnect a local or remote input from a local output OutputId A unique identifier for the local output InputId A unique identifier for the local or...

Page 94: ...ue identifier for the local output InputId A unique identifier for the local or remote input Requires user role ADMIN Parameters OutputId r 0 65534 InputId r 0 65534 Example xCommand Audio RemoteOutput DisconnectInput OutputId 10 InputId 8 OK r AudioRemoteOutputGroupDisconnectInputResult status OK end xCommand Audio Setup Clear Remove all local inputs and local outputs Requires user role ADMIN Exa...

Page 95: ...meter information for all connectors Requires user role USER Example xCommand Audio VUMeter StopAll r AudioVumeterStopResult status OK end xCommand Audio SoundsAndAlerts Ringtone List Lists all available ringtones that can be configured using xConfiguration Audio SoundsAndAlerts RingTone Requires user role USER Example xCommand Audio SoundsAndAlerts Ringtone List r AudioRingtoneListResult Ringtone...

Page 96: ...ngs Booking 1 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 HostKe...

Page 97: ...ole USER Example xCommand Bookings Clear end OK Boot commands xCommand Boot Reboot system Action As a default the system restarts after a reboot By selecting Shutdown the system will not restart Requires user role USER Parameters Action Restart Shutdown Example xCommand Boot r BootResult status OK end OK CUIL reboot request restarting Connection closed by foreign host Contents Introduction About t...

Page 98: ...mand to see the CallId Requires user role USER Parameters CallId 0 65534 Example xCommand Call Reject CallId 20 OK r CallRejectResult status OK end xCommand Call Disconnect Disconnect a 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 Requires user role USER Parameters CallId r 0 65534 Example xCommand Call Dis...

Page 99: ...ng 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 result from the command itself not the result from the extension request to ...

Page 100: ...mands xCommand CallHistory AcknowledgeAllMissedCalls Turns off the missed calls indicator on the touch controller for all missed calls Requires user role USER Example xCommand CallHistory AcknowledgeAllMissedCalls r AcknowledgeAllMissedCallsResult status OK end xCommand CallHistory AcknowledgeMissedCall Turns off the missed calls indicator on the touch controller for the specified call CallHistory...

Page 101: ...ified display name or call back number CallHistoryId CallHistoryId for the call in question Requires user role USER Parameters Filter o All Missed Placed Received UnacknowledgedMissed Offset o 0 65534 Limit o 0 65534 DetailLevel o Basic Full SearchString o S 0 255 CallHistoryId o 0 65534 Example xCommand CallHistory Get Filter All Offset 3 DetailLevel Basic r CallHistoryGetResult Entry 0 CallHisto...

Page 102: ...mple xCommand CallHistory Recents Filter Missed Offset 6 DetailLevel Full r CallHistoryRecentsResult ResultInfo Offset 6 r CallHistoryRecentsResult ResultInfo Limit 65534 end CallLog commands xCommand CallLog Clear Clear call logs stored in the system If a logtag is given as argument that specific call is deleted from the logs If no logtag is given the system deletes all call logs The LogTag value...

Page 103: ... Received command Requires user role USER Parameters LogTag 0 2147483647 Example xCommand CallLog Received Delete LogTag 126 r DeleteResult status OK end xCommand CallLog Missed Delete Delete the call log of missed 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 missed calls log The LogTag values for missed cal...

Page 104: ...mmand CamCtrlPip Mode On r CamCtrlPipResult status OK end Camera commands xCommand Camera PanTiltReset The camera is reset to its default values 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 OK r PanTiltResetResult status OK end xCommand Camera Positio...

Page 105: ...and tilt can be operated simultaneously but no other combinations In the latter case only the first operation specified is executed For example if you try to run both zoom and pan at the same time only zoom is executed NOTE You must run a stop command to stop the camera see the example below CameraId Give the camera id Pan Move the camera to the Left or Right followed by Stop PanSpeed Set the pan ...

Page 106: ...nd xCommand Camera Preset Activate Activate one of the stored camera preset Note 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 activate Requires user role USER Parameters PresetId r 1 35 ...

Page 107: ...ove Requires user role USER Parameters PresetId r 1 35 Example xCommand Camera Preset Remove PresetId 1 OK r CameraPresetRemoveResult status OK end xCommand Camera Preset Store Store the current position of the chosen camera The camera is identified by the CameraId parameter Note The xCommand Camera Preset commands applies to an individual camera This is in contrast to the xCommand Preset commands...

Page 108: ...mand only takes effect when xConfiguration Conference DoNotDisturb Mode is set to Timed When Do Not Disturb is switched off incoming calls come through as normal Requires user role USER Example xCommand Conference DoNotDisturb Deactivate r DeactivateResult end xCommand Conference ActiveSpeaker Reset Resets ActiveSpeaker Normal voice switching is switched back on Requires user role USER Example xCo...

Page 109: ...a GUID The booking Id is supplied in call logs call events etc for the call DisplayName The display name of the remote participant Requires user role USER Parameters Number r S 0 255 Protocol H320 H323 Sip CallRate 64 6000 CallType Audio Video BookingId S 0 255 Appearance o 1 999999999 DisplayName o S 0 255 Example xCommand Dial Number 543210 Protocol h323 OK r DialResult status OK CallId 2 Confer...

Page 110: ...e far end camera the remote camera NOTE The far end camera moves in the specified direction until the stop command ref xCommand FarEndControl Camera Stop is issued CallId 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 Value Select the action for how to move the camera Requires user role USER Parameters CallId 0 65...

Page 111: ...Result status OK end xCommand FarEndControl Preset Store While in a call this command is used to store a preset on the far end codec The preset covers the far end codec s camera positions and input video switcher settings 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...

Page 112: ...ots for feedback ServerUrl 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...

Page 113: ...Key Release command to emulate releasing the key Requires user role ADMIN Parameters Key r 0 1 2 3 4 5 6 7 8 9 C Call Disconnect Down F1 F2 F3 F4 F5 Grab Home Layout Left Mute MuteMic Ok PhoneBook Presentation Right Selfview Square SrcAux SrcCamera SrcDocCam SrcPc SrcVcr Star Up VolumeDown VolumeUp ZoomIn ZoomOut Example xCommand Key Press Key Home r KeyPressResult status OK end xCommand Key Relea...

Page 114: ...ired when the Duration parameter is not set Requires user role ADMIN Example xCommand Message Alert Clear OK r MessageAlertClearResult status OK end 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...

Page 115: ...ant to extend the meeting Option 1 No Option 2 Yes extend with 5 minutes Option 3 Yes extend with 10 minutes OK r MessagePromptDisplayResult status OK end xCommand Message Prompt Clear Remove the window displayed using the xCommand Message Alert Display command Use the xFeedback commands to monitor the feedback from the user Read more about the xFeed back commands in the API introduction section i...

Page 116: ...nt Type Type of the message Text Enter the text line to be displayed Requires user role USER Parameters CallId o 0 65534 Type r S 0 255 Text r S 1 1450 LocalEcho o On Off Example xCommand Message FarendMessage CallId 3 Type 3 Text Hello r FarendMessageResult status Error Reason Generic Message mode not enabled end Phonebook commands xCommand Phonebook Folder Add Phonebook entries can be stored in ...

Page 117: ...Id localGroupId 3 OK r PhonebookFolderDeleteResult status OK end xCommand Phonebook Contact Add Add a new contact to the local phonebook The command returns the ContactId which is a unique string that identifies the contact typically the format is localContactId n You can add several contact methods to a contact using the xCommand Phonebook ContactMethod Add command Note that only the first contac...

Page 118: ...e identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Folder Add command was issued ImageURL Currently not in use Title The title of the 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 Example xCommand Phonebook Contact Modify ContactId localContactId 1 Name ...

Page 119: ...bile 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 Protocol H323 OK r PhonebookContactMethodAddResult status OK Name 1 end xCommand Phonebook ContactMethod Modify Modify details about the contact method for an existing contact in the local phonebook Contact...

Page 120: ... have to begin with the string If no FolderId is specified all folders phonebook directories will be searched The SearchString parameter is optional for software version TC2 0 and later SearchField Currently not in use Offset Get records starting with this offset in a search The default value is 0 Offset is used together with Limit to support paging FolderId Search only in the specified folder The...

Page 121: ...dId 3 r PhonebookSearchResult ResultSet Contact 2 ContactMethod 1 Number H323 John Doe Home company com r PhonebookSearchResult ResultSet Contact 2 ContactMethod 1 Protocol H323 r PhonebookSearchResult ResultSet Contact 2 ContactMethod 2 ContactMethodId 4 r PhonebookSearchResult ResultSet Contact 2 ContactMethod 2 Number SIP John Doe Home company com r PhonebookSearchResult ResultSet Contact 2 Con...

Page 122: ...f you select Camera or All However this may change in the future other audio or video settings may be included in a preset If you want to ensure that a preset only affects camera positions we recommend that you select Camera Description Enter a description of the camera preset Requires user role USER Parameters PresetId r 1 15 Type r All Camera Description S 0 255 Example xCommand Preset Store Pre...

Page 123: ...tware upgrade Requires user role USER Parameters SecondsToPostpone r 0 65534 Example xCommand Provisioning PostponeUpgrade SecondsToPostpone 60 r PostponeUpgradeResult status OK end 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 li...

Page 124: ...ivate xCommand Provisioning CUCM ExtensionMobility Login UserId user1 Pin 1234 Profile private r NoResult status OK end e ExtensionMobility Success True ResponseCode Success xCommand Provisioning CUCM ExtensionMobility Logout This command will log you out of your Extension Mobility profile Requires user role USER Example xCommand Provisioning CUCM ExtensionMobility Logout r NoResult status OK end ...

Page 125: ...he system reboots ConfirmandReboot Reboots the system Requires user role ADMIN Parameters Configurations r NonPersistent Persistent CallHistory r NonPersistent Persistent InternalLogging r NonPersistent Persistent LocalPhonebook r NonPersistent Persistent DHCP r NonPersistent Persistent ConfirmAndReboot r Yes Example xCommand Security Persistency Configurations Persistent CallHistory Persistent In...

Page 126: ...ect the Standby Delay in the Advanced configuration menu or by xConfiguration Standby Delay Next time this delay is the valid standby delay Requires user role USER Parameters Delay r 1 480 Example xCommand Standby ResetTimer Delay 10 r ResetResult status OK end SystemUnit commands xCommand SystemUnit OptionKey Add Add an option key to support additional features Requires user role ADMIN Parameters...

Page 127: ... extended logging which stores more information than regular logging in the log files You can determine the duration in seconds Note that extended logging uses more of your video system s resources and should only be used when troubleshooting an issue Requires user role USER Parameters Duration o 1 600 Example xCommand SystemUnit Diagnostics ExtendedLogging Start Duration 20 OK r ExtendedLoggingMo...

Page 128: ...xCommand SystemUnit DateTime Get Read the time and date from the system Requires user role USER Example xCommand SystemUnit DateTime get r DateTimeGetResult status OK Year 2012 Month 7 Day 3 Hour 12 Minute 0 Second 0 end xCommand SystemUnit FactoryReset Reset the codec to factory default settings The call logs are deleted and all system parameters are reset to default values All files that have be...

Page 129: ...em Requires user role ADMIN Parameters Name r S 0 255 Example xCommand SystemUnit ConfigurationProfile Remove Name My _ ConfigurationProfile _ 1 r ConfigurationProfileRemoveResult status OK end xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs Save the current system settings into a configuration profile Assign a name to the new profile The name is the unique identifier of the pr...

Page 130: ...eKey List r SystemUnit ReleaseKey 1 Version TC1 r SystemUnit ReleaseKey 2 Version TC2 r SystemUnit ReleaseKey 3 Version TC3 r SystemUnit ReleaseKey 4 Version TC4 r SystemUnit ReleaseKey 5 Version TC5 end TStringSend commands xCommand TStringSend Send data to far end e g for TelePresence control systems Uses the H 245 control channel TCP Works with H 323 calls only Message Enter the message to be s...

Page 131: ...ew empty video layout composition Returns the LayoutId When the command has been issued you can use the result the LayoutId of the newly created layout to add frames with different video sources to the layout Requires user role ADMIN Parameters LayoutId 1 2147483647 Example xCommand Video Layout Add OK r VideoLayoutAddResult status OK LayoutId 1 end xCommand Video Layout Remove Remove an existing ...

Page 132: ...h 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 H 239 content in a conference RemoteMain Select the main source of remote site The CallId must then be specified in the VideoSourceId...

Page 133: ...emote Select another remote site in a call This involves logic in the codec to ensure that a site does not see 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 it...

Page 134: ...er for the local output which was created when the xCommand Audio LocalOutput Add command was issued Requires user role ADMIN Parameters LayoutId r 1 2147483647 OutputId r 0 65534 Example xCommand Video Layout AssignLocalOutput OutputId 1 LayoutId 2 OK r VideoLayoutAssignLocalOutputResult status OK end xCommand Video Layout AssignCall Assign the call layout main stream to the remote output The def...

Page 135: ...ocalOutputResult status OK end xCommand Video Layout UnAssignCall 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 Requires user role ADMIN Parameters CallId 0 65534 Example xCommand Video Layout UnAssignCall CallId 1 OK r...

Page 136: ... all layout frames created by command xCommand Video Layout Frame Add for a specific layout identified by LayoutId Requires user role ADMIN Parameters LayoutId o 1 2147483647 Example xCommand Video Layout Frame List LayoutId 1 OK r VideoLayoutFrameListResult LayoutId 1 FrameId 1 PositionX 0 r VideoLayoutFrameListResult LayoutId 1 FrameId 1 PositionY 0 r VideoLayoutFrameListResult LayoutId 1 FrameI...

Page 137: ... 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 r PresentationPipSetResult status OK end xCommand Video Selfview Set Sets self view on off and specifies i...

Page 138: ...Example xCommand Video PIP Presentation Set Position LowerLeft r PresentationPipSetResult status OK end xCommand Video PreviewFilmstrip Set Moves the location of the filmstrip associated with the layouts used in presentation preview mode Not in use in this software version LowerCenter The preview appears on the bottom of the screen in center LowerLeft The preview appears in the lower left corner o...

Page 139: ...0 JANUARY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 139 Cisco TelePresence System Codec C90 API Reference Guide Chapter 5 xStatus commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xStatus ...

Page 140: ...s Call n Direction 150 xStatus Call n Protocol 150 xStatus Call n CallType 151 xStatus Call n RemoteNumber 151 xStatus Call n CallbackNumber 151 xStatus Call n DisplayName 151 xStatus Call n TransmitCallRate 151 xStatus Call n ReceiveCallRate 151 xStatus Call n FacilityServiceId 152 xStatus Call n Encryption Type 152 xStatus Call n PlacedOnHold 152 xStatus Call n Duration 152 xStatus Call n Securi...

Page 141: ... Conference SelectedCallProtocol 161 Diagnostics status 162 xStatus Diagnostics 162 xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 Jitter 162 xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 Jitter 162 xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 Jitter 162 xStatus Diagnostics Call n Channels OutgoingAudioChannel n Netstat 1 Jitter 1...

Page 142: ... 165 xStatus Diagnostics Call n Channels OutgoingDataChannel n Netstat 1 ChannelRate 165 xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 MaxJitter 166 xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 MaxJitter 166 xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 MaxJitter 166 xStatus Diagnostics Call n Channels OutgoingAudioChannel n Nets...

Page 143: ...n Transport RTCP Local IpAddress 177 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTCP Local Port 177 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTCP Remote IpAddress 178 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RCTP Remote Port 178 xStatus MediaChannels Call n OutgoingVideoChannel n Encryption Status 178 xStatus MediaChannels Call n Outgoin...

Page 144: ...tatus Provisioning CUCM UserId 190 xStatus Provisioning CUCM CTL State 190 xStatus Provisioning CUCM ExtensionMobility Enabled 190 xStatus Provisioning CUCM ExtensionMobility LoggedIn 190 xStatus Provisioning CUCM ExtensionMobility LastLoggedInUserId 190 xStatus Provisioning CUCM TVS Proxy n Server 190 xStatus Provisioning CUCM TVS Proxy n IPv6Address 191 xStatus Provisioning CUCM TVS Proxy n Port...

Page 145: ...ureThreshold 201 xStatus SystemUnit State System 201 xStatus SystemUnit State MaxNumberOfCalls 202 xStatus SystemUnit State MaxNumberOfActiveCalls 202 xStatus SystemUnit State NumberOfActiveCalls 202 xStatus SystemUnit State NumberOfSuspendedCalls 202 xStatus SystemUnit State NumberOfInProgressCalls 202 xStatus SystemUnit State Subsystem Application 202 xStatus SystemUnit ContactInfo 202 xStatus S...

Page 146: ...1 6 Height 212 xStatus Video Layout Site n Output 1 5 Frame 1 6 Layer 212 xStatus Video Layout Site n Output 1 5 Frame 1 6 MediaChannelId 213 xStatus Video Layout Site n Output 1 5 Frame 1 6 VideoSourceType 213 xStatus Video Layout Site n Output 1 5 Frame 1 6 VideoSourceId 213 xStatus Video Layout Site n Output 1 5 Frame 1 6 InputNumber 213 xStatus Video Layout Site n Output 1 5 Frame 1 6 Filename...

Page 147: ...ave 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 strongest speaker is active and the others are strongly attenuated Fixed The input connector signals are mixed together with equal gains GainShared The microphones are given a normalized gain factor relative to the strongest speaker before being mixed toge...

Page 148: ...eInput 8 CallId s Audio Input RemoteInput 8 CallId 28 end xStatus Audio Input Connectors Microphone n EcReferenceDelay Returns the detected latency for each loudspeaker to microphone path The result is in milliseconds Value space of the result returned Integer Example xStatus Audio Input Connectors Microphone 1 EcReferenceDelay s Audio Connectors Microphone 1 EcReferenceDelay 120 end xStatus Audio...

Page 149: ...Output to find the identity n of the output and input Value space of the result returned 54 15 Example xStatus Audio Output LocalOutput 4 Input 2 Gain s Audio Output LocalOutput 4 Input 2 Gain 0 end xStatus Audio Output RemoteOutput n CallId Shows the CallId for the remote audio output You can run the command xStatus Audio Output RemoteOutput to find the identity n of the output Value space of the...

Page 150: ...hows the top level overview of the call status The call identity is used when query for additional information about the call xStatus Call 1 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 ...

Page 151: ...o find 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 ...

Page 152: ... of a 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 NotAuthentica...

Page 153: ...Shows the top level overview of the camera status xStatus Camera 1 7 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 1 7 HardwareID Shows the hardware identity of the camera Value space of the result returned String Example xStatus Camera 1 HardwareID s Camera 1 HardwareI...

Page 154: ...atus Camera 1 7 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 1 7 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 1 7 Position Pan Shows the current pa...

Page 155: ...Camera 1 Position Focus s Camera 1 Position Focus 4597 end xStatus Camera 1 7 Capabilities Options Shows the camera capabilities ptzf pan tilt zoom focus Value space of the result returned String Example xStatus Camera 1 Capabilities Options s Camera 1 Capabilities Options ptzf end xStatus Camera 1 7 Flip In Flip mode vertical flip the image can be flipped upside down Value space of the result ret...

Page 156: ...overview of the conference status The identity of the Conference Site can only be read during a call xStatus Conference Presentation Mode Shows the status of the secondary video stream Value space of the result returned Off Sending Receiving Example xStatus Conference Presentation Mode s Conference Presentation Mode Off end xStatus Conference Presentation Protocol Shows the video protocol used whe...

Page 157: ...xample 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 Presentation LastLocalSource 2 end xStatus Conference Site n Capabilities FECC Num...

Page 158: ... not permitted Value space of the result returned On Off Example xStatus Conference Site 2 Capabilities FECC Mode s Conference Site 2 Capabilities FECC Mode On 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...

Page 159: ...alue 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 identifica tion of a call or conference Value space of the result returned String Example xStatus Confer...

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

Page 161: ...e of the result returned Off MultiWay 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 ...

Page 162: ... the incoming 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 N...

Page 163: ...t 1 Loss 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 ...

Page 164: ... of the 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 ...

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

Page 166: ...oChannel n Netstat 1 MaxJitter xStatus 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 ...

Page 167: ... 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 H320 Gateway Mode Unknown...

Page 168: ...s Registered end xStatus H323 Gatekeeper Address Displays the IP address of the gatekeeper where the system is registered Value space of the result returned 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 H...

Page 169: ...nformation 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 ...

Page 170: ...ess PRFLX The endpoint sends media from its public IP address as seen by the remote Peer SRFLX The endpoint sends media from its public IP address as seen by the TURN server RELAY The endpoint sends media from the IP address and port allocated on the TURN server and is used as a fallback until ICE has concluded Value space of the result returned HOST PRFLX SRLFX RELAY Example xStatus ICE Call Loca...

Page 171: ...ce of the result returned Verified NotVerified Failed Off Example xStatus ICE Turn Discovermode s ICE Turn Discovermode Verified end xStatus ICE Turn Bandwidth Returns the bandwidth available for the turn server right after xConfiguration SIP Profile 1 Turn BandwidthProbe is set to On Probing failed Could not obtain information on bandwidth Probe Aborted The probing was canceled because a call sta...

Page 172: ...TU standard G729AB The G 729 annex A and B is an ITU standard Opus Opus is a lossy audio compression format Value space of the result returned AACLD G722 G7221 G711Mu G711A G729 G729AB Opus Example xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol AACLD end xStatus MediaChannels Call n IncomingAudioChannel n Audio ...

Page 173: ...annel 327 Transport RTP Remote Port s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port 50932 end xStatus MediaChannels Call n IncomingAudioChannel n Transport RTCP Local IpAddress Shows the local IP address of the Real time Transport Control Protocol RTCP port for the incoming audio in the media channel Value space of the result returned String Example xStatus MediaChannels...

Page 174: ...hannels Call 27 IncomingVideoChannel 330 ChannelRole Main end xStatus MediaChannels Call n IncomingVideoChannel n Video Protocol Shows the video algorithm for the incoming video channel H264 The H 264 algorithm is an ITU T standard for video compression H263pp The H 263pp algorithm is an ITU T standard for video compression H263 The H 263 algorithm is an ITU T standard for video compression H261 T...

Page 175: ...rt s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port 16404 end xStatus MediaChannels Call n IncomingVideoChannel n Transport RTP Remote IpAddress Shows the remote IP address of the Real time Transport Protocol RTP port for the incoming video in the media channel Value space of the result returned String Example xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transpor...

Page 176: ...mingVideoChannel 330 Transport RTCP Remote Port 50933 end xStatus MediaChannels Call n OutgoingAudioChannel n Encryption Status Shows the encryption status on the outgoing channel Value space of the result returned On Off Example xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Encryption Status s MediaChannels Call 27 OutgoingAudioChannel 328 Encryption Status Off end xStatus MediaChannels ...

Page 177: ...oChannel 328 Transport RTP Remote IpAddress s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress 192 168 136 130 end xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTP Remote Port Shows the remote UDP port number of the Real time Transport Protocol RTP port for the outgoing audio in the media channel Value space of the result returned Integer Example xStat...

Page 178: ...gVideoChannel 331 Encryption Status s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status Off end xStatus MediaChannels Call n OutgoingVideoChannel n ChannelRole Shows if the outgoing channel is the main video channel or presentation channel Value space of the result returned Main Presentation Example xStatus MediaChannels Call 27 OutgoingVideoChannel 331 ChannelRole s MediaChannels C...

Page 179: ...oChannel 331 Transport RTP Local IpAddress 192 168 24 190 end xStatus MediaChannels Call n OutgoingVideoChannel n Transport RTP Local Port Shows the local UDP port number of the Real time Transport Protocol RTP port for the outgoing video in the media channel Value space of the result returned Integer Example xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Local Port s MediaCh...

Page 180: ...ll 27 OutgoingVideoChannel 331 Transport RTCP Local Port s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Local Port 16405 end xStatus MediaChannels Call n OutgoingVideoChannel n Transport RTCP Remote IpAddress Shows the remote 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 Exampl...

Page 181: ...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 Gateway Shows the addres...

Page 182: ...s used 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 provi sioning server address is defined as a vendor encap...

Page 183: ... Example xStatus Network CDP Platform s Network 1 CDP Platform cisco WS C3750X 48P end xStatus Network 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 ...

Page 184: ...rk CDP VTPMgmtDomain s Network 1 CDP VTPMgmtDomain anyplace end xStatus Network 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 CDP PrimaryMgmtAddress Returns the management address used to configure and monitor the switch the endp...

Page 185: ... 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 Returns the address of the NTP server that is currently in use Value space of the result returned String Example xStatus NetworkServices NTP CurrentAddress s NetworkServices NTP CurrentAddress 123 254 15 121 end xStatus NetworkServices...

Page 186: ...g Example xStatus Preset 1 Description s Preset 1 Description Zoom in end Provisioning status xStatus Provisioning Shows the top level overview of the provisioning status xStatus Provisioning Status Shows the status of the provisioning Failed The provisioning failed AuthenticationFailed The authentication failed Provisioned The endpoint is provisioned Idle The provisioning is not active NeedConfig...

Page 187: ...g Software UpgradeStatus Status s Provisioning Software UpgradeStatus Status None end xStatus Provisioning Software UpgradeStatus Phase Shows the phase of the software upgrade Value space of the result returned None DownloadPending FormingHierarchy Downloading DownloadPaused DownloadDone Seeding AboutToInstallUpgrade Postponed PeripheralsReady UpgradingPeripherals Installing Example xStatus Provis...

Page 188: ..._ 0 pkg end xStatus Provisioning Software Current CompletedAt Shows date and time for when the current software upgrade was completed Value space of the result returned String Example xStatus Provisioning Software Current CompletedAt s Provisioning Software Current CompletedAt 2011 06 07T07 20 03Z end xStatus Provisioning CUCM CAPF Mode Shows the authentication mode required for a pending CAPF ope...

Page 189: ...on specified CAPFInvalidAuthMode Invalid authentication mode CAPFNotNone Last CAPF session is still running CAPFNullCInt Invalid client CAPFNullCIntcontext Invalid client context CAPFInvalidUsageStartSession Session is in wrong state CAPFNullSessionData Session context data is empty CAPFInvalidSession Invalid CAPF session CAPFNullParameters Invalid server parameters CAPFNoStat Empty status CAPFTim...

Page 190: ...Provisioning CUCM CTL State Installed end xStatus Provisioning CUCM ExtensionMobility Enabled Indicates if Extension Mobility is enabled for the UCM registered device Value space of the result returned True False Example xStatus Provisioning CUCM ExtensionMobility Enabled s Provisioning CUCM ExtensionMobility Enabled False end xStatus Provisioning CUCM ExtensionMobility LoggedIn Indicates whether ...

Page 191: ...f the result returned Integer Example xStatus Provisioning CUCM TVS Proxy 1 Priority s Provisioning CUCM TVS Proxy 1 Priority 0 end Security status xStatus Security FIPS Mode Shows the 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...

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

Page 193: ... SIP 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 Sh...

Page 194: ...m end 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 NTLM Off Example xSta...

Page 195: ...tch 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 xConfigura tion 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 authenticati...

Page 196: ...registering 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 Profi...

Page 197: ... be used 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 ...

Page 198: ...tform s 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 Syst...

Page 199: ...leaseKey s SystemUnit Software ReleaseKey true end xStatus SystemUnit Software OptionKeys NaturalPresenter Shows if the system has the option key installed that supports the NaturalPresenter functionality Value space of the result returned String Example xStatus SystemUnit Software OptionKeys NaturalPresenter s SystemUnit Software OptionKeys NaturalPresenter true end xStatus SystemUnit Software Op...

Page 200: ...eturned 1 0 Example xStatus SystemUnit Hardware Module CompatibilityLevel s SystemUnit Hardware Module CompatibilityLevel 1 end xStatus SystemUnit 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 PH0999989 end xStatu...

Page 201: ...returned String Example xStatus SystemUnit Hardware Monitoring Fan 1 Status s SystemUnit Hardware Monitoring Fan 1 Status locked on 1096 rpm end xStatus SystemUnit Hardware Temperature The feedback shows the current maximum temperature degree Celsius measured in the codec system Value space of the result returned String Example xStatus SystemUnit Hardware Temperature s SystemUnit Hardware Temperat...

Page 202: ...uspendedCalls Shows the number of suspended calls Value space of the result returned 0 5 Example xStatus SystemUnit State NumberOfSuspendedCalls s SystemUnit State NumberOfSuspendedCalls 0 end xStatus SystemUnit State NumberOfInProgressCalls Shows the number of calls in progress Value space of the result returned 0 5 Example xStatus SystemUnit State NumberOfInProgressCalls s SystemUnit State Numbe...

Page 203: ...otifications Notification 1 Type SoftwareUpgradeOK end xStatus SystemUnit Notifications Notification n Text Lists text related to important system notifications Notifications are issued e g when a system was rebooted because of a software upgrade or when a factory reset has been performed All the notifications can be removed from the list by issuing the xCommand SystemUnit Notifications RemoveAll ...

Page 204: ...gnostics Message Level end xStatus SystemUnit Diagnostics Message Description A description of the current diagnostics alerts Value space of the result returned String Example xStatus SystemUnit Diagnostics Message Description s SystemUnit DiagnosticsResult Message 1 Description IP configuration incomplete end xStatus SystemUnit Diagnostics Message References Additional information on the diagnost...

Page 205: ...out 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 presentation will be shown on separate monitors Value space of the result returned Single Dual DualPresentationOnly Tripl...

Page 206: ...ution 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 1 5 Resolution FormatType Shows the resolution format type for the video input source Value space of the result returned Unknown AnalogCVTBlanking AnalogCVTReducedBlankin...

Page 207: ... xStatus Video Input HDSDI 1 Connected s Video Input HDSDI 1 Connected False end xStatus Video Input HDSDI 1 4 SignalState Shows the signal state for the HD SDI 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...

Page 208: ...which are the Y Comp and C inputs 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 xStatus Video Input Legacy 5 SignalState s Video Input Legacy 5 SignalState OK end xStatus Video Input USB 3 Type Not in use in this...

Page 209: ...or not NOTE When a display enters standby mode the endpoint may not be able to detect it The connector status will then return False Unknown even if the display is physically connected True A display is connected to the video output connector False No display is connected to the video output Value space of the result returned True False Example xStatus Video Output HDMI Connected s Video Output HD...

Page 210: ...hysically connected True A display is connected to the video output connector False No display is connected to the video output Applicable to digital outputs only Unknown Because both digital and analog are supported on the DVI I connector in some situa tions it is uncertain whether a display is connected or not Therefore the state is Unknown by default However when EDID is received from a display...

Page 211: ...60 end xStatus Video Layout Shows the top level overview of the video layout status xStatus Video Layout Mode Indicates type of layout currently used by the codec custom or default Value space of the result returned Default Custom Example xStatus Video Layout Mode s Video Layout Mode Default end xStatus Video Layout PresentationView Returns information about the presentation view mode Value space ...

Page 212: ...yout Site 1 Output 1 Frame 1 PositionX 0 end xStatus Video Layout Site n Output 1 5 Frame 1 6 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 Site 1 Output 1 Frame 1 PositionY s Video Layout Site 1 Output 1 Frame 1 PositionY 0 end xStatus Video Layout Site n Output 1 5 Frame 1 6 Width Shows the widt...

Page 213: ...ourceType s Video Layout Site 1 Output 1 Frame 1 VideoSourceType graphic end xStatus Video Layout Site n Output 1 5 Frame 1 6 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 1 5 Example xStatus Video Layout Site 1 Output 1 Frame 1 VideoSourceId s Vi...

Page 214: ...Output 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 La...

Page 215: ...t on or not Value space of the result returned On Off Example xStatus Video Selfview Mode s Video Selfview Mode Off end xStatus Video Selfview FullscreenMode Shows whether selfview is set on full screen mode or not Value space of the result returned On Off Example xStatus Video Selfview FullscreenMode s Video Selfview FullscreenMode Off end xStatus Video Selfview PIPPosition Shows the position of ...

Page 216: ...splay output Value space of the result returned Integer Example xStatus Video OSD Output s Video OSD Output 3 end xStatus Video OSD Mode Indicates whether on screen display in indicator or full mode Indicators The on screen display is in passive mode when a Touch controller is paired to the system Full Full on screen display menu is active and can be controlled with a remote control Value space of...

Page 217: ... 0 JANUARY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 217 Cisco TelePresence System Codec C90 API Reference Guide Chapter 6 Appendices Contents Introduction About the API xConfiguration Appendices xCommand xStatus Appendices ...

Page 218: ...s Configure the main video source and the default presenta tion source for the system The values 1 5 represents the video input sources 1 5 xConfiguration Video MainVideoSource 1 5 xConfiguration Video DefaultPresentationSource 1 5 Default configurations Video Input Source 1 Connector HDMI Video Input Source 2 Connector HDMI Video Input Source 3 Connector DVI Video Input Source 4 Connector HDMI Vi...

Page 219: ...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 configura tions in ...

Page 220: ... key 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 ...

Page 221: ...F 16 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...

Page 222: ... 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 serial console systemtools boothalt status Show whether or n...

Page 223: ...um number of simultaneous sessions per user Number of passwords to remember 0 Number of previous passwords that the new password must differ from Number of PINs to remember 0 Number of previous PINs that the new PIN must differ from Maximum time between password renewals days 0 If the user has not changed the password within the renewal time the user will be set inactive Minimum time between passw...

Page 224: ...ct 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 DisconnectCauseValue 2 h xHistory CallLogs Call 694 DisconnectCause Normal h xHistory CallLogs Call 694 DisconnectCauseType Re...

Page 225: ...D SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS CISCO AND THE ABOVE NAMED SUPPLIERS DISCLAIM ALL WARRANTIES EXPRESSED OR IMPLIED INCLUDING WITHOUT LIMITATION THOSE OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING USAGE OR TRADE PRACTICE IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT SPECIAL CONSEQUENTI...

Reviews:

No comments

Brands by name

Popular brands

Load more brands