TANDBERG Codec C Series Api Manual Download Page 1

Page: 1 / 145

D14642.02—MAY 2010

TANDBERG Codec C60 and Codec C40

API Guide

Contents

Introduction

About the API

xConfiguration

xCommand

xStatus

Appendices

www.tandberg.com

Software version TC3.1
MAY 2010

TANDBERG API Guide

TANDBERG Codec C60 and Codec C40

About the API

xConfiguration

xCommand

xStatus

Appendices

Contents

Introduction

Summary of Contents for Codec C Series

Page 1: ...s Introduction About the API xConfiguration xCommand xStatus Appendices Contact us www tandberg com Software version TC3 1 MAY 2010 TANDBERG API Guide TANDBERG Codec C60 and Codec C40 Contact us About the API xConfiguration xCommand xStatus Appendices Contents Introduction ...

Page 2: ...h 11 Feedback 11 Connecting to the codec 12 Accessing XACLI 12 Telnet SSH login 12 Serial port login 12 Serial port configurations 12 Reboot 12 Hardware Cabling RS 232 12 Troubleshooting RS 232 12 Value types and formats 13 Root commands 14 Main type of commands 15 Configuration type commands 15 What s in this guide Command type commands 15 Status type commands 15 Special commands 15 Feedback type...

Page 3: ...Send command 77 The Standby command 78 The SystemUnit commands 78 The Video commands 81 The Experimental commands 89 Description of the xStatus commands xStatus commands 91 The Audio status 91 The Call status 95 The Camera status 97 The Conference status 99 The Diagnostics status 101 The GPIO status 109 The H323 status 109 The HTTP Feedback status 110 The Media Channel status 111 The Network statu...

Page 4: ...I Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us www tandberg com www tandberg com Chapter 1 Introduction Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us Introduction ...

Page 5: ...me without notice by TANDBERG Every effort has been made to supply complete and accurate information in this Guide however TANDBERG assumes no responsibility or liability for any errors or inaccuracies that may appear in this document TANDBERG is a registered trademark belonging to Tandberg ASA Other trademarks used in this document are the property of their respective holders This Guide may be re...

Page 6: ...e best video quality every time regardless of environment Highest Quality Audio with flexibility to add up to 2 microphones directly from the codec and superior full duplex audio with high quality stereo sound Full APIs Ensure successful streamlined integration projects with standards compliant professional connectors The Codec C40 ties easily into the TANDBERG Total Solution for full management f...

Page 7: ...erg com callway NAT support With NAT Network Address Translation support on H 323 the TANDBERG 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 FECC on SIP Far End Camera Control FECC is now supported on SIP Experiment...

Page 8: ...xStatus Provisioning PendingUpgrade xStatus Video Input HDMI SignalState xStatus Video Input DVI SignalState xStatus Video Input Legacy SignalState xStatus Experimental Conference Site Capabilities FECC xStatus Experimental Audio StereoEchoCancellation Mode Commands that have been changed xConfiguration xConfiguration Provisioning Mode CallWay has been added xConfiguration Time Zone Added the Coor...

Page 9: ...de Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us www tandberg com www tandberg com Chapter 2 About the TANDBERG API Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us About the API ...

Page 10: ... information R WRITE information W READ WRITE information RW R READ information This is Status Information about the system and system processes i e information generated by the system Typical examples include status about ongoing calls network status conference status etc All status information is structured in a hierarchy making up a database constantly being updated by the system to reflect pro...

Page 11: ... numbers are separated with white spaces Network 1 DNS Server 1 Address Example xConfiguration Network 1 DNS Server 1 Address c xConfiguration Network 1 DNS Server 1 Address test OK Feedback Feedback is an extremely powerful feature where the TANDBERG system actively returns updated status and configuration information to the user control application whenever changes occur The user control applica...

Page 12: ...quires a reboot for the changes to baud rate and password protection to take effect NOTE When system boots up the baud rate of the boot messages is 38400 regardless of the baud rate set in the codec application Hardware Cabling RS 232 The pin outs for the RS 232 are defined in the tables to the right Observe that the DTE Data Terminal Equipment could be a PC or any other device capable of serial c...

Page 13: ... values X Y Z Defines the possible values for a given configuration On Off Auto String values S x y Defines that the valid input for this configuration is a String with minimum length x and maximum length of y characters S 0 49 IPv4 Address values IPAddr Defines that the input must be an IPv4 address IPAddr IPv6 Address values IPv6Addr x y Defines that the input must be an IPv6 address with minimu...

Page 14: ...dberg com User Commands help xconfiguration xfeedback xgetxml xhistory xstatus xpreferences xcommand log OK Root commands By typing or help after connecting to the TANDBERG Codec C Series using RS 232 Telnet SSH the system will list all supported root commands Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us About the API ...

Page 15: ...ation about the system and system processes Status type commands are read by the user Example Information generated by the system about ongoing calls network status conference status etc All status information is structured in a hierarchy making up a database constantly being updated by the system to reflect system and process changes Supported Status type commands xStatus xHistory Special command...

Page 16: ... Video xConfiguration h xConfiguration Audio Volume 0 100 Sets the volume level 0 100 on the loudspeaker output in steps of 0 5dB from 34 5dB to 15dB Volume 0 Off The volume level bar which is displayed on screen when using the remote control goes from 0 to 20 Range The volume level goes from 0 to 100 Volum level equals Audio gain value 0 equals 0 1 equals 34 5 dB 70 equals 0 0 dB 100 equals 15 0 ...

Page 17: ... about the setting defined by the path xConfiguration H323 Profile 1 Gatekeeper help As above xConfiguration Read When reading a value you will use the configuration read The level of details is defined by the path xConfiguration H323 Profile 1 Gatekeeper Discovery Returns the current value of the setting defined by the path xConfiguration Write When defining a system setting you will use the conf...

Page 18: ... parameters are identified by an r behind the parameter name xCommand User Commands OK xCommand h xCommand Audio Microphones Mute h xCommand Audio Microphones Unmute h xCommand Audio Sound Play Sound r Busy CallWaiting Dial KeyTone Ringing SpecialInfo TelephoneCall VideoCall Loop On Off h xCommand Audio Sound Stop h xCommand Audio Vumeter Start ConnectorType r HDMI Line Microphone ConnectorId r 1 ...

Page 19: ...Conference False True ConferenceId 0 65534 OK xCommand Help To get help on a setting you can use a help query Enter the path followed by or help xCommand dial Returns a set of return values See the example to the right xCommand dial help As above xCommand Write When issuing a command the system will return a set of return values The structure is described by the example to the right xCommand Dial ...

Page 20: ... by the system to reflect system and process changes To get an overview of the supported xStatus type commands type or help after the xStatus xStatus xStatus help Return result parameters The following operation can be performed on xStatus commands xStatus Read s is used when returning the result of xStatus read query xStatus Status OK Audio Call CallTransfer Camera 1 7 Conference Diagnostics Expe...

Page 21: ...h or TANDBERG SimplePath You can set up the xStatus read command to address all information or just some of it see the examples to the right for illustrations Example 1 Query all ongoing Call information xstatus call s Call 3 Status Connected s Call 3 Direction Outgoing s Call 3 Protocol h323 s Call 3 RemoteNumber firstname lastname company com s Call 3 CallbackNumber h323 firstname lastname compa...

Page 22: ...ogs Call 1 CallId 13 h xHistory CallLogs Call 1 Protocol h323 h xHistory CallLogs Call 1 Direction Outgoing h xHistory CallLogs Call 1 CallType Video h xHistory CallLogs Call 1 RemoteNumber h323 firstname lastname office company com h xHistory CallLogs Call 1 CallbackNumber h323 firstname lastname office company com h xHistory CallLogs Call 1 DisplayName firstname lastname company com h xHistory C...

Page 23: ...the system like a call connecting or disconnecting The xFeedback command is used to specify what parts of the configuration and status hierarchies to monitor and will only be issued on the RS 232 Telnet SSH for which it is specified If connecting to the TANDBERG codec with multiple sessions each session can define feedback individually CAUTION We discourage registering all status changes as this m...

Page 24: ...efore important to define settings to match the parser used on the control system XACLI is designed to make parsing of data from the TANDBERG Codec C Series very simple To get an overview of the supported xPreferences commands and their value space type or help after the xPreferences xPreferences xPreferences help The xPreferences output modes Terminal Line based XACLI output for use with line bas...

Page 25: ... location parameter passed to the request The elements or complete document matching the expression will be returned On Incorrect XPath expression a Fault element with a XPathError element will be returned getxml REQUEST getxml PARAM location XPath expression formputxml This is most useful in a POST to extend character limit of 255 of GET urls It posts a Configuration or Command document to set th...

Page 26: ...s Introduction About the API xConfiguration xCommand xStatus Appendices Contact us www tandberg com www tandberg com Chapter 3 Description of the xConfiguration commands Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us xConfiguration ...

Page 27: ... a value We recommend you visit the TANDBERG web site regularly for updated versions of the manual Go to http www tandberg com docs xConfiguration Audio Input HDMI 2 VideoAssociation VideoInputSource Select the associated video input source Value space 1 2 3 Range Select one of the three video input sources Example xConfiguration Audio Input HDMI 2 VideoAssociation VideoInputSource 1 xConfiguratio...

Page 28: ...anges in the audio conditions are very significant the echo canceller may take a second or two to re adjust Value space On Off On Echo Control is normally set to On to prevent the far end from hearing their own audio Once selected echo cancellation is active at all times Off Echo Control should be switched Off if external echo cancellation or playback equipment is used Example xConfiguration Audio...

Page 29: ...the microphone connector Off Disable the microphone connector Example xConfiguration Audio Input Microphone 1 Mode On xConfiguration Audio Input Microphone 1 2 1 4 Type NOTE Codec C40 has two microphone connectors Codec C60 has four microphone connectors The microphone connectors are intended for electret type microphones The microphone connector can be set to line or microphone mode Value space M...

Page 30: ... SPDIF when you want the line output to be in digital mode Example xConfiguration Audio Output Line 1 Type Auto xConfiguration Audio Output Line 2 Type Line output 2 is a dedicated analog output hence type can be set to analog only Value space Analog Analog Can be set to analog only Example xConfiguration Audio Output Line 1 Type Analog xConfiguration Audio SoundsAndAlerts KeyTones Mode The system...

Page 31: ...ma table to use by setting the 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 changes to the brightness setting does not provide satisfactory results NOTE Requires the Gamma Mode to be set ...

Page 32: ...e it automatically adjusted by the system Value space Auto Manual Auto When set to Auto the camera will continuously adjust the whitebalance depending on the camera view Manual Set to Manual to enable manual control of the camera whitebalance e g the level of the whitebalance level setting will be used for the camera Example xConfiguration Cameras Camera 1 Whitebalance Mode auto xConfiguration Cam...

Page 33: ...g determines whether or not there should be an alert on incoming calls Value space On Off On All incoming calls will be rejected with no alert The calling side will receive a busy signal when trying to call the codec A message will display on screen telling that Do not disturb is turned on together with an option to turn off the Do not disturb When turning off the Do not disturb mode you will see ...

Page 34: ...Conference 1 1 MaxReceiveCallRate Specify the maximum receive call rate to be used when placing or receiving calls Value space 64 6000 Range 64 6000kbps Example xConfiguration Conference 1 MaxReceiveCallRate 6000 xConfiguration Conference 1 1 VideoBandwidth Mode Set the conference video bandwidth mode Value space Dynamic Static Dynamic The available transmit bandwidth for the video channels are di...

Page 35: ...o conferencing system when the IP traffic goes through a NAT router NOTE NAT does not work in conjunction with gatekeepers Value space Auto On Off Auto The system will try to determine if the NAT Address or the real IP address should be used within signalling This is done to make it possible to place calls to endpoints on the LAN as well as endpoints on the WAN On The system will signal the config...

Page 36: ...ample xConfiguration H323 Profile 1 CallSetup Mode Gatekeeper xConfiguration H323 Profile 1 1 Gatekeeper Discovery Determines how the system shall register to a H 323 Gatekeeper Value space Manual Auto Manual The system will use a specific Gatekeeper identified by the Gatekeeper s IP address Auto The system will automatically try to register to any available Gatekeeper If a Gatekeeper responds to ...

Page 37: ...et to Static Value space S 0 64 Format Only the valid IP address format is accepted An IP address that contains letters 192 a 2 0 or unvalid IP addresses 192 0 1234 0 will be rejected Example xConfiguration Network 1 IPv4 Address 10 47 5 100 xConfiguration Network 1 1 IPv4 Gateway Define the IP network gateway Only applicable if the Network Assignment is set to Static Value space S 0 64 Format Com...

Page 38: ...he Network IPv4 QoS Mode to be set to Diffserv Value space 0 63 Data A recommended value is Diffserv Code Point DSCP AF23 which equals the value 22 If in doubt contact your network administrator Example xConfiguration Network 1 IPv4 QoS Diffserv Data 0 xConfiguration Network 1 1 IPv4 QoS Diffserv Signalling The Diffserv Signalling defines which priority Signalling packets should have in an IP netw...

Page 39: ...AP PEAP protocol is enabled default Off The EAP PEAP protocol is disabled Example xConfiguration Network 1 IEEE8021X Eap Peap On xConfiguration Network 1 1 IEEE8021X Eap TTLS Set the TTLS Tunneled Transport Layer Security mode Authenticates LAN clients without the need for client certificates Developed by Funk Software and Certicom Usually supported by Agere Systems Proxim and Avaya Value space On...

Page 40: ...HTTP Mode Set the HTTP mode to enable disable access to the system through a web browser The web interface is used for system management call management such as call transfer diagnostics and software uploads Value space On Off On The HTTP protocol is enabled Off The HTTP protocol is disabled Example xConfiguration NetworkServices HTTP Mode On xConfiguration NetworkServices HTTPS Mode HTTPS is a we...

Page 41: ...work attached devices routers servers switches projectors etc for conditions that warrant administrative attention SNMP exposes management data in the form of variables on the managed systems which describe the system configuration These variables can then be queried set to ReadOnly and sometimes set set to ReadWrite by managing applications Value space Off ReadOnly ReadWrite Off Disable the SNMP ...

Page 42: ... 0 64 Format String with a maximum of 64 characters Example xConfiguration Phonebook Server 1 ID xConfiguration Phonebook Server 1 5 Type Select the phonebook server type Value space VCS TMS Callway VCS Select VCS if the phonebook is located on the TANDBERG Video Communication Server TMS Select TMS if the phonebook is located on the TANDBERG Management Suite server Callway Select Callway if the ph...

Page 43: ...ernal Manager typically a management system can return configurations commands to the unit as a result If the DHCP Option 242 is returned in the DHCP response from the DHCP server the system will interpret this as the External Manager address to use Value space S 0 255 Format String with a maximum of 255 characters Example xConfiguration Provisioning ExternalManager Path tms public external manage...

Page 44: ...1 1 Password This is the password part of the credentials used to authenticate towards the SIP proxy Value space S 0 50 Format String with a maximum of 50 characters Example xConfiguration SIP Profile 1 Authentication 1 Password xConfiguration SIP Profile 1 1 DefaultTransport Select the transport protocol to be used over the LAN Value space UDP TCP TLS Auto UDP The system will always use UDP as th...

Page 45: ...RI or number is used to address the system This is the URI that is registered and used by the SIP services to route inbound calls to the system A Uniform Resource Identifier URI is a compact string of characters used to identify or name a resource Value space S 0 255 Format Compact string with a maximum of 255 characters Example xConfiguration SIP Profile 1 URI sip firstname lastname company com x...

Page 46: ... the infrared receiver on the codec should be enabled or not The IR sensor LED is located in the front of the codec and flickers when an IR signal is received from the remote control Value space On Off Auto On Enable the IR sensor on the codec Off Disable the IR sensor on the codec Auto Both the TANDBERG codec and camera has an IR sensor The system will automatically disable the IR sensor on the c...

Page 47: ...ersal Time GMT Greenwich Mean Time Dublin Edinburgh Lisbon London GMT 01 00 West Central Africa GMT 01 00 Amsterdam Berlin Bern Rome Stockholm Vienna GMT 01 00 Brussels Copenhagen Madrid Paris GMT 01 00 Sarajevo Skopje Warsaw Zagreb GMT 01 00 Belgrade Bratislava Budapest Ljubljana Prague GMT 02 00 Harare Pretoria GMT 02 00 Jerusalem GMT 02 00 Athens Istanbul Minsk GMT 02 00 Helsinki Kyiv Riga Sofi...

Page 48: ... AnalogYPbPr to force the DVI video input to AnalogYPbPr as the component YPbPr signal cannot be auto detected Example xConfiguration Video Input DVI 3 Type AutoDetect xConfiguration Video Input Source 1 Connector Select which video input connector to be active on video input source 1 Value space HDMI HDMI Select HDMI when you want to use the HDMI 1 as input source 1 Example xConfiguration Video I...

Page 49: ...Do not set a threshold for transmitting 60fps Example xConfiguration Video Input Source 1 OptimalDefinition Threshold60fps 1280 _ 720 xConfiguration Video Input Source 1 3 Quality When encoding and transmitting video there will be a tradeoff between high resolution and high framerate For some video sources it is more important to transmit high framerate than high resolution and vice versa The Qual...

Page 50: ...s DualPresentationOnly All participants in the call will be shown on the first monitr while the presentation if any will be shown on the second monitor Example xConfiguration Video Monitors Single xConfiguration Video OSD InputMethod InputLanguage The codec can be enabled for Cyrillic input characters in the GUI Graphical User Interface NOTE Requires that xConfiguration Video OSD inputMethod Cyril...

Page 51: ...ll be placed in a separate folder called MyContacts in the phonebook dialog Example xConfiguration Video OSD MyContactsExpanded Off xConfiguration Video Output HDMI 1 MonitorRole The HDMI monitor role describes what video stream will be shown on the monitor connected to the video output HDMI connector Applicable only if the Video Monitors configuration is set to dual Value space First Second Prese...

Page 52: ...0x600 60p 1024x768 60p 1280x1024 60p 1280x720 60p 1920x1080 60p 1280x768 60p 1360x768 60p 1366x768 60p 1600x1200 60p 1920x1200 60p Example xConfiguration Video Output DVI 2 Resolution 1024 _ 768 _ 60 xConfiguration Video Output Composite 3 MonitorRole NOTE This command is not supported on Codec C40 The Composite monitor role describes what video stream will be shown on the monitor connected to the...

Page 53: ...Growing Select one of the predefined wallpapers to be displayed on screen Custom The custom wallpaper must be uploaded to the codec from the web interface 1 On the video system Find the IP address of the codec Open the menu on screen and go to Home Settings System information to find the IP Address 2 On your computer Open a web browser and enter the IP address of the codec Select Wallpaper from th...

Page 54: ...tion Experimental Audio Input Microphone 1 4 EchoControl HighPassFilter Value space On Off xConfiguration Experimental CapsetFilter Value space S 0 32 xConfiguration Experimental Conference 1 1 PacketLossResilience Value space On Off xConfiguration Experimental CustomSoftbuttons State 1 2 Softbutton 1 5 Type Value space NotSet MainSource PresentationSource CameraPreset Actions SpeedDial xConfigura...

Page 55: ...ontents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us www tandberg com www tandberg com Chapter 4 Description of the xCommand commands Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us xCommand ...

Page 56: ... commands xCommand Audio Equalizer Update The system has eight user defined equalizers each made up of six second order IIR sections Each of the eight equalizers 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 variat...

Page 57: ...sMuteResult status OK end xCommand Audio Microphones Unmute Unmute microphones Parameters No paramters Example xCommand Audio Microphones Unmute r AudioMicrophonesUnmuteResult status OK end xCommand Audio LocalInput Add Create a local input and generates the local input id A local input is a mix of input connectors with the following settings Name MixerMode AGC Mute and Channels Read more about th...

Page 58: ...nd Audio LocalInput Remove Remove the local input given by the input ID InputId A unique identifier for the local input Parameters InputId r 0 65534 Example xCommand Audio LocalInput Remove InputID 2 OK r AudioInputGroupRemoveResult status OK end xCommand Audio LocalInput AddConnector Attach an input connector to the local input given by the input ID A connector is defined by its type and ID Input...

Page 59: ...utputId 47 end xCommand Audio LocalOutput Update Update the settings of the local output given by the output ID OutputId A unique identifier for the local output Name Choose a name that describes the local output Loudspeaker If one or more of the output connectors are connected to a loudspeaker this signal should be a reference signal to the echo canceller Hence set loudspeaker to On NOTE When mic...

Page 60: ...d 1 OK r AudioOutputGroupRemoveConnectorResult status OK end xCommand Audio LocalOutput ConnectInput Connect a local input or remote input to a local output by giving their IDs as parameters OutputId A unique identifier for the local output InputId A unique identifier for the local input InputGain Set a gain on the input signal in the range from 54dB to 15dB The value 54dB equals Off Parameters Ou...

Page 61: ...to a remote output with their IDs as parameters When a call is made a remote input and remote output pair is created OutputId A unique identifier for the local output InputId A unique identifier for the local or remote input InputGain Set a gain on the input signal in the range from 54dB to 15dB The value 54dB equals Off Parameters OutputId r 0 65534 InputId r 0 65534 InputGain 54 15 Example xComm...

Page 62: ...und r Busy CallWaiting Dial KeyTone Ringing SpecialInfo TelephoneCall VideoCall Loop On Off Example xCommand Audio Sound Play Sound Ringing r AudioSoundPlayResult status OK end xCommand Audio Sound Stop Stop playing audio sound Parameters No paramters Example xCommand Audio Sound Stop r AudioSoundStopResult status OK end xCommand Audio Vumeter Start Start collecting VU meter information for connec...

Page 63: ...onnect 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 Parameters CallId r 0 65534 Example xCommand Call Disconnect CallId 17 OK r DisconnectCallResult status OK end xCommand Call DisconnectAll Disconnect all active calls Parameters No paramters Example xCommand Call DisconnectAll OK r DisconnectAllResult st...

Page 64: ...d from the log If no logtag is given the complete outgoing calls log will be deleted The LogTag values for outgoing calls are found by issuing the xHistory CallLog Outgoing command Parameters LogTag 0 2147483647 Example xCommand CallLog Outgoing Delete LogTag 202 r DeleteResult status OK end xCommand CallLog Received Delete Delete the call log of received calls If a logtag is given as argument tha...

Page 65: ...y chain you need to know the CameraId for the camera you want to address Parameters CameraId r 1 7 Pan 65535 65535 Tilt 65535 65535 Zoom 0 65535 Focus 0 65535 Example xCommand Camera PositionSet CameraId 1 Pan 200 Tilt 300 OK r CameraPositionSetResult status OK end xCommand Camera PanTiltReset The camera is reset to its default values for pan and tilt In a daisy chain you need to know the CameraId...

Page 66: ...ilt Down Stop Up TiltSpeed 1 15 Zoom In Out Stop ZoomSpeed 1 15 Focus Far Near Stop Example xCommand Camera Ramp CameraId 1 Pan left PanSpeed 1 OK r RampResult status OK endxCommand Camera Ramp CameraId 1 Pan stop OK r RampResult status OK end xCommand Camera TriggerAutofocus Trigger the autofocus functionality The camera must support autofocus functionality In a daisy chain you need to know the C...

Page 67: ...ers Number r S 0 255 Protocol H323 Sip CallRate 64 6000 CallType Audio Video Example xCommand Dial Number 543210 Protocol h323 OK r DialResult status OK CallId 2 ConferenceId 1 end xCommand DTMFSend Send DTMF tones to the far end 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 DTMFString Enter the DTMF strin...

Page 68: ... Parameters CallId r 0 65534 Example xCommand FarEndControl Camera Stop CallId 3 r FECCMoveResult status OK end xCommand FarEndControl Preset Activate Move the far end camera to a camera preset position 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 PresetId The PresetId for far end control must be retrieve...

Page 69: ...source on the far end Parameters CallId r 0 65534 SourceId r 0 15 Example xCommand FarEndControl Source Select CallId 3 SourceId 1 r FECCSelectSourceResult status OK end xCommand GPIO ManualState Set NOTE This command is not supported on Codec C40 Set the status of a GPIO pin that is configured to OutputManualState mode ref xConfiguration GPIO Pin 1 4 Mode Parameters Pin1 High Low Pin2 High Low Pi...

Page 70: ...ease 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 Click Key Down r KeyClickResult status OK end xCommand Key Press Emulates a remote control key press without releasing it The Key Pre...

Page 71: ...e Duration parameter is not set Parameters No paramters Example xCommand Message Alert Clear OK r MessageAlertClearResult 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 will display on screen until the user gives a response or until the system receives the following command xCommand Mess...

Page 72: ...onses in the xCommand Message Prompt Display command Parameters FeedbackId S 0 255 OptionId r 0 5 Example xCommand Message Prompt Response OptionId 1 OK r MessagePromptResponseResult status OK end xCommand Phonebook Folder Add Add a folder to the local phonebook where phonebook entries can be stored Returns the FolderId localGroupId 3 which is a unique Id of the folder Name r The name of the folde...

Page 73: ...tactId 1 which is a unique Id of the contact Name The name of the contact FolderId A unique identifier for the folder which was created when the xCommand Phonebook Folder Add command was issued ImageURL The URL to an image Title The title of the contact Number The phone number or address of the contact Protocol Select H323 or SIP protocol CallRate Set a call rate Device Set which type of device to...

Page 74: ...bout the call setup to an existing contact in the local phonebook Returns the ContactMethodId Name 1 which is a unique Id of the contact method ContactId A unique identifier for the contact which was created when the xCommand Phonebook Contact Add command was issued Device Set which type of device to call to Number r The phone number or address of the contact Protocol Select H323 or SIP protocol C...

Page 75: ...Set of 10 entries Contacts Folders although the total number of hits may be greater Parameters PhonebookId S 0 255 PhonebookType Corporate Local SearchString S 0 255 SearchField Name Number FolderId S 0 255 Offset 0 65534 Limit 0 65534 Example xCommand Phonebook Search PhonebookType Corporate Limit 2 FolderId corporate _ 001 OK r ResultSet ResultInfo TotalRows 25 r ResultSet Contact 1 Name tmp r R...

Page 76: ...nd Preset Store Store the current camera position The system may hold 15 predefined camera positions presets PresetId Select preset 1 to 15 Type Select Camera or All Description Enter a description of the preset Parameters PresetId r 1 15 Type r All Camera Description S 0 255 Example xCommand Preset Store PresetId 3 Type Camera Description Left view OK r PresetStoreResult status OK end xCommand Pr...

Page 77: ...es the software upgrade This will reboot the codec NOTE This command is required if the xCommand Provisioning StartUpgrade has been run with the AutoComplete set to Off Parameters None Example xCommand Provisioning CompleteUpgrade r CompleteUpgradeResult status OK end xCommand Provisioning CancelUpgrade Cancel a software update in progress Parameters None Example xCommand Provisioning CancelUpgrad...

Page 78: ...figuration Standby Delay will be valid Parameters Delay 1 480 Example xCommand Standby ResetTimer Delay 10 r ResetResult status OK end xCommand SystemUnit OptionKey Add Add an option key to support additional features Parameters Key r S 16 24 Example xCommand SystemUnit OptionKey Add Key r OptionKeyResult status OK end xCommand SystemUnit ReleaseKey Add Add software release key Used to enable new ...

Page 79: ...1 12 Day 1 31 Hour 0 23 Minute 0 59 Second 0 59 Example xCommand SystemUnit DateTime Set Year 2009 Month 7 Day 3 Hour 12 Minute 0 Second 0 r DateTimeSetResult status OK end xCommand SystemUnit DateTime Get Read the time and date from the system Parameters No paramters Example xCommand SystemUnit DateTime get r DateTimeGetResult status OK Year 2009 Month 7 Day 3 Hour 12 Minute 0 Second 0 end xComma...

Page 80: ...ancelChange Cancel the xCommand SystemUnit ConfigurationProfile Change command that would otherwise take effect after next system boot Parameters Name r S 0 255 Example xCommand SystemUnit ConfigurationProfile CancelChange Name My _ ConfigurationProfile _ 1 r ConfigurationProfileCancelChangeResult status OK end xCommand SystemUnit ConfigurationProfile Remove Delete a configuration profile that has...

Page 81: ...to Equal Fullscreen PresentationLargeSpeaker PresentationSmallSpeaker Example xCommand Video PictureLayoutSet LayoutFamily Equal r SetPictureLayoutResult status OK end xCommand Video Layout AutoMode SetLayoutFamily Set the default picture layout defined by the LayoutFamily parameter for the specified situation defined by the Monitors Selfview Presentation and NumberOfCalls parameters Monitors Set ...

Page 82: ...ngleMonitor 1 SelfviewOff 1 Presentation _ 16 _ 9 1 NumberOfCalls 3 LayoutFamily presentationsmallspeaker r VideoLayoutAutoModeListResult LayoutAutoMode 1 SingleMonitor 1 SelfviewOff 1 Presentation _ 4 _ 3 1 NumberOfCalls 0 LayoutFamily fullscreen r VideoLayoutAutoModeListResult LayoutAutoMode 1 SingleMonitor 1 SelfviewOff 1 Presentation _ 4 _ 3 1 NumberOfCalls 1 LayoutFamily fullscreen r VideoLay...

Page 83: ...eListResult LayoutAutoModeRemote 1 WithoutPresentationCapability 1 PresentationOff 1 NumberOfCalls 3 LayoutFamily followlocal r VideoLayoutAutoModeRemoteListResult LayoutAutoModeRemote 1 WithoutPresentationCapability 1 PresentationOn 1 NumberOfCalls 1 LayoutFamily followlocal r VideoLayoutAutoModeRemoteListResult LayoutAutoModeRemote 1 WithoutPresentationCapability 1 PresentationOn 1 NumberOfCalls...

Page 84: ... an existing video layout LayoutId A unique identifier for the layout which was created when the xCommand Video Layout Add command was issued Parameters LayoutId r 1 2147483647 Example xCommand Video Layout Remove LayoutId 1 r VideoLayoutRemoveResult status OK end xCommand Video Layout RemoveAll NOTE This command is not supported on Codec C40 Removes all the existing video layouts Parameters No pa...

Page 85: ...an add several frames with OtherMain The source and the layout engine will automatically populate the frame content with one of the other 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 selfview Presentation Select what is currently the presentation source there is always only one active H 239 content in a con...

Page 86: ...e on the local side MostSpeaking Select the current loudest speaker in the conference OtherMain 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 OtherMain The source and the layout engine will automatically populate the frame content with one of the other sites main video making sure that you do not see ...

Page 87: ...ifier for the layout which was created when the xCommand Video Layout Add command was issued Parameters OutputId r 0 65534 LayoutId r 1 2147483647 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 the remote...

Page 88: ...ued Parameters OutputId r 0 65534 LayoutId r 1 2147483647 Example xCommand Video Layout UnAssignLocalOutput OutputId 1 LayoutId 2 OK r VideoLayoutUnAssignLocalOutputResult status OK end xCommand Video Layout UnAssignCall NOTE This command is not supported on Codec C40 Remove the defined video layout and go back to default CallId A unique identifier for the call The CallID is returned when the xCom...

Page 89: ...le xCommand Experimental Audio LocalOutput Unmute ConferenceID 1 r AudioLocalOutputUnmuteResult status OK end xCommand Experimental Audio StereoEchoCancellation The Experimental commands can be used as is NOTE The Experimental settings WILL change Turn on off the stereo echo cancellation Parameters Mode r On Off Example xCommand Experimental Audio StereoEchoCancellation Mode Off r AudioStereoEchoC...

Page 90: ...Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us www tandberg com www tandberg com Chapter 5 Description of the xStatus commands Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us xStatus ...

Page 91: ...ut LocalInput 2 Channels 2 s Audio Input LocalInput 2 AGC Off s Audio Input LocalInput 2 Connector Line 1 s Audio Input LocalInput 2 Connector Line 2 s Audio Input LocalInput 3 Name HDMI input s Audio Input LocalInput 3 MixerMode Fixed s Audio Input LocalInput 3 Mute Off s Audio Input LocalInput 3 Channels 2 s Audio Input LocalInput 3 AGC Off s Audio Input LocalInput 3 Connector HDMI 2 s Audio Inp...

Page 92: ...ophone 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 together Value space of the result returned Auto Fixed GainShared Example xStatus Audio Input LocalInput 1 MixerMode s Audio Input L...

Page 93: ...RemoteInput 8 CallId 28 end xStatus Audio Input RemoteInput 1 n AGC Shows the AGC Automatic Gain Control mode on the remote input You can run the command xStatus Audio Input RemoteInput to find the identity of the input Value space of the result returned On Off Example xStatus Audio Input RemoteInput 8 AGC s Audio Input RemoteInput 8 AGC Off end xStatus Audio Output LocalOutput 1 n Name Shows the ...

Page 94: ...he 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 1 n CallId Shows the CallId for the remote audio output You can run the command xStatus Audio Output RemoteOutput to find the identity of the output Value space of the result returned 0 65534 Example x...

Page 95: ...hen query for additional information about the call Example xStatus Call s Call 27 Status Connected s Call 27 Direction Outgoing s Call 27 Protocol sip s Call 27 RemoteNumber firstname lastname company com s Call 27 CallbackNumber sip firstname lastname company com s Call 27 DisplayName Firstname Lastname s Call 27 TransmitCallRate 768 s Call 27 ReceiveCallRate 4000 s Call 27 Encryption Type None ...

Page 96: ... returned S 0 100 Example xStatus Call 27 CallbackNumber s Call 27 CallbackNumber h323 firstname lastname company com end xStatus Call 1 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 S 0 100 Example xStatus Call 27 DisplayName s Call 27 DisplayName firs...

Page 97: ...teger value Example xStatus Call 27 Duration s Call 27 Duration 2354 end xStatus Camera Shows the top level overview of the camera status Example xStatus Camera s Camera 1 Connected True s Camera 1 HardwareID 50000000 s Camera 1 Manufacturer TANDBERG s Camera 1 Model PrecisionHD 1080p 12X s Camera 1 SoftwareID S01718 4 0FINAL ID 40059 2010 04 29 s Camera 1 IpAddress s Camera 1 MacAddress s Camera ...

Page 98: ...ple xStatus Camera 1 SoftwareID s Camera 1 SoftwareID S01718 4 0FINAL ID 40059 2010 04 29 end xStatus Camera 1 7 IpAddress Shows the camera IP address Value space of the result returned S 0 100 Examples 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 S 0 100 Examples xStat...

Page 99: ...end xStatus Conference Shows the top level overview of the conference status The identity of the Conference Site can only be read during a call Example xStatus Conference s Conference Presentation Mode Off s Conference Presentation Protocol s Conference Presentation Resolution Height 0 s Conference Presentation Resolution Width 0 s Conference Presentation SiteId 0 s Conference Presentation LocalSo...

Page 100: ...ation SiteId s Conference Presentation SiteId 0 end xStatus Conference Presentation LocalSource Shows the local video input source that is used when the presentation is sent from the local site Value space of the result returned 1 5 Example xStatus Conference Presentation LocalSource s Conference Presentation LocalSource 0 end xStatus Conference Site 1 n MicrophonesMuted Lists the audio mute statu...

Page 101: ...rop 0 s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Bytes 0 s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 ChannelRate 0 s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 MaxJitter 0 s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 Jitter 0 s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 Packets 0 s Diagnostics ...

Page 102: ...nnels IncomingAudioChannel 327 Netstat 1 Loss s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 Loss 96 end xStatus Diagnostics Call 1 n Channels IncomingAudioChannel 1 n Netstat 1 Drop Shows the packets dropped in the incoming channel Value space of the result returned Integer value Example xStatus Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 Drop s Diagnostics ...

Page 103: ... xStatus Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 Packets s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 Packets 38699 end xStatus Diagnostics Call 1 n Channels IncomingVideoChannel 1 n Netstat 1 Loss Shows the packets lost in the incoming channel Value space of the result returned Integer value Example xStatus Diagnostics Call 27 Channels IncomingVideoCha...

Page 104: ...le xStatus Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Jitter s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Jitter 0 end xStatus Diagnostics Call 1 n Channels IncomingDataChannel 1 n Netstat 1 Packets Shows the number of packets received in the incoming channel Value space of the result returned Integer value Example xStatus Diagnostics Call 27 Channels Incomi...

Page 105: ...taChannel 335 Netstat 1 MaxJitter s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 MaxJitter 0 end xStatus Diagnostics Call 1 n Channels OutgoingAudioChannel 1 n Netstat 1 Jitter Shows the jitter at the present moment in the outgoing channel as specified by RFC 3550 Value space of the result returned Integer value Example xStatus Diagnostics Call 27 Channels OutgoingAudioChannel 32...

Page 106: ... Channels OutgoingAudioChannel 328 Netstat 1 ChannelRate 127000 end xStatus Diagnostics Call 1 n Channels OutgoingAudioChannel 1 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 value Example xStatus Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 MaxJitter s Diagnostics Call 27 Chan...

Page 107: ...nnels OutgoingVideoChannel 331 Netstat 1 Bytes 39111160 end xStatus Diagnostics Call 1 n Channels OutgoingVideoChannel 1 n Netstat 1 ChannelRate Shows the bandwidth for the outgoing channel Value space of the result returned Integer value Example xStatus Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 ChannelRate s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 Cha...

Page 108: ...Drop s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 Drop 0 end xStatus Diagnostics Call 1 n Channels OutgoingDataChannel 1 n Netstat 1 Bytes Shows the number of bytes sent in the media channel Value space of the result returned Integer value Example xStatus Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 Bytes s Diagnostics Call 27 Channels OutgoingDataChannel 336 ...

Page 109: ...H323 Gatekeeper Status Registered s H323 Gatekeeper Address 192 0 2 20 s H323 Gatekeeper Port 1719 s H323 Gatekeeper Reason end xStatus H323 Gatekeeper Status Shows the gatekeeper registration status Value space of the result returned Registered Inactive Rejected Example xStatus H323 Gatekeeper Status s H323 Gatekeeper Status Registered end xStatus H323 Gatekeeper Address Displays the IP address o...

Page 110: ...ory CallLog History s HttpFeedback 1 Expression Status Call Status connected s HttpFeedback 1 Expression Status H323 Gatekeeper s HttpFeedback 1 Expression Status Ethernet s HttpFeedback 1 Expression Event CallSuccessful s HttpFeedback 1 Expression s HttpFeedback 1 Expression s HttpFeedback 1 Expression s HttpFeedback 1 Expression s HttpFeedback 1 Expression s HttpFeedback 1 Expression s HttpFeedb...

Page 111: ...oChannel 330 Video Protocol H264 s MediaChannels Call 27 IncomingVideoChannel 330 Video FrameRate 25 s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX 352 s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionY 288 s MediaChannels Call 27 IncomingVideoChannel 333 Encryption Status Off s MediaChannels Call 27 IncomingVideoChannel 333 ChannelRole Presentation s MediaChann...

Page 112: ...l 1 n IncomingAudioChannel 1 n Audio Mute Shows the audio mute status of the incoming audio channel Value space of the result returned True False Example xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Mute s MediaChannels Call 27 IncomingAudioChannel 327 Audio Mute True end xStatus MediaChannels Call 1 n IncomingAudioChannel 1 n Audio Channels Shows the number of incoming audio chann...

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

Page 114: ...VideoChannel 1 n Video Protocol Shows the video algorithm for the outgoing video channel H264 The H 264 algorithm is an ITU T standard for video compression H263pp The H 263pp algorithm is an ITU T standard for video compression H263 The H 263 algorithm is an ITU T standard for video compression H261 The H 261 algorithm is an ITU T standard for video compression Value space of the result returned ...

Page 115: ...Gateway 192 0 2 10 s Network 1 IPv4 DNS Domain Name www example com www example int s Network 1 IPv4 DNS Server 1 Address 192 0 2 60 s Network 1 IPv4 DNS Server 2 Address 192 0 2 61 s Network 1 IPv4 DNS Server 3 Address s Network 1 IPv4 DNS Server 4 Address s Network 1 IPv4 DNS Server 5 Address s Network 1 IPv4 MTU 1500 end xStatus Network 1 Ethernet MacAddress Shows the MAC Media Access Control a...

Page 116: ...the result returned S 0 100 Example xStatus Network 1 IPv4 Gateway s Network 1 IPv4 Gateway 192 0 2 10 end xStatus Network 1 IPv4 DNS Domain Name Shows the domain name Value space of the result returned S 0 100 Example xStatus Network 1 IPv4 DNS Domain Name s Network 1 IPv4 DNS Domain Name www example com www example int end xStatus Network 1 IPv4 DNS Server 1 5 Address Shows the IP address of the...

Page 117: ...tatus Preset 1 15 Defined Shows if a camera preset is stored at this position Value space of the result returned True False Example xStatus Preset 1 Defined s Preset 1 Defined True end xStatus Preset 1 15 Type Shows the camera preset type Value space of the result returned All Camera Example xStatus Preset 1 Type s Preset 1 Type All end xStatus Preset 1 15 Description Shows the name for the preset...

Page 118: ...ned Idle The provisioning is not active NeedConfig The endpoint needs to be configured Value space of the result returned Failed AuthenticationFailed Provisioned Idle NeedConfig Example xStatus Provisioning Status s Provisioning Status Provisioned end xStatus Provisioning Reason Shows the cause when provisioning has failed Value space of the result returned S 0 80 Example xStatus Provisioning Reas...

Page 119: ...roxy server Active The communication between the endpoint and the SIP Proxy is active DNSFailed The attempt to 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 ...

Page 120: ... 1 Status Registered end xStatus SIP Registration 1 n Reason Shows a message to explain the reason why the SIP registration failed Value space of the result returned S 0 100 Example xStatus SIP Registration 1 Reason s SIP Registration 1 Reason 404 Not Found end xStatus SIP Registration 1 n URI Shows the URI used for registration to the SIP Proxy server Value space of the result returned S 0 100 Ex...

Page 121: ...pace of the result returned True False Example xStatus SIP Profile 1 Secure s SIP Profile 1 Secure True end xStatus SIP Profile 1 Verified Not supported in this software version Value space of the result returned True False Example xStatus SIP Profile 1 Verified s SIP Profile 1 Verified False end xStatus SIP Profile 1 Authentication Shows which authentication mechanism is used when registering to ...

Page 122: ...egistration 1 Reason 404 Not Found end xStatus SIP Profile 1 Registration 1 n URI Shows the URI used for registration to the SIP Proxy server Value space of the result returned S 0 100 Example xStatus SIP Profile 1 Registration 1 URI s SIP Profile 1 Registration 1 URI firstname lastname company com end xStatus Standby Active Shows if the system is in standby or not Value space of the result return...

Page 123: ...r PH0497874 s SystemUnit Hardware VideoBoard Identifier 101560 1 02 s SystemUnit Hardware AudioBoard SerialNumber N A s SystemUnit Hardware AudioBoard Identifier s SystemUnit Hardware BootSoftware U Boot 2009 03 53 s SystemUnit State System Initialized s SystemUnit State MaxNumberOfCalls 3 s SystemUnit State MaxNumberOfActiveCalls 3 s SystemUnit State NumberOfActiveCalls 1 s SystemUnit State Numbe...

Page 124: ... xStatus SystemUnit Software Version s SystemUnit Software Version TC3 1 0 end xStatus SystemUnit Software Name Shows the name of the software that is installed on the codec Value space of the result returned S 0 100 Example 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 Va...

Page 125: ...esult returned S 0 100 Example xStatus SystemUnit Software OptionKeys MultiSite s SystemUnit Software OptionKeys MultiSite true end xStatus SystemUnit Software OptionKeys PremiumResolution Shows if the system has the option key installed that supports the PremiumResolution functionality Value space of the result returned S 0 100 Example xStatus SystemUnit Software OptionKeys PremiumResolution s Sy...

Page 126: ...xStatus SystemUnit Hardware VideoBoard SerialNumber s SystemUnit Hardware VideoBoard SerialNumber PH0534914 end xStatus SystemUnit Hardware VideoBoard Identifier Shows the revision of the video board in the codec Value space of the result returned S 0 100 Example xStatus SystemUnit Hardware VideoBoard Identifier s SystemUnit Hardware VideoBoard Identifier 101410 4 07 end xStatus SystemUnit Hardwar...

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

Page 128: ...overview of the video input status Example xStatus Video Input s Video Input Source 1 Resolution Height 1080 s Video Input Source 1 Resolution Width 1920 s Video Input Source 1 Resolution RefreshRate 60 s Video Input Source 2 Resolution Height 0 s Video Input Source 2 Resolution Width 0 s Video Input Source 2 Resolution RefreshRate 0 s Video Input Source 3 Resolution Height 0 s Video Input Source ...

Page 129: ... end xStatus Video Input HDMI 1 2 SignalState Shows the signal state for the HDMI 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 Unknown OK Unsupported Example xStatus Video Input HDMI 1 SignalState s Video Input HDMI 1 SignalState OK end xStatus Video Input DV...

Page 130: ...w of the video output status Example xStatus Video Output s Video Output HDMI 1 Resolution Height 1080 s Video Output HDMI 1 Resolution Width 1920 s Video Output HDMI 1 Resolution RefreshRate 60 s Video Output DVI 2 Resolution Height 768 s Video Output DVI 2 Resolution Width 1024 s Video Output DVI 2 Resolution RefreshRate 60 s Video Output Legacy 3 Resolution Height 480 s Video Output Legacy 3 Re...

Page 131: ...Status 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 Video Output DVI 2 Resolution RefreshRate s Video Output DVI 2 Resolution RefreshRate 60 end xStatus Video Output Legacy 3 Resolution Height ...

Page 132: ...phicNumber 1017 s Video Layout Site 1 Output 1 Descriptor 4 s Video Layout Site 1 Output 1 DescriptorOutput 1 s Video Layout Site 1 Output 1 Frame 1 PositionX 1333 s Video Layout Site 1 Output 1 Frame 1 PositionY 59 s Video Layout Site 1 Output 1 Frame 1 Width 7334 s Video Layout Site 1 Output 1 Frame 1 Height 7334 s Video Layout Site 1 Output 1 Frame 1 Layer 1 s Video Layout Site 1 Output 1 Frame...

Page 133: ...ut 1 Frame 1 PositionX 0 end xStatus Video Layout Site 1 n Output 1 3 FullFamilyName Shows the name included information about selfview on off for the video layout family Value space of the result returned S 0 100 Example xStatus Video Layout Site 1 Output 1 FullFamilyName s Video Layout Site 1 Output 1 FullFamilyName full sv on end xStatus Video Layout Site 1 n Output 1 3 FamilyNumber Shows the n...

Page 134: ...e Update Value space of the result returned 1 5 Example xStatus Video Layout Site 1 Output 1 Frame 1 VideoSourceId s Video Layout Site 1 Output 1 Frame 1 VideoSourceId 0 end xStatus Video Layout Site 1 n Output 1 3 Frame 1 6 PositionY Shows the vertical position of the upper left corner of the frame Value space of the result returned 0 10000 Example xStatus Video Layout Site 1 Output 1 Frame 1 Pos...

Page 135: ...tus Video Layout Site 1 Output 1 Frame 1 InputNumber s Video Layout Site 1 Output 1 Frame 1 InputNumber 0 end xStatus Video Layout Site 1 n Output 1 3 Frame 1 6 Filename Shows the filename of the layout frame Value space of the result returned S 0 200 Example xStatus Video Layout Site 1 Output 1 Frame 1 Filename s Video Layout Site 1 Output 1 Frame 1 Filename user posters wallpaper png end The Vid...

Page 136: ... Activity s Experimental Audio Input Connectors Line 1 Activity False end xStatus Experimental Shows the top level overview of the Experimental status information Example xStatus Experimental s Experimental Conference Site 18 Capabilities FECC On s Experimental Audio StereoEchoCancellation Mode Off s Experimental Audio Input Connectors Microphone 1 Activity True s Experimental Audio Input Connecto...

Page 137: ...Audiotracking Camera 1 Angle NOTE The Experimental command can be used as is and will not be further documented The Experimental settings WILL change Value space of the result returned Integer value Example xStatus Experimental Audiotracking Camera 1 Angle s Experimental Audiotracking Camera 1 Angle 0 end xStatus Experimental Audiotracking Camera 1 Quality NOTE The Experimental command can be used...

Page 138: ... API Guide Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us www tandberg com www tandberg com Chapter 6 Appendices Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us Appendices ...

Page 139: ...managed by disconnecting and connecting local and remote inputs The Local input 1 has been defined with two Microphones The Local output 2 has been defined with two Line outputs The audio from the Remote input 3 goes to the Local output 2 The audio from the Local input 1 goes to the Remote output 4 Example 1 The dynamic audio API offers a great flexibility when configuring the system and it is sim...

Page 140: ...input and output connectors on the codec The Audio Console application We recommend using the Audio Console with the build in equalizer GUI to modify the equalizers The Audio Console application is found at the TANDBERG Developer Zone web page Go to http developer tandberg com web guest tools integrators audio console The equalizer filter parameters Each section 1 6 of each user defined equalizer ...

Page 141: ...according to the channel configuration of the connectors Line 1 receives the left channel and Line 2 receives the right channel Local stereo circuit example Stereo Stereo in point to point call Receive stereo If the other participant sends stereo the codec will receive stereo To play stereo the local output still needs to be configured correctly see local stereo circuit example Transmit stereo In ...

Page 142: ...t an executable file permission must be changed to executable in this directory Example of the text in such a file About 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 will execute the commands configurations in sequence The file can have any name as long as it is placed in this director...

Page 143: ...1 0B 0 12 0C 0 13 0D 14 0E 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 31 1F 0 Arrow left 32 20 0 Arrow right Button codes Remote control TRC5 Dec Hex Address Button name 33 21 0 Ok 34 22 0 Call 35 23 0 End call 36 24 0 Phone book 37 25 0 Layout 38...

Page 144: ...mera 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 Press the key to en...

Page 145: ...nue of the Americas 24th Floor New York NY 10036 Telephone 1 212 692 6500 Fax 1 212 692 6501 Video 1 212 692 6535 E mail tandberg tandberg com EUROPEAN HEADQUARTERS TANDBERG Philip Pedersens vei 20 1366 Lysaker Norway Telephone 47 67 125 125 Fax 47 67 125 234 Video 47 67 126 126 E mail tandberg tandberg com Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us C...

Search results

Summary of Contents for Codec C Series

Reviews:

Related manuals for Codec C Series

Brands by name

Popular brands

TANDBERG Codec C Series, Api Manual

Search results

Summary of Contents for Codec C Series

Reviews:

Related manuals for Codec C Series

Brands by name

Popular brands