Cisco TelePresence System Codec C40 Reference Manual Download Page 2

Page: 2 / 224

D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014.

Cisco TelePresence System Codec C40/C60

API Reference Guide

TA - ToC - Hidden

text anchor

Table of Contents

Introduction ..........................................................................3

About this guide ......................................................................4

User documentation .............................................................4

What’s new in this version ......................................................5

Software release notes ........................................................5

Software download ..............................................................5

New features and improvements .........................................5

System configuration changes .............................................6

System command changes..................................................6

System status changes ........................................................6

About the API ........................................................................ 7

API fundamentals ....................................................................8

Connecting to the API ..........................................................8

Password .............................................................................8

RS-232/serial connection ....................................................8

Telnet ....................................................................................8

SSH ......................................................................................8

HTTP/HTTPS ........................................................................8

API output ...............................................................................9

The output modes ................................................................9

Using the command line .......................................................10

API commands ...................................................................10

Other commands ...............................................................10

Command line shortcuts ....................................................10

Searching ........................................................................... 11

Value types and formats .................................................... 11

Commands ........................................................................... 12

Configurations ......................................................................13

Status .................................................................................... 14

Events ...................................................................................15

Call history ............................................................................16

Feedback mechanism........................................................... 17

Feedback expressions ....................................................... 17

Terminal 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 ...........................................................140

Description of the xStatus commands ............................... 141

Appendices....................................................................... 217

About startup scripts ..........................................................218

Cisco TelePresence Remote Control ..................................219

Remote control key map .....................................................220

The SystemTools commands .............................................. 221

About disconnect cause types ...........................................223

What’s in this guide?

The top menu bar and the entries in the table

of contents are all hyperlinks, just click on

them to go to the topic.

We recommend you visit our web site

regularly for updated versions of the user

documentation.

Go to:



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

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

Contents

Summary of Contents for TelePresence System Codec C40

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

Page 2: ...ack mechanism 17 Feedback expressions 17 Terminal 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 ...

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

Page 4: ...eo conference room acoustics guidelines Installation guides for the TelePresence systems Software release notes for the TC software Getting started guide for the TelePresence systems User guide for the TelePresence systems Touch controller User guide for the TelePresence systems Remote Control Quick reference guides for the TelePresence systems Administrator guides for the TelePresence systems Cam...

Page 5: ...h IP 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 presentation will automatically be resumed Wh...

Page 6: ... status 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 ISDNLinkCompati...

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

Page 8: ...ect xConfiguration SerialPort BaudRate 9600 19200 38400 57600 115200 xConfiguration SerialPort LoginRequired Off On Connecting On the C Series codecs C40 and C60 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 38400 The reason...

Page 9: ...ased 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 Examp...

Page 10: ...o Feedback 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 entering text in a command line interface If echo is set to Off no user input is displayed when entering text in a command line interface xEvent the xEvent command ret...

Page 11: ...nsitive All of the following commands will work XCOMMAND DIAL NUMBER foo bar org xcommand dial number foo bar org xCommand Dial Number foo bar org Example 1 List all configurations that include a word that starts with DVI xConfiguration dvi c xConfiguration Video Input DVI 2 RGBQuantizationRange Full c xConfiguration Video Input DVI 2 Type AutoDetect c xConfiguration Video Input DVI 3 RGBQuantizat...

Page 12: ...FSend Experimental FacilityService 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 ...

Page 13: ...Level Medium High None xConfiguration Video Output Composite 3 MonitorRole Auto First Second PresentationOnly Recorder 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 sys...

Page 14: ... Encryption Type Aes 128 s Call 3 PlacedOnHold False s Call 3 Duration 123 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 Network 1 1 NetworkServ...

Page 15: ...Successful CallId 132 Protocol h223 Direction outgoing CallRate 768 RemoteURI h223 integratorHQ company com EncryptionIn Off EncryptionOut Off end Example 4 FECC Action request FECC Action request is an event reported when far end is sending FECC commands e FeccActionInd Id 132 Req 1 Pan 1 PanRight 1 Tilt 0 TiltUp 0 Zoom 0 ZoomIn 0 Focus 0 FocusIn 0 Timeout 300 VideoSrc 0 m 0 end Example 5 TString...

Page 16: ...ory CallLogs Call 1 CallRate 0 h xHistory CallLogs Call 1 CallPriority None h xHistory CallLogs Call 1 DisconnectCauseValue 1 h xHistory CallLogs Call 1 DisconnectCause h xHistory CallLogs Call 1 DisconnectCauseType LocalDisconnect h xHistory CallLogs Call 1 DisconnectCauseCode 0 h xHistory CallLogs Call 1 DisconnectCauseOrigin Internal h xHistory CallLogs Call 1 StartTime 2013 07 10 15 13 08 h xH...

Page 17: ...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 registering for feedback is a variant of the XPath langua...

Page 18: ...tive 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 ...

Page 19: ...nding 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 syst...

Page 20: ...backslot to register its expressions ServerUrl The URL that you want the codec to post the HTTP feedback messages to Expression 1 15 Register the expressions you want to receive feedback on Refer to Feedback mechanism on page 17 Example Registering feedback on configuration changes disconnect events and call status changes Command HttpFeedback Register command True FeedbackSlot 1 FeedbackSlot Serv...

Page 21: ...45 Number 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 attribut...

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

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

Page 24: ...Output Line 1 2 Equalizer ID 32 xConfiguration Audio Output Line 1 2 Equalizer Mode 32 xConfiguration Audio Output Line 1 2 Level 32 xConfiguration Audio Output Line 1 2 Mode 33 xConfiguration Audio Output Line 1 Type 33 xConfiguration Audio Output Line 2 Type 33 xConfiguration Audio Microphones Mute Enabled 33 xConfiguration Audio SoundsAndAlerts KeyTones Mode 33 xConfiguration Audio SoundsAndAle...

Page 25: ... Mode 43 xConfiguration H323 Profile 1 1 Gatekeeper Discovery 43 xConfiguration H323 Profile 1 1 Gatekeeper Address 43 xConfiguration H323 Profile 1 1 H323Alias E164 44 xConfiguration H323 Profile 1 1 H323Alias ID 44 xConfiguration H323 Profile 1 1 PortAllocation 44 Logging configuration 44 xConfiguration Logging Mode 44 Network configuration 45 xConfiguration Network 1 1 IPStack 45 xConfiguration...

Page 26: ...orkServices CTMS Mode 55 xConfiguration NetworkServices CTMS Encryption 55 Phonebook configuration 55 xConfiguration Phonebook Server 1 1 ID 55 xConfiguration Phonebook Server 1 1 Type 55 xConfiguration Phonebook Server 1 1 URL 55 Provisioning configuration 56 xConfiguration Provisioning Connectivity 56 xConfiguration Provisioning Mode 56 xConfiguration Provisioning LoginName 56 xConfiguration Pro...

Page 27: ...ime DateFormat 67 UserInterface configuration 67 xConfiguration UserInterface TouchPanel DefaultPanel 67 xConfiguration UserInterface UserPreferences 67 Video configuration 68 xConfiguration Video Input Source 1 3 Name 68 xConfiguration Video Input Source 1 Connector 68 xConfiguration Video Input Source 2 Connector 68 xConfiguration Video Input Source 3 Connector 68 xConfiguration Video Input Sour...

Page 28: ... 77 xConfiguration Video OSD TodaysBookings 77 xConfiguration Video OSD MyContactsExpanded 77 xConfiguration Video OSD Output 77 xConfiguration Video OSD InputMethod InputLanguage 78 xConfiguration Video OSD InputMethod Cyrillic 78 xConfiguration Video OSD LoginRequired 78 xConfiguration Video AllowWebSnapshots 78 xConfiguration Video Output HDMI 1 RGBQuantizationRange 78 xConfiguration Video Outp...

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

Page 30: ...ly adjusts itself to the audio characteristics of the room and compensate for any changes it detects in the audio environment If the changes in the audio conditions are very significant the echo canceller may take a second or two to re adjust Requires user role ADMIN Value space Off On Off Echo Control should be switched Off if external echo cancellation or playback equipment is used On Echo Contr...

Page 31: ...o will be muted if the associated video source is not displayed Example xConfiguration Audio Input Microphone 1 VideoAssociation MuteOnInactiveVideo On xConfiguration Audio Input Microphone 1 2 1 4 VideoAssociation VideoInputSource NOTE Codec C40 has two microphone connectors Codec C60 has four microphone connectors Select the associated video input source Requires user role ADMIN Value space 1 2 ...

Page 32: ...hannel on the HDMI output On Enable the audio channel on the HDMI output Example xConfiguration Audio Output HDMI 1 Mode On xConfiguration Audio Output Line 1 2 Channel Define whether the Audio Line output is a mono signal or part of a multichannel signal Requires user role ADMIN Value space Right Left Mono Right The Audio Line output signal is the right channel of a stereo signal Left The Audio L...

Page 33: ...ed by mistake Example xConfiguration Audio Microphones Mute Enabled True xConfiguration Audio SoundsAndAlerts KeyTones Mode The system can be configured to make a keyboard click sound effect key tone when pressing a key on the remote control or when typing text or numbers on the Touch screen control panel Requires user role USER Value space Off On Off No key tones will be played when you type On Y...

Page 34: ...ery dark to the far end Requires user role ADMIN Value space Off On Off Turn off the camera backlight compensation On Turn on the camera backlight compensation Example xConfiguration Cameras Camera 1 Backlight Off xConfiguration Cameras Camera 1 7 Brightness Mode Set the camera brightness mode Requires user role ADMIN Value space Auto Manual Auto The camera brightness is automatically set by the s...

Page 35: ...default and the recommended setting Manual In manual mode the gamma value is changed with the gamma level setting ref Cameras Camera 1 n Gamma Level Example xConfiguration Cameras Camera 1 Gamma Mode Auto xConfiguration Cameras Camera 1 7 Gamma Level By setting the Gamma Level you can select which gamma correction table to use This setting may be useful in difficult lighting conditions where chang...

Page 36: ...ce Mode Set the camera whitebalance mode Requires user role ADMIN Value space Auto Manual Auto The camera will continuously adjust the whitebalance depending on the camera view Manual Enables manual control of the camera whitebalance The whitebalance level is set using the Cameras Camera Whitebalance Level setting Example xConfiguration Cameras Camera 1 Whitebalance Mode Auto xConfiguration Camera...

Page 37: ...lay Define how long in seconds an incoming call has to wait before it is answered automatically by the system Requires that AutoAnswer Mode is switched on Requires user role ADMIN Value space 0 50 Range Select a value from 0 to 50 seconds Example xConfiguration Conference 1 AutoAnswer Delay 0 xConfiguration Conference 1 1 MicUnmuteOnDisconnect Mode Determine if the microphones shall be unmuted aut...

Page 38: ...Mode Set the conference encryption mode A padlock with the text Encryption On or Encryption Off displays on screen for a few seconds when the conference starts NOTE Requires the Encryption Option Key to be installed When the Encryption Option Key is not installed the encryption mode is set to Off Requires user role ADMIN Value space Off On BestEffort Off The system will not use encryption On The s...

Page 39: ...alue between 64 and 10000 Example xConfiguration Conference 1 MaxTotalTransmitCallRate 10000 xConfiguration Conference 1 1 MaxTotalReceiveCallRate This configuration applies when using a video system s built in MultiSite feature optional to host a multipoint video conference Specify the maximum overall receive bit rate allowed The bit rate will be divided fairly among all active calls at any time ...

Page 40: ...ion will not continue when the call is resumed NoAction The video system will not stop the presentation sharing when put on hold The presentation will not be shared while you are on hold but it will continue automatically when the call is resumed Example xConfiguration Conference 1 Presentation OnPlacedOnHold NoAction xConfiguration Conference 1 1 Multipoint Mode Define how the video system handle...

Page 41: ...1 with Type Helpdesk is available on the Touch screen control panel Note that the facility services are not available when using the remote control and on screen menu Requires user role ADMIN Value space Other Concierge Helpdesk Emergency Security Catering Transportation Other Select this option for services not covered by the other options Concierge Select this option for concierge services Helpd...

Page 42: ... audio calls Example xConfiguration FacilityService Service 1 CallType Video GPIO configuration xConfiguration GPIO Pin 1 4 Mode NOTE Applies only to Codec C60 The four GPIO pins are configured individually The state can be retrieved by xStatus GPIO Pin 1 4 State The default pin state is High 12 V When activated as output they are set to 0 V To activate them as input they must be pulled down to 0 ...

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

Page 44: ...ile 1 Gatekeeper Address 192 0 2 0 xConfiguration H323 Profile 1 1 H323Alias E164 The H 323 Alias E 164 defines the address of the system according to the numbering plan implemented in the H 323 Gatekeeper The E 164 alias is equivalent to a telephone number sometimes combined with access codes Requires user role ADMIN Value space S 0 30 Format Compact string with a maximum of 30 characters Valid c...

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

Page 46: ...HCPv6 server See RFC 3315 for a detailed description The Network IPv6 DHCPOptions setting will be ignored Autoconf Enable IPv6 stateless autoconfiguration of the IPv6 network interface See RFC 4862 for a detailed description The options for example NTP and DNS server addresses must either be set manually or obtained from a DHCPv6 server The Network IPv6 DHCPOptions setting determines which method ...

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

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

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

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

Page 51: ...o Manual Off Auto The Cisco Discovery Protocol CDP if available assigns an id to the voice VLAN If CDP is not available VLAN is not enabled Manual The VLAN ID is set manually using the Network VLAN Voice VlanId setting If CDP is available the manually set value will be overruled by the value assigned by CDP Off VLAN is not enabled Example xConfiguration Network 1 VLAN Voice Mode Off xConfiguration...

Page 52: ...e and receive SIP calls On Enable the possibility to place and receive SIP calls default Example xConfiguration NetworkServices SIP Mode On xConfiguration NetworkServices Telnet Mode Telnet is a network protocol used on the Internet or Local Area Network LAN connections Requires user role ADMIN Value space Off On Off The Telnet protocol is disabled This is the factory setting On The Telnet protoco...

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

Page 54: ...es user role ADMIN Value space S 0 64 Format A valid IPv4 address IPv6 address or DNS name Example xConfiguration NetworkServices NTP Address 1 ntp tandberg com xConfiguration NetworkServices SNMP Mode SNMP Simple Network Management Protocol is used in network management systems to monitor network attached devices routers servers switches projectors etc for conditions that warrant administrative a...

Page 55: ...multiparty conferences controlled by a Cisco TelePresence Multipoint Switch CTMS Video systems running software TC5 0 or later are able to initiate or join non encrypted multiparty conferences controlled by CTMS version 1 8 or later Encrypted conferences are supported as from software versions TC6 0 and CTMS 1 9 1 Encryption is addressed in the NetworkServices CTMS Encryption setting Requires user...

Page 56: ...t an internal or external configuration from the provisioning server Requires user role ADMIN Value space Internal External Auto Internal Request internal configuration External Request external configuration Auto Automatically discover using NAPTR queries whether internal or external configurations should be requested If the NAPTR responses have the e flag external configurations will be requeste...

Page 57: ...ill send a message to this address when starting up When receiving this message the external manager provisioning system can return configurations commands to the unit as a result When using CUCM or TMS provisioning the DHCP server can be set up to provide the external manager address automatically DHCP Option 242 for TMS and DHCP Option 150 for CUCM An address set in the Provisioning ExternalMana...

Page 58: ...r role ADMIN Value space S 0 64 Format String with a maximum of 64 characters Example xConfiguration Provisioning ExternalManager Domain any domain com RTP configuration xConfiguration RTP Ports Range Start Specify the first port in the range of RTP ports Also see the H323 Profile 1 1 PortAllocation setting NOTE Restart the system for any change to this setting to take effect Requires user role AD...

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

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

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

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

Page 63: ...to connect using transport protocols in the following order TLS TCP UDP Example xConfiguration SIP Profile 1 DefaultTransport Auto xConfiguration SIP Profile 1 1 TlsVerify For TLS connections a SIP CA list can be uploaded to the video system This can be done from the web interface Requires user role ADMIN Value space Off On Off Set to Off to allow TLS connections without verifying them The TLS con...

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

Page 65: ...sition defined by the selected preset RestoreCameraPosition After a reboot the camera position will be set to the position it had before the last boot DefaultCameraPosition After a reboot the camera position will be set to the factory default position Example xConfiguration Standby BootAction DefaultCameraPosition xConfiguration Standby StandbyAction Define the camera position when going into stan...

Page 66: ...en control panel The information can also be read with the command xStatus SystemUnit ContactInfo Requires user role ADMIN Value space Auto None IPv4 IPv6 H323Id E164Alias H320Number SipUri SystemName DisplayName Auto Show the address which another system can dial to reach this system The address depends on the default call protocol and system registration None Do not show any contact information ...

Page 67: ...h GMT 04 00 Moscow St Petersburg Volgograd GMT 03 00 Baghdad GMT 03 30 Tehran GMT 04 00 Abu Dhabi Muscat GMT 04 00 Baku Tbilisi Yerevan GMT 04 30 Kabul GMT 05 00 Islamabad Karachi Tashkent GMT 05 00 Ekaterinburg GMT 05 30 Chennai Kolkata Mumbai New Delhi GMT 05 45 Kathmandu GMT 06 00 Sri Jayawardenepura GMT 06 00 Astana Dhaka GMT 06 00 Almaty Novosibirsk GMT 06 30 Rangoon GMT 07 00 Bangkok Hanoi J...

Page 68: ...n the Touch screen control panel Example xConfiguration UserInterface UserPreferences On Video configuration xConfiguration Video AllowWebSnapshots Allow or disallow snapshots being taken of the local input sources remote sites and presentation channel If allowed the web interface Call Control page will show snapshots both when idle and in a call NOTE This feature is disabled by default and must b...

Page 69: ...whether the signal is analog RGB or digital However in some rare cases when DVI I cables are used these cables can carry both the analog and digital signals the auto detection fails This setting makes it possible to override the AutoDetect and select the correct DVI video input This setting should also be used if the video input is an analog component YPbPr type signal This is used by some cameras...

Page 70: ...o input Document_Camera Select Document_Camera when you have a document camera connected to the selected video input Example xConfiguration Video Input Source 1 Type PC xConfiguration Video Input Source 1 3 PresentationSelection Define how the video system will behave when a presentation source is connected to the video input In general any input source can be used as a presentation source normall...

Page 71: ...l CameraId 1 xConfiguration Video Input Source 1 3 OptimalDefinition Profile The Video Input Source Quality setting must be set to Motion for the optimal definition settings to take any effect The optimal definition profile should reflect the lighting conditions in your room and the quality of the video input camera the better the lighting conditions and video input the higher the profile Then in ...

Page 72: ...d for 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 m...

Page 73: ...sentation 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 Over...

Page 74: ...he setting takes effect from the next call onwards if changed during a call it will have no effect on the current call Requires user role ADMIN Value space Current UpperLeft UpperCenter UpperRight CenterLeft 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...

Page 75: ...he call 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 s...

Page 76: ...indicators On Display the on screen menus icons and indicators Example xConfiguration Video OSD Mode On xConfiguration Video OSD WallpaperSelection In cases where you want to prevent users from easily changing the wallpaper setting from the Settings menu the wallpaper setting can be made available from within the Administrator Settings menu The administrator settings can be password protected The ...

Page 77: ...f 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 OSD EncryptionIndicator Auto xConfiguration Video OSD MissedCallsNotification Define if there should be a missed calls notification on screen The setting only applies when the video system is operated by a remote con...

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

Page 79: ...ync Sony HDMI CEC Hitachi Kuro Link 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 MonitorRole The HDMI monitor role desc...

Page 80: ... range includes all code values 0 255 This is defined in CEA 861 E Limited Limited Quantization Range R G B quantization range that excludes some code values at the extremes 16 235 This is defined in CEA 861 E Example xConfiguration Video Output DVI 2 RGBQuantizationRange Full xConfiguration Video Output DVI 2 MonitorRole The DVI monitor role describes which video stream will be shown on the monit...

Page 81: ...including the local main video If active also show the presentation Example xConfiguration Video Output Composite 3 MonitorRole Auto xConfiguration Video Output Composite 3 OverscanLevel NOTE Applies only to Codec C60 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 to let the...

Page 82: ...ePresence System Codec C40 C60 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 C40 C60 API Reference Guide Chapter 4 xCommand commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

Page 84: ...mand 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 ...

Page 85: ...nd Conference 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 Sel...

Page 86: ...Unit 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 S...

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

Page 88: ... can 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 parameter 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 fact...

Page 89: ...le xCommand 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 Th...

Page 90: ...putId 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 Requ...

Page 91: ... output and generate the local output id A local output is a mix of local input and remote input signals All connectors attached to the local output receive the same signal 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...

Page 92: ... unique 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 Co...

Page 93: ...es user 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 loca...

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

Page 95: ... VU 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 Ring...

Page 96: ...ookings 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 Ho...

Page 97: ...er role 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 Abo...

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

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

Page 100: ... commands 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 CallHis...

Page 101: ...specified 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 CallH...

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

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

Page 104: ... xCommand 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 Pos...

Page 105: ...pan 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 ...

Page 106: ...K end 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 ...

Page 107: ... remove 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 comm...

Page 108: ... command 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...

Page 109: ...e g 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 Co...

Page 110: ...e the 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 ...

Page 111: ...vateResult 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 iden...

Page 112: ...t You can have from 1 to 4 slots for feedback ServerUrl Define the URL for the HTTP S server Expression 1 15 What parts of the Status and Configuration XML documents to monitor are specified 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 Feedback...

Page 113: ...y a 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 R...

Page 114: ...equired 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 Mess...

Page 115: ...you want 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 xFeedback commands in the API introduction secti...

Page 116: ...e sent 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...

Page 117: ...lderId 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 co...

Page 118: ...r The 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 N...

Page 119: ...e Mobile Other Telephone Video Number r S 0 255 Protocol Auto H320 H323 SIP CallRate 0 6000 CallType Audio Video Example xCommand Phonebook ContactMethod Add ContactId localContactId 2 Number 54321 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 Con...

Page 120: ... not 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...

Page 121: ...ethodId 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...

Page 122: ...ce if 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...

Page 123: ... software 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 perfor...

Page 124: ...d private 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 ...

Page 125: ...en the 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 Persisten...

Page 126: ... affect 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 Parame...

Page 127: ... the 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 ExtendedLoggi...

Page 128: ...end 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 hav...

Page 129: ...rofile will be active after next boot end xCommand SystemUnit ConfigurationProfile Remove Delete a configuration profile that has been stored in the system 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 SaveCurrentC...

Page 130: ...emUnit ReleaseKey List List all software versions that the system has a valid release key for Requires user role ADMIN Example xCommand SystemUnit ReleaseKey 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 S...

Page 131: ...outId 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 NOTE This command is not supported on Codec C40 Removes an existing ...

Page 132: ...t with one of the other remote sites main video making sure that you do not see the same site more than once nor yourself OwnMain Select that each site can see its own self view Presentation Select what is currently the presentation source there is always only one active H 239 content in a conference RemoteMain Select the main source of remote site The CallId must then be specified in the VideoSou...

Page 133: ... once nor yourself otherMainRemote 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 Sel...

Page 134: ...hich 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 NOTE This command is not supported on Codec C40 Assign the call layout main stream to th...

Page 135: ...ault OutputId A unique identifier for the local output which was created when the xCommand Audio LocalOutput Add command was issued Requires user role ADMIN Parameters OutputId r 0 65534 Example xCommand Video Layout UnAssignLocalOutput OutputId 1 OK r VideoLayoutUnAssignLocalOutputResult status OK end xCommand Video Layout UnAssignCall NOTE This command is not supported on Codec C40 Remove the de...

Page 136: ...Modes The system uses the auto mode part of the custom video layout database Default The system use the default video layout database which is provided by the system Requires user role ADMIN Parameters Type r Custom CustomAutoModes Default Example xCommand Video Layout LoadDb Type Default r VideoLayoutLoadDbResult status OK end xCommand Video Layout Frame List Lists the data related to all layout ...

Page 137: ...in the upper right corner of the screen Requires user role ADMIN Parameters Position r CenterLeft CenterRight LowerLeft LowerRight UpperCenter UpperLeft UpperRight Example xCommand Video PIP ActiveSpeaker Set Position UpperRight r ActiveSpeakerPipSetResult status OK end xCommand Video PIP Presentation Set Sets position for the presentation PiP picture in picture Position Predefined positions Cente...

Page 138: ...ult status OK end xCommand Video PIP Presentation Set Sets position for the presentation PiP picture in picture Position Predefined positions CenterLeft The presentation PiP appears on the left side of the screen in center CenterRight The presentation PiP appears on the right side of the screen in center LowerLeft The presentation PiP appears in the lower left corner of the screen LowerRight The p...

Page 139: ...co TelePresence System Codec C40 C60 API Reference Guide Experimental commands The Experimental commands are for testing only and should not be used unless agreed with Cisco These commands are not documented and WILL change in later releases Contents Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

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

Page 141: ...Status Call n Direction 151 xStatus Call n Protocol 151 xStatus Call n CallType 152 xStatus Call n RemoteNumber 152 xStatus Call n CallbackNumber 152 xStatus Call n DisplayName 152 xStatus Call n TransmitCallRate 152 xStatus Call n ReceiveCallRate 152 xStatus Call n FacilityServiceId 153 xStatus Call n Encryption Type 153 xStatus Call n PlacedOnHold 153 xStatus Call n Duration 153 xStatus Call n S...

Page 142: ...atus Conference SelectedCallProtocol 162 Diagnostics status 163 xStatus Diagnostics 163 xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 Jitter 163 xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 Jitter 163 xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 Jitter 163 xStatus Diagnostics Call n Channels OutgoingAudioChannel n Netstat 1 Jitt...

Page 143: ...s OutgoingDataChannel n Netstat 1 ChannelRate 166 xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 MaxJitter 167 xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 MaxJitter 167 xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 MaxJitter 167 xStatus Diagnostics Call n Channels OutgoingAudioChannel n Netstat 1 MaxJitter 167 xStatus Diagnostics...

Page 144: ...atus MediaChannels Call n OutgoingAudioChannel n Transport RTCP Local Port 178 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RTCP Remote IpAddress 179 xStatus MediaChannels Call n OutgoingAudioChannel n Transport RCTP Remote Port 179 xStatus MediaChannels Call n OutgoingVideoChannel n Encryption Status 179 xStatus MediaChannels Call n OutgoingVideoChannel n ChannelRole 179 xStatus ...

Page 145: ...1 xStatus Provisioning CUCM UserId 191 xStatus Provisioning CUCM CTL State 191 xStatus Provisioning CUCM ExtensionMobility Enabled 191 xStatus Provisioning CUCM ExtensionMobility LoggedIn 191 xStatus Provisioning CUCM ExtensionMobility LastLoggedInUserId 191 xStatus Provisioning CUCM TVS Proxy n Server 191 xStatus Provisioning CUCM TVS Proxy n IPv6Address 192 xStatus Provisioning CUCM TVS Proxy n ...

Page 146: ...it State System 202 xStatus SystemUnit State MaxNumberOfCalls 202 xStatus SystemUnit State MaxNumberOfActiveCalls 203 xStatus SystemUnit State NumberOfActiveCalls 203 xStatus SystemUnit State NumberOfSuspendedCalls 203 xStatus SystemUnit State NumberOfInProgressCalls 203 xStatus SystemUnit State Subsystem Application 203 xStatus SystemUnit ContactInfo 203 xStatus SystemUnit ContactName 203 xStatus...

Page 147: ...tput 1 3 Frame 1 6 MediaChannelId 213 xStatus Video Layout Site n Output 1 3 Frame 1 6 VideoSourceType 213 xStatus Video Layout Site n Output 1 3 Frame 1 6 VideoSourceId 213 xStatus Video Layout Site n Output 1 3 Frame 1 6 InputNumber 213 xStatus Video Layout Site n Output 1 3 Frame 1 6 Filename 213 xStatus Video Layout Site n Output n Frame n VideoSourceContent 214 xStatus Video Layout Site n Out...

Page 148: ...rs have been mixed together You can run the command xStatus Audio Input LocalInput to find the identity n of the input Auto The microphone with the 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 ...

Page 149: ...teInput 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 Audi...

Page 150: ...ocalOutput 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...

Page 151: ...ws 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 St...

Page 152: ...l to 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 xStat...

Page 153: ...tion 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 NotAuthen...

Page 154: ...era 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 Hardw...

Page 155: ... xStatus 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 curren...

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

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

Page 158: ...ly Example xStatus Conference Presentation LocalSendingMode s Conference Presentation LocalSendingMode Off end xStatus Conference Presentation LastLocalSource Identifies the last used local presentation source Value space of the result returned Integer Example xStatus Conference Presentation LastLocalSource s Conference Presentation LastLocalSource 2 end xStatus Conference Site n Capabilities FECC...

Page 159: ...l is 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 Presentati...

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

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

Page 162: ...space 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 Confere...

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

Page 164: ...tstat 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 OutgoingAudioChan...

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

Page 166: ...l 27 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 Ca...

Page 167: ... 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 0 end GPIO status xS...

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

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

Page 170: ...re information 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 Exam...

Page 171: ...address 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 ...

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

Page 173: ...an ITU 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 Au...

Page 174: ...ioChannel 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 MediaChan...

Page 175: ...diaChannels 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 H2...

Page 176: ...l Port 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 Tran...

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

Page 178: ...AudioChannel 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 x...

Page 179: ...goingVideoChannel 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 MediaChanne...

Page 180: ...VideoChannel 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 Med...

Page 181: ...s Call 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 Ex...

Page 182: ...ace 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 ad...

Page 183: ...us is 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 provisioning server address is defined as a vendor en...

Page 184: ...ring 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 Techni...

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

Page 186: ...ring 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 NetworkServ...

Page 187: ...tring 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 NeedCo...

Page 188: ...oning 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 Pr...

Page 189: ..._ 1 _ 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...

Page 190: ...reason 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 CAP...

Page 191: ...e s 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 whet...

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

Page 193: ...mode 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 Exa...

Page 194: ...f the 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 Verifi...

Page 195: ...y com 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 ...

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

Page 197: ... of 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 P...

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

Page 199: ...tPlatform 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 ...

Page 200: ...tware 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 OptionKeys MultiSite Shows ...

Page 201: ...her 0 or 1 0 The system does not have the new flash memory installed 1 The system has the new flash memory installed If downgraded it can only be downgraded to previous TC software versions having support for the new version of the flash memory Value space of the result returned 1 0 Example xStatus SystemUnit Hardware Module CompatibilityLevel s SystemUnit Hardware Module CompatibilityLevel 1 end ...

Page 202: ...re degree Celsius measured in the codec system Value space of the result returned String Example xStatus SystemUnit Hardware Temperature s SystemUnit Hardware Temperature 64 0 end xStatus SystemUnit Hardware TemperatureThreshold Returns information on the maximum temperature for the codec If this temperature is exceeded the system automatically shuts down Value space of the result returned String ...

Page 203: ...ple xStatus SystemUnit State NumberOfInProgressCalls s SystemUnit State NumberOfInProgressCalls 0 end xStatus SystemUnit State Subsystem Application Shows the status of the sub system application Initialized The sub system application is initialized Initializing The sub system application is initializing Value space of the result returned Initialized Initializing Example xStatus SystemUnit State S...

Page 204: ...ooted 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 command Value space of the result returned String Example xStatus SystemUnit Notifications Notification 1 Text s SystemUnit Notifications Notification 1 Text OK end xStatus SystemUnit Diagnostics LastRun Shows w...

Page 205: ... Diagnostics 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 diag...

Page 206: ... layout is distributed on two monitors DualPresentationOnly All participants in the call will be shown on the first monitor while the presentation if any will be shown on the second monitor Quadruple The layout is distributed on four monitors so that each remote participant and the presentation will be shown on separate monitors Value space of the result returned Single Dual DualPresentationOnly T...

Page 207: ...esolution 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 3 Resolution FormatType Shows the resolution format type for the video input source Value space of the result returned Unknown AnalogCVTBlanking AnalogCVTReducedBla...

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

Page 209: ...tus Video Output HDMI 1 Resolution Height Shows the resolution height in pixels for the video output HDMI Value space of the result returned 120 3000 Example xStatus Video Output HDMI 1 Resolution Height s Video Output HDMI 1 Resolution Height 720 end xStatus Video Output HDMI 1 Resolution Width Shows the resolution width in pixels for the video output HDMI Value space of the result returned 176 4...

Page 210: ...put DVI 2 Resolution Width Shows the resolution width in pixels for the video output DVI Value space of the result returned 176 4000 Example xStatus Video Output DVI 2 Resolution Width s Video Output DVI 2 Resolution Width 1280 end xStatus Video Output DVI 2 Resolution RefreshRate Shows the resolution refresh rate Hz for the video output DVI Value space of the result returned 1 300 Example xStatus...

Page 211: ...t returned 120 3000 Example xStatus Video Output Legacy 3 Resolution Height s Video Output Legacy 3 Resolution Height 480 end xStatus Video Output Legacy 3 Resolution Width Shows the resolution width in pixels for the video output Legacy Composite Value space of the result returned 176 4000 Example xStatus Video Output Legacy 3 Resolution Width s Video Output Legacy 3 Resolution Width 720 end xSta...

Page 212: ...nstance Value space of the result returned String Example xStatus Video Layout Site 1 Output 1 GraphicName s Video Layout Site 1 Output 1 GraphicName full pip end xStatus Video Layout Site n Output 1 3 Frame 1 6 PositionX Shows the horizontal position of the upper left corner of the frame Value space of the result returned 0 10000 Example xStatus Video Layout Site 1 Output 1 Frame 1 PositionX s Vi...

Page 213: ...e type in the frame Value space of the result returned String Example xStatus Video Layout Site 1 Output 1 Frame 1 VideoSourceType s Video Layout Site 1 Output 1 Frame 1 VideoSourceType graphic end xStatus Video Layout Site n Output 1 3 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 Fr...

Page 214: ...e 1 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 Vide...

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

Page 216: ...n display 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 spac...

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

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

Page 219: ... the 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 Stan...

Page 220: ...15 0F 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 Bu...

Page 221: ...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 not the system can b...

Page 222: ...per user 0 Maximum 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 ti...

Page 223: ...nnect 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...

Page 224: ...S AND 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 CONSEQU...

Search results

Summary of Contents for TelePresence System Codec C40

Reviews:

Related manuals for TelePresence System Codec C40

Brands by name

Popular brands

Cisco TelePresence System Codec C40, Reference Manual

Search results

Summary of Contents for TelePresence System Codec C40

Reviews:

Related manuals for TelePresence System Codec C40

Brands by name

Popular brands