Cisco Quick Set C20 Reference Manual Download Page 78 | Manualshive

Page: 78 / 195

background image

D14869.11

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

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

78

Cisco TelePresence System Codec C20

API Reference Guide

Audio commands

xCommand Audio Microphones Mute

Mute all microphones.

Requires user role:

USER

Example:

xCommand Audio Microphones Mute
*r AudioMicrophonesMuteResult (status=OK):
** end

xCommand Audio Microphones Unmute

Unmute microphones.

Requires user role:

USER

Example:

xCommand Audio Microphones Unmute
*r AudioMicrophonesUnmuteResult (status=OK):
** end

xCommand Audio Sound Play

Play a specified audio sound.

Requires user role:

USER

Parameters:

Sound(r): <Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/KeyTone/Nav/

NavBack/Notification/OK/PresentationConnect/Ringing/SpecialInfo/TelephoneCall/VideoCall/

Volume>
Loop: <On/Off>

Example:

xCommand Audio Sound Play Sound: Ringing
*r AudioSoundPlayResult (status=OK):
** end

xCommand Audio Sound Stop

Stop playing audio sound.

Requires user role:

USER

Example:

xCommand Audio Sound Stop
*r AudioSoundStopResult (status=OK):
** end

xCommand Audio SoundsAndAlerts Ringtone List

Lists all available ringtones that can be configured using xConfiguration Audio SoundsAndAlerts

RingTone.

Requires user role:

USER

Example:

xCommand Audio SoundsAndAlerts Ringtone List
*r AudioRingtoneListResult Ringtone 1 Id: "Sunrise"
*r AudioRingtoneListResult Ringtone 2 Id: "Mischief"
*r AudioRingtoneListResult Ringtone 3 Id: "Ripples"
*r AudioRingtoneListResult Ringtone 4 Id: "Reflections"
*r AudioRingtoneListResult Ringtone 5 Id: "Vibes"
*r AudioRingtoneListResult Ringtone 6 Id: "Delight"
*r AudioRingtoneListResult Ringtone 7 Id: "Evolve"
*r AudioRingtoneListResult Ringtone 8 Id: "Playful"
*r AudioRingtoneListResult Ringtone 9 Id: "Ascent"
*r AudioRingtoneListResult Ringtone 10 Id: "Calculation"
*r AudioRingtoneListResult Ringtone 11 Id: "Mellow"
*r AudioRingtoneListResult Ringtone 12 Id: "Ringer"
** end

Contents

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus

xCommand

«
...
76
77
78
79
80
...
»

Summary of Contents for Quick Set C20

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

Page 2: ...k 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 74 Description of the xCommand commands...

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

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

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

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

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

Page 8: ... is required for these settings to take effect xConfiguration SerialPort BaudRate 9600 19200 38400 57600 115200 xConfiguration SerialPort LoginRequired Off On Connecting For the C20 codec you need to use a Y cable to connect to the Camera port 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 rea...

Page 9: ... control systems XML XML output for use with control systems that understand XML The default output mode is terminal To change this you have to define your preferences for each session individually Examples in this guide are in terminal mode To set ouput mode to XML issue the command xPreferences outputmode xml To revert to terminal mode issue the command xPreferences outputmode terminal Example L...

Page 10: ...edback 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 returns...

Page 11: ... Quotes are not necessary for values without spaces Examples xCommand dial number my number contains spaces xCommand dial number 12345 Case sensitivity All commands are case insensitive 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 ...

Page 12: ...ce Dial DTMFSend Experimental FacilityService FarEndControl HttpFeedback Key Message Phonebook Presentation Preset Provisioning Security Standby SystemUnit Video OK Commands Commands instruct the codec to execute actions such as to dial a number or to search the phone book All commands start with the prefix xCommand followed by a command path Writing xCommand on the command line will list all the ...

Page 13: ...rence Experimental FacilityService H323 Logging Network NetworkServices Phonebook Provisioning RTP Security SerialPort SIP Standby SystemUnit Time UserInterface Video OK Configurations Configurations are system settings that are persistent across boots Like commands also configurations are structured in a hierarchy Writing xConfiguration on the command line lists all the top level configurations W...

Page 14: ... Call 2 Encryption Type None s Call 2 PlacedOnHold False s Call 2 Duration 6 s Call 2 AnswerState Answered s Call 2 ModifyState Idle s Call 2 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 1 Conference Diagnostics Experimental H320 H323 HttpFeedback 1 4 ICE MediaChannels Network 1 1 NetworkService...

Page 15: ...nected successfully that is when all channels are up and established e CallSuccessful 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 ...

Page 16: ...gs Call 1 CallRate 6000000 h xHistory CallLogs Call 1 CallPriority None h xHistory CallLogs Call 1 DisconnectCauseValue 2 h xHistory CallLogs Call 1 DisconnectCause Normal h xHistory CallLogs Call 1 DisconnectCauseType RemoteDisconnect h xHistory CallLogs Call 1 DisconnectCauseCode 16 h xHistory CallLogs Call 1 DisconnectCauseOrigin SIP h xHistory CallLogs Call 1 StartTime 2013 03 09 10 55 53 h xH...

Page 17: ...sions 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 language This language describes a w...

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

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

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

Page 21: ...umber Protocol H323 Protocol Dial Command Example 2 Assigning video layout to a call Terminal xCommand Video Layout AssignCall CallId 2 LayoutId 1 XML Command Video Layout AssignCall command True CallId 2 CallId LayoutId 1 LayoutId AssignCall Layout Video Command Translating configurations Translating from xConfiguration to XML is similar to commands but with the addition of a special attribute it...

Page 22: ...to unnecessary feedback Subscribing to too much feedback may congest the control application Although the amount of feedback may seem fine in the current version the amount of feedback may grow in future releases DO present one screen to the end user Avoid making the user look at two menus one on the control panel and one on the video screen Do not make the control panel a substitute for the remot...

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

Page 24: ...efaultTimeout 32 xConfiguration Conference 1 1 FarEndControl Mode 32 xConfiguration Conference 1 1 FarEndControl SignalCapability 32 xConfiguration Conference 1 1 Encryption Mode 33 xConfiguration Conference 1 1 DefaultCall Protocol 33 xConfiguration Conference 1 1 DefaultCall Rate 33 xConfiguration Conference 1 1 MaxTransmitCallRate 33 xConfiguration Conference 1 1 MaxReceiveCallRate 33 xConfigur...

Page 25: ...ation Network 1 1 IEEE8021X Identity 43 xConfiguration Network 1 1 IEEE8021X Password 43 xConfiguration Network 1 1 IEEE8021X AnonymousIdentity 43 xConfiguration Network 1 1 IEEE8021X Eap Md5 43 xConfiguration Network 1 1 IEEE8021X Eap Ttls 43 xConfiguration Network 1 1 IEEE8021X Eap Tls 43 xConfiguration Network 1 1 IEEE8021X Eap Peap 44 xConfiguration Network 1 1 MTU 44 xConfiguration Network 1 ...

Page 26: ...ateTransferror 54 xConfiguration SIP ListenPort 54 xConfiguration SIP PreferredIPMedia 54 xConfiguration SIP PreferredIPSignaling 54 xConfiguration SIP OCSP Mode 54 xConfiguration SIP OCSP DefaultResponder 54 xConfiguration SIP Profile 1 1 Ice Mode 54 xConfiguration SIP Profile 1 1 Ice DefaultCandidate 55 xConfiguration SIP Profile 1 1 Turn DiscoverMode 55 xConfiguration SIP Profile 1 1 Turn Bandw...

Page 27: ...tion Video SelfviewDefault FullscreenMode 66 xConfiguration Video SelfviewDefault PIPPosition 66 xConfiguration Video SelfviewDefault OnMonitorRole 66 xConfiguration Video CamCtrlPip CallSetup Mode 67 xConfiguration Video CamCtrlPip CallSetup Duration 67 xConfiguration Video PIP ActiveSpeaker DefaultValue Position 67 xConfiguration Video PIP Presentation DefaultValue Position 67 xConfiguration Vid...

Page 28: ...ones Mode Off xConfiguration Audio SoundsAndAlerts RingVolume Sets the ring volume for an incoming call Requires user role USER Value space 0 100 Range The value goes in steps of 5 from 0 to 100 from 34 5 dB to 15 dB Volume 0 Off Example xConfiguration Audio SoundsAndAlerts RingVolume 50 xConfiguration Audio Volume Adjust the speaker volume Requires user role USER Value space 0 100 Range The value...

Page 29: ... 1 Brightness Mode Auto xConfiguration Cameras Camera 1 1 Brightness Level Set the brightness level NOTE Requires the Camera Brightness Mode to be set to Manual Requires user role ADMIN Value space 1 31 Range Select a value from 1 to 31 Example xConfiguration Cameras Camera 1 Brightness Level 1 xConfiguration Cameras Camera 1 1 Flip With Flip mode vertical flip you can flip the image upside down R...

Page 30: ...Requires user role ADMIN Value space Auto Off On Auto When the camera is placed upside down the image is automatically mirrored Use this setting with cameras that can be mounted upside down and that can auto detect that the camera is mounted upside down Off See the self view in normal mode that is the experience of self view is as seeing yourself as other people see you On See the self view in mir...

Page 31: ...ple xConfiguration Cameras Camera 1 DHCP Off Conference configuration xConfiguration Conference 1 1 CallProtocolIPStack Select if the system should enable IPv4 IPv6 or dual IP stack on the call protocol SIP H323 Requires user role ADMIN Value space Dual IPv4 IPv6 Dual Enables both IPv4 and IPv6 for H323 and SIP calls IPv4 When set to IPv4 the call protocol SIP H323 will use IPv4 IPv6 When set to I...

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

Page 33: ...ed when placing calls from the system Requires user role ADMIN Value space 64 6000 Range Select a value between 64 and 6000 kbps Example xConfiguration Conference 1 DefaultCall Rate 768 xConfiguration Conference 1 1 MaxTransmitCallRate Specify the maximum transmit bit rate to be used when placing or receiving calls Note that this is the maximum bit rate for each individual call use the Conference ...

Page 34: ...ation channel weight is 1 then the main channel will use twice as much bandwidth as the presentation channel Requires user role ADMIN Value space 1 10 Range 1 to 10 Example xConfiguration Conference 1 VideoBandwidth MainChannel Weight 5 xConfiguration Conference 1 1 VideoBandwidth PresentationChannel Weight The available transmit video bandwidth is distributed on the main channel and presentation ...

Page 35: ...quires MultiSite or MultiWay support Deny An incoming call will be rejected if you are already in a call You will not be notified about the incoming call However the call will appear as a missed call in the call history list Example xConfiguration Conference 1 IncomingMultisiteCall Mode Allow FacilityService configuration xConfiguration FacilityService Service 1 5 Type Up to five different facilit...

Page 36: ...ce Service 1 CallType Video H323 configuration xConfiguration H323 NAT Mode The firewall traversal technology creates a secure path through the firewall barrier and enables proper exchange of audio video data when connected to an external video conferencing system when the IP traffic goes through a NAT router NOTE NAT does not work in conjunction with gatekeepers Requires user role ADMIN Value spa...

Page 37: ...the system will still try to register NOTE Requires the H 323 Gatekeeper Authentication Mode to be enabled Requires user role ADMIN Value space S 0 50 Format String with a maximum of 50 characters Example xConfiguration H323 Profile 1 Authentication Password xConfiguration H323 Profile 1 1 CallSetup Mode The H 323 Call Setup Mode defines whether to use a Gatekeeper or Direct calling when establish...

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

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

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

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

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

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

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

Page 45: ...d 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 protocol is...

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

Page 47: ...ser 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 atten...

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

Page 49: ...nternal 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 requested Othe...

Page 50: ...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 ExternalManager ...

Page 51: ...le 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 ADMIN ...

Page 52: ... 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 Address Th...

Page 53: ...erialPort configuration xConfiguration SerialPort Mode Enable disable the serial port connection via Camera port with Y cable 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 ...

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

Page 55: ... 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 relay...

Page 56: ...onnect 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 connect...

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

Page 58: ...osition 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 sta...

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

Page 60: ...T 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 Jakar...

Page 61: ...user preferences are available from the Settings menu on the touch screen control panel Example xConfiguration UserInterface UserPreferences On Video configuration xConfiguration Video Input Source 1 2 Name Enter a name for the video input source Requires user role ADMIN Value space S 0 50 Format String with a maximum of 50 characters Example xConfiguration Video Input Source 1 Name xConfiguration...

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

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

Page 64: ...mage with any source The default value is set to Full because most DVI sources expects full quantization range Requires user role ADMIN Value space Auto Full Limited Auto RGB quantization range is automatically selected based on video format according to CEA 861 E CE video formats will use limited quantization range levels IT video formats will use full quantization range levels Full Full quantiza...

Page 65: ...w Determine if the main video source self view shall be displayed on screen This setting is obsoleted by the Video SelfviewDefault Mode setting as from TC6 0 Requires user role USER Value space Off On Off Do not display self view on screen On Display self view on screen Example xConfiguration Video Selfview On xConfiguration Video SelfviewPosition Select where the small self view PiP Picture in Pi...

Page 66: ...f view is switched on see the Video SelfviewDefault Mode setting and fullscreen view is switched off see the Video SelfviewDefault FullscreenMode setting This setting obsoletes the Video SelfviewPosition setting as from TC6 0 Requires user role ADMIN Value space Current UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Current The position of the self view PiP will be ke...

Page 67: ...ve speaker PiP will appear in the lower right corner of the screen Example xConfiguration Video PIP ActiveSpeaker DefaultValue Position Current xConfiguration Video PIP Presentation DefaultValue Position Determine the position on screen of the presentation picture in picture PiP The setting only takes effect when the presentation is explicitly minimized to a PiP for example using the remote contro...

Page 68: ...PresentationDefault View Default xConfiguration Video Layout RemoteLayoutFamily Select which video layout family to be used for the remote participants Requires user role ADMIN Value space Auto FullScreen Equal PresentationSmallSpeaker PresentationLargeSpeaker Prominent Overlay Single Auto The default layout family as given by the local layout database will be used as the remote layout For more in...

Page 69: ...OSD LanguageSelection On xConfiguration Video OSD MenuStartupMode Configure the state of the on screen menus after a video system codec boot Requires user role ADMIN Value space Closed Home Closed The on screen menu will NOT expand automatically This setting is recommended for 3rd party integrations that need full control of what is shown on the OSD Home The on screen menu will show the home menu ...

Page 70: ... OSD CallSettingsSelection Off xConfiguration Video OSD TodaysBookings This setting can be used to display the system s bookings for today on the main on screen menu This requires that the system is bookable by an external booking system like for example the Cisco TelePresence Management Suite TMS Requires user role ADMIN Value space Off On Off Do not display todays bookings On Displays informatio...

Page 71: ...and add the PIN code Requires user role ADMIN Value space Off On Off No login to the menus on screen OSD is required On The user must log in to access the menus on screen OSD Example xConfiguration Video OSD LoginRequired Off xConfiguration Video AllowWebSnapshots Allow or disallow snapshots being taken of the local input sources remote sites and presentation channel If allowed the web interface C...

Page 72: ...ole 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 system not use the outer parts of video resolution Both the video and the on screen menu will be scaled in this case Requires user role ADMIN Value space None Medium High None The system will use all of the output resolution Medium The system will not use the outer ...

Page 73: ...ePresence System Codec C20 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 74: ... JANUARY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 74 Cisco TelePresence System Codec C20 API Reference Guide Chapter 4 xCommand commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

Page 75: ...AcknowledgeMissedCall 83 xCommand CallHistory DeleteAll 83 xCommand CallHistory DeleteEntry 84 xCommand CallHistory Get 84 xCommand CallHistory Recents 85 CallLog commands 85 xCommand CallLog Clear 85 xCommand CallLog Recent Delete 85 xCommand CallLog Outgoing Delete 86 xCommand CallLog Received Delete 86 xCommand CallLog Missed Delete 86 xCommand CallLog Missed Dismiss 86 CamCtrlPip commands 87 x...

Page 76: ... Message TextLine Clear 97 xCommand Message Prompt Display 97 xCommand Message Prompt Clear 98 xCommand Message Prompt Response 98 xCommand Message Echo 98 xCommand Message FarendMessage 98 Phonebook commands 99 xCommand Phonebook Folder Add 99 xCommand Phonebook Folder Modify 99 xCommand Phonebook Folder Delete 99 xCommand Phonebook Contact Add 100 xCommand Phonebook Contact Modify 100 xCommand P...

Page 77: ...110 xCommand SystemUnit DateTime Set 110 xCommand SystemUnit DateTime Get 110 xCommand SystemUnit FactoryReset 110 xCommand SystemUnit SoftwareUpgrade 111 xCommand SystemUnit ConfigurationProfile Change 111 xCommand SystemUnit ConfigurationProfile Remove 111 xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs 111 xCommand SystemUnit ConfigurationProfile List 111 xCommand SystemUnit...

Page 78: ...ult status OK end xCommand Audio Sound Stop Stop playing audio sound Requires user role USER Example xCommand Audio Sound Stop r AudioSoundStopResult 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 AudioRi...

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

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

Page 81: ...mand to see the CallId Requires user role USER Parameters CallId 0 65534 Example xCommand Call Reject CallId 20 OK r CallRejectResult status OK end xCommand Call Disconnect Disconnect a call The CallID is returned when the xCommand Dial command is run During the call you can run the xStatus Call command to see the CallId Requires user role USER Parameters CallId r 0 65534 Example xCommand Call Dis...

Page 82: ...ng are required 1 The result from the xStatus Conference Site CallId ConferenceExtended must be NotExtended s Conference Site CallId ConferenceExtended NotExtended 2 The following tag from the bookings list command must have a value 0 r Bookings Booking bookingNumber MaximumMeetingExtension 30 Note The command returns the result from the command itself not the result from the extension request to ...

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

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

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

Page 86: ... Received command Requires user role USER Parameters LogTag 0 2147483647 Example xCommand CallLog Received Delete LogTag 126 r DeleteResult status OK end xCommand CallLog Missed Delete Delete the call log of missed calls If a logtag is given as argument that specific call is deleted from the log If no logtag is given the system deletes the complete missed calls log The LogTag values for missed cal...

Page 87: ...mand 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 1 Example xCommand Camera PanTiltReset CameraId 1 OK r PanTiltResetResult status OK end xCommand Camera Position...

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

Page 89: ...to the xCommand Preset commands where a single preset covers ALL connected cameras plus the Video Input switcher settings PresetId The ID of the camera preset you want to activate Requires user role USER Parameters PresetId r 1 35 Example xCommand Camera Preset Activate PresetId 1 OK r CameraPresetActivateResult status OK end xCommand Camera Preset Edit Edit a stored camera preset You can change t...

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

Page 91: ...and 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 xCom...

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

Page 93: ...e far end camera the remote camera NOTE The far end camera moves in the specified direction until the stop command ref xCommand FarEndControl Camera Stop is issued CallId The CallID is returned when the xCommand Dial command is run During the call you can run the xStatus Call command to see the CallId Value Select the action for how to move the camera Requires user role USER Parameters CallId 0 65...

Page 94: ...Result status OK end xCommand FarEndControl Preset Store While in a call this command is used to store a preset on the far end codec The preset covers the far end codec s camera positions and input video switcher settings Note The far end codec s xConfiguration Conference FarEndControl Mode setting must be switched On for the FarEndControl commands to work CallId The CallId is required to identify...

Page 95: ...TP S Requires user role USER Parameters FeedbackSlot r 1 4 Example xCommand HttpFeedback Deregister FeedbackSlot 1 OK r FeedbackDeregisterResult status OK FeedbackSlot 1 end Key commands xCommand Key Click Emulates a remote control key press followed by a key release 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 MuteM...

Page 96: ...o monitor the feedback from the user Read more about the xFeedback commands in the API introduction section in this guide Title Enter a message title Text Enter the message to be displayed The p and br HTML tags will result in line breaks as normal any other tags will appear as plain text Duration Set how long in seconds the message is to be displayed on the screen If set to 0 zero the message doe...

Page 97: ...as defined by the xCommand Message TextLine Display command Requires user role ADMIN Example xCommand Message TextLine Clear OK r MessageTextLineClearResult status OK end xCommand Message Prompt Display Display a small window on screen with a title text and up to five options for response from the user The message is displayed on screen until the user gives a response or until the system receives ...

Page 98: ...lay command Requires user role USER Parameters FeedbackId S 0 255 OptionId r 1 5 Example xCommand Message Prompt Response OptionId 1 OK r MessagePromptResponseResult status OK end xCommand Message Echo Issuing the command makes the API raise a message echo event The command has no other impact on the codec Usage can be to poll the codec from a control system or any external device system to check ...

Page 99: ...der The identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder Name r The name of the contact ParentFolderId The unique identifier for the parent folder The identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Folder Add comm...

Page 100: ...rId S 0 255 ImageURL S 0 255 Title S 0 255 Number S 0 255 Protocol Auto H320 H323 SIP CallRate 0 6000 CallType Audio Video Device Mobile Other Telephone Video Example xCommand Phonebook Contact Add Name John Doe Number 12345 OK r PhonebookContactAddResult status OK Name localContactId 1 end xCommand Phonebook Contact Modify Modify contact details of an existing contact in the local phonebook The f...

Page 101: ...ppear in the Favorites list on the Cisco TelePresence Touch controller The first contact method may have been created when issuing the xCommand Phonebook Contact Add command to make the contact All contact methods are available in the API on the web interface and when using the remote control ContactId The unique identifier for the contact that you want to add a contact method to The identifier wi...

Page 102: ...ser role USER Parameters ContactId r S 0 255 ContactMethodId r S 0 255 Device Mobile Other Telephone Video Number S 0 255 Protocol Auto H320 H323 SIP CallRate 0 6000 CallType Audio Video Example xCommand Phonebook ContactMethod Modify ContactMethodId 117 ContactId localContactId 10 Number newnumber cisco com OK xCommand Phonebook ContactMethod Delete Delete a contact method from an existing contac...

Page 103: ...cifying any parameters all folders contacts and contact methods in the local phone book will be returned Requires user role USER Parameters PhonebookId S 0 255 PhonebookType Corporate Local SearchString S 0 255 SearchField Name Number Offset 0 65534 FolderId S 0 255 Limit 0 65534 Recursive False True ContactType o Any Folder Contact Example xCommand Phonebook Search PhonebookType Corporate Limit 2...

Page 104: ... in the same preset The system may hold 15 predefined video input presets These presets are available for far end control i e they are referred in the PresetId parameter of the xCommand FarEndControl Preset Activate command In contrast the xCommand Camera Preset commands applies to individual cameras only Those presets are not available for far end control PresetId The ID of this preset Type Curre...

Page 105: ...ically downloaded and installed The codec reboots to complete the software upgrade Requires user role ADMIN Example xCommand Provisioning StartUpgrade r StartUpgradeResult status OK end xCommand Provisioning CompleteUpgrade Starts installing the software upgrade if you wish to install it before it is set to do so Requires user role USER Example xCommand Provisioning CompleteUpgrade r CompleteUpgra...

Page 106: ...nd for the Extension Mobility service You login to the Extension Mobility service with a user name and pin If there are multiple profiles available for that user a separate event will be sent with the available profiles for the user A new login command with the profile can then be submitted Requires user role USER Parameters UserId r S 1 255 Pin r S 1 255 Profile o S 1 255 Example xCommand Proviso...

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

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

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

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

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

Page 112: ... CallID is returned when the xCommand Dial command is run During the call you can run the xStatus Call command to see the CallId LayoutFamily Select a layout family CustomLayoutName Enter a name for the layout Requires user role USER Parameters Target local remote CallId 0 65534 LayoutFamily r auto custom equal fullscreen overlay presentationlargespeaker presentationsmallspeaker prominent single s...

Page 113: ...enterRight The ActiveSpeaker PiP appears on the right side of the screen in center LowerLeft The ActiveSpeaker PiP appears in the lower left corner of the screen LowerRight The ActiveSpeaker PiP appears in the lower right corner of the screen UpperCenter The ActiveSpeaker PiP appears on top of the screen in center UpperLeft The ActiveSpeaker PiP appears in the upper left corner of the screen Upper...

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

Page 115: ...co TelePresence System Codec C20 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 116: ...0 JANUARY 2014 Copyright 2010 2014 Cisco Systems Inc All rights reserved 116 Cisco TelePresence System Codec C20 API Reference Guide Chapter 5 xStatus commands Contents Introduction About the API xConfiguration Appendices xCommand xStatus xStatus ...

Page 117: ...atus Camera 1 1 Position Tilt 128 xStatus Camera 1 1 Position Zoom 129 xStatus Camera 1 1 Position Focus 129 xStatus Camera 1 1 Capabilities Options 129 xStatus Camera 1 1 Flip 129 xStatus Camera n UpgradeStatus 129 xStatus Camera n DownloadProgress 130 Conference status 130 xStatus Conference 130 xStatus Conference Presentation Mode 130 xStatus Conference Presentation Protocol 130 xStatus Confere...

Page 118: ...atus Diagnostics Call n Channels OutgoingVideoChannel n Netstat 1 Loss 137 xStatus Diagnostics Call n Channels OutgoingDataChannel n Netstat 1 Loss 137 xStatus Diagnostics Call n Channels IncomingAudioChannel n Netstat 1 LastIntervalLost 137 xStatus Diagnostics Call n Channels IncomingVideoChannel n Netstat 1 LastIntervalLost 137 xStatus Diagnostics Call n Channels IncomingDataChannel n Netstat 1 ...

Page 119: ...s 146 xStatus MediaChannels Call n IncomingAudioChannel n Transport RTP Local IpAddress 146 xStatus MediaChannels Call n IncomingAudioChannel n Transport RTP Local Port 146 xStatus MediaChannels Call n IncomingAudioChannel n Transport RTP Remote IpAddress 146 xStatus MediaChannels Call n IncomingAudioChannel n Transport RTP Remote Port 146 xStatus MediaChannels Call n IncomingAudioChannel n Transp...

Page 120: ...pAddress 153 xStatus MediaChannels Call n OutgoingVideoChannel n Transport RCTP Remote Port 154 Network status 154 xStatus Network 154 xStatus Network 1 Ethernet MacAddress 154 xStatus Network 1 Ethernet Speed 154 xStatus Network 1 IPv4 Address 154 xStatus Network 1 IPv4 SubnetMask 155 xStatus Network 1 IPv4 Gateway 155 xStatus Network 1 IPv4 DNS Domain Name 155 xStatus Network 1 IPv4 DNS Server 1...

Page 121: ...Status Security Audit Server Port 166 SIP status 166 xStatus SIP 166 xStatus SIP Proxy 1 Status 166 xStatus SIP Proxy 1 Address 166 xStatus SIP Proxy 1 Secure 167 xStatus SIP Proxy 1 Verified 167 xStatus SIP Registration n Status 167 xStatus SIP Registration n Reason 167 xStatus SIP Registration n URI 167 xStatus SIP Registration n Authentication 168 xStatus SIP Profile 1 Proxy 1 Status 168 xStatu...

Page 122: ...ght 179 xStatus Video Input Source 1 2 Resolution Width 179 xStatus Video Input Source 1 2 Resolution RefreshRate 179 xStatus Video Input Source 1 2 Resolution FormatType 180 xStatus Video Input Source 1 2 Resolution FormatStatus 180 xStatus Video Input Source 1 2 MediaChannelId 180 xStatus Video Input HDMI 1 Connected 180 xStatus Video Input HDMI 1 SignalState 180 xStatus Video Input DVI 2 Connec...

Page 123: ... PositionY 185 xStatus Video Layout Prediction Site n FrameContainer OutputRole n Width 185 xStatus Video Layout Prediction Site n FrameContainer OutputRole n Height 185 xStatus Video Layout Prediction Site n Output 1 2 Frame 1 6 MediaChannelId 185 xStatus Video Selfview Mode 185 xStatus Video Selfview FullscreenMode 186 xStatus Video Selfview PIPPosition 186 xStatus Video Selfview OnMonitorRole 1...

Page 124: ...nectors Microphone 1 EcReferenceDelay s Audio Connectors Microphone 1 EcReferenceDelay 120 end Call status xStatus Call Shows 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...

Page 125: ... find the call identity Value space of the result returned String Example xStatus Call 27 CallbackNumber s Call 27 CallbackNumber h323 firstname lastname company com end xStatus Call n DisplayName Shows the name of the remote far end participant in an incoming or outgoing call You can run the command xStatus Call to find the call identity Value space of the result returned String Example xStatus C...

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

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

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

Page 129: ...Camera 1 Position Focus s Camera 1 Position Focus 4597 end xStatus Camera 1 1 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 1 Flip In Flip mode vertical flip the image can be flipped upside down Value space of the result ret...

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

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

Page 132: ... not permitted Value space of the result returned On Off Example xStatus Conference Site 2 Capabilities FECC Mode s Conference Site 2 Capabilities FECC Mode On end xStatus Conference Site n Capabilities Presentation Lists the presentation capabilities for other participants in the conference Value space of the result returned True False Example xStatus Conference Site 2 Capabilities Presentation s...

Page 133: ...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 Confer...

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

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

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

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

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

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

Page 140: ...r Example xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter 0 end H320 status xStatus H320 Gateway Status Returns the state of the H320 Gateway if the codec is paired with an ISDN Link Value space of the result returned OK OKWithWarning Error Inactive Warning Example xStatus H320 Gateway statu...

Page 141: ...DN Link Value space of the result returned String Example xStatus H320 Gateway Id s H320 Gateway Id 00 50 60 0B EF 11 end H323 status xStatus H323 Shows the top level overview of the H323 status xStatus H323 Gatekeeper Status Shows the gatekeeper registration status Value space of the result returned Required Discovering Discovered Authenticating Authenticated Registering Registered Inactive Rejec...

Page 142: ...f the HTTP status xStatus HttpFeedback 1 4 URL Shows the URL Uniform Resource Locator of the HTTP server There can be up to three HTTP servers specified by the URL Value space of the result returned String Example xStatus HttpFeedback 1 URL s HttpFeedback 1 URL http tms company com tms public feedback code aspx end xStatus HttpFeedback 1 4 Expression 1 15 Shows the feedback from the HTTP server Th...

Page 143: ...rver that is currently in use Value space of the result returned String Example xStatus ICE Turn IP s ICE Turn IP 192 0 1 20 end xStatus ICE Turn Hostname Returns the hostname or IP address that is configured as the TURN server Value space of the result returned String Example xStatus ICE Turn Hostname s ICE Turn Hostname callway medianetworkservices com end xStatus ICE Turn Username Returns the u...

Page 144: ...ar end receives media on its own IP address PRFLX The far end receives media on its public IP address as seen by the remote Peer SRFLX The far end receives media on its public IP address as seen by the TURN server RELAY The far end receives media on 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 S...

Page 145: ...call and channels are used when querying additional information xStatus MediaChannels Call n IncomingAudioChannel n Encryption Status Shows the encryption status on the incoming channel Value space of the result returned On Off Example xStatus MediaChannels Call 27 IncomingAudioChannel 327 Encryption Status s MediaChannels Call 27 IncomingAudioChannel 327 Encryption Status Off end xStatus MediaCha...

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

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

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

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

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

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

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

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

Page 154: ...level overview of the network status xStatus Network 1 Ethernet MacAddress Shows the MAC Media Access Control address for the Ethernet interface Value space of the result returned String Example xStatus Network 1 Ethernet MacAddress s Network 1 Ethernet MacAddress 00 50 60 02 FD C7 end xStatus Network 1 Ethernet Speed Shows the Ethernet speed in Mbps The speed can be in full duplex or half duplex ...

Page 155: ...4 DHCP TftpServerAddress Returns the IP address of the TFTP server provisioning server as assigned by DHCP provided that the DHCP server supports option 150 This status is used only when xConfiguration Provisioning Mode is CUCM Value space of the result returned String Example xStatus Network 1 IPv4 DHCP TftpServerAddress s Network 1 IPv4 DHCP TftpServerAddress 192 0 2 0 end xStatus Network 1 IPv4...

Page 156: ...rAddress 192 0 2 0 s Network 1 IPv4 DHCP TftpServer 1234 company com end xStatus Network 1 IPv6 Address Shows the IPv6 address that uniquely identifies this system Value space of the result returned String Example xStatus Network 1 IPv6 Address s Network 1 IPv6 Address end xStatus Network 1 IPv6 Gateway Shows the address of the IPv6 gateway Value space of the result returned String Example xStatus...

Page 157: ...tring Value space of the result returned String Example xStatus Network CDP DeviceId s Network 1 CDP DeviceId 123456 company com end xStatus Network CDP PortID Returns the identification the switch uses of the port the endpoint is connected to Value space of the result returned String Example xStatus Network CDP PortID s Network 1 CDP PortID GigabitEthernet1 0 23 end xStatus Network CDP Duplex Ind...

Page 158: ...connected to Value space of the result returned String Example xStatus Network CDP SysName s Network 1 CDP SysName end xStatus Network CDP SysObjectID Returns the SysObjectID as configured in the switch the endpoint is connected to Value space of the result returned String Example xStatus Network CDP SysObjectID s Network 1 CDP SysObjectID end xStatus Network CDP VoIPApplianceVlanID Identifies the...

Page 159: ...e NTP server Unknown State of the synchronization is unknown Synced The system is in sync with the NTP server Discarded The NTP result has been discarded Value space of the result returned Unknown Synced Discarded Example xStatus NetworkServices NTP Status s NetworkServices NTP Status Synced end Preset status xStatus Preset Shows the top level overview of the camera presets status xStatus Preset 1...

Page 160: ...server the system is provisioned to This address may either be defined in the xConfiguration ExternalManager Address setting or provided by DHCP Value space of the result returned String Example xStatus Provisioning Server s Provisioning Server 192 0 2 0 end xStatus Provisioning Software UpgradeStatus SessionId Shows the ID of the session for the software upgrade Value space of the result returned...

Page 161: ...eStatus URL Shows the URL that the new software currently is being uploaded and installed from Value space of the result returned String Example xStatus Provisioning Software UpgradeStatus URL s Provisioning Software UpgradeStatus URL http s52000tc5 _ 1 _ 0 pkg end xStatus Provisioning Software UpgradeStatus SecondsUntilUpgrade Indicates how many seconds remain before the software upgrade is autom...

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

Page 163: ...F operation has succeeded Value space of the result returned NotSet CAPFUnknown CAPFInvalidAuthStrLen CAPFInvalidInitReason CAPFInvalidAuthMode CAPFNotNone CAPFNullClnt CAPFNullClntcontext CAPFInvalidUsageStartSession CAPFNullSessiondata CAPFInvalidSession CAPFNullParameters CAPFNoStat CAPFTimeout CAPFConnLost CAPFAbort CAPFKeyGenFailed CAPFConnectFailed CAPFFenceError CAPFServerBusy CAPFAuthRejec...

Page 164: ...CM ExtensionMobility LastLoggedInUserId s Provisioning CUCM ExtensionMobility LastLoggedInUserId User 1 end xStatus Provisioning CUCM TVS Proxy n Server Returns the address of the TVS server in form of a hostname FQDN or IPv4 address Value space of the result returned String Example xStatus Provisioning CUCM TVS Proxy 1 Server s Provisioning CUCM TVS Proxy 1 Server 192 0 2 0 end xStatus Provisioni...

Page 165: ...ample xStatus Security Persistency CallHistory s Security Persistency CallHistory Persistent end xStatus Security Persistency InternalLogging Shows whether internal logging is set to persistent or non persistent mode Persistent is the default mode Value space of the result returned NonPersistent Persistent Example xStatus Security Persistency InternalLogging s Security Persistency InternalLogging ...

Page 166: ...o establish communication to the DNS server failed Off There is no communication between the endpoint and the SIP Proxy Timeout The attempt to establish communication to the SIP Proxy timed out UnableTCP The system is unable to use TCP as the transport method UnableTLS The system is unable to use TLS as the transport method Unknown The status of the communication is not known AuthenticationFailed ...

Page 167: ...figuration SIP Profile TlsVerify set to Off Value space of the result returned True False Example xStatus SIP Proxy 1 Verified s SIP Proxy 1 Verified False end xStatus SIP Registration n Status Shows the status of the registration to the SIP Proxy Server Deregister The system is in the process of de registering to the SIP Proxy Failed The system failed to register to the SIP Proxy Inactive The sys...

Page 168: ...f Timeout UnableTCP UnableTLS Unknown AuthenticationFailed Example xStatus SIP Profile 1 Proxy 1 Status s SIP Profile 1 Proxy 1 Status Active end xStatus SIP Profile 1 Proxy 1 Address Shows the address of the SIP Proxy that the system communicates with Value space of the result returned String Example xStatus SIP Profile 1 Proxy 1 Address s SIP Profile 1 Proxy 1 Address 192 0 2 50 end xStatus SIP ...

Page 169: ...Forward Mode s SIP Profile 1 CallForward Mode Off end xStatus SIP Profile 1 CallForward URI Indicates the address the incoming calls are directed to when call forward mode is set on Value space of the result returned String Example xStatus SIP Profile 1 CallForward URI s SIP Profile 1 CallForward URI end xStatus SIP Profile 1 CallForward DisplayName Returns the URI that is displayed on the user in...

Page 170: ... URI Returns the primary directory URI set for the endpoint in UCM Directory URI is associated with a directory number and 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...

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

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

Page 173: ...tus SystemUnit Hardware Module SerialNumber Shows the serial number of the hardware module in the codec Value space of the result returned String Example xStatus SystemUnit Hardware Module SerialNumber s SystemUnit Hardware Module SerialNumber F9AA99A00090 end xStatus SystemUnit Hardware Module Identifier Shows the revision of the hardware module in the codec Value space of the result returned Str...

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

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

Page 176: ...ion types Notifications are issued e g when a system is rebooted because of a software upgrade or when a factory reset is performed FactoryResetOK This value is returned after a successful factory reset FactoryResetFailed This value is returned after a failed factory reset attempt SoftwareUpgradeOK This value is returned after a successful software upgrade SoftwareUpgradeFailed This value is retur...

Page 177: ...otocolDualStackConfig Example xStatus SystemUnit Diagnostics Message type s SystemUnit Diagnostics Message 1 Type InvalidAdminPassword end xStatus SystemUnit Diagnostics Message Level Returns information on the level of the diagnostics message Error There is an error in the system The system can still be used but there can be some restrictions Warning A problem is detected and a more specific repo...

Page 178: ... of diagnostics is turned on or off Value space of the result returned On Off Example xStatus SystemUnit Diagnostics ExtendedLogging Mode s SystemUnit Diagnostics ExtendedLogging Mode Off end Time status xStatus Time ZoneOlson Shows the current time zone in Olson format Value space of the result returned String Example xStatus Time ZoneOlson s Time ZoneOlson Europe Berlin end Contents Introduction...

Page 179: ...Video Input LastConnectedSource 0 end xStatus Video Input MainVideoSource Returns the local video input currently used as the main source The main video source is set with the xConfiguration Video Input VideoMainSource command Value space of the result returned Integer Example xStatus Video Input MainVideoSource s Video Input MainVideoSource 1 end xStatus Video Input Source 1 2 Resolution Height S...

Page 180: ...e space of the result returned Integer Example xStatus Video Input Source MediaChannelId s Video Input Source 1 MediaChannelId 2 s Video Input Source 2 MediaChannelId 3 end xStatus Video Input HDMI 1 Connected Shows if there is something connected to the HDMI connector Not all connections can be detected Value space of the result returned True False Unknown Example xStatus Video Input HDMI 1 Conne...

Page 181: ...onOnly Shows presentation video stream if active Recorder Shows all participants including the local main video If active shows also the presentation InternalSetup Determined by the system when xConfiguration Video Output HDMI n MonitorRole is set to Auto Value space of the result returned First Second Third Fourth PresentationOnly Recorder InternalSetup Example xStatus Video Output HDMI 1 Monitor...

Page 182: ...e result returned Default Maximized Minimized Example xStatus Video Layout PresentationView s Video Layout PresentationView Default end xStatus Video Layout Site n Output 1 2 FamilyName Shows the name of the video layout family Value space of the result returned String Example xStatus Video Layout Site 1 Output 1 FamilyName s Video Layout Site 1 Output 1 FamilyName fullscreen end xStatus Video Lay...

Page 183: ... of the frame Value space of the result returned 0 10000 Example xStatus Video Layout Site 1 Output 1 Frame 1 Height s Video Layout Site 1 Output 1 Frame 1 Height 10000 end xStatus Video Layout Site n Output 1 2 Frame 1 6 Layer Shows the layer of the frame Value space of the result returned 1 6 Example xStatus Video Layout Site 1 Output 1 Frame 1 Layer s Video Layout Site 1 Output 1 Frame 1 Layer ...

Page 184: ... or a remote user self view The frame displays the self view image selfviewPip The frame displays the self view image in PiP format speaker The frame displays the image of the speaker speakerPip The frame displays the image of the speaker in PiP format presentation The frame displays the image of the presentation presentationPip The frame displays the image of the presentation in PiP format presen...

Page 185: ...tainer OutputRole n PositionY For internal use only Value space of the result returned Integer xStatus Video Layout Prediction Site n FrameContainer OutputRole n Width For internal use only Value space of the result returned Integer xStatus Video Layout Prediction Site n FrameContainer OutputRole n Height For internal use only Value space of the result returned Integer xStatus Video Layout Predict...

Page 186: ...ve speaker s image on the screen Value space of the result returned UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Example xStatus Video PIP ActiveSpeaker Position s Video PIP ActiveSpeaker Position UpperCenter end xStatus Video PIP Presentation Position Shows the position of the presentation image on the screen Value space of the result returned UpperLeft UpperCenter...

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

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

Page 189: ...pts 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 190: ... key to zoom the camera in and out Arrows Up Down Use the and arrow keys to navigate in the menu Arrow Right Press the arrow key to expand the selected menu item or to move to the right in a text field Arrow Left Press the arrow key to go one step back in the menu or to move to the left in a text field Layout Press the key to display the Layout menu then select a view in the menu End call Standby ...

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

Page 192: ...he 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 be st...

Page 193: ...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 time b...

Page 194: ...t 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 Rem...

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

Reviews:

No comments

Related manuals for Quick Set C20

Brand: CAME Pages: 12

Brand: fadini Pages: 16

Brand: Panasonic Pages: 16

Brand: Funktel Pages: 28

MorphoAccess VP MD

Brand: Idemia Pages: 29

Brand: Hame Pages: 26

Brand: Planet Pages: 51

Brand: SPINOGY Pages: 27

MAGSTOP MIB 10-C090

Brand: Magnetic Autocontrol Pages: 15

Brand: RCA Pages: 68

Chromebox for meetings for the large room

Brand: Asus Pages: 54

Brand: Asus Pages: 66

Brand: Asus Pages: 54

SAPM38 - CD STEREO SYSTEM

Brand: Panasonic Pages: 48

Brand: Sony Pages: 10

Brand: Sony Pages: 74

Brand: Sony Pages: 78

Brand: Sony Pages: 200

Brands by name

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

Popular brands

Load more brands