Tandberg MXP Reference User Guide For System Integrators f8
Tandberg MXP Reference User Guide For System Integrators f8
Codec
• 19” mountable codecs
• Expandability for future applications
• Total management via serial port, embedded web
server, SNMP, Telnet, XML, HTTP / HTTPS, FTP and
on screen menu
REFERENCE
FOR SYSTEM
INTEGRATORS
Software version F8.X
D 13887.09
APRIL 2009
Finding the Information You Need
We recommend that you check out the
TANDBERG web site regularly for updated
Thank you for choosing TANDBERG!
versions of this manual: The TANDBERG Codec 3000 MXP and Codec 6000 MXP
http://www.tandberg.com/docs have been designed to provide you with many years of
safe, reliable operation.
This section of the User Guides contains an overview of
what’s new in this version and the Table of Contents.
Our objective with this Reference User Guide for System
Integrators has been to address your goals and needs.
Please let us know how well we succeeded!
Finding the Information You Need
What’s New in This Version? TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
There are a number of new and altered instructions available in Camera [1..13] Whitebalance Mode: <Auto/Manual/Indoor/Out- uses of the TANDBERG/Codian MCU software Ver. 3.0 or higher.
version F8.0 door/Gain> Set to MultiSite if you have the optional feature MultiSite installed.
Altered. The camera picture control white balance setting has Set to Off if none of the above features are being used.
Software release note been enhanced with Indoor and Outdoor settings in addition to the
Auto and Manual settings. Multipoint MulitwayURI <S: 0, 60>
The F8 software release note is found at the TANDBERG web
site. Go to: http://www.tandberg.com/support/documentation. New in version F8. Specify the Multiway URI. When calling
php?p=Upgrades_and_Diagnostics Camera [1..13] Whitebalance Gain Red: <0..255> Multiway on SIP the SIP prefix must be added to the URI for the
New in version F8. The camera picture control white balance set- endpoint who initiates the Multiway call.
ting has been enhanced with a new Red Gain setting.
Multipoint MulitwayMultiprotocol <On/Off>
Configuration Commands Camera [1..13] Whitebalance Gain Blue: <0..255> New in version F8. Enable/disable the Multiway multi protocol.
New in version F8. The camera picture control white balance set-
Audio HearingImpaired Mode: <On/Off> ting has been enhanced with a new Blue Gain setting. Multipoint MulitwayStartupPeriod <0..21>
New in version F8. If set to On the Hearing Impaired Mode New in version F8. Specify the startup period (in seconds) for the
reduces the delay on audio output 3 from 100 ms to 23 ms, CameraReverseControl: <On/Off> Multiway call.
allowing an assisted listening device (ALD) to be installed in New in version F8. Reverse the local camera control, allowing
conjunction with this output and still maintain a high level of lip the camera to more naturally mimic the directional arrows of the OSD Menu Language: <English/German/Norwegian/French/Swed-
synchronization. remote control. ish/Italian/Portuguese/Japanese/Chinese/TraditionalChinese/
Russian/Spanish/Korean/Finnish/Thai/Arabic/Polish/Czech/
Audio Delay AUX: <On/Off> Conference VideoFormatCP: <16:9/4:3> Hungarian/Turkish/Danish/Romanian/Welsh>
New in version F8. The audio delay on AUX can be enabled/dis- New in version F8. As an enhancement to the Continuous Altered. The menu language has been enhanced with more lan-
abled. Presence (CP) layouts already supported by the MXP endpoints, guages: Polish, Czech, Hungarian, Turkish, Romanian and Welsh.
this version includes support for wide CP layouts, transmitted in
Audio Delay VCR: <On/Off> w576p (1024x576) in both the 4-split and 5+1-split video layout OSD Menu InputEditor Language: <Off/Japanese/Chinese/Ko-
New in version F8. The audio delay on VCR can be enabled/ to the far-end systems. If the normal CP layout is preferred the rean/Russian>
disabled. host will transmit all CP layouts using 4CIF (704x576). Altered. The input editor menu language has been enhanced with
Russian language.
Audio HearingImpaired NoiseReduction: <On/Off> KeepDuoOpen: <On/Off>
New in version F8. The noise reduction can be controlled on the New in version F8. Keeps the dual channel open even when there PresentationSoftkey: <DuoScr/MainScr>
endpoint. Noise reduction is added to the output used for hearing is no presentation video source connected to the endpoint.
New in version F8.
impaired devices installed on output 3. You can configure the Presentation key on the remote control to
MaxBandwidth: <128..6144>
either select dual source or main source when in a call, Default is
Audio HearingImpaired EQ: <On/Off> Altered. Limit max bandwidth usage for the system. Related to IP- DuoSrc (dual source).
New in version F8. An equalizer (EQ) can be enabled on the end- Media MaxVideoTXRate, which only controls upstream bandwidth.
point, adding more amplification to the higher frequencies typically Updated the value space from MaxBandwidth: <128..10240> to
Preset [1..15] Camera Brightness Level: <0..31>
found in voices. MaxBandwidth: <128..6144>.
Altered. Defines the brightness level to use if Brightness Mode is
Multipoint Mode <Off/Multisite/Multiway> set to Manual. Updated the value space from 0..16 to 0..31.
Camera [1..13] Brightness Level: <0..31>
Altered. Defines the brightness level to use if Brightness Mode is New in version F8. The Multiway feature will extend point to point
RTP MTU: <400..1400>
set to Manual. Updated the value space from 0..16 to 0..31. calls to conferences on MCU’s hosted on the network over H.323
and SIP. The new participant will be consulted before he is added Altered. Maximum Transfer Unit is the number of bytes of video
to the conference. Requires the uses of the TANDBERG Vide Com- payload per packet. Updated the value space from 1200..1400 to
munications Server (VCS) software Ver. X4.1 or higher, and the 400..1400.
D 13887.09
APRIL 2009 3
Finding the Information You Need
What’s New in This Version? TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Security Level: <0..2> SIP TURN Server: <S: 0, 60> OSD Menu DisplayWelcomeTime: <On/Off>
New in version F8. A Security level parameter has been added to New in version F8. Address of the TURN server for data redirec- Added to the guide. Enables/disables the date and time to be
the configuration of the endpoint, restricting access to the system. tion. A fully qualified domain name or an IP address can be used. displayed on the welcome menu. Requires the NTP IP settings to
When configured for level 0, the system will have a similar security Default port 3478 is assumed. Optional port can be provided be configured to synchronize with the NTP time server.
regime as F7.x. Password storage, encryption, logging etc. will not using ”:nnnnn” notation.
be influenced by setting this to 0. When configured for level 1, the OSD Menu Simple: <On/Off>
system password can only be changed once every 24 hours and ThreePartyLayout: <On/Off> Added to the guide. Enables/disables the Simple Menu mode
three failed attempts to log into the system will lock the inter-
New in version F8. The 3 party layout on the multisite host with some of the menus and buttons hidden.
face for 30 minutes. If a password is set, the system will ask for
utilizes the dual monitor setting of the system to display the two
password confirmation from all web sessions every 15 minutes to
far-end sites on individual monitors. This feature is supported OSD Menu CodecLabel: <S: 0, 48>
ensure the session is still active. When set to level 2, the system
when the multisite picture mode is set to Auto Split or 4 split.
will include all security parameters within level 1 and will also pre- Added to the guide. Specify the text of the codec label.
When a dual stream is started during the conference, the screen
vent normal access to the web server. If a password is set, level
will return to a standard 4-split in order to display the dual stream
2 will time out all active management sessions every 15 minutes, OSD Menu DisplayLogo: <On/Off>
on the second monitor. Upon termination of the dual stream, the
prompting for password input.
layout will return to the 3 party layout. Added to the guide. Enables/disables the Display Logo on
screen.
SecurityLog Mode: <On/Off> Video Outputs DVI [1,2] AspectChoice: <Auto/Clip/Letterbox/Fill>
New in version F8. When enabled, the security log feature will New in version F8. The aspect ratio for the DVI-I outputs can be OSD Icon DuoVideo: <On/Off>
now log all security related events and configuration changes adjusted to Auto, Clip, Letterbox, and Fill to customize the aspect Added to the guide. Enables/Disables the DuoVideo icon.
within the event-log file on the endpoint, allowing an administra- ratio of the monitor to the preferred configuration.
tor to ensure all access to the system is properly logged and can
be reviewed at a later point. When enabled, the security log will OSD Icon CameraTracking: <On/Off>
Video Outputs TV [1,2] AspectChoice: <Auto/Clip/Letterbox/Fill>
maintain a record of events. Added to the guide. Enables/Disables the Camera Tracking icon.
New in version F8. The aspect ratio for the TV outputs can be
adjusted to Auto, Clip, Letterbox, and Fill to customize the aspect
SIP ICE Mode: <On/Off> ratio of the monitor to the preferred configuration. OSD CallDuration Mode: <On/Off>
New in version F8. This version supports SIP interactive con- Added to the guide. Enables/Disables the display of the call
nectivity establishment (ICE) for SIP traversal. ICE is a client duration on screen while in a call.
protocol that governs NAT traversal for SIP endpoints through a Other updates to the xConfiguration commands
combination use of Simple Traversal of UDP through NAT (STUN)
and Traversal Using Relay NAT (TURN, also known as STUN Relay) The following xConfiguration settings were new in a previous ver-
Command Instructions
by allowing the endpoint to determine the best possible path to sion and have now been added to this guide.
the far end system. Observe that the (r) in the Command instructions denotes that
the parameter is required. The (r) appears for your information
AutoPIP Timeout: <1..60>
only and is not a part of the instruction.
SIP MNS Mode: <On/Off> Added to the guide. Controls the timeout for the PIP (Picture-
There are no new xCommand instructions for this version.
New in version F8. This version supports Media Network Services In-Picture) containing the far-end mainstream when dual video
mode for SIP traversal functionality that prioritizes the use of stream is activated. To make the PIP disappear automatically
TURN, so that all media traffic is relayed, unless sent to an end- after a few seconds set the AutoPIP Mode to Auto and define the Status Information Commands
point on the local network. AutoPIP Timeout.
xStatus H323Gatekeeper
SIP ForceTurn Mode: <On/Off> Directory SmartSearch: <On/Off> Run this command from the data port to display the alternate
New in version F8. This version supports SIP traversal using relay Added to the guide. Enables/disables Smart Search in the Phone gatekeepers.
NAT (TURN) for SIP traversal, allowing endpoints behind a NAT to Book.
traverse the firewall through a relay server, such as a TANDBERG
VCS.
D 13887.09
APRIL 2009 4
Finding the Information You Need About the TANDBERG API TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
What’s New in This Version?................................................ 3 Introduction...................................................................... 39
XACLI - Basic Principles................................................ 39
Intellectual Property Rights Root Commands.......................................................... 42
About Main Types of Commands................................... 43
XACLI – Configuration Type Commands.............................. 44
Disclaimer XACLI – Configuration Type Operation ............................... 45
Configuration Help....................................................... 45
Configuration Read....................................................... 45
License Information and Patent Information
Configuration Set (Write).............................................. 45
License Agreements......................................................... 10 About Configuration Types............................................ 46
Patent Information............................................................ 10 Format for Value Types................................................. 46
XACLI – xcommands/xdirectory.......................................... 47
Operator Safety / Environmental Issues Getting an Overview..................................................... 47
Safety Instructions............................................................ 12 Command help............................................................. 47
Environmental Issues........................................................ 13 Issuing a Command...................................................... 48
China RoHS Table............................................................. 14 Command Response.................................................... 48
Command Parameter Value Types................................. 49
Format for Value Types................................................. 49
What’s in the Shipping Box?
XACLI – Status Type Commands........................................ 50
Contents of the 3000 MXP Codec Shipping Box.................. 16 About Status Type Commands...................................... 50
Contents of the 6000 MXP Codec Shipping Box.................. 17 Understanding Status Information Structuring............... 50
About Status Type Commands Formatting..................... 51
Interfaces and Sockets – Codec 3000 MXP Default XACLI Formatting.............................................. 51
Rear Panel Socket– and Interface Groups.......................... 19 About Complete Path formatting................................... 52
Audio Sockets.................................................................. 20 About XML Formatting.................................................. 53
Audio signal levels in Vpp and dBu..................................... 21 About Addressing Status Information............................ 54
Video Sockets.................................................................. 22 About Exposure Options............................................... 55
Camera Socket................................................................. 23 XACLI – Special Commands – xfeedback (I)........................ 56
ISDN BRI sockets (not applicable to 3000 MXP Net)........... 24 About the xfeedback Command.................................... 56
Net socket (applies to 3000 MXP Net only)........................ 25 XACLI – Special Commands – xpreferences (I).................... 58
Network Interface Sockets................................................ 26 About xpreferences...................................................... 58
Power Socket & On/Off Switch.......................................... 27 The xpreferences Options............................................. 58
xpreferences xpathwrite............................................... 58
xpreferences xmlcommandresult.................................. 58
Interfaces and Sockets – Codec 6000 MXP xpreferences detaillevel................................................ 58
Rear Panel Socket– and Interface Groups.......................... 29 xpreferences xmlconfigfeedback................................... 58
Audio Sockets.................................................................. 30 xpreferences xmlstatusfeedback.................................. 59
Audio Signal Levels in Vpp and dBu................................... 31 xpreferences itemnumber............................................. 59
Video Sockets.................................................................. 32 xpreferences completepath.......................................... 60
Net Interface Socket......................................................... 33 XACLI – Special Commands – xgetxml................................ 61
Network Interface Sockets................................................ 34 About xgetxml.............................................................. 61
What’s in this Camera Sockets............................................................... 35
Data Ports........................................................................ 36
TXAS - TANDBERG XML API Service.................................... 62
About TANDBERG XML API Service................................ 62
User Guide? Power Socket & On/Off Switch.......................................... 37 Bare-bone HTTP(S) Access........................................... 62
D 13887.09
APRIL 2009 5
Configuration-type Commands IP................................................................................ 89 TANDBERG 3000 MXP & 6000 MXP
VNC........................................................................... 123
IPMedia....................................................................... 90 REFERENCE
LocalEntry — GroupEntry. GUIDE FOR SYSTEM INTEGRATORS
................................................. 124
Understanding the Table Layout......................................... 64
AdditionalCamera......................................................... 65 IRControl..................................................................... 90 LocalEntry [1..200]..................................................... 124
AlertSpeaker................................................................ 65 ISDN............................................................................ 90 GroupEntry [1..50]...................................................... 124
AlertTone..................................................................... 65 Key.............................................................................. 94 GlobalEntry..................................................................... 125
AllowLatency................................................................ 65 Keyboard..................................................................... 98
AutoAnswer.................................................................. 69 Kiosk........................................................................... 98 Configuration Storage Levels
AutoPIP........................................................................ 70 LocalLayout............................................................... 100
Understanding the Table Layout....................................... 127
AutoLayout.................................................................. 70 Logo.......................................................................... 100
AutoDisplaySnapshot................................................... 70 LoS........................................................................... 100
Bonding....................................................................... 70 MainVideoSource....................................................... 101 Command Information Tables
CallManager................................................................ 70 MaxBandwidth........................................................... 101 Understanding the Table Layout....................................... 143
CallVideoSource........................................................... 70 Multipoint.................................................................. 101 AlertToneTest............................................................. 144
Camera [1..13]............................................................. 71 NAT........................................................................... 102 AudioTestSignal.......................................................... 144
CameraDVI.................................................................. 72 NetProfile [1..7].......................................................... 102 Boot.......................................................................... 145
CameraSleep............................................................... 72 NTP........................................................................... 102 CallAccept................................................................. 145
CameraTracking........................................................... 73 OptionKey.................................................................. 103 CallMute.................................................................... 145
Conference.................................................................. 73 OSD.......................................................................... 103 CallMuteOutgoing....................................................... 145
CorporateDirectory....................................................... 77 PictureProgram [1..4].................................................. 106 CallSetAudioTP........................................................... 146
DefaultPIPPosition....................................................... 78 PresentationStart....................................................... 106 CameraFocus............................................................. 146
Directory...................................................................... 78 PacketlossDownSpeed............................................... 106 CameraForceUpgrade................................................. 146
DoNotDisturb............................................................... 78 PresentationSoftkey................................................... 107 CameraHalt............................................................... 146
DualMonitor................................................................. 78 Preset [1..15]............................................................. 107 CameraMove............................................................. 147
DuoVideoSource.......................................................... 78 QoS........................................................................... 108 CameraPosition......................................................... 147
DynamicResolution...................................................... 78 RemoteSwUpgrade..................................................... 110 CameraReconfigure.................................................... 147
E1............................................................................... 79 RTP........................................................................... 110 CameraTrackingStart.................................................. 148
Ethernet [1..2].............................................................. 79 Screensaver............................................................... 110 CameraTrackingStop.................................................. 148
ExternalManager.......................................................... 79 SecurityLog................................................................ 111 CameraUpgrade......................................................... 148
ExternalNetwork........................................................... 79 Security..................................................................... 111 CameraWhiteBalance................................................. 148
ExternalServices.......................................................... 80 SelfViewOnStartup..................................................... 111 ChairRelease............................................................. 148
FECC........................................................................... 80 SerialPort.................................................................. 112 ChairTake................................................................... 148
FeedbackFilter............................................................. 80 SIP............................................................................ 112 ConferenceDisconnect............................................... 149
FTP.............................................................................. 80 SNMP........................................................................ 114 ConferenceTerminate................................................. 149
G703........................................................................... 80 StartupVideoSource................................................... 115 CorpDirSearch........................................................... 150
H320........................................................................... 81 StillImageSource........................................................ 115 CorpDirGetNext.......................................................... 151
H323........................................................................... 81 SSH........................................................................... 115 CorpDirGetPrevious.................................................... 152
H323CallSetup............................................................ 81 Streaming.................................................................. 116 DefaultValuesSet....................................................... 153
H323Gatekeeper......................................................... 82 StrictPassword........................................................... 117 Dial........................................................................... 154
H323Prefix.................................................................. 83 Switch....................................................................... 117 DialGlobalEntry.......................................................... 155
HTTP........................................................................... 83 SystemUnit................................................................ 117 DialGroupEntry........................................................... 155
HTTPS......................................................................... 83 T1............................................................................. 118 DialLocalEntry............................................................ 155
IdReport...................................................................... 83 Telnet........................................................................ 118 DisconnectCall........................................................... 156
IEEE802.1x.................................................................. 84 TelnetChallenge......................................................... 118 DuoVideoStart........................................................... 156
IMUX........................................................................... 84 Time.......................................................................... 118 DuoVideoStop............................................................ 156
Integrator..................................................................... 89 ThreePartyLayout....................................................... 119 DTMFSend................................................................. 156
IPProtocol.................................................................... 89 UseAsLocalPCMonitor................................................ 119 FECCFocus................................................................ 156
Video......................................................................... 119 FECCMove................................................................. 157
D 13887.09
APRIL 2009 6
FECCPresetActivate.................................................... 157 Status Information Tables TANDBERG 3000 MXP & 6000 MXP
Controlling External Cameras
FECCPresetStore........................................................ 157 REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Understanding the Table Layout....................................... 168 Extcam Protocol Basics................................................... 231
FECCRequestStill....................................................... 157 Audio............................................................................. 169 Far End Video Source Switching.................................. 231
FECCSelectSource..................................................... 157 BRI................................................................................. 170 Far End Preset Switching............................................ 231
FeedbackDeregister................................................... 157 Call................................................................................ 172 The extcap and the extname....................................... 231
FeedbackRegister...................................................... 158 Camera.......................................................................... 184 The extswitch............................................................. 231
FIPSMode.................................................................. 158 CameraSWUpgrade......................................................... 185 Interfacing to the TANDBERG WAVE II Camera ................. 232
FloorRelease.............................................................. 158 CameraTracking.............................................................. 186 Commands..................................................................... 233
FloorRequest............................................................. 158 Conference..................................................................... 187 Interfacing to the Precision HD Camera............................ 235
FloorToSite................................................................. 159 Ethernet......................................................................... 193
FloorToSiteEnd........................................................... 159 ExternalManager............................................................. 194
GroupEntryAdd........................................................... 159 TANDBERG Video Switch
ExternalNetwork............................................................. 195
GroupEntryDelete....................................................... 159 Unpacking the Video Switch............................................ 237
FarEndInformation ......................................................... 196
KeyDown................................................................... 159 Connecting the Video Switch........................................... 238
Feedback ..................................................................... 198
KeyRelease................................................................ 160 Installation of the Video Switch....................................... 241
G703.............................................................................. 199
KeyPress................................................................... 160 Communicating with the Video Switch.............................. 242
H323Gatekeeper............................................................ 200
KeyDisable................................................................ 160 Disclaimer and Safety Instructions.................................. 244
IP................................................................................... 201
KeyEnable.................................................................. 160 Product Declaration........................................................ 245
NTP................................................................................ 202
LocalEntryAdd............................................................ 161 PRI................................................................................. 203
LocalEntryDelete........................................................ 161 RemoteSwUpgrade......................................................... 206
MessageBoxDelete.................................................... 161 Screensaver................................................................... 207
MessageBoxDisplay................................................... 162 SIP . ............................................................................. 208
PIPHide...................................................................... 162 SoftwareUpgrade............................................................ 209
PIPShow.................................................................... 162 Switch ........................................................................... 210
PresetActivate........................................................... 162 VirtualMonitor................................................................. 213
PresetClear................................................................ 163 Warning.......................................................................... 214
PresetStore............................................................... 163 Call................................................................................ 215
ProfileActivate............................................................ 163 Call - DisconnectCause................................................... 216
ProfileCreate.............................................................. 163 Call - DisconnectCauseValue........................................... 217
ProfileDelete.............................................................. 163 AuthenticationFailure...................................................... 220
ProfileList.................................................................. 163 CallDisconnected............................................................ 221
ScreensaverActivate................................................... 163 CallSuccessful................................................................ 222
ScreensaverDeactivate............................................... 164 DownspeedingFinished................................................... 223
ScreensaverReset...................................................... 164 MessageBoxResult......................................................... 224
SiteDisconnect.......................................................... 164 PacketlossDownSpeed.................................................... 225
SiteView.................................................................... 164 SString........................................................................... 226
SiteViewEnd............................................................... 164 SystemActivity................................................................ 227
SPIDAutoConfigure..................................................... 165
StillImageSend........................................................... 165
StreamingStart.......................................................... 165 Startup Scripts
StreamingStop........................................................... 165 How to create and run a startup script............................. 229
TextDelete................................................................. 165 Create a startup script............................................... 229
TextDisplay................................................................ 165 Upload the file to the codec........................................ 229
VirtualMonitorReset................................................... 166 Run the startup script................................................ 229
VirtualMonitorSet....................................................... 166
D 13887.09
APRIL 2009 7
Intellectual Property Rights
We recommend that you check out the This Reference Guide for System Integrators and the Products to
TANDBERG web site regularly for updated
versions of this manual: which it relates contain information that is proprietary to TANDBERG
http://www.tandberg.com/docs and its licensors. Information regarding the Products is found on the
page entitled License Agreements and Patent Information.
This Reference Guide for System Integrators may be reproduced in
its entirety, including all copyright and intellectual property notices, in
limited quantities in connection with the use of the Products. Except
for the limited exception set forth in the previous sentence, no part
of this Reference Guide for System Integrators may be reproduced,
stored in a retrieval system, or transmitted, in any form, or by any
means, electronically, mechanically, by photocopying, or otherwise,
without the prior written permission of TANDBERG. Requests for
such permission should be addressed to [email protected].
TANDBERG® is a registered trademark belonging to Tandberg ASA.
Other trademarks used in this document are the property of their
respective holders.
COPYRIGHT © 2009, TANDBERG
All rights reserved.
Philip Pedersens vei 20, 1366 Lysaker, Norway
Tel: +47 67 125 125 Fax: +47 67 125 234
E-mail: [email protected]
Disclaimer
We recommend that you check out the The specifications for the Products and the information in this
TANDBERG web site regularly for updated
versions of this manual:
document are subject to change at any time, without notice, by
http://www.tandberg.com/docs
TANDBERG.
Every effort has been made to supply complete and accurate
information in this Reference Guide for System Integrators,
however, TANDBERG assumes no responsibility or liability for any
errors or inaccuracies that may appear in this document.
INTELLECTUAL PROPERTY RIGHTS
The Products that are covered by this Reference Guide for System
Integrators are protected under copyright, patent, and other
intellectual property rights of various jurisdictions. Any applicable
software licenses and any limited warranty are located in the
License Information section in this System Integrator Reference
Guide.
This Product is
COPYRIGHT © 2009, TANDBERG
All rights reserved.
License Information and Patent Information TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
eCos ICU
eCos, the Embedded Configurable Operating System. ICU License - ICU 1.8.1 Copyright © 1995-2003 International Busi-
ness Machines Corporation and others. All rights reserved.
Portions of eCos code are distributed under several BSD style
licenses. Other portions of eCos code are distributed under the ICU is distributed under the terms of the ICU license which is a
terms of the GNU General Public License with a non-copyleft excep- MIT/X Consortium style license.
tion which allows staic links to non-copyleft programs. Portions
of the code are distributed under the terms of various BSD style
D 13887.09
APRIL 2009 10
Operator Safety / Environmental Issues
We recommend that you check out the
TANDBERG web site regularly for updated
For your own protection, please read the overleaf safety
versions of this manual: instructions completely, before operating the equipment
http://www.tandberg.com/docs and keep this manual for future reference. The information
in this summary is intended for operators. Carefully
observe all warnings, precautions and instructions both on
the apparatus and in the operating instructions.
Safety Instructions TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
For your protection please read these safety • Do not place the product in direct sunlight • Do not tug the power cord. in accordance with the operating
instructions completely before you connect or close to a surface directly heated by the • If the provided plug does not fit into your instructions.
the equipment to the power source. Carefully sun. outlet, consult an electrician.
observe all warnings, precautions and instruc-
• Never install cables, or any peripherals, Accessories
tions both on the apparatus and in these
Lightning without first unplugging the device from it's Use only accessories specified by the
operating instructions.
Never use this apparatus, or connect/discon- power source. manufacturer, or sold with the apparatus.
Retain this manual for future reference.
nect communication cables or power cables • Always use the power supply (AC–DC adap-
during lightning storms. tor) provided with this product (adaptor is Communication Lines
Water and Moisture supplied with 3000 MXP only).
Do not use communication equipment to
• Do not operate the apparatus under or near Dust • Replace only with power supply (AC–DC report a gas leak in the vicinity of the leak.
water – for example near a bathtub, kitchen adaptor) specified by TANDBERG (adaptor
Do not operate the apparatus in areas with
sink, or laundry tub, in a wet basement, is supplied with 3000 MXP only).
high concentration of dust
near a swimming pool or in other areas • Never connect attached power supply
with high humidity. (AC–DC adaptor) to other products (adaptor
• Never install jacks for communication Vibration is supplied with 3000 MXP only).
cables in wet locations unless the jack is Do not operate the apparatus in areas with
specifically designed for wet locations. vibration or place it on an unstable surface.
Servicing
• Do not touch the product with wet hands.
• Do not attempt to service the apparatus
Power Connection and Hazardous yourself as opening or removing covers
Cleaning Voltage may expose you to dangerous voltages or
• Unplug the apparatus from communication • The product may have hazardous voltage other hazards, and will void the warranty.
lines, mains power-outlet or any power inside. Never attempt to open this product, Refer all servicing to qualified service
source before cleaning or polishing. Do or any peripherals connected to the prod- personnel.
uct, where this action requires a tool.
not use liquid cleaners or aerosol clean- • Unplug the apparatus from its power
ers. Use a lint-free cloth lightly moistened • This product should always be powered source and refer servicing to qualified
with water for cleaning the exterior of the from an earthed power outlet. personnel under the following conditions:
apparatus. • Never connect attached power supply cord • If the power cord or plug is damaged or
• Unplug the apparatus from communication to other products. frayed.
lines before cleaning or polishing. Do not • In case any parts of the product has visual • If liquid has been spilled into the
use liquid cleaners or aerosol cleaners. damage never attempt to connect mains apparatus.
Use a lint-free cloth lightly moistened with power, or any other power source, before
water for cleaning the exterior of the ap- • If objects have fallen into the apparatus.
consulting service personnel
paratus. • If the apparatus has been exposed to
• The plug connecting the power cord to the rain or moisture
product/power supply serves as the main
Ventilation disconnect device for this equipment. The • If the apparatus has been subjected to
power cord must always be easily acces- excessive shock by being dropped.
• Do not block any of the ventilation openings
of the apparatus. Never cover the slots sible. • If the cabinet has been damaged.
and openings with a cloth or other mate- • Route the power cord so as to avoid it be- • If the apparatus seems to be
rial. Never install the apparatus near heat ing walked on or pinched by items placed overheated.
sources such as radiators, heat registers, upon or against it. Pay particular attention • If the apparatus emits smoke or
stoves, or other apparatus (including ampli- to the plugs, receptacles and the point abnormal odor.
fiers) that produce heat. where the cord exits from the apparatus.
• If the apparatus fails to operate
D 13887.09
APRIL 2009 12
Environmental Issues TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Thank you for buying a product which contributes to a reduc- European Environmental Directives Information for Recyclers
tion in pollution, and thereby helps save the environment. Our
As a manufacturer of electrical and electronic equipment TAND- As part of compliance with the European WEEE Directive, TAND-
products reduce the need for travel and transport and thereby
BERG is responsible for compliance with the requirements in BERG provides recycling information on request for all types of
reduce pollution. Our products have either none or few consum-
the European Directives 2002/96/EC (WEEE) and 2002/95/EC new equipment put on the market in Europe after August 13th
able parts (chemicals, toner, gas, paper). Our products are low
(RoHS). 2005.
energy consuming products.
The primary aim of the WEEE Directive and RoHS Directive is Please contact TANDBERG and provide the following details
to reduce the impact of disposal of electrical and electronic for the product for which you would like to receive recycling
TANDBERG’s Environmental Policy equipment at end-of-life. The WEEE Directive aims to reduce information:
Environmental stewardship is important to TANDBERG’s the amount of WEEE sent for disposal to landfill or incineration • Model number of TANDBERG product
culture. As a global company with strong corporate values, by requiring producers to arrange for collection and recycling.
• Your company’s name
TANDBERG is committed to following international environmen- The RoHS Directive bans the use of certain heavy metals and
tal legislation and designing technologies that help companies, brominated flame retardants to reduce the environmental • Contact name
individuals and communities creatively address environmental impact of WEEE which is landfilled or incinerated. • Address
challenges. TANDBERG has implemented necessary process changes to • Telephone number
TANDBERG’s environmental objectives are to: comply with the European RoHS Directive (2002/95/EC) and • E-mail.
• Develop products that reduce energy consumption, CO2 the European WEEE Directive (2002/96/EC).
emissions, and traffic congestion Digital User Guides
• Provide products and services that improve quality of life for Waste Handling TANDBERG is pleased to announce that we have replaced the
our customers In order to avoid the dissemination of hazardous substances printed versions of our User Guides with a digital CD version.
• Produce products that can be recycled or disposed of safely in our environment and to diminish the pressure on natural Instead of a range of different user manuals, there is now one
at the end of product life resources, we encourage you to use the appropriate take-back CD – which can be used with all TANDBERG products – in a
variety of languages. The environmental benefits of this are
• Comply with all relevant environmental legislation. systems in your area. Those systems will reuse or recycle most
of the materials of your end of life equipment in a sound way. significant. The CDs are recyclable and the savings on paper
are huge. A simple web-based search feature helps you directly
TANDBERG products put on the market after August access the information you need. In addition, the TANDBERG
2005 are marked with a crossed-out wheelie bin sym- video systems now have an intuitive on-screen help function,
bol that invites you to use those take-back systems. which provides a range of useful features and tips. The con-
Please contact your local supplier, the regional waste tents of the CD can still be printed locally, whenever needed.
administration or http://www.tandberg.com/recycling
if you need more information on the collection and recycling
system in your area.
D 13887.09
APRIL 2009 13
Environmental Issues TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 14
What’s in the Shipping Box?
We recommend that you check out the This part of the Reference Guide for System Integrators
TANDBERG web site regularly for updated
versions of this manual: presents the contents of the shipping box to ease your
http://www.tandberg.com/docs acceptance test as well as assist you in making sure
you’ve got everything with you if you need to take the
codec along for installation etc.
What’s in the Shipping Box?
Contents of the 3000 MXP Codec Shipping Box TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 16
What’s in the Shipping Box?
Contents of the 6000 MXP Codec Shipping Box TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 17
Interfaces and Sockets – Codec 3000 MXP
We recommend that you check out the This part of the manual provides an in-depth presentation
TANDBERG web site regularly for updated
versions of this manual: of the rear panel sockets and interfaces of the Codec
http://www.tandberg.com/docs 3000 MXP, including the audio signal levels and the
formats supported.
Interfaces and Sockets – Codec 3000 MXP
Rear Panel Socket– and Interface Groups TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
The Codec 3000 MXP comes in two flavours – with ISDN BRI sockets (upper) or with Net socket (lower).
Codec 3000 MXP
PC card Camera
D 13887.09
APRIL 2009 19
Interfaces and Sockets – Codec 3000 MXP
Audio Sockets TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Tip! Audio signal levels Use Audio Input No. 3 to Use Audio Input No. 4 to Tip! Audio Input No. 4 is not Stereo Settings
expressed in volts and dBu connect to external playback connect a VCR or DVD player equipped with an acoustic
Settings Output Response
can be found overleaf. devices. This input can also to the system. For systems echo canceller. Connecting a
be configured as a microphone configured with stereo I/O, microphone to this input can Out 1 mode Stereo Stereo Audio Out 1 Audio Out 2
input. It will then function in connect the VCR/DVD right therefore not be recommended. I/O mode speakers
Note! Audio inputs 3 &
4 are referred to as Line lieu of the Mic. 2 input and be channel to this input. This Analogue Off Off Loudspeaker mono VCR
input 1 & 2 in the API. connected to Mic. 2’s echo input should be used when Analogue Off On Loudspeaker L Loudspeaker R
canceller (which can be turned connecting a telephone add-on
Analogue On Off Loudspeaker mono VCR
on/off). system.
Tip! Unused, but connected Analogue On On Loudspeaker L Loudspeaker R
audio inputs should be set
SPDIF Off Off Loudspeaker mono VCR
to Off to avoid unwanted
audio/noise. SPDIF Off On Loudspeaker L & R VCR
D 13887.09
APRIL 2009 20
Interfaces and Sockets – Codec 3000 MXP
Audio signal levels in Vpp and dBu TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Microphone Inputs 1 & 2 Audio Inputs 3 & 4 Audio Outputs 1 & 2 Note! Audio inputs 3 & 4 are referred
Signal levels Signal levels Signal levels to as Line input 1 & 2 in the API.
Signal Clipping levels Nominal Signal Clipping levels Nominal Signal Absolute max output Nominal
levels level levels level levels level level Tip! To convert dBu values to dBV,
subtract 2.2 dB from the dBu value.
Input Input Input
menu menu menu Example: –10 dBu => –12.2 dBV
level level level
setting setting setting Note! The input clipping levels and
[dB] [mVpp] [dBu] [dBu] [dB] [Vpp] [dBu] [dBu] [dB] [Vpp] [dBu] [dBu] the absolute max output levels all
assume sinusoidal signals for the dBu
0.0 83.0 –28.4 –46.4 0.0 15.5 17.0 –1.0 0.0 1.2 –5.5 –23.5
values.
1.5 69.8 –29.9 –47.9 1.5 13.0 15.5 –2.5 1.5 1.4 –4.0 –22.0
3.0 58.8 –31.4 –49.4 3.0 11.0 14.0 –4.0 3.0 1.6 –2.5 –20.5
4.5 49.4 –32.9 –50.9 4.5 9.2 12.5 –5.5 4.5 1.9 –1.0 –19.0
6.0 41.6 –34.4 –52.4 6.0 7.8 11.0 –7.0 6.0 2.3 0.5 –17.5
7.5 35.0 –35.9 –53.9 7.5 6.5 9.5 –8.5 7.5 2.8 2.0 –16.0
9.0 29.4 –37.4 –55.4 9.0 5.5 8.0 –10.0 9.0 3.3 3.5 –14.5
10.5 24.8 –38.9 –56.9 10.5 4.6 6.5 –11.5 10.5 3.9 5.0 –13.0
12.0 20.8 –40.4 –58.4 12.0 3.9 5.0 –13.0 12.0 4.6 6.5 –11.5
13.5 17.5 –41.9 –59.9 13.5 3.3 3.5 –14.5 13.5 5.5 8.0 –10.0
15.0 14.8 –43.4 –61.4 15.0 2.8 2.0 –16.0 15.0 6.5 9.5 –8.5
16.5 12.4 –44.9 –62.9 16.5 2.3 0.5 –17.5 16.5 7.8 11.0 –7.0
18.0 10.4 –46.4 –64.4 18.0 2.0 -1.0 –19.0 18.0 9.2 12.5 –5.5
19.5 8.8 –47.9 –65.9 19.5 1.6 -2.5 –20.5 19.5 11.0 14.0 –4.0
21.0 7.4 –49.4 –67.4 21.0 1.4 -4.0 –22.0 21.0 13.0 15.5 –2.5
22.5 6.2 –50.9 –68.9 22.5 1.2 -5.5 –23.5 22.5 15.5 17.0 –1.0
–31.4
D 13887.09
APRIL 2009 21
Interfaces and Sockets – Codec 3000 MXP
Video Sockets TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Note! The system S-video input Composite video input RCA sockets PC DVI-I input sockets
will automatically Mini-DIN socket Doc. camera VCR (Digital Video Interface,
adapt to a PAL or Aux. camera Integrated digital
NTSC input. and analogue)
Single
S-video output
Mini-DIN socket
transmit analogue VGA signals 7 DDC Data 15 GND 23 T.M.D.S. Clock+ Do as follows to get WXGA:
and DVI-I cables can transmit (return for +5 V, 1 VGA Out Quality must be set to Auto. RCA pin-out
HSync and Vsync) External view of socket
either digital or analogue signals. 2 VGA Monitor Format must be set to Wide.
8 Analogue Vertical 16 Hot plug detect 24 T.M.D.S. Clock– 3 PC Picture Format must be set to Normal.
If your DVI cable is not long Sync If you are using TANDBERG supplied monitors this will give WXGA out Signal GND
enough, use extension cables. when displaying graphics.
C1 Analogue Red C2 Analogue Green C3 Analogue Blue
Observe, however, that the If non-TANDBERG provided displays are used, you must in addition
maximum cable length should not C4 Analogue C5 Analogue GND execute the command:
Horizontal Sync (analogue
exceed 5 m to avoid quality loss. xConfiguration Video Outputs AllowWXGA: On
R, G & B return)
D 13887.09
APRIL 2009 22
Interfaces and Sockets – Codec 3000 MXP
Camera Socket TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
9 6
Codec side
S-video Mini-DIN pin-out
Split cable for non- External view of socket
TANDBERG 3000 WAVE II TANDBERG HD 3000 Non-TANDBERG
Camera cable pin-out Camera cable pin-out Camera cable pin-out TANDBERG WAVE II 4 3
cameras
SIGNAL RJ-45 S-VIDEO DSUB SIGNAL RJ-45 DSUB SIGNAL DSUB S-VIDEO DSUB
NAME NAME NAME Camera Codec
C — 4 6 C — 4 6
NC — — 7 NC — — 7
D 13887.09
APRIL 2009 23
Interfaces and Sockets – Codec 3000 MXP
ISDN BRI sockets (not applicable to 3000 MXP Net) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
S/T Interface
RJ-45 Connector pin-out ISDN BRI interface. ISDN I.420
BRI Pin out (RJ-45 Jack) Basic Rate Interface
Pin 3 TX+ S/T (2B + D), 128 kbps per ISDN
Pin 4 RX+ I/F. Use any standard BRI cable
Pin 5 RX– to connect the Codec to BRI.
Pin 6 TX–
D 13887.09
APRIL 2009 24
Interfaces and Sockets – Codec 3000 MXP
Net socket (applies to 3000 MXP Net only) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
HD D-SUB 26 pin-out
External view of socket
V35 DTE → DCE RS449 DTE → DCE Note the following:
Pin Signal name Direction Description Pin Signal name Direction Description V.10 (RS423). For balanced signals a
1 9
0 = low voltage, is defined as terminal 10 18
1 FGND ↔ Frame GND on equipment 1 FGND ↔ Frame GND
A positive with respect to terminal B. 19 26
11 SD(A) → Send Data / Transmit 11 SD(A) → Send Data
For unbalanced signals a 0 = low volt-
12 SD(B) → Send Data / Transmit 12 SD(B) → Send Data age, is defined as terminal positive
13 RD(A) ← Receive Data 13 RD(A) ← Receive Data with respect to GND. Cable length X.21 DTE → DCE
for Leased Line Control should not
14 RD(B) ← Receive Data 14 RD(B) ← Receive Data Pin Signal name Direction Description
exceed 20 m.
15 SCR(A) ← Signal Clock Receive 15 RT(A) ← Receive Timing 1 FGND ↔ Frame GND
16 SCR(B) ← Signal Clock Receive 16 RT(B) ← Send Timing RS 366. All balanced inputs and 11 T(A) → Send Data / Transmit
17 SCT(A) ← Signal Clock Transmit 17 ST(A) ← Send Timing outputs (A and B) use balanced line 12 T(B) → Send Data / Transmit
18 SCT(B) ← Signal Clock Transmit 18 ST(B) ← Send Timing signals according to V.11 (RS 422), 13 R(A) ← Received Data / Receive
while single ended signals are in
19 GND1 ↔ Signal GND 19 GND1 ↔ GND 14 R(B) ← Received Data / Receive
accordance with V.10 (RS423). The
22 RLSD(CD) ←
Received Line Signal Detector / 20 TR(A) → Terminal Ready 0 = low voltage definitions are the 15 S(A) ← Signal Element Timing
Carrier Detect
21 TR(B) → Terminal Ready same as for V.10 above. Max cable 16 S(B) ← Signal Element Timing
23 RLSD(GND)1 ← Signal GND length, as for V.10 above.
22 RR(A) ← Carrier Detect / Receiver Ready 20 C(A) → Terminal Ready / Control
24 RI ← Ring Indicator
23 RR(B) ← Carrier Detect / Receiver Ready
X.21. Signals are as for RS 366 above.
21 C(B) → Terminal Ready / Control
25 LOS → Loss of Signal (KG194)
24 IC ← Incoming Call Cable length should not exceed 50 m. 22 I(A) ← Carrier Detect
26 DTR → Data Terminal Ready
25 LOS → Loss of Signal (KG194) 23 I(B) ← Carrier Detect
1) This pin is connected to ground for correct operations
Frame GND is connected to pin 1 on DTE
1) This pin is connected to ground for correct operations
D 13887.09
APRIL 2009 25
Interfaces and Sockets – Codec 3000 MXP
Network Interface Sockets TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 26
Interfaces and Sockets – Codec 3000 MXP
Power Socket & On/Off Switch TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 27
Interfaces and Sockets – Codec 6000 MXP
We recommend that you check out the This part of the manual provides an in-depth presentation
TANDBERG web site regularly for updated
versions of this manual: of the rear panel sockets and interfaces of the Codec
http://www.tandberg.com/docs 6000 MXP, including the audio signal levels and the
formats supported.
Interfaces and Sockets – Codec 6000 MXP
Rear Panel Socket– and Interface Groups TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Audio sockets
Video sockets
Power socket
and On/Off switch
D 13887.09
APRIL 2009 29
Interfaces and Sockets – Codec 6000 MXP
Audio Sockets TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Use Audio Input No. 4 Use Audio Input No. 5 to Use Audio Input No. 6 to Tip! Audio inputs Nos. 5 Stereo Settings
to connect to an external connect to external playback connect a VCR or DVD player & 6 are not equipped with
Settings Output Response
microphone amplifier or to devices or to telephone add-on to the system. For systems acoustic echo canceller.
an external mixer. hybrids. For systems configured configured with stereo I/O, Connecting microphones to Out 1 Stereo Stereo Audio Out 1 Audio Out 2 Audio
with stereo I/O, connect the connect the VCR/DVD right these inputs can therefore mode I/O mode speakers Out 3
VCR/DVD left channel to this channel to this input. not be recommended. Analogue Off Off Loudspeaker Aux VCR
input. mono
Note! Audio Tip! Unused, but connected Analogue Off On Loudspeaker L Loudspeaker R VCR
inputs 4–6 audio inputs should be set
Analogue On Off Loudspeaker VCR L VCR R
are referred to Off to avoid unwanted mono
to as Line RCA pin-out audio/noise.
Analogue On On Loudspeaker L Loudspeaker R VCR
input 1–3 in
External view of socket Tip! Audio signal levels SPDIF Loudspeaker Aux VCR
the API. Off Off
mono
Signal GND expressed in volts and dBu
can be found overleaf. SPDIF Off On Loudspeaker
Aux VCR
L & R
SPDIF Loudspeaker
On Off VCR L VCR R
mono
SPDIF Loudspeaker
On On VCR L VCR R
L & R
Microphone Inputs Use Audio Output No. 1 to Use Audio Output No. 2 (the Use Audio Output No. 3 Hardware Information
Nos. 1–3. provide a mixed signal of audio AUX output) to provide a mixed (the VCR output) to provide
Microphone(s) Audio Input(s) Audio Outputs
Three balanced from far end and local external signal consisting of audio from a mixed signal consisting
microphone inputs for devices connected to input 5 & the local side (AUX input not of audio from the local side Signal type Balanced Unbalanced
electret microphones 6, in addition to dial tones. included) and audio from the (VCR input not included) Socket XLR-F RCA/phono
balanced, 24V phantom This output should be connected far end. and audio from the far end.
Input impedance 2400 W 10 kW
powered via XLR to the local loudspeaker system, This output should be used This output should be used (pin 2–3)
connectors. which may, or may not, include when connecting a telephone when connecting a VCR to Output impedance 680 W
The phantom powering the TANDBERG Digital Natural add-on system. the system.
Max input level when set to
of XLR socket No. 3 can Audio Module. For system configured with For system configured with min. input level
83 mVpp 15.5 Vpp
be switched off. The For systems configured with stereo I/O and with SPDIF† stereo I/O and with SPDIF† Max output level when set to
Mic. input No. 3 will stereo speakers and SPDIF† active on Audio Output No. 1, active on Audio Output No. max. output level
15.5 Vpp
then be a balanced line active, the left and right channel this output will provide the VCR 1, this output will provide Max input level when set to
level input. of the loudspeaker signal will left channel stereo information. the VCR right channel max. input level
6.2 mVpp 1.2 Vpp
both be provided on this output. For systems configured with stereo information.
XLR pin-out Max output level when set to
1.2 Vpp
For systems configured with stereo I/O, stereo speakers and For systems configured min. output level
External view of socket
stereo speakers and SPDIF† SPDIF† not active, this output with stereo I/O, stereo Gain range 22.5 dB (16 steps of 1.5 dB)
2 1 not active, the left channel of will provide the right channel of speakers and SPDIF† not Phantom power 24 V ± 5 %
the loudspeaker signal will be the loudspeaker signal (the left active, this output will
Phantom power resistor
Pin 1: Gnd present on this output. The right channel will be provided on the provide the mix of left and pin 2
1200 W
loudspeaker channel will be Audio Output No. 1). right channel of the VCR
Pin 2: Hot Phantom power resistor
3 provided on Audio Output No. 2. out signal. pin 3
1200 W
Pin 3: Cold/neutral
Max phantom power current 12 mA
†
SPDIF (Sony/Philips Digital Interface)
is used by the Digital Natural Audio module.
D 13887.09
APRIL 2009 30
Interfaces and Sockets – Codec 6000 MXP
Audio Signal Levels in Vpp and dBu TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Microphone Inputs 1, 2 & 3 Microphone Input 3 Audio Inputs 4, 5 & 6 Audio Outputs 1, 2 & 3
Signal levels Line level mode signal levels Signal levels Signal levels
Signal Clipping levels Nominal Signal Clipping levels Nominal Signal Clipping levels Nominal Signal Absolute max output Nominal
levels level levels level levels level levels level level
Input Input Input Input
menu level menu level menu level menu level
setting setting setting setting
[dB] [mVpp] [dBu] [dBu] [dB] [Vpp] [dBu] [dBu] [dB] [Vpp] [dBu] [dBu] [dB] [Vpp] [dBu] [dBu]
0.0 83.0 –28.4 –46.4 0.0 15.5 17.0 –1.0 0.0 15.5 17.0 –1.0 0.0 1.2 –5.5 –23.5
1.5 69.8 –29.9 –47.9 1.5 13.0 15.5 –2.5 1.5 13.0 15.5 –2.5 1.5 1.4 –4.0 –22.0
3.0 58.8 –31.4 –49.4 3.0 11.0 14.0 –4.0 3.0 11.0 14.0 –4.0 3.0 1.6 –2.5 –20.5
4.5 49.4 –32.9 –50.9 4.5 9.2 12.5 –5.5 4.5 9.2 12.5 –5.5 4.5 1.9 –1.0 –19.0
6.0 41.6 –34.4 –52.4 6.0 7.8 11.0 –7.0 6.0 7.8 11.0 –7.0 6.0 2.3 0.5 –17.5
7.5 35.0 –35.9 –53.9 7.5 6.5 9.5 –8.5 7.5 6.5 9.5 –8.5 7.5 2.8 2.0 –16.0
9.0 29.4 –37.4 –55.4 9.0 5.5 8.0 –10.0 9.0 5.5 8.0 –10.0 9.0 3.3 3.5 –14.5
10.5 24.8 –38.9 –56.9 10.5 4.6 6.5 –11.5 10.5 4.6 6.5 –11.5 10.5 3.9 5.0 –13.0
12.0 20.8 –40.4 –58.4 12.0 3.9 5.0 –13.0 12.0 3.9 5.0 –13.0 12.0 4.6 6.5 –11.5
13.5 17.5 –41.9 –59.9 13.5 3.3 3.5 –14.5 13.5 3.3 3.5 –14.5 13.5 5.5 8.0 –10.0
15.0 14.8 –43.4 –61.4 15.0 2.8 2.0 –16.0 15.0 2.8 2.0 –16.0 15.0 6.5 9.5 –8.5
16.5 12.4 –44.9 –62.9 16.5 2.3 0.5 –17.5 16.5 2.3 0.5 –17.5 16.5 7.8 11.0 –7.0
18.0 10.4 –46.4 –64.4 18.0 2.0 –1.0 –19.0 18.0 2.0 -1.0 –19.0 18.0 9.2 12.5 –5.5
19.5 8.8 –47.9 –65.9 19.5 1.6 –2.5 –20.5 19.5 1.6 -2.5 –20.5 19.5 11.0 14.0 –4.0
21.0 7.4 –49.4 –67.4 21.0 1.4 –4.0 –22.0 21.0 1.4 -4.0 –22.0 21.0 13.0 15.5 –2.5
22.5 6.2 –50.9 –68.9 22.5 1.2 –5.5 –23.5 22.5 1.2 -5.5 –23.5 22.5 15.5 17.0 –1.0
This specification is always valid for mic 1 and 2, and This specification is valid for mic 3 if line level setting is Default levels are denoted as follows: –31.4 This specification is always valid for output 2 and 3,
for mic 3 if mic level setting is selected. selected. and for output 1 at volume setting 15.
Audio inputs 4–6 Note: Audio inputs 4–6 are referred to as Line
Tip: To convert dBu values to dBV, subtract
input 1–3 in the API.
2.2 dB from the dBu value.
Example: –10 dBu ≡ –12.2 dBV
D 13887.09
APRIL 2009 31
Interfaces and Sockets – Codec 6000 MXP
Video Sockets TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
The system will S-video input Mini-DIN sockets Composite video input RCA sockets PC DVI-I input sockets Note that the S-Video/Composite outputs on the
automatically Main camera Aux. camera Doc. camera VCR (Digital Video Interface, 6000 MXP are now by default turned off from
adapt to a PAL or Integrated digital factory.
NTSC input. and analogue) Ref. xConfiguration Video Outputs TV [1..2] Mode
transmit analogue VGA signals 7 DDC Data 15 GND 23 T.M.D.S. Clock+ Do as follows to get WXGA:
and DVI-I cables can transmit (return for +5 V, 1 VGA Out Quality must be set to Auto. RCA pin-out
HSync and Vsync) External view of socket
either digital or analogue signals. 2 VGA Monitor Format must be set to Wide.
8 Analogue Vertical 16 Hot plug detect 24 T.M.D.S. Clock– 3 PC Picture Format must be set to Normal.
If your DVI cable is not long Sync If you are using TANDBERG supplied monitors this will give WXGA out Signal GND
enough, use extension cables. when displaying graphics.
C1 Analogue Red C2 Analogue Green C3 Analogue Blue
Observe, however, that the If non-TANDBERG provided displays are used, you must in addition
maximum cable length should not C4 Analogue C5 Analogue GND execute the command:
Horizontal Sync (analogue
exceed 5 m to avoid quality loss. xConfiguration Video Outputs AllowWXGA: On
R, G & B return)
D 13887.09
APRIL 2009 32
Interfaces and Sockets – Codec 6000 MXP
Net Interface Socket TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
HD D-SUB 26 pin-out
External view of socket
1 9
10 18
19 26
Net interface socket. 1 × X.21 / V.35 / RS449
with 1 × RS366 Call Control up to 2 Mbps
RS366 DTE - DCE
D 13887.09
APRIL 2009 33
Interfaces and Sockets – Codec 6000 MXP
Network Interface Sockets TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Tip! If you connect your Codec directly to a PC, make sure you set up
the system to use static TCP/IP settings. There will be no DHCP server
controlling the little LAN created by the computer and the Codec. When
configuring a back-to-back connection between the PC and the Codec,
make sure both static IP addresses exist on the same subnet.
D 13887.09
APRIL 2009 34
Interfaces and Sockets – Codec 6000 MXP
Camera Sockets TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
2 1
Pin 1: Ground (Luminance) 9-pin D-sub pin-out
TANDBERG WAVE II TANDBERG HD 6000
Pin 2: Ground (Chrominance) Camera cable pin-out Camera cable pin-out External view of socket
Pin 3: Luminance (Y) SIGNAL RJ-45 DSUB SIGNAL RJ-45 DSUB 5 1
NAME NAME
Pin 4: Chrominance (C)
+12V DC 8 4 +12V DC 1 Twisted 4
TXD 4 3 TX 6 pair 3
D 13887.09
APRIL 2009 35
Interfaces and Sockets – Codec 6000 MXP
Data Ports TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
9 6
Data Ports
Data port 1 Data port 2
Pin Signal name Direction Signal name Direction USB interface. Data port 1 (upper) and 2 (lower). The Data ports
From DCE Carrier detect, From DCE
For future use. are implemented as Digital Circuit Terminating
1 Carrier detect,
CD CD Equipment (DCE).
2 Receive data, From DCE Receive data, From DCE Note! The TANDBERG main camera is normally
RXD RXD connected to data port 2 and pin No. 4 provides
3 Transmit data, To DCE Transmit data, To DCE 12 Vdc / 1 A to the main camera. Otherwise the pin-
TXD TXD outs are the same for the two data ports.
41 Data terminal From DCE 12 V / 1 A
ready, DTR
6 Data set ready, From DCE Data set ready, From DCE
DSR DSR
1) The TANDBERG main camera is normally connected to data port 2 and pin No. 4
provides 12 Vdc / 1 A to the main camera. Otherwise the pin-outs are the same for the
two data ports.
D 13887.09
APRIL 2009 36
Interfaces and Sockets – Codec 6000 MXP
Power Socket & On/Off Switch TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Power switch
D 13887.09
APRIL 2009 37
About the TANDBERG API
We recommend that you check out the The heart of the API is the TANDBERG API-Engine. This is
TANDBERG web site regularly for updated
versions of this manual: where all information is stored and processed. The API-
http://www.tandberg.com/docs engine can be accessed by an easy-to-use Command Line
Interface called XACLI using RS 232 or Telnet, or by the
TANDBERG XML API Service (TXAS) over HTTP/HTTPS.
Both alternatives are described in detail in this section of
the User Guide.
About the TANDBERG API
Introduction TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
The heart of the API is the TANDBERG The TANDBERG API-Engine is optimized for easy, yet advanced, machine- A command is usually followed by a set of parameters to specify how the given
API-Engine. This is where all information is machine interaction between a TANDBERG system and an external control action is to be executed.
stored and processed. The API-engine can application.
be accessed by an easy-to-use Command (RW) Read-Write information. This is Configuration Information defining sys-
Line Interface called XACLI using RS 232 The main features can be summarized to: tem settings. This information can both be supplied and read by the user/con-
or Telnet, or by the TANDBERG XML API • Structuring of information trol application. Typical examples include: default call rate, baud rate of a serial
Service (TXAS) over HTTP/HTTPS. • Addressing using XPath (XML Path Language) or TANDBERG SimplePath port, enabling/disabling of various features etc.
• Feedback All configuration information is structured in a hierarchy making up a database
of system settings. But for the Configuration information, the data in the data-
XACLI TXAS
Structuring of Information base can only be updated by the user/control application.
An application programming interface (API) can be seen as a gate where infor-
mation is exchanged between two systems – a control application and a target Addressing Using XPath or TANDBERG SimplePath
system. To address information in the hierarchic structure of Status and Configuration
RS 232 HTTP
Telnet HTTPS The control application transmits instructions to the target system, while the information, the TANDBERG systems support abbreviated XML Path Language
target system supplies information about how these instructions are executed, (XPath) and a proprietary notation called TANDBERG SimplePath (only available
in addition to other system related information. using XACLI).
API-Engine Consequently, the exchange of information can be divided into: This allows the user/control application to address everything from a single
element of data (for example the call rate of a specific call) to larger parts of the
1. Information flowing from target. This we call read information (R). The (R) hierarchy (for example all information available for a given call).
should not be confused with the (r) used to indicate required parameters in
the Commands tables.
Working with the API-engine is very similar 2. Information flowing to target. This we call write information (W). Feedback
to working with catalogues and files on a Feedback is an extremely powerful feature where the TANDBERG system
computer. All information is stored in a hi- actively returns updated status and configuration information to the user/
If we now look at the TANDBERG systems we can identify three main types of
erarchic tree structure which is accessible control application whenever changes occur.
information
from different interfaces.
• read information (R) The user/control application can specify what parts of the status and configura-
When accessing the API-engine using tion hierarchies it wants to monitor by using XPath. The user/control application
• write information (W)
XACLI (RS 232 or Telnet), the information can thereby limit the amount of information it receives from the target system to
• read-write information (RW)
is formatted in a proprietary Command Line only those parts being of interest for the given application. This will also reduce
style or in XML formatting. (R) Read information. This is Status Information about the system and system the load on the link connecting the systems.
When accessing the API-engine using the processes, i.e. information generated by the system. Feedback is supported on both XACLI (RS232/Telnet) and TXAS (HTTP/
TXAS interface (HTTP/HTTPS), XML/SOAP Typical examples include: status about ongoing calls, network status, confer- HTTPS) simultaneously.
formatting is supported. ence status etc. The system uses TANDBERG SimplePath when presenting configurations.
This is similar to viewing files on a compu- All status information is structured in a hierarchy, making up a database con- XPath and TANDBERG SimplePath are described more thoroughly later in this
ter; accessing catalogues on a Windows stantly being updated by the system to reflect process changes. section of the manual.
computer using the Command Prompt
gives a different view than using Windows (W) Write information. This is Command Information the user/control applica- The structuring of information together with XPath and TANDBERG SimplePath
Explorer, but the information is the same. tion supply to initiate an action. for addressing, makes up powerful features like searchability and setting of
Typical examples include: instructing the system to place a call, assigning floor multiple instances of a configuration.
NOTE! New features on the TANDBERG
MXP will be supported on XACLI only. to a specific site, disconnecting a call etc. Examples are provided overleaf.
D 13887.09
APRIL 2009 39
About the TANDBERG API
XACLI and the classic data port commands TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
The TANDBERG MXP also supports the RS 232/Telnet Da- Example showing Serial Port configurations of a TANDBERG Example: To address the BaudRate element of serial port 2:
taport Interface that was supported on the Classic systems. 6000 MXP codec, using the standard XACLI formatting for XPath
You may use any mixture of Classic Dataport commands and configurations:
Each level is separated with a slash (‘/’). Item numbers are
XACLI commands on the same RS232/Telnet session. A xconfiguration serialport added in brackets after the element name:
multitude of the commands overlaps, but XACLI offers more
flexibillity and gives access to the latest features supported *c xConfiguration SerialPort 1 BaudRate: SerialPort[2]/BaudRate
by the system. 57600 Example
We recommend the use of XACLI commands whenever *c xConfiguration SerialPort 1 Parity: None xconfiguration serialport[2]/baudrate
you write new control system modules and whenever you add
new features into existing control modules, but there is no *c xConfiguration SerialPort 1 DataBits: 8 *c xConfiguration SerialPort 2 BaudRate: 9600
need to to rewrite already existing control modules based on *c xConfiguration SerialPort 1 StopBits: 1 OK
Classic commands.
The XACLI API is described in detail in this section of the User *c xConfiguration SerialPort 1 Mode: Control
Guide. The Classic Dataport Interface is described in the TANDBERG SimplePath
*c xConfiguration SerialPort 2 BaudRate: 9600
TANDBERG 770-8000MXP API (Dataport User Guide), which is Both levels and item numbers are separated with whitespac-
available separately. *c xConfiguration SerialPort 2 Parity: None es:
NOTE! New features on the TANDBERG MXP will be sup- *c xConfiguration SerialPort 2 DataBits: 8 SerialPort 2 BaudRate
ported on XACLI only. Example
*c xConfiguration SerialPort 2 StopBits: 1
Example: To configure the baudrate of serial port 1 to xconfiguration serialport 2 baudrate
9600: *c xConfiguration SerialPort 2 Mode: Auto
*c xConfiguration SerialPort 2 BaudRate: 9600
Classic Dataport: sport data1 9600 OK OK
XACLI: xconfiguration serialport 1 baudrate:
9600
D 13887.09
APRIL 2009 40
About the TANDBERG API
XACLI TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
XACLI can be accessed through Telnet via the LAN interface The pin outs for the RS 232 are defined in the tables to the
or through RS 232 by connecting a serial cable to the serial right. Observe that the DTE (Data Terminal Equipment), could Pin Signal name Direction
interface connector, referred to as the Dataport. Eight Telnet be a PC or any other device capable of serial communica- 1 Carrier detect, CD From DCE
sessions can be connected to the TANDBERG MXP simulta- tion.
2 Receive data, RXD From DCE
neously, in addition to the RS 232 connection. NOTE! A straight-through cable should be used between the
TANDBERG MXP’s RS 232 port and the DTE. 3 Transmit data, TXD To DCE
The lower table shows the recommended cable-wiring 4 Data terminal ready, DTR From DCE
scheme when connecting the TANDBERG MXP to a PC
5 Signal GND
through RS 232.
Connecting to XACLI using the Dataport (RS 232) 6 Data set ready, DSR From DCE
DTR and RTS are ignored. DSR, CD, and CTS are always as-
serted, while RI is not used. 7 Ready to send, RTS To DCE
8 Clear to send, CTS From DCE
The RS 232 port is a 9-pin, female, D-sub connector located
on the back of the TANDBERG MXP. The port is configured 9 Ring indicator, RI From DCE
as a DCE (Data Communications Equipment). The RS 232
port is default set to 9600 baud, 8 data bits, none parity
and 1 stop bit from factory. The RS 232 port is also referred
to as the Dataport.
D 13887.09
APRIL 2009 41
About the TANDBERG API
XACLI – the Basics TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
?
Root Commands - User Commands -
about dumph221 layout-keyboard prisearch
access duovideo localdn protect
By typing ? or help after connecting to the aim echoctrl los-duration rinfo
TANDBERG MXP using RS 232/Telnet, the alrtvol enable los-inhibit rnumber
system will list all supported root com- ansdelay encmode los-initial screensaver
mands. audioagc encrypt los-polarity selfview
audiofeature encstatus los-retry sendnum
All root commands prefixed with an x
audiofeedback eventlog maxcall services
belongs to the XACLI interface. These are
audioin extcam mcucommand snmp
shown in orange colour in the table to the audiolevel extcap mcudirectory spid
right. All other root commands belong to audiomix extname mculine spkr
the Classic Dataport Interface (described in audiomodule extswitch mcustat sport
a separate document). audioout fallback menupassword sstring
NOTE! Classic Dataport commands and autoans fecc mic statin
XACLI commands can be used side by side. automute feedback monstat statout
However, the use of XACLI commands is autopip feinfo msn still
recommended whenever writing new control beep fevidsrc multisite streaming
system modules and whenever adding new bondingtimer g703settings netclock strictpassword
features into existing control modules, but boot globdirectory netctrl sub
there is no need to rewrite existing code callstatus h239 netdtrpulse syslog
based on the Classic commands. camcenter h323alias netisdn systemname
cammove h323callmanager netpri telephony
Note! New features on the TANDBERG campos h323gatekeeper netprofile teltone
MXP will be supported on XACLI only. camsettings h323mtu netstat test
camsleepmode h323nat nettype traceroute
camtrack h323ports optionkey vgaout
chanstat h323prefix pardial vidfeature
chat h323qos ping vidin
custominfo h323rate pip vidname
defcall h323status pldownspeed vidtone
defvalues h331mode preset-activate vnc
delbox help preset-list vol
dial ifconfig preset-store websnapshots
directory ipaddress pressource xcommand
disable ipassignment pricable xconfiguration
disc ipconflictcheck pricrc4 xdirectory
dispbox iplr prihighch xevent
dispparam ippassword prilowch xfeedback
disptxt irctrl primaxchan xgetxml
dltxt isdntrace prinsf xhistory
donotdist key prinumber xpreferences
downspeed language prinumbrange xstatus
dualmon
OK
All root commands prefixed with an ‘x’ belong to the XACLI interface.
D 13887.09
APRIL 2009 42
About the TANDBERG API
XACLI – Main Types of Commands TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
About Main Types of Commands Configuration Type Commands Status Type Commands Command Type Commands
The XACLI is divided into three main types Commands defining system settings. Commands returning information about Commands instructing the system to per-
of commands (and a fourth – see below), Configuration-type commands are either the system and system processes, i.e. form an action. E.g. instructing the system
reflecting the information types supported supplied or read by the user. E.g. default information generated by the system. E.g. to place a call, assigning floor to a specific
by the TANDBERG API Engine. callrate, baudrate of a serial port, ena- status about ongoing calls, network status, site, disconnecting a call etc. A command
bling/disabling of various features etc. conference status etc. All status informa- is usually followed by a set of parameters
The main types are: tion is structured in a hierarchy, making up to specify how the given action is to be
All Configurations are structured in a
• Configuration-type commands hierarchy making up a database of system a database constantly being updated by executed.
• Status-type commands settings. the system to reflect system and process
• Command-type commands changes. Supported Command-type commands:
Supported Configuration-type commands: • xCommand
Supported Status-type commands:
• xConfiguration
• xStatus
• xDirector y
• xHistor y
• xEvent
Special Commands
In addition to the above sets of commands, xfeedback is a command used to specify xpreferences is used to set various prefer- xgetxml gives access to the exact same
XACLI supports the following set of special what parts of the configuration and status ences for the RS 232/Telnet sessions. Each information as the Main types of commands
commands: hierarchies to monitor. Feedback will only session can define preferences individually. (xstatus, xhistory, xconfiguration etc.), but
be issued on the RS 232/Telnet for which it IMPORTANT! This command has various returns the information XML formatted.
is specified. If connecting to the TANDBERG settings to define the formatting of the XACLI More on this can be found in xgetxml.
MXP with multiple RS 232/Telnet sessions, output. It is therefore important to define set-
each session can define feedback individu- tings to match the parser used on the control
ally. system. XACLI is designed to make parsing of
More on this can be found in xfeedback. data from the TANDBERG MXP very simple.
More on this can be found in xpreferences.
D 13887.09
APRIL 2009 43
About the TANDBERG API
XACLI – Configuration Type Commands TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
xconfiguration ?
About Configuration Type Commands
- User Configurations -
AdditionalCamera FTP PacketlossDownSpeed
All Configurations are organized in a hierarchic tree structure.
AlertSpeaker G703 PictureProgram [1..4]
To get an overview of accessible top-level configuration elements within a AlertTone H320 PresentationSoftkey
configuration-type command, type ? or help after the configuration-type com- AllowLatency H323 PresentationStart
mands (xconfiguration/xdirectory), as shown in the example to the right. Audio H323CallSetup Preset [1..15]
AutoAnswer H323Gatekeeper QoS
Tip! To list all supported configurations with corresponding valuespace: AutoDisplaySnapshot H323Prefix RemoteSwUpgrade
xConfiguration ?? AutoLayout HTTP Robotron
AutoPIP HTTPS RTP
Configurations consists of three parts: Bonding IdReport Screensaver
CallManager IEEE802.1x Security
1. A Configuration-type command (xConfiguration or xDirectory) CallVideoSource IMUX SecurityLog
2. A Configuration path (address-expression) Camera [1..13] Integrator SelfViewOnStartup
3. A Configuration value CameraDVI IP SerialPort [1..2]
CameraReverseControl IPMedia SIP
CameraSleep IPProtocol SNMP
Configuration-type command Configuration value CameraSwUpgrade IRControl SSH
CameraTracking ISDN StartupVideoSource
xConfiguration H323Gatekeeper Discovery: Manual Conference KeepDuoOpen StillImageSource
CorporateDirectory Key Streaming
Configuration path DefaultPIPPosition Keyboard StrictPassword
Directory Kiosk Switch
DoNotDisturb LocalLayout SystemUnit
DualMonitor Logo T1
DuoVideoSource LoS Telnet
DynamicResolution MainVideoSource TelnetChallenge
E1 MaxBandwidth ThreePartyLayout
Ethernet Multipoint Time
ExternalManager NAT TURN
ExternalNetwork NetProfile [1..7] UseAsLocalPCMonitor
ExternalServices NTP Video
FECC OptionKey VNC
FeedbackFilter OSD
OK
xdirectory ?
- Directory -
GlobalEntry [1..400] LocalEntry [1..200]
GroupEntry [1..50]
OK
D 13887.09
APRIL 2009 44
About the TANDBERG API
XACLI – Configuration Type Operation TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Three operations can be performed on To get help on configurations, type ? after the configuration path To read configurations from the system just type the root command
configurations: (address expression): (xConfiguration/xDirectory) followed by the path (address
• Configuration Help <configuration-type command> <address expression> ? expression):
• Configuration Read <configuration-type command> <address expression>
• Configuration Set (Write) Example:
xconfiguration h323gatekeeper discovery ? Example:
*h xConfiguration H323Gatekeeper Discovery: <Manual/Auto> xconfiguration h323gatekeeper discovery
OK *c xConfiguration H323Gatekeeper Discovery: Manual
OK
D 13887.09
APRIL 2009 45
About the TANDBERG API
XACLI – Configuration Types TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Integer values:<x..y>
The system supports the following value
Defines the valid range for an integer input. x = min value, y = max value.
types:
<1..100>
• Integer values
• Literal values Literal values: <X/Y/../Z>
• String values Defines the possible values for a given configuration.
• E164 string values (strings only contain- <On/Off/Auto>
ing digits, ‘#’ and ‘*’)
• IPv4 Address values 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.
• IPv6 Address values
<S: 0, 49>
• IPv4 or IPv6 Address values
IPv4 Address values: <IPAddr>
Defines that the input must be an IPv4 address.
<IPAddr>
D 13887.09
APRIL 2009 46
About the TANDBERG API
XACLI – Command-type Commands – xcommands/xdirectory TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
To get an overview of the supported command-type commands, type ? or help after the com- xcommand ?
mand-type command (xcommand) .
Tip! To list all supported configurations with corresponding valuespace: - User Commands -
xcommand ?? AlertToneTest DefaultValueSet LocalEntryAdd
AudioTestSignal Dial LocalEntryDelete
Boot DialGlobalEntry MessageBoxDelete
CallAccept DialGroupEntry MessageBoxDisplay
CallHold DialLocalEntry PIPHide
Command help CallJoin DisconnectCall PIPShow
CallMute DTMFSend PresenceForce
CallMuteOutgoing DuoVideoStart PresetActivate
To get help on a specific command, type the command-type command (xcommand) – then a CallResume DuoVideoStop PresetClear
command name followed by ? or help: CallSetAudioTP FECCFocus PresetStore
<command-type command> <command name> ? CallTransfer FECCMove ProfileActivate
CameraFocus FECCPresetActivate ProfileCreate
Example: CameraForceUpgrade FECCPresetStore ProfileDelete
xcommand dial ? CameraHalt FECCRequestStill ProfileList
CameraMove FECCSelectSource ScreensaverActivate
*h xCommand Dial CameraPosition FeedbackDeregister ScreensaverDeactivate
Number: <S: 0, 60>
CameraReConfigure FeedbackRegister ScreensaverReset
SecondNumber: <S: 0, 60>
CameraTrackingStart FIPSMode SiteDisconnect
SubAddress: <S: 0, 20>
CallRate: <Tlph/1xh221/2xh221/64/128/…/4096/Max/Auto> CameraTrackingStop FloorRelease SiteView
Restrict: <On/Off> CameraUpgrade FloorRequest SiteViewEnd
NetProfile: <1..7> CameraWhitebalance FloorToSite SPIDAutoConfigure
BillingCode: <S: 0, 16> ChairRelease FloorToSiteEnd SStringSend
ChairTake GroupAddEntry StillImageSend
NOTE! Required parameters are identified by an (r) behind the parameter name. ConferenceDisconnect GroupEntryDelete StreamingStart
ConferenceMoveToMCU KeyDisable StreamingStop
Example:
ConferenceTerminate KeyDown TextDelete
xcommand cameramove ?
CorpDirGetNext KeyEnable TextDisplay
CorpDirGetPrevious KeyPress VirtualMonitorReset
*h xCommand CameraMove
Camera(r): <1..4> CorpDirSearch KeyRelease VirtualMonitorSet
Direction(r): <Up/Down/Right/Left/In/Out>
OK
OK
D 13887.09
APRIL 2009 47
About the TANDBERG API
XACLI – Command-type Commands – Issuing a Command TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
A command must start with the command-type command (xcommand), followed by a command name, followed When issuing a command, the system will return a set of return values. The
by a set of parameters. Parameters values are identified by specifying the parameter name followed by a ‘:’ response will by default be on the same format as the standard XACLI Status
<command-type command> <command name> <parameter:value> <parameter:value>... format. The other supported status formats (completepath/XML) are also
supported – ref. xpreferences.
Example: Example
xcommand dial 558458
xcommand dial number:558458 restrict:on callrate:128 subaddress:10
*r Result (status=OK):
CallRef: 1
If there are multiple instances of a parameter, the item number is added after the tag separated with a dot: LogTag: 6
<command-type command> <command> <parameter.item:value> <parameter.item:value>... *r/end
OK
Example: If complete path is enabled for the RS-232/Telnet session
xcommand groupentryadd name:TANDBERG localentryid.1:15 localentryid.2:57 (“xpreferences completepath on”):
Example
xcom dial 558458
*r Result (status=OK):
*r Result CallRef: 1
Sequence Notation (Optional) *r Result LogTag: 4
OK
D 13887.09
APRIL 2009 48
About the TANDBERG API
XACLI – Command-type Commands – Parameter Value Types TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
<S: 0, 49>
<IPAddr>
<IPv6Addr: 0, 43>
D 13887.09
APRIL 2009 49
About the TANDBERG API
XACLI – Status Type Commands TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 50
About the TANDBERG API
XACLI – Status Type Commands – Default Formatting TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 51
About the TANDBERG API
XACLI – Status Type Commands – Complete Path Formatting TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Example
About Status Type Commands Formatting
xpreferences completepath on
XACLI supports three different formattings for status
information: OK
xstatus call 1
• Default XACLI formatting, provides good human
readability, compact format. However, a custom parser
*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing, logTag=2):
must be used
*s Call 1 CallRate: 768
• Complete Path formatting. Recommended when parsing *s Call 1 RemoteNumber: “558458”
the information line by line. *s Call 1 Mute: Off
• XML formatting – to be used when using an XML-parser. *s Call 1 Microphone: Off
*s Call 1 Duration: 527
*s Call 1 MuteOutgoing: Off
*s Call 1 Channels 1 (type=Incoming):
*s Call 1 Channels 1 Rate: 768
*s Call 1 Channels 1 Restrict: Off
About Complete Path formatting
*s Call 1 Channels 1 Encryption (status=Off): /
*s Call 1 Channels 1 Audio (status=Active):
*s Call 1 Channels 1 Audio Protocol: G722
The following should be observed: *s Call 1 Channels 1 Audio Rate: 64
*s Call 1 Channels 1 Video 1 (status=Active):
• Complete Path formatting is recommended for easy *s Call 1 Channels 1 Video 1 Protocol: H264
parsing *s Call 1 Channels 1 Video 1 Resolution: CIF
• All lines are prefixed with *s (for status), *e (for event), *s Call 1 Channels 1 Video 1 Rate: 704
or *l (for historylog) *s Call 1 Channels 1 Video 2 (status=Inactive): /
• The complete path to an element is supplied on all lines *s Call 1 Channels 1 Data (status=Inactive): /
*s Call 1 Channels 2 (type=Outgoing):
• The parser can work line by line *s Call 1 Channels 2 Rate: 768
• Root-element end is designated by a *s/end (*e/end or *s Call 1 Channels 2 Restrict: Off
*l/end respectively). *s Call 1 Channels 2 Encryption (status=Off): /
*s Call 1 Channels 2 Audio (status=Active):
NOTE! Complete Path formatting is enabled by: “xprefer- *s Call 1 Channels 2 Audio Protocol: G722
ences completepath on”, described later in this section of *s Call 1 Channels 2 Audio Rate: 64
the User Guide. *s Call 1 Channels 2 Video 1 (status=Active):
NOTE! the xpreferences is a session specific command and *s Call 1 Channels 2 Video 1 Protocol: H264
must be issued every time the control application connects *s Call 1 Channels 2 Video 1 Resolution: CIF
to the codec. *s Call 1 Channels 2 Video 1 Rate: 704
*s Call 1 Channels 2 Video 2 (status=Inactive): /
*s Call 1 Channels 2 Data (status=Inactive): /
*s/end
OK
D 13887.09
APRIL 2009 52
About the TANDBERG API
XACLI – Status Type Commands – XML Formatting TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Example
About Status Type Commands Formatting
xgetxml status/call[1]
<Status>
XACLI supports three different formattings for status <Call item=”1” status=”Synced” type=”Vtlph” protocol=”H323” direction=”Outgoing” logTag=”2”>
information: <CallRate item=”1”>768</CallRate>
<RemoteNumber item=”1”>558458</RemoteNumber>
• Default XACLI formatting, provides good human <Mute item=”1”>Off</Mute>
readability, compact format. However, a custom parser
<Microphone item=”1”>Off</Microphone>
must be used
<Duration item=”1”>887</Duration>
• Complete Path formatting. Recommended when parsing <MuteOutgoing item=”1”>Off</MuteOutgoing>
the information line by line. <Channels item=”1” type=”Incoming”>
• XML formatting – to be used when using an XML-parser. <Rate item=”1”>768</Rate>
<Restrict item=”1”>Off</Restrict>
<Encryption item=”1” status=”Off”/>
<Audio item=”1” status=”Active”>
<Protocol item=”1”>G722</Protocol>
<Rate item=”1”>64</Rate>
About XML Formatting
</Audio>
<Video item=”1” status=”Active”>
<Protocol item=”1”>H264</Protocol>
The following should be observed: <Resolution item=”1”>CIF</Resolution>
<Rate item=”1”>704</Rate>
• To be used when the control application is using an XML </Video>
parser
<Video item=”2” status=”Inactive”/>
• XML formatting is used when polling for information using <Data item=”1” status=”Inactive”/>
the special command xgetxml, described later in this sec- </Channels>
tion of the manual. <Channels item=”2” type=”Outgoing”>
• To enable XML formatting on feedback issued from the <Rate item=”1”>768</Rate>
codec, the special command xpreferences should be <Restrict item=”1”>Off</Restrict>
used. <Encryption item=”1” status=”Off”/>
<Audio item=”1” status=”Active”>
<Protocol item=”1”>G722</Protocol>
<Rate item=”1”>64</Rate>
</Audio>
<Video item=”1” status=”Active”>
<Protocol item=”1”>H264</Protocol>
<Resolution item=”1”>CIF</Resolution>
<Rate item=”1”>704</Rate>
</Video>
<Video item=”2” status=”Inactive”/>
<Data item=”1” status=”Inactive”/>
</Channels>
</Call>
</Status>
OK
D 13887.09
APRIL 2009 53
About the TANDBERG API
XACLI – Status Type Commands – Addressing Status Information TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
About Addressing Status Information Example 1 a) Addressing status information, user wants to know callrate of call 1:
xstatus call 1 callrate
*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing, logTag=3):
CallRate: 768
You address status information by supplying a status-type *s/end
command followed by an address-expression (XPath or
OK
TANDBERG SimplePath):
<status-type command> <address expression>
See example 1 a) for an illustration.
Example 1 b) xpreferences completepath set to on:
If complete path is enabled for the RS 232/Telnet session xstatus call 1 callrate
(xpreferences completepath on), it will look like
example 1 b). *s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing, logTag=3):
As a second set of examples let us consider a situation *s Call 1 CallRate: 768
where the user wants to know Audio status for both incoming
OK
and outgoing channels for Call 1. This is shown in examples
2 a) and 2 b).
Example 2 a) the user wants to know Audio status for both incoming and outgoing channels for Call 1.
xstatus call 1 channels audio
*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing, logTag=3):
Channels 1 (type=Incoming):
Audio (status=Active):
Protocol: G722
Rate: 64
Channels 2 (type=Outgoing):
Audio (status=Active):
Protocol: G722
Rate: 64
*s/end
OK
D 13887.09
APRIL 2009 54
About the TANDBERG API
XACLI – Status Type Commands – Exposure Options TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
About Exposure Options Request for Call 1 element with no exposure option
xstatus call 1
OK
Request for Call 1 element with exposure option --:
xstatus call 1 --
OK
D 13887.09
APRIL 2009 55
About the TANDBERG API
XACLI – Special Commands – xfeedback (I) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 56
About the TANDBERG API
XACLI – Special Commands – xfeedback (II) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Example. User wants to know when calls are connected Note! If sub-elements are removed from a status structure between transitions, the removed elements will be notified with an attribute
and when calls are disconnected, without monitoring any ghost=True when feedback is issued. This allows for an external control system to be completely synchronised with the codec.
call data changes when the call is active:
This can be done by registering feedback on the events:
• CallSuccessful Example. This example shows status for a call that is beeing Rate: 64
• CallDisconnected disconnected. The user has registered a feedback expression to Video 1 (status=Active):
monitor all call changes (xfeedback register status/call). Protocol: H264
When the call is active the Call element contains a large sub-struc- Resolution: CIF
xfeedback register event/callsuccessful Rate: 704
ture. When the call is disconnected this status tree collapses, i.e.
OK the only information availible for a disconnected call is a Cause Video 2 (status=Inactive): /
xfeedback register event/calldisconnected element. All sub-elements that are being removed in this transition Data (status=Inactive): /
OK are marked with a ghost=True attribute when feedback is issued, *s/end
xcommand dial number:558458 see below. OK
*r Result (status=OK): xstatus call 1 xcommand disconnect
CallRef: 1 *s Call 1 (status=Synced, type=Vtlph, *r Result (status=OK): /
LogTag: 8 protocol=H323, direction=Outgoing, logTag=30): *r/end
*r/end CallRate: 768 OK
RemoteNumber: “558458”
OK *s Call 1 (status=ClearOut, type=Vtlph,
Mute: Off
CONNECT protocol=H323, direction=Outgoing, logTag=30):
Microphone: Off
*e CallSuccessful: *s/end
Duration: 62
CallRef: 1 NO CARRIER
MuteOutgoing: Off
LogTag: 8 Channels 1 (type=Incoming):
Protocol: H323 *s Call 1 (status=Disconnected, type=NA,
Rate: 768
Direction: Outgoing protocol=NA, direction=NA, logTag=NA):
Restrict: Off
Cause: 16
CallRate: 768 Encryption (status=On):
RemoteNumber: “558458” CallRate (ghost=True): /
Type: AES-128
Encryption: RemoteNumber (ghost=True): /
CheckCode: “C6D478F231E09A04”
Incoming: Off Mute (ghost=True): /
Audio (status=Active):
Microphone (ghost=True): /
Outgoing: Off Protocol: G722
Duration (ghost=True): /
*e/end Rate: 64
MuteOutgoing (ghost=True): /
Video 1 (status=Active):
Channels 1 (ghost=True): /
xcommand disconnectcall call:1 Protocol: H264
Channels 2 (ghost=True): /
*r Result (status=OK): / Resolution: CIF
*s/end
*r/end Rate: 704
Video 2 (status=Inactive): / xstatus call 1
OK Data (status=Inactive): / *s Call 1 (status=Disconnected, type=NA,
NO CARRIER Channels 2 (type=Outgoing): protocol=NA, direction=NA, logTag=NA):
Rate: 768 Cause: 16
*e CallDisconnected: Restrict: Off *s/end
CallRef: 1 Encryption (status=On): OK
LogTag: 8 Type: AES-128
*e/end CheckCode: “C6D478F231E09A04”
Audio (status=Active):
Protocol: G722
D 13887.09
APRIL 2009 57
About the TANDBERG API
XACLI – Special Commands – xpreferences (I) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
A command of great importance, xpreferences lets the xpreferences xpathwrite <on/off> xpreferences detaillevel <1..2>
user/control application individually configure the Telnet/
Disables/enables the XPath search engine when issuing con- Most information elements accessible by the status-type
RS 232 session in use. When parsing data sent from the co-
figurations. When the XPath search engine is disabled, the commands are defined to be level 1 information. However
dec using a control system it is important to set preferences
user/control application must supply the complete path to there are some information elements defined to be level 2
to match the parser in use.
the configurations to be set (no “double slashes” allowed). information. When reading status information, only the infor-
The xpreferences is a session specific command, i.e. This will improve the performance of the system when issu- mation elements with a detail level equal to or less than the
different RS 232/Telnet sessions can define preferences ing many consecutive configurations. detaillevel defined for the interface will be listed.
individually. This also implies that the preferences must be
NOTE! It is always recommended to supply the complete The detaillevel is by default set to 1 when connecting to an
set each time the control application connects to the codec,
path for configurations to be set when issuing commands RS 232/Telnet session.
i.e. the control application should always set the necessary
from an external control application.
preferences when connecting to the system (or after system
reboot when using RS 232).
D 13887.09
APRIL 2009 58
About the TANDBERG API
XACLI – Special Commands – xpreferences (II) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
OK
xconfiguration serialport 1
*c xConfiguration SerialPort 1 BaudRate 1: 9600
*c xConfiguration SerialPort 1 Parity 1: None
*c xConfiguration SerialPort 1 DataBits 1: 8
*c xConfiguration SerialPort 1 StopBits 1: 1
*c xConfiguration SerialPort 1 Mode 1: Control
OK
D 13887.09
APRIL 2009 59
About the TANDBERG API
XACLI – Special Commands – xpreferences (III) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
xpreferences completepath
Example. Reading status for Call 1 with xpreferences completepath on: Example. Reading status for Call 1 with xpreferences completepath off:
xstatus call 1 xstatus call 1
*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing, logTag=2): *s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing, logTag=2):
*s Call 1 CallRate: 768 CallRate: 768
*s Call 1 RemoteNumber: “558458” RemoteNumber: “558458”
*s Call 1 Mute: Off Mute: Off
*s Call 1 Microphone: Off Microphone: Off
*s Call 1 Duration: 527 Duration: 10
*s Call 1 MuteOutgoing: Off MuteOutgoing: Off
*s Call 1 Channels 1 (type=Incoming): Channels 1 (type=Incoming):
*s Call 1 Channels 1 Rate: 768 Rate: 768
*s Call 1 Channels 1 Restrict: Off Restrict: Off
*s Call 1 Channels 1 Encryption (status=Off): / Encryption (status=Off): /
*s Call 1 Channels 1 Audio (status=Active): Audio (status=Active):
*s Call 1 Channels 1 Audio Protocol: G722 Protocol: G722
*s Call 1 Channels 1 Audio Rate: 64 Rate: 64
*s Call 1 Channels 1 Video 1 (status=Active): Video 1 (status=Active):
*s Call 1 Channels 1 Video 1 Protocol: H264 Protocol: H264
*s Call 1 Channels 1 Video 1 Resolution: CIF Resolution: CIF
*s Call 1 Channels 1 Video 1 Rate: 704 Rate: 704
*s Call 1 Channels 1 Video 2 (status=Inactive): / Video 2 (status=Inactive): /
*s Call 1 Channels 1 Data (status=Inactive): / Data (status=Inactive): /
*s Call 1 Channels 2 (type=Outgoing): Channels 2 (type=Outgoing):
*s Call 1 Channels 2 Rate: 768 Rate: 768
*s Call 1 Channels 2 Restrict: Off Restrict: Off
*s Call 1 Channels 2 Encryption (status=Off): / Encryption (status=Off): /
*s Call 1 Channels 2 Audio (status=Active): Audio (status=Active):
*s Call 1 Channels 2 Audio Protocol: G722 Protocol: G722
*s Call 1 Channels 2 Audio Rate: 64 Rate: 64
*s Call 1 Channels 2 Video 1 (status=Active): Video 1 (status=Active):
*s Call 1 Channels 2 Video 1 Protocol: H264 Protocol: H264
*s Call 1 Channels 2 Video 1 Resolution: CIF Resolution: CIF
*s Call 1 Channels 2 Video 1 Rate: 704 Rate: 704
*s Call 1 Channels 2 Video 2 (status=Inactive): / Video 2 (status=Inactive): /
*s Call 1 Channels 2 Data (status=Inactive): / Data (status=Inactive): /
*s/end *s/end
OK OK
D 13887.09
APRIL 2009 60
About the TANDBERG API
XACLI – Special Commands – xgetxml TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Example
About xgetxml
xgetxml status/ip
As an alternative to the XACLI output format, XML format is
supported through the root command xgetxml. The xgetxml <Status>
takes an XPath expression as parameter and the elements <IP item=”1”>
(or complete document) matching the expression will be <Address item=”1”>10.47.11.179</Address>
returned. <SubnetMask item=”1”>255.255.248.0</SubnetMask>
<Gateway item=”1”>10.47.8.1</Gateway>
<V6 item=”1”>
<Address item=”1” type=”NA”></Address>
<Address item=”2” type=”NA”></Address>
</V6>
<DNS item=”1”>
<Server item=”1”>
<Address item=”1”>10.0.0.10</Address>
</Server>
<Server item=”2”>
<Address item=”1”>10.0.0.2</Address>
</Server>
<Server item=”3”>
<Address item=”1”></Address>
</Server>
<Server item=”4”>
<Address item=”1”></Address>
</Server>
<Server item=”5”>
<Address item=”1”></Address>
</Server>
<Domain item=”1”>
<Name item=”1”>eu.tandberg.int</Name>
</Domain>
</DNS>
</IP>
</Status>
OK
D 13887.09
APRIL 2009 61
About the TANDBERG API
TXAS - TANDBERG XML API Service TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
TXAS is a service provided by TANDBERG units for transmit- The bare-bone HTTP mode uses a unique URL to identify the specific request. The contents of
ting and receiving (transceiving) information encoded in XML the HTTP body will be a XML document (or part of it).
format. Bare-bone HTTP(S) access is accomplished by passing arguments in the query string (after
The API uses HTTP(S) as the transport mechanism and con- ‘?’ in URL) in a GET request, or using the “application/x-www-form-urlencoded” content-type
nects to the normal web port (80). TXAS can be accessed method of POSTing form data (Each argument starts with a name ‘=’ and a value, and every
in two ways; bare-bone HTTP requests where URL’s uniquely parameter separated with ‘&’ (and opt NL).)
identifies the request, and SOAP where a single URI is used getxml
but the request itself is encoded with XML. REQUEST:
/getxml
PARAM:
location = XPath expression
/getxml request returns an XML document based on the 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 re-
turned.
formputxml
REQUEST:
/formputxml
PARAM:
xmldoc = “an XML document of Configuration, Directory or Command”
This is most useful in a POST (to extend character limit of 255 of GET urls). It posts a Configu-
ration or Command document to set the configurations or issue a command.
Like getxml, it has the data URL form-data encoded with one single parameter. The Content-
Type of the document must be of type “application/x-www-form-urlencoded” and the body must
be encoded accordingly (e.g. first line will be xmldoc=<then the document>).
putxml
REQUEST:
/putxml
PARAM:
HTTP BODY as argument
Putxml is like formputxml+, put uses the complete BODY as argument (i.e. the content of
the xmldoc parameter). The Content-type should be “text/xml” or “application/xml” (
or “text/plain”), though no check at the moment. (Except for application/x-www-form-url
encoded which will cause a failure).
D 13887.09
APRIL 2009 62
Configuration-type Commands
We recommend that you check out the This part of the manual describes the Configuration
TANDBERG web site regularly for updated
versions of this manual: information available.
http://www.tandberg.com/docs There are two types of configuration-type commands
available:
• xconfiguration / configuration.xml
• xdirectory / directory.xml
Both types are covered in this section.
Configuration-type Commands
Understanding the Table Layout TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Description
Configuration-type Commands – xconfiguration / configuration.xml
AdditionalCamera — Audio TANDBERG 3000 MXP & 6000 MXP
REFERENCE USER GUIDE FOR SYSTEM INTEGRATORS
Configuration path
AdditionalCamera Type: <0..4>
This configuration enables improved support for some non-TANDBERG cameras. When using one of the cameras listed below, set the configuration accordingly. Software version
F5 offers camera type autodetection. Should, however, the camera you use fail to to be detected properly, you may use this command to select the camera type that best resem-
bles the camera used.
0 = TANDBERG Wave 2 (default)
1 = Sony EVI-D30
2 = Sony BRC-300
3 = Sony EVI-D100
4 = Sony EVI-D70
5 = Sony BRC-H700
6 = Sony EVI-HD1
ExAMplE: If using a Sony EVI-D30: xconfiguration additionalcamera type: 1
Allowlatency: <On/Off>
If set to Off (default), the IP call rate will sometimes exceed the maximum callrate specified for the call to reduce latency.
In some cases with poor network quality this might however result in increased packet loss. To avoid this, AllowLatency should be set to On.
Example: xConfiguration AllowLatency: On
D 13887.06
NOVEMBER 2007 65
Tip! An exhaustive
description of the API
structure can be found Contents of this
in the section column is sorted
The TANDBERG API alphabetically
D 13887.09
APRIL 2009 64
Configuration-type Commands – xconfiguration / configuration.xml
AdditionalCamera — Audio TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
AllowLatency: <On/Off>
If set to Off (default), the IP call rate will sometimes exceed the maximum call rate specified for the call to reduce latency.
In some cases with poor network quality this might however result in increased packet loss. To avoid this, AllowLatency should be set to On.
Example: xconfiguration AllowLatency: On
D 13887.09
APRIL 2009 65
Configuration-type Commands – xconfiguration / configuration.xml
Audio cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 66
Configuration-type Commands – xconfiguration / configuration.xml
Audio cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Stereo Settings Output Response Codec 3000 MXP Output Response Codec 6000 MXP
Audio Stereo: <On/Off>
Turns stereo I/O mode On or Off. Out 1 Stereo Stereo Audio Out 1 Audio Out 2 Audio Out 1 Audio Out 2 Audio
mode I/O mode speakers Out 3
Example: xconfiguration audio stereo: on
Analogue Off Off Loudspeaker mono VCR Loudspeaker mono Aux VCR
Out 1 mode is controlled through the xconfiguration audio outputs line type command (overleaf)
Audio Inputs Microphone [1..x] Level: <1..16> By default, all inputs are
6000 MXP: x=3 Defines the input levels for the different microphones. enabled. Just plug in an audio
3000 MXP: x=2 Example: xconfiguration audio inputs microphone 2 level: 10 source and it is active. Audio
inputs that are On will auto-
Audio Inputs Microphone [1..x] Mode: <On/Off> matically be mixed. Unconnected
6000 MXP: x=3 Turns On or Off the different microphone inputs. inputs will automatically be
3000 MXP: x=2 Example: xconfiguration audio inputs microphone 2 mode: off muted. Select Off to prevent
Turns microphone 2 off. audio/noise from connected but
unused inputs.
Audio Inputs Microphone [1..x] Mode: <Line> The microphone inputs are
6000 MXP: x=3 Note! Applies to 6000 MXP only! Here the Microphone 3 Mode can be set to Line. It then intended for electret type micro-
3000 MXP: x=2 becomes a balanced line level input. The gain will be reduced accordingly. phones. The microphone inputs
Example: xconfiguration audio inputs microphone 3 mode: line are balanced with 24 V phantom
Sets microphone input 3 on a 6000 MXP to a balanced line level input. power.
D 13887.09
APRIL 2009 67
Configuration-type Commands – xconfiguration / configuration.xml
Audio cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 68
Configuration-type Commands – xconfiguration / configuration.xml
Audio cont... — AutoAnswer TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 69
Configuration-type Commands – xconfiguration / configuration.xml
AutoPIP — CallVideoSource TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
AutoDisplaySnapshot: <On/Off>
If set to On the system will automatically display snapshots (still images) when received from the other side.
Example: xconfiguration autodisplaysnapshot: on
CallVideoSource: <0/1/5/6>
The Call Video Source is the default call video source you would prefer to use in a call..
Example: xconfiguration callvideosource: 0
D 13887.09
APRIL 2009 70
Configuration-type Commands – xconfiguration / configuration.xml
Camera [1..13] TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 71
Configuration-type Commands – xconfiguration / configuration.xml
Camera[1..13] cont.. — CameraSleep TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
The Auto mode, which is the default, will detect if you connect two PrecisionHD cameras, where one is first and the other is last in the chain. If that’s the case, control of the 2nd
PrecisionHD camera is automatic when the PC Input is selected.
If you have any other type of camera with a VGA/DVI/HDMI output, you must put it last in the chain, and manually turn this configuration. When you select the PC Input, you will
gain control of the last camera. This configuration may be useful when using the VGA output on a Sony BRC-H700 camera.
Important: If you set this configuration to on with a single PrecisionHD camera connected, the system will assume that it is connected to the PC Input and avoid configuring
the THSI interface. This may or may not be what you intended.
When set to Off the system assumes all cameras are connected to the normal video inputs, and/or THSI. May be useful if you connect a 2nd PrecisionHD camera to the codec
via an HDMI to s-video/composite converter.
Important: Changing any of these options may require a hard boot of connected PrecisionHD cameras and a soft boot of the codec. If you experience problems, like no video
or get the message “unsupported video format”, make sure that all connected PrecisionHD cameras are turned off, reboot the codec, and turn cameras back on.
D 13887.09
APRIL 2009 72
Configuration-type Commands – xconfiguration / configuration.xml
CameraSwUpgrade — Conference TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
CameraSwUpgrade: <Auto/Off>
If set to Auto the Camera software will be automatically upgraded by the codec. If set to Off, camera software upgrade must be initiated manually by the command CameraForceUpgrade.
NOTE! If codec software is downgraded the camera software must be downgraded manually by the command CameraForceUpgrade. Applies to TANDBERG Precision HD camera only!
Example: xconfiguration cameraswupgrade: Auto
CameraReverseControl: <On/Off>
Set to On to enable the reverse camera control, allowing the local camera to more naturally mimic the directional arrows of the remote control. The setting does not affect the camera sleep pan.
Set to Off to disable the camera reverse control
Example: xconfiguration camerareversecontrol: off
Conference H323Alias E164: <E164: 0, 30> The aliases define the tele-
Defines the E164 alias for the system. Valid characters are 0-9, and #.
Example: xconfiguration conference h323alias e164: 666666
* phone numbers for the unit, i.e.
numbers to call to reach the
unit. The system can register
Conference H323Alias ID: <S: 0, 49> both an E164 alias, which can
Defines the H323Alias ID for the system. If no ID is specified the system will use the SystemUnit Name as
#) and an ID, which can also
*
only contain digits (including ,
H323Alias ID.
Example: xconfiguration conference h323alias id: MyH323AliasId contain letters.
D 13887.09
APRIL 2009 73
Configuration-type Commands – xconfiguration / configuration.xml
Conference cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 74
Configuration-type Commands – xconfiguration / configuration.xml
Conference cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 75
Configuration-type Commands – xconfiguration / configuration.xml
Conference cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 76
Configuration-type Commands – xconfiguration / configuration.xml
Conference cont... — CorporateDirectory TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 77
Configuration-type Commands – xconfiguration / configuration.xml
CorporateDirectory cont... — DynamicResolution TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
DefaultPIPPosition: <BottomLeft/BottomRight/TopLeft/TopRight>
Specifies the default positioning of the PIP (Picture In Picture).
Example: xconfiguration defaultpipposition: bottomleft
DuoVideoSource: <0/1/2/3/4/5/6>
Defines which video input to be used as the default Dual Stream source. Note! 0 means None
Example: xconfiguration duovideosource: 1
D 13887.09
APRIL 2009 78
Configuration-type Commands – xconfiguration / configuration.xml
E1 — ExternalNetwork TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
ExternalManager Address: <S: 0, 64> If an External Manager address and a path is config-
Specifies the address to the External Manager/Management system. ured, the system will post an HTTP message to this
Example: xconfiguration externalmanager address: “10.47.6.75” address when starting up. When receiving this HTTP
posting the External Manager (typically a management
ExternalManager Path: <S: 0, 255> system) can return configurations/commands to the
Specifies the path to the External Manager/Management system. unit as a result.
Example: xconfiguration externalmanager path: tms/public/external/management/SystemMan- If the DHCP Option 242 is returned in the DHCP re-
agementService.asmx sponse from the DHCP server the system will interpret
this as the External Manager address to use.
D 13887.09
APRIL 2009 79
Configuration-type Commands – xconfiguration / configuration.xml
ExternalNetwork cont... — G703 TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
FeedbackFilter Conference: <0..10> Only relevant if using feedback (xfeedback over RS-232/Telnet or feedback
Defines the Feedback filter (in seconds) for the Conference status element. over HTTP).
Example: xconfiguration feedbackfilter conference: 4 The feedback filter lets the user configure the maximum frequency between
feedback updates. That means if data changes very rapidly, the control application
FeedbackFilter Call: <0..10> will not receive feedback more frequent than every xth second. This will help reduc-
Defines the Feedback filter (in seconds) for the Call status element. ing the load on both the link and the control system, but some transition information
Example: xconfiguration feedbackfilter call: 2 might be lost.
D 13887.09
APRIL 2009 80
Configuration-type Commands – xconfiguration / configuration.xml
G703 cont... — H323CallSetup TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 81
Configuration-type Commands – xconfiguration / configuration.xml
H323Gatekeeper TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 82
Configuration-type Commands – xconfiguration / configuration.xml
H323Gatekeeper cont... — IdReport TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 83
Configuration-type Commands – xconfiguration / configuration.xml
IEEE802.1x — IMUX TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 84
Configuration-type Commands – xconfiguration / configuration.xml
IMUX cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 85
Configuration-type Commands – xconfiguration / configuration.xml
IMUX cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 86
Configuration-type Commands – xconfiguration / configuration.xml
IMUX cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 87
Configuration-type Commands – xconfiguration / configuration.xml
IMUX cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 88
Configuration-type Commands – xconfiguration / configuration.xml
IMUX cont... — IP TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
IPProtocol: <IPv4/IPv6/Both>
Defines what IP protocol to use. If set to Both the system will support both IPv4 and IPv6.
Example: xconfiguration ipprotocol: both
IP Assignment: <DHCP/Static>
Defines whether to use DHCP or Static IP assignment. NOTE! This configuration only applies to IPv4.
Example: xconfiguration ip assignment: dhcp
IP Address: <IPAddr>
Defines the IPv4 address to use. Only applicable if Static IP assignment is being used.
Example: xconfiguration ip address:
IP SubnetMask: <IPAddr>
Defines the subnet mask. Only applicable if Static IP assignment is being used.
Example: xconfiguration ip subnetmask:
IP Gateway: <IPAddr>
Defines the gateway address. Only applicable if Static IP assignment is being used.
Example: xconfiguration ip gateway:
D 13887.09
APRIL 2009 89
Configuration-type Commands – xconfiguration / configuration.xml
IP cont... — ISDN TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 90
Configuration-type Commands – xconfiguration / configuration.xml
ISDN cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 91
Configuration-type Commands – xconfiguration / configuration.xml
ISDN cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
ISDN PRI NSFTelephony Number: <0..31> Service profiles for Sprint (ref. 2):
Defines what Service Facility to use for telephony if the NSFTelephony Mode is set to On. NSF Service
Example: xconfiguration isdn pri nsftelephony number: 8 0 Reserved
1 Private
2 Inwatts
Service profiles for AT&T (ref.1): 3 Outwatts
4 FX
NSF Service 5 TieTrunk
0 Disable
1 SDN (including GSDN)
2 Toll Free Megacom (800) Service profiles for MCI (ref. 3):
NSF Service
3 Megacom 1 VNET/Vision
6 ACCUNET Switched Digital Service (including Switched Digital International) 2 800
7 Long Distance Service (including AT&T World Connect) 3 PRISM1, PRISMII, WATS
8 International Toll Free Service (I800) 4 900
16 AT&T MultiQuest 5 DAL
23 Call Redirection Service
D 13887.09
APRIL 2009 92
Configuration-type Commands – xconfiguration / configuration.xml
ISDN cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 93
Configuration-type Commands – xconfiguration / configuration.xml
ISDN cont... — Key TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
KeepDuoOpen <On/Off>
Keeps the dual channel open even when there is no presentation video source connected to the endpoint. Requires the optional Natural Presenter Package to be installed.
Example: xconfiguration keepduoopen: off
D 13887.09
APRIL 2009 94
Configuration-type Commands – xconfiguration / configuration.xml
Key cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 95
Configuration-type Commands – xconfiguration / configuration.xml
Key cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 96
Configuration-type Commands – xconfiguration / configuration.xml
Key cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 97
Configuration-type Commands – xconfiguration / configuration.xml
Key cont... — Kiosk TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 98
Configuration-type Commands – xconfiguration / configuration.xml
Kiosk cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 99
Configuration-type Commands – xconfiguration / configuration.xml
Kiosk cont... — LoS TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Logo: <On/Off>
If set to On the system will display a company logo will appear in the background of the welcome menu. NOTE! The TANDBERG logo will be displayed if no other company logo is uploaded.
Example: xconfiguration logo: on
LoS Duration Exponent: <10..30> The duration of the LoS-pulse can be calcu-
lated from:
Example: xconfiguration los duration exponent: 15
Offset + 2 Exponent
Duration =
LoS Duration Offset: <0..65534> bit rate
LoS configurations are relevant
Offset is specified in milliseconds
for systems with NET interface
Example: xconfiguration los duration offset: 100
(External Network) only.
D 13887.09
APRIL 2009 100
Configuration-type Commands – xconfiguration / configuration.xml
LoS cont... — Multipoint TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
MainVideoSource: <1/2/3/4/5/6>
Defines which video input to be used as the main video source.
Example: xconfiguration mainvideosource: 2
MaxBandwidth: <128..6144>
Limit max bandwidth usage for the system. Related to IPMedia MaxVideoTXRate, which only controls upstream bandwidth.
Example: xconfiguration maxbandwidth: 6144
D 13887.09
APRIL 2009 101
Configuration-type Commands – xconfiguration / configuration.xml
NAT — NTP TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 102
Configuration-type Commands – xconfiguration / configuration.xml
OptionKey — OSD TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 103
Configuration-type Commands – xconfiguration / configuration.xml
OSD cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 104
Configuration-type Commands – xconfiguration / configuration.xml
OSD cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 105
Configuration-type Commands – xconfiguration / configuration.xml
OSD cont... — PacketlossDownSpeed TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
PictureProgram [1..4] Window [1..6] Picture: <LocalMain/LocalDuo/Current/Previous/Duo/RemoteMain/RemoteDuo/JPEG/TandbergMonitor1/TandbergMoni- The Picture Programs are used
tor2/None> to define custom picture layouts
Example: xconfiguration pictureprogram 1 window 2 picture: localmain to be displayed locally.
PresentationStart: <Manual/Auto>
If set to Auto, the Dual Stream is started automatically when a presentation is initiated from the menu or directly from the remote control
(requires that the system has Presenter option installed and the far end side also supports Dual Stream).
If set to Manual, the Dual Stream must be started manually.
Example: xconfiguration presentationstart: auto
D 13887.09
APRIL 2009 106
Configuration-type Commands – xconfiguration / configuration.xml
PresentationSoftKey — Preset [1..15] TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
PresentationSoftkey: <DuoScr/MainScr>
You can configure the Presentation key on the remote control to either select dual source or main source when in a call, Default is DuoSrc (dual source).
Example: xconfiguration presentationsoftkey: mainscr
D 13887.09
APRIL 2009 107
Configuration-type Commands – xconfiguration / configuration.xml
Preset [1..15] cont... — QoS TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 108
Configuration-type Commands – xconfiguration / configuration.xml
QoS cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 109
Configuration-type Commands – xconfiguration / configuration.xml
QoS cont... — ScreenSaver TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 110
Configuration-type Commands – xconfiguration / configuration.xml
SecurityLog — SelfViewOnStartup TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
• System Unit name • External Services Mode and Protocol • DNS Server [1..5] Address
• International Name Display Name • External Manager Protocol • VNC Password
• Option Keys, Feature Keys, Bandwidth • SNMP Community Name, System Contact, • Streaming Password
• IP Protocol System Location, Host IP Address • Remote Software Upgrade Password
• Telnet Challenge Port • H.323 Call Setup Mode • IEEE 802.1x Password
• Auto Answer Mode • H.323 Gatekeeper Discovery, Address, Au- • On Screen Display Menu Password
thentication Mode
• Far End Camera Control Mode • Serial Port Mode
• IP Assignment, IP Address, Subnet Mask,
• Strict Password Default Gateway, DNS Domain Name • Security Level
• Corporate Directory Protocol • IPv6 Address • Security Log
SelfViewOnStartup: <On/Off>
If set to On the system will display the local main video source on the main monitor when the system is started.
Example: xconfiguration selfviewonstartup: on
D 13887.09
APRIL 2009 111
Configuration-type Commands – xconfiguration / configuration.xml
SerialPort — SIP TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 112
Configuration-type Commands – xconfiguration / configuration.xml
SIP cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 113
Configuration-type Commands – xconfiguration / configuration.xml
SIP cont... — SNMP TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 114
Configuration-type Commands – xconfiguration / configuration.xml
SNMP cont... — SSH TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
StartupVideoSource: <0/1/2/3/4/5/6>
Defines the video source the system will use as default after a reboot, and after the system goes out from screen saver mode.
If set to 0, the system will use the video source that was selected before reboot.
Example: xconfiguration startupvideosource: 1
StillImageSource: <0/1/2/3/4/5/6>
Defines the default still image source. If set to 0, the system will use the current main video source as still image source.
Example: xconfiguration stillimagesource: 4
D 13887.09
APRIL 2009 115
Configuration-type Commands – xconfiguration / configuration.xml
Streaming TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 116
Configuration-type Commands – xconfiguration / configuration.xml
StrictPassword — SystemUnit TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
StrictPassword: <On/Off>
When enabled, strict password now requires the following restrictions to be met for all newly configured passwords on the system:
• Password cannot be the same as any of the previous 10 passwords used.
• Password must be 15 characters or more.
• Password must have at least 2 lower case letters, 2 upper case letters, 2 numeric characters and 2 special characters (e.g. #, *, &, %, etc).
• Three (3) consecutive characters cannot be the same..
Example: xconfiguration strictpassword: on
D 13887.09
APRIL 2009 117
Configuration-type Commands – xconfiguration / configuration.xml
SystemUnit cont... — Time TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
TelnetChallenge Mode: <On/Off> TelnetChallenge can be enabled on either ip port 23 or ip port 57.
Enables/disables TelnetChallenge. When connecting to an ip port that has telnetChallenge set to On, an MD5
Example: xconfiguration telnetchallenge mode: on encryption challenge string are being issued instead of a password prompt. An
encrypted password based on the challenge string must then be generated by
TelnetChallenge Port: <23/57> an MD5 encryptor and sent back to the system as a response in order to get
Specifies whether to port 23 or port 57 for TelnetChallenge. access to the system.
Example: xconfiguration telnetchallenge port: 57 NOTE! Regular Telnet are using ip port 23. When TelnetChallenge is set to ip port
23, this will override regular Telnet.
D 13887.09
APRIL 2009 118
Configuration-type Commands – xconfiguration / configuration.xml
Time cont... — Video TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
ThreePartyLayout: <On/Off>
3 party layout on the multisite host utilizes the dual monitor setting of the system to display the two far-end sites on individual monitors. This feature is supported when the MultiSite Picture mode is set
to Auto split or 4Split, and the Dual Monitor setting is enabled. When a dual stream is started during the conference, the screen will return to a standard 4-split in order to display the dual stream on the
second monitor. Upon termination of the dual stream, the layout will return to the 3 party layout. NOTE! 3 Party Mode will not function if the MultiSite Picture mode is set to 5+1Split or VoiceSwitched.
Example: xconfiguration threepartylayout: on
UseAsLocalPCMonitor: <On/Off>
If the main monitor is used as a local PC display, UseAsLocalPCMonitor should be set to On. This will avoid transmitting the local PC image while the system is in a video conference.
Example: xconfiguration useaslocalpcmonitor: on
Video Inputs Source 5 HorizAdjust: <0..255> NOTE! Only Video Input Source 5
Gives you the possibility to adjust the placement of the PC image on screen. Much like the setting you find on a regular PC
screen.
Example: xconfiguration video inputs source 5 horizadjust: 0
D 13887.09
APRIL 2009 119
Configuration-type Commands – xconfiguration / configuration.xml
Video cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 120
Configuration-type Commands – xconfiguration / configuration.xml
Video cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 121
Configuration-type Commands – xconfiguration / configuration.xml
Video cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 122
Configuration-type Commands – xconfiguration / configuration.xml
VNC cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 123
Configuration-type Commands – xdirectory / directory.xml
LocalEntry — GroupEntry TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 124
Configuration-type Commands – xdirectory / directory.xml
GlobalEntry TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 125
Configuration Storage Levels
We recommend that you check out the You may reset configuration settings to their default
TANDBERG web site regularly for updated
versions of this manual: values. Whether a specific configuration command will be
http://www.tandberg.com/docs affected by the reset command depends on two things;
which class(es) of configuration commands you want to
reset and which class the specific configuration command
belongs to.
Configuration Storage Levels
Understanding the Table Layout TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Configuration Commands
shown on this page.
level parameter 3, all Con- 1 PictureProgram [1..4] Window [1..6] Call: <1..11>
figuration commands will be 1 PictureProgram [1..4] Window [1..6] Picture: <LocalMain/LocalDuo/Current/Previous/Duo/RemoteMain/RemoteDuo/JPEG/ TandbergMonitor1/TandbergMonitor2/None>
D 13887.09
APRIL 2009 127
Configuration Storage Levels
AdditionalCamera — Audio MicrophoneMixer Mode TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 AllowLatency: <On/Off>
D 13887.09
APRIL 2009 128
Configuration Storage Levels
Audio Microphones Mode — Camera [1..13] WhiteBalance Level TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 AutoDisplaySnapshot: <On/Off>
D 13887.09
APRIL 2009 129
Configuration Storage Levels
Camera [1..13] WhiteBalance Mode — Conference H263 TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 CameraSwUpgrade: <Auto/Off>
D 13887.09
APRIL 2009 130
Configuration Storage Levels
Conference H264 — ExternalNetwork Clocking TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 DefaultPIPPosition: <BottomLeft/BottomRight/TopLeft/TopRight>
1 DuoVideoSource: <0/1/2/3/4/5/6>
D 13887.09
APRIL 2009 131
Configuration Storage Levels
ExternalNetwork DTRPulse — H323Prefix TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 132
Configuration Storage Levels
HTTP Mode — IPProtocol TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
3 IP Address: <IPAddr>
3 IP Assignment: <DHCP/Static>
2 IPDualstreamRate: <25Percent/50Percent/75Percent>
3 IP Gateway: <IPAddr>
3 IP SubnetMask: <IPAddr>
3 IPProtocol: <IPv4/IPv6/Both>
D 13887.09
APRIL 2009 133
Configuration Storage Levels
IRControl NumberKeyMode — ISDN PRI Interface Search TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 134
Configuration Storage Levels
ISDN PRI L2WindowSize — LocalLayout Toggle TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 135
Configuration Storage Levels
Logo — OptionKey Features TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 Logo: <On/Off>
1 MainVideoSource: <1/2/3/4/5/6>
D 13887.09
APRIL 2009 136
Configuration Storage Levels
OSD Icon BadNetwork — Preset [1..15] Camera Autofocus TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 PresentationStart: <Manual/Auto>
D 13887.09
APRIL 2009 137
Configuration Storage Levels
Preset [1..15] Camera Brightness — RemoteSwUpgrade Password TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 138
Configuration Storage Levels
RTP MTU — SSH Mode TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 SelfViewOnStartup: <On/Off>
D 13887.09
APRIL 2009 139
Configuration Storage Levels
StartupVideoSource — UseAsLocalPCMonitor TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
1 StartupVideoSource: <0/1/2/3/4/5/6>
1 StillImageSource: <0/1/2/3/4/5/6>
1 StrictPassword: <On/Off>
1 UseAsLocalPCMonitor: <On/Off>
D 13887.09
APRIL 2009 140
Configuration Storage Levels
Video Inputs Source [1..6] Name — VNC Password TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 141
Command Information Tables
We recommend that you check out the This part of the manual describes the Command
TANDBERG web site regularly for updated
versions of this manual: Information available.
http://www.tandberg.com/docs
Command Information
Understanding the Table Layout TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Command AlertToneTest Command used to Tone(r): <1..10> None Cause: <1…> xcommand alerttonetest tone:5
test the supported The tone to test. Cause code *r Result (status=OK):
alert tones. When the specifying why the *r/end
command is issued the command was not OK
Brief description of system will playback the accepted by the
what the command specified alert tone. system
Description:
is used to. Textual description
of the cause code.
Parameters used with this
Boot Command used to ParameterRestore: <On/Off> None As above. xcommand boot parameterrestore: on
command. If there is an (r) reboot the system. When rebooting the system after *r Result (status=OK):
*r/end
appearing, this indicates a software upgrade, all configurations
OK
will be restored.
required parameter (i.e. a
By setting ParameterRestore to Off,
parameter that always must the system configurations prior to
be specified. The (r) is not software upgrade will be lost.
to be written – it appears CallAccept Command used to None None As above xcommand callaccept If the command was not
for your information only. answer an incoming *r Result (status=OK): / executed succesfully,
call if autoanswer is *r/end
disabled. OK a description telling
why will be provided.
CallMute Command used to mute Call(r): <1..11> None As above xcommand callmute call:2 mode:on
incoming audio from a Reference to the call to be muted or *r Result (status=OK): Details are found in this
*r/end
specific call in a Multi-
Site conference.
unmuted.
OK
column.
Mode(r): <On/Off>
Denotes whether the call is to be
muted or unmuted.
If the command is
executed succesfully,
any result parameter
returned will be stated
here.
Required parameters are identified by an (r) behind the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.X3
AUGUST 2006
Tip! An exhaustive
description of the API
structure can be found
in the section
The TANDBERG API
D 13887.09
APRIL 2009 143
Command Information
AlertToneTest — AudioTestSignal TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
AlertToneTest Command used to Tone(r): <1..10> None Cause: <1…> xcommand alerttonetest tone:5
test the supported The tone to test. Cause code *r Result (status=OK):
alert tones. When the specifying why the *r/end
command is issued the command was not OK
system will playback the accepted by the
specified alert tone. system
Description:
Textual description
of the cause code.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 144
Command Information
Boot — CallMuteOutgoing TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Boot Command used to ParameterRestore: <On/Off> None As above. xcommand boot parameterrestore: on
reboot the system. When rebooting the system after *r Result (status=OK):
software upgrade, all configurations *r/end
will be restored. OK
CallMute Command used to mute Call(r): <1..11> None As above xcommand callmute call:2 mode:on
incoming audio from a Reference to the call to be muted or *r Result (status=OK):
specific call in a Multi- unmuted. *r/end
Site conference. OK
Mode(r): <On/Off>
Denotes whether the call is to be
muted or unmuted.
CallMuteOutgoing Command used to Call(r): <1..11> None As above xcommand callmuteoutgoing call:2 mode:on
mute outgoing audio Reference to the call to be muted or *r Result (status=OK):
to a specific call in a unmuted. *r/end
MultiSite conference. OK
Mode(r): <On/Off>
Typical user scenario
for this command is a Denotes whether the call is to be
three-part conference muted or unmuted.
where two of the
participants are from
the same company
discussing an issue with
a sub-contractor.
During the conference
the participants from
the same company want
to share some thoughts
in private before making
the final decision.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 145
Command Information
CameraFocus — CameraHalt TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
CallSetAudioTP Command used with Call(r): <1..11> None As above xcommand callsetaudiotp call:2 mode:on
TANDBERG Experia. *r Result (status=OK):
*r/end
Mode(r): <On/Off> OK
CameraFocus Command used to Camera(r): <1..13> None As above xcommand camerafocus camera:1 value:+
change focus of a spe- Addresses which camera to have its *r Result (status=OK):
cific camera. focus changed. *r/end
OK
Value(r): <Auto/Manual/+/->
Specifies the wanted operation.
CameraForceUpgrade Command used to Camera(r): <1..13> None As above xcommand cameraforceupgrade camera:1
initiate software *r Result (status=OK):
upgarde of the *r/end
TANDBERG Precision HD OK
Camera. Should only be
used after downgrade
of the TANDBERG
MXP Codec software
or if the configuration
CameraSwUpgrade is
set to Off. When the
TANDBERG MXP Codec
software is upgraded,
the TANDBERG Precision
HD Camera will be
upgraded automatically
if the configuration
CameraSwUpgrade is
set to Auto.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 146
Command Information
CameraMove — CameraReconfigure TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
CameraMove Command used to Camera(r): <1..13> None As above xcommand cameramove camera:1 direction:
instruct the camera Addresses the camera to move. right
to move in a specified *r Result (status=OK):
direction. The camera Direction(r): <Up/Down/Right/ *r/end
will continue moving Left/In/Out/FocusIn/FocusOut > OK
until the CameraHalt Specifies the direction to move.
command is issued.
CameraPosition Command used to Camera(r): <1..13> None As above xcommand cameraposition camera:1
instruct the camera Addresses the camera to position. pan:1700 tilt:1700
to move to a specific *r Result (status=OK):
position. Pan: <-32768..32767> *r/end
Pan value. OK
Tilt: <-32768..32767>
Tilt value.
Zoom: <0..65534>
Zoom value.
Focus: <0..65534>
Focus value.
Note! The supported values for pan,
tilt, zoom, focus will depend on the
type of camera in use. For example:
Sony cameras have value ranges
different from TANDBERG cameras.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 147
Command Information
CameraTrackingStart — ChairTake TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
CameraUpgrade Upgrade camera or (r): <1..13> <filename> None As above xcommand cameraupgrade:1 s01692.pkg
video switch with new Addresses the specific camera or *r Result (status=OK):
software. The software TANDBERG Video Switch. *r/end
must be put on a folder OK
named either /tmp or Camera software files are named
/user. s01692.pkg.
CameraWhiteBalance Command used to Camera(r): <1..13> None As above xcommand camerawhitebalance camera:1
initiate calibration of Addresses the specific camera. *r Result (status=OK):
the whitebalance of the *r/end
camera. The command OK
is valid only when the
Camera Whitebalance
Mode is configured to
Manual.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 148
Command Information
ConferenceDisconnect — ConferenceTerminate TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 149
Command Information
CorpDirSearch TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
CorpDirSearch Command to search With no parameters specified the None As above xcommand corpdirsearch
for contacts in the result will show the first 40 catalogs. *r Result (status=OK):
corporate directory Entity 1 <type:Catalog>:
phone book. Name: “0.1 - Personal Systems“
Use the CorpDirGetNext Path: <S: 0, 256> Path: ““
and the ID of the last Enter the path, which is the ID of the ID: “138“
entity to search for the folder or subfolder, to search in. IsFirst: True
next contacts. The result will show the first 40 IsLast: False
entries in the given catalog. If no Entity 2 <type:Catalog>:
Use the Name: “0.2 - Meeting Rooms“
CorpDirGetPrevious catalog specified by Path, then the
root catalog is used. Path: ““
and the ID of the first ID: “140“
entity to search for the Query: <S: 0, 81> IsFirst: False
previous contacts. IsLast: True
Enter the query to search for.
*r/end
StartsWith: <S: 0, 81> OK
The search string should start with.
xcommand corpdirsearch query:charlie
Hits: <1..40> hits:1
Specify the number of hits to show. *r Result (status=OK):
Entity 1 <type:Entry>:
SubFolders: <On/Off>
Name: “charlie.brown“
Define if the search should also Path: ““
include subfolders. ID: “29“
IsFirst: True
IsLast: False
IsFirst: <True/False> ContactInfo 1:
True indicates that this is the first hit Protocol: H323
matching the search criteria. CallRate: 384
False indicates that this is not the Restrict: Off
first hit matching the search criteria. DialString: “[email protected]“
CorpDirGetPrevious can be used to Description: “[email protected]
search for more contacts. <H323>“
ContactInfo 2:
IsLast: <True/False> Protocol: H320
True indicates that this is the last hit CallRate: 384
matching the search criteria. Restrict: Off
DialString: “791“
False indicates that this is not the
Description: “791 <ISDN>“
last hit matching the search criteria.
*r/end
CorpDirGetNext can be used to
OK
search for more contacts.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 150
Command Information
CorpDirGetNext TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
CorpDirGetNext After having used the With no parameters specified the None As above xcommand corpdirgetnext path:138 query:
CorpDirSearch, this result will show first 40 catalogs. charlie id:29 hits:5
command is used when *r Result (status=OK):
you want to search for ...
the next contacts in Path: <S: 0, 256> <The next 5 entries, from id 29 for the given search
the corporate directory Enter the path, which is the ID of the will show>
phone book. folder or subfolder, to search in. ...
The result will show the first 40 *r/end
entries in the given catalog. If no OK
The ID is found in the
CorpDirSearch result. catalog specified by Path, then the
root catalog is used. xcommand corpdirgetnext path:138 query:
charlie id:34 hits:5
Query: <S: 0, 81> *r Result (status=OK):
Enter the query to search for. ...
<The next 5 entries, from id 34 for the given search
StartsWith: <S: 0, 81> will show>
The search string should start with. ...
*r/end
Hits: <1..40> OK
Specify the number of hits to show.
ID: <S: 0, 21>
Define the ID of an entity.
The ID is relative to a specific
search. When using the
CorpDirGetNext command you
need to specify the same Query
and StartsWith strings as in the
CorpDirSearch command.
SubFolders: <On/Off>
Define if the search should also
include subfolders
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 151
Command Information
CorpDirGetPrevious TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
CorpDirGetPrevious After having used the With no parameters specified the None As above xcommand corpdirgetprevious path:138
CorpDirSearch, this result will show first 40 catalogs. query:charlie id:29 hits:5
command is used when *r Result (status=OK):
you want to search for ...
the previous contacts in Path: <S: 0, 256> <The previous 5 entries, from id 29 for the given
the corporate directory Enter the path, which is the ID of the search will show>
phone book. folder or subfolder, to search in. ...
The result will show the first 40 *r/end
entries in the given catalog. If no OK
The ID is found in the
CorpDirSearch result. catalog specified by Path, then the
root catalog is used. xcommand corpdirgetprevious path:138
query:charlie id:34 hits:5
Query: <S: 0, 81>
*r Result (status=OK):
Enter the query to search for. ...
StartsWith: <S: 0, 81> <The previous 5 entries, from id 34 for the given
search will show>
The search string should start with. ...
Hits: <1..40> *r/end
OK
Specify the number of hits to show.
ID: <S: 0, 21>
Define the ID of an entity.
The ID is relative to a specific
search. When using the
CorpDirGetPrevious command you
need to specify the same Query
and StartsWith strings as in the
CorpDirSearch command
SubFolders: <On/Off>
Define if the search should also
include subfolders
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 152
Command Information
DefaultValueSet TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
DefaultValuesSet Command used to reset Level: <1..3> None As above xcommand defaultvaluesset level:2
configurations to factory Configurations are divided into *r Result (status=OK):
default values. three different storage levels. *r/end
The level parameter denotes that OK
configurations on this level and all
levels below (lower value) are to be
reset.
The complete list of Storage Levels
can be found in Configuration
Storage Levels.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 153
Command Information
Dial TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Dial Command used to dial Number: <S: 0, 60> CallRef: <1..11> As above xcommand dial number:123 callrate:256
out from the system. Number to dial. Reference to the netprofile:3
call. To be used *r Result (status=OK):
SecondNumber: <S: 0, 60> as reference when CallRef: 1
2Xh221 second number. monitoring the call. LogTag: 312
*r/end
SubAddress: <S: 0, 20> LogTag: <1…> OK
Sub address. Unique reference
to call. Identifies
CallRate: <Tlph/1xh221/xh221/6 the call in the call
4/128/192/256/320/384/512/7 log.
68/1152/1472/1920/2560/3072
/4096/H0/Max/Auto>
Specifies the callrate to use. The
CallRates supported for a system
will depend on model and software
options.
Restrict: <On/Off>
A restricted call uses 56kbps
channels rather than the default
unrestricted 64kbps channels. Some
older networks (primarily in the USA)
do not support 64kbps channels and
require the use of restricted 56kbps
calls. By default the system will dial
an unrestricted call and downspeed
to 56kbps if necessary.
NetProfile: <1..7>
Defines the NetProfile to use. A
NetProfile defines network type and
a possible prefix, ref. configuration
Netprofile.
BillingCode: <S: 0, 16>
By adding a Billing Code when
placing a call, the call can be
identified in the call log (xhistory/
history.xml) after it is disconnected.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 154
Command Information
DialGlobalEntry — DialLocalEntry TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
DialGlobalEntry Command used to dial a GlobalEntryId(r): <1..400> CallRef: <1..11> As above xcommand dialglobalentry globalentry-
number from the global Reference to the directory entry to Reference to the id:19
directory (the Global be dialed. call. To be used *r Result (status=OK):
Directory is downloaded as reference when CallRef: 1
to the system by an monitoring the call. LogTag: 312
external application). *r/end
LogTag: <1…> OK
Unique reference
to call. Identifies
the call in the call
log.
DialGroupEntry Command used to dial GroupEntryId(r): <1..50 > The system As above xcommand dialgroupentry groupentryid:19
an entry from the Group Reference to the directory entry to will return the *r Result (status=OK):
Directory. Dialling from be dialed. following elements CallRef: 2
the Group Directory for each call LogTag: 313
makes it possible to initiated. CallRef: 1
set up a MultiSite CallRef: <1..11> LogTag: 312
conference in one CallRef:
operation. Reference to the *r/end
call. To be used OK
as reference when
monitoring the call.
LogTag: <1…>
Unique reference
to call. Identifies
the call in the call
log.
DialLocalEntry Command used to dial a LocalEntryId(r): <1..200> CallRef: <1..11> As above xcommand diallocalentry localentryid:15
number from the locally Reference to the directory entry to Reference to the *r Result (status=OK):
stored directory. be dialed. call. To be used CallRef: 1
as reference when LogTag: 312
monitoring the call. *r/end
OK
LogTag: <1…>
Unique reference
to call. Identifies
the call in the call
log.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 155
Command Information
DisconnectCall — FECCFocus TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
DisconnectCall Command used to Call: <1..11> None As above xcommand disconnectcall call:9
disconnect a call. Reference to the call to be *r Result (status=OK):
disconnected. If this parameter is *r/end
omitted, all active calls in the system OK
will be disconnected.
DuoVideoStart Command used to VideoSource: <1..6> None As above xcommand duovideostart videosource:5
initiate DuoVideo/H.239 Specifies which video source to be *r Result (status=OK):
from the system. used for the additional video stream. *r/end
If this parameter is omitted, the OK
system will use the default DuoVideo
source configured for the system,
ref. configuration DuoVideoSource
DTMFSend Command used to send Value(r): <E164: 1, 1> None As above xcommand dtmfsend value:5
DTMF tones to the far The DTMF tone to send. *r Result (status=OK):
end. *r/end
OK
NOTE! The DTMF tones
are also played back
locally.
NOTE! This command
is also supported when
the system is not in a
call (the tones will only
be played back locally).
FECCFocus Command used to Value(r): <+/-> None As above xcommand feccfocus value:+
change focus of a far Specifies whether to increase or *r Result (status=OK):
end camera. decrease focus. *r/end
OK
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 156
Command Information
FECCMove — FeedbackDeregister TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
FECCMove Command used Direction(r): <Up/Down/Right/Left/ None As above xcommand feccmove direction:right
to issue a Far End In/Out/FocusIn/FocusOut> *r Result (status=OK):
Camera Control – Move Specifies the direction to move. *r/end
command. OK
FECCPresetActivate Command used to Number(r): <0..15> None As above xcommand feccpresetactivate number:4
activate a far end The preset number to activate. *r Result (status=OK):
preset. *r/end
OK
FECCPresetStore Command used to store Number(r): <0..15> None As above xcommand feccpresetstore number:4
a far end preset. The preset number to store. *r Result (status=OK):
*r/end
OK
FECCRequestStill Command used to Source(r): <0..15> None As above xcommand requeststill source:4
request a still image The far end source to select. *r Result (status=OK):
from a specific source *r/end
on the far end side. OK
FECCSelectSource Command used to Source(r): <0..15> None As above xcommand feccselectsource source:4
select a far end source. The far end source to select. *r Result (status=OK):
*r/end
OK
FeedbackDeregister Command used ID: <1..3> None As above xcommand feedbackderegister id:1
to deregister XML ID for the registration to deregister. *r Result (status=OK):
feedback over HTTP(S). ID: 2
*r/end
OK
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 157
Command Information
FeedbackRegister — FloorRequest TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
FeedbackRegister Command used to ID: <1..3> ID: <1..3> As above xcommand feedbackregister url:http://10.
instruct the system to ID for the registration. If this 47.14.185:8000
return XML feedback parameter is omitted the system expression.1:status/call
over HTTP(S) to uses the first vacant ID. expression.2:status/conference
specific URLs. What *r Result (status=OK):
parts of the Status URL(r): <S: 0, 256> ID: 2
and Configuration XML The URL to post feedback to. *r/end
documents to monitor OK
are specified by XPath Expression.1..15: <S: 0, 256>
expressions. XPath expression
The system supports
issuing feedback to 3
different URLs.
The system allows
a total of 20 XPath
expressions to be
registered, with a
maximum of 15 for a
single URL.
FIPSMode Command to activate Mode(r): <On/Off> On: “Entering FIPS As above xcommand fipsmode:off
and deactivate FIPS Denotes whether the video system is mode, restart *r Result (status=OK):
mode. to be in FIPS mode or not. required.” *r/end
OK
Off: “Exiting FIPS
mode, restart
required.”
The codec wil
restart.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 158
Command Information
FloorToSite — KeyDown TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
FloorToSite Command used to MCUID(r): <1..191> None As above xcommand floortosite mcuid:85 terminal-
assign floor to a specific MCUID to the MultiSite the site is id:2
site in a MultiSite connected to. *r Result (status=OK):
conference supporting *r/end
H.243. TerminalID(r): <1..191> OK
The site’s terimnal id, referenced to
the MultiSite it is connected to.
GroupEntryAdd Command used to add Name: <S: 0, 48> GroupEntryId: As above xcommand groupentryadd name:”My Group
a new Group entry to The entry’s name. <1..50> Entry” localentryid.1:1 localentryid.2:7
the locally stored Group Reference to the localentryid.3:9
Directory (or MultiSite LocalEntryId.1..10: <1..200> Group Directory *r Result (status=OK):
Directory). The entry is References to local entry ids to be position the entry GroupEntryId: 17
stored in the first vacant included in this Group entry. is stored. *r/end
position in the Group OK
Directory.
GroupEntryDelete Command used to GroupEntryId(r): <1..50> None As above xcommand groupentrydelete groupentryid:30
delete an entry in the Reference to the entry to delete. *r Result (status=OK):
locally stored Group *r/end
Directory. OK
KeyDown Command used to Key(r): <0/1/2/3/4/5/6/7/8/ None As above xcommand keydown key: phonebook
emulate pressing a key 9/*/#/Connect/Disconnect/ *r Result (status=OK):
on the TANDBERG MXP Up/Down/Right/Left/Selfview/ *r/end
remote control without Layout/Phonebook/Cancel/ OK
releasing it. The KeyDown MicOff/Presentation/VolumeUp/
command should be VolumeDown/OK/ZoomIn/
followed by a KeyRelease ZoomOut/Grab>
command to emulate
releasing the key.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 159
Command Information
KeyRelease — KeyEnable TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
KeyRelease Command used to Key(r): <0/1/2/3/4/5/6/7/8/ None As above xcommand keyrelease key: phonebook
emulate release an 9/*/#/Connect/Disconnect/ *r Result (status=OK):
already pressed key on Up/Down/Right/Left/Selfview/ *r/end
the TANDBERG MXP Layout/Phonebook/Cancel/ OK
remote control. The MicOff/Presentation/VolumeUp/
KeyRelease command VolumeDown/OK/ZoomIn/
should be preceded by ZoomOut/Grab>
a KeyDown command to
emulate pressing the key.
KeyPress Command used to Key(r): <0/1/2/3/4/5/6/7/8/ None As above xcommand keypress key: phonebook
emulate pressing a 9/*/#/Connect/Disconnect/ *r Result (status=OK):
key on the TANDBERG Up/Down/Right/Left/Selfview/ *r/end
MXP remote control Layout/Phonebook/Cancel/ OK
for a short while. This MicOff/Presentation/VolumeUp/
command needs no VolumeDown/OK/ZoomIn/
release command. ZoomOut/Grab>
KeyDisable Command used to Key(r): <0/1/2/3/4/5/6/7/8/ None As above xcommand keydisable key: micoff
disable a key on the 9/*/#/Connect/Disconnect/ *r Result (status=OK):
TANDBERG MXP remote Up/Down/Right/Left/Selfview/ *r/end
control. Layout/Phonebook/Cancel/ OK
MicOff/Presentation/VolumeUp/
VolumeDown/OK/ZoomIn/
ZoomOut/Grab>
KeyEnable Command used to Key(r): <0/1/2/3/4/5/6/7/8/ None As above xcommand keyenable key: micoff
enable a key on the 9/*/#/Connect/Disconnect/ *r Result (status=OK):
TANDBERG MXP remote Up/Down/Right/Left/Selfview/ *r/end
control. Layout/Phonebook/Cancel/ OK
MicOff/Presentation/VolumeUp/
VolumeDown/OK/ZoomIn/
ZoomOut/Grab>
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 160
Command Information
LocalEntryAdd — MessageBoxDelete TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
LocalEntryAdd Command used to Name: <S: 0, 48> LocalEntryId: As above xcommand localentryadd name:”John Galt”
add a new entry to the The entry’s name. <1..200> number:123
Directory stored locally. Reference to the *r Result (status=OK):
The entry is stored in Number: <S: 0, 60> Directory position LocalEntryId: 17
the first vacant position The entry’s number. the entry is stored. *r/end
in the Directory. OK
SecondNumber: <S: 0, 60>
The entry’s second number (2XH221
number).
SubAddress: <S: 0, 10>
The entry’s sub address.
CallRate:
<Tlph/1xh221/2xh221/64/128/
192/256/320/384/512/768/115
2/1472/1920/2560/3072/4096/
H0/Max/Auto>
The callrate to use when calling this
entry.
Restrict: <On/Off>
Whether to use restrict or not when
calling this entry.
NetProfile: <1..7>
The Net Profile to use when calling
this entry.
LocalEntryDelete Command used to LocalEntryId(r): <1..200> None As above xcommand localentrydelete localentry-
delete an entry in the Reference to the entry to delete. id:66
locally stored Directory. *r Result (status=OK):
*r/end
OK
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 161
Command Information
MessageBoxDisplay — PresetActivate TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
MessageBoxDisplay Command used to add a Title(r): <S: 0, 40> None As above xcommand messageboxdisplay title:Welcome
graphical message box Message box title. line.1:”How are you?”
on the screen. key.1:Good
Line.1..3: <S: 0, 40> key.2:Bad
Text to be displayed on the lines *r Result (status=OK):
within the box. *r/end
OK
Key.1..3: <S: 0, 15>
Text to be displayed on the keys
PIPHide Command used to hide VirtualMonitor(r): <1..4> None As above xcommand piphide virtualmonitor:1
a PIP on a specific Addresses which VirtualMonitor to *r Result (status=OK):
VirtualMonitor. apply the command. *r/end
OK
PIPShow Command used to VirtualMonitor(r): <1..4> None As above xcommand pipshow virtualmonitor:1 pic-
display a specific picture Addresses which VirtualMonitor to ture:remoteduo call:5
in a PIP on a selected apply the command. postion:topright
VirtualMonitor *r Result (status=OK):
Picture(r): <LocalMain/LocalDuo/ *r/end
RemoteMain/RemoteDuo/ OK
JPEG/TandbergMonitor1/
TandbergMonitor2/None>
Specifies which of the supported
pictures to display in the PIP on the
addressed VirtualMonitor.
Call: <1..11>
If RemoteMain or RemoteDuo is
selected, this parameter must be
supplied to select the correct remote
call.
Position: <BottomLeft/
BottomRight/TopLeft/TopRight>
Specifies where to postion the PIP.
PresetActivate Command used to Number(r): <0..14> None As above xcommand presetactivate number:4
activate a stored preset. The preset to activate. *r Result (status=OK):
*r/end
OK
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 162
Command Information
PresetClear — ScreensaverActivate TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
PresetClear Command used to clear Number(r): <0..14> None As above xcommand presetclear number:4
a preset previously The preset to clear. *r Result (status=OK):
stored. *r/end
OK
PresetStore Command used to store Number(r): <0..14> None As above xcommand presetstore number:4
a preset. The number where to store the *r Result (status=OK):
preset. *r/end
OK
ProfileActivate Command to activate an Name(r): <S: 0, 16> None As above xcommand profileactivate:profilename
existing user profile. The name of the user profile to *r Result (status=OK):
activate. *r/end
OK
ProfileCreate Configure the video Name(r): <S: 0, 16> None As above xcommand profilecreate:profilename
system and use this The name of the user profile to *r Result (status=OK):
command to create a create. *r/end
new user profile. OK
ProfileDelete Command to delete an Name(r): <S: 0, 16> None As above xcommand profiledelete:profilename
user profile. The name of the user profile to *r Result (status=OK):
delete. *r/end
OK
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 163
Command Information
ScreensaverDeactivate — SiteViewEnd TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
ScreensaverReset Command used to reset Delay(r): <1..480> None As above xcommand screensaverreset delay:90
the screensaver timer. Specifies the screensaver delay in *r Result (status=OK):
minutes. *r/end
OK
SiteDisconnect Command used to MCUID(r): <1..191> None As above xcommand sitedisconnect mcuid:85 termi-
disconnect a specific MCUID to the MultiSite the site is nalid:2
site from a MultiSite connected to. *r Result (status=OK):
conference supporting *r/end
H.243. TerminalID(r): <1..191> OK
The site’s terimnal id, referenced to
the MultiSite it is connected to.
SiteView Command used to MCUID(r): <1..191> None As above xcommand siteview mcuid:85 terminalid:2
request view of a MCUID to the MultiSite the site is *r Result (status=OK):
specific site in a connected to. *r/end
MultiSite conference OK
supporting H.243. TerminalID(r): <1..191>
The site’s terimnal id, referenced to
the MultiSite it is connected to.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 164
Command Information
SPIDAutoConfigure — TextDisplay TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
StillImageSend Command used to send VideoSource: <1..6> None As above xcommand stillimagesend videosource:5
a still image. Specifies from which video source to *r Result (status=OK):
send a still image. If this parameter *r/end
is omitted, the system will use the OK
default still image source configured
for the system.
TextDelete Command used to Layer(r): <1..3> None As above xcommand textdelete layer:1
delete a text line added The layer to delete. *r Result (status=OK):
by the TextDisplay *r/end
command. OK
TextDisplay Command used add a Layer(r): <1..3> None As above xcommand textdisplay layer:1 text:TAND-
text line on screen. Defines the lines position. BERG timeout:100
*r Result (status=OK):
Text: <S: 0, 38> *r/end
The text to display. OK
TimeOut: <0..999>
Sets the timeout value for the text
line.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 165
Command Information
VirtualMonitorReset — VirtualMonitorSet TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
VirtualMonitorReset Command used to VirtualMonitor(r): <1..4> None As above xcommand virtualmonitorreset virtual-
reset a VirtualMonitor. Addresses which VirtualMonitor to monitor:2
By resetting a apply the command. *r Result (status=OK):
VirtualMonitor the *r/end
system itself retakes OK
control over what to
be displayed on the
VirtualMonitor.
VirtualMonitorSet Command used to VirtualMonitor(r): <1..4> None As above xcommand virtualmonitorset virtualmoni-
instruct the system Addresses the VirtualMonitor to tor:2 picture:still
to display a specific which the command is to be applied. *r Result (status=OK):
picture on a specific *r/end
VirtualMonitor. A Picture(r): <LocalMain/LocalDuo/ OK
VirtualMonitor can Still/RemoteMain/RemoteDuo/
be displayed on one JPEG/TandbergMonitor1/
or more of the local TandbergMonitor2/
video outputs (which PictureProgram1/PictureProgram2/
VirtualMonitor a specific PictureProgram3/
video output is to PictureProgram4/None>
display is configurable). Specifies which of the supported
When this command pictures to display on the addressed
is issued for a specific VirtualMonitor.
VirtualMonitor the Call: <1..11>
picture displayed on this
If RemoteMain or RemoteDuo is
monitor will not change
selected, this parameter must be
until the VirtualMonitor
supplied to select the correct remote
is reset or set to display
call.
another picture.
Required parameters are identified by an (r) appended to the parameter name. The (r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
D 13887.09
APRIL 2009 166
Status Information Tables
We recommend that you check out the This part of the manual describes the Status information
TANDBERG web site regularly for updated
versions of this manual: available.
http://www.tandberg.com/docs There are three types of status information available:
• xstatus / status.xml
• xhistory / history.xml
• xevent / event.xml
Status Information
Understanding the Table Layout TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Status Information
Conference TANDBERG 3000 MXP & 6000 MXP
REFERENCE USER GUIDE FOR SYSTEM INTEGRATORS
<Nothing>
Example:
*s Conference (type=Idle): /
*s/end Which status elements
to show in a given
If type = PointToPoint the following will be included: situation is context
Calls: dependent. The
CallRef [1..11]: 1..11 context is reflected in
DuoVideo (status = None / Ready / On): the attribute values.
If status = None / Ready the following will be included: Certain conditions will
<Nothing> cause some status
This condition If status = On the following will be included: elements to be shown,
causes CallRef [1..11]: 0..11 while other conditions
this to appear LoudestParticipant: will produce other
CallRef: 0..11 status elements.
Example: The conditions are
Example showing *s Conference (type=PointToPoint): always shown on grey
Calls:
status of a real CallRef 1: 1 background and start
DuoVideo (status=Ready): /
case. LoudestParticipant: with an If statement.
CallRef: 1
*s/end
If type = PointToMultiSite the following will be included:
Calls:
If status = None / Ready the following will be included:
<Nothing>
D 13887.X3
AUGUST 2006 20
Indenting is used to keep track of the Tip! For easy line-by-line parser, use the complete path formatter,
levels. In the tables one light grey square described in XACLI – Status-type commands – complete path formatting
is used per level.
D 13887.09
APRIL 2009 168
Status Information – xstatus /xstatus.xml
Audio TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Audio
Inputs
Microphone [1..3]:
Line [1..3]:
Example:
*s Audio:
AudioModule: None
Inputs:
Microphone 1:
Active: True
Microphone 2:
Active: False
Microphone 3:
Active: False
Line 1:
Active: False
Line 2:
Active: False
Line 3:
Active: False
*s/end
Channel [1..2] (type = BChannel , status=Idle / Calling / Answering / Proceeding / Connect / Disconnecting / Disconnected)
<Nothing>
If type = Bchannel and status = Calling / Answering / Proceeding / Connect the following will be included:
CallingNumber:
ConnectionTime:
If type = Bchannel and status = Disconnecting / Disconnected the following will be included:
CallingNumber:
CauseLocation:
ChannelCause:
ConnectionTime:
Layer1Alarm: <NA>
Layer2Alarm: <NA>
Example:
*s BRI 1 (ready=True):
Channel 1 (type=BChannel, status=Idle): /
Channel 2 (type=BChannel, status=Disconnected):
CallingNumber: “8770”
CauseLocation: 0
ChannelCause: 41
ConnectionTime: 258
*s/end
*s BRI 2 (ready=True):
Channel 1 (type=BChannel, status=Connect):
CallingNumber: “8770”
ConnectionTime: 346
Channel 2 (type=BChannel, status=Connect):
CallingNumber: “8770”
ConnectionTime: 346
*s/end
*s BRI 3 (ready=True):
Channel 1 (type=BChannel, status=Connect):
CallingNumber: “8770”
ConnectionTime: 345
Channel 2 (type=BChannel, status=Connect):
CallingNumber: “8770”
ConnectionTime: 345
*s/end
Call [1..10] (status=Disconnected / CallIDLE / Dialing / Alerting / Proceeding / EstablOut / EstablIn / AwaitInCnf / Connected / Disconnecting / Await2ndnr / ClearOut / ClearIn / Syncing / Capex / Synced / Unframed,
type = NA / Tlph / Vtlph,
protocol = NA / ISDN / H320 / H323 / SIP,
direction = NA / Incoming / Outgoing,
logTag = 1..x )
If status = Disconnected
and type = NA
and protocol = NA
and direction = NA
and logtag = x
the following will be included:
Cause:
If status = Dialing / Alerting / Proceeding / EstablOut / EstablIn / AwaitInCnf / Connected / Disconnecting / Await2ndnr / ClearOut / ClearIn / Syncing / Capex / Synced / Unframed
and type = Tlph
and protocol = ISDN
and direction = Incoming / Outgoing
and logTag = x
the following will be included:
CallRate: 64
RemoteNumber [1..2]:
RemoteSubAddress:
IncomingNumber:
Appears for incoming calls only
IncomingSubAddress:
Mute: On/Off
Microphone: On/Off
Duration: 0...
MuteOutgoing: On/Off
Rate: 64
Restrict: On/Off
<Nothing>
Rate: 16...
Example:
*s Call 1 (status=Synced, type=Tlph, protocol=ISDN, direction=Incoming, logTag=5944):
CallRate: 64
RemoteNumber 1: “8733”
RemoteNumber 2: “”
RemoteSubAddress: “”
IncomingNumber: “8770”
IncomingSubAddress: “”
Mute: Off
Microphone: On
Duration: 127
MuteOutgoing: Off
Channels 1 (type=Incoming):
Rate: 64
Restrict: Off
Audio (status=Active):
Protocol: G711
Rate: 64
Channels 2 (type=Outgoing):
Rate: 64
Restrict: Off
Audio (status=Active):
Protocol: G711
Rate: 64
*s/end
If status = Dialing / Alerting / Proceeding / EstablOut / EstablIn / AwaitInCnf / Connected / Disconnecting / Await2ndnr / ClearOut / ClearIn / Syncing / Capex / Synced / Unframed
and type = Vtlph
and protocol = H320
and direction = Incoming / Outgoing
and logTag = x
the following will be included:
CallRate: 64/128/../4096
RemoteNumber [1..2]:
RemoteSubAddress:
IncomingNumber:
Appears for incoming calls only
IncomingSubAddress:
Mute: On / Off
Microphone: On / Off
Duration: 0...
MuteOutgoing: On / Off
Rate: 64 / .. / 4096
Restrict: On / Off
<Nothing>
CheckCode:
<Nothing>
Rate:
<Nothing>
Resolution: QCIF / SQCIF / CIF / 2CIF / 4CIF / ICIF / SIF / 4SIF /ISIF /VGA / SVGA / XGA / QVGA / 448p / 400p / w288p / w448p / w576p / w720p
Rate:
<Nothing>
Protocol: FECC
Rate:
If status = Dialing / Alerting / Proceeding / EstablOut / EstablIn / AwaitInCnf / Connected / Disconnecting / Await2ndnr / ClearOut / ClearIn / Syncing / Capex / Synced / Unframed
and type = Tlph
and protocol = H323 / SIP
and direction = Incoming / Outgoing
and logTag = x
the following will be included:
CallRate: 64
RemoteNumber:
RemoteSubAddress:
IncomingNumber:
Appears for incoming calls only
IncomingSubAddress:
Mute: On / Off
Microphone: On / Off
Duration: 0...
MuteOutgoing: On / Off
Rate: 64 / .. / 4096
Restrict: On / Off
<Nothing>
RSVP*: On/Off
RSVPRate*:
DynamicRate*:
TotalPackets*:
PacketLoss*:
Jitter*:
Example:
*s Call 1 (status=Synced, type=Tlph, protocol=H323, direction=Incoming, logTag=5):
CallRate: 64
RemoteNumber: “5020019”
IncomingNumber: “5020059”
IncomingSubAddress: “”
Mute: Off
Microphone: On
Duration: 16
MuteOutgoing: Off
Channels 1 (type=Incoming):
Rate: 64
Restrict: Off
Encryption (status=On):
Type: AES-128
CheckCode: “E2957C90C5DF0649”
Audio (status=Active):
Protocol: G711
Rate: 64
RemoteIPAddress: “”
LocalIPAddress: “10.47.20.59:2334”
Encryption (status=On):
Type: AES-128
RSVP: Off
RSVPRate: 0
DynamicRate: 64
TotalPackets: 725
PacketLoss: 0
Jitter: 0
PacketsDropped: 0
Data (status=Inactive): /
Channels 2 (type=Outgoing):
Rate: 64
Restrict: Off
Encryption (status=On):
Type: AES-128
CheckCode: “E2957C90C5DF0649”
Audio (status=Active):
Protocol: G711
Rate: 64
RemoteIPAddress: “10.47.20.19:2334”
LocalIPAddress: “10.47.20.59:2334”
Encryption (status=On):
Type: AES-128
RSVP: Off
RSVPRate: 0
DynamicRate: 64
TotalPackets: 725
PacketLoss: 0
Jitter: 0
Data (status=Inactive): /
*s/end
If status = Dialing / Alerting / Proceeding / EstablOut / EstablIn / AwaitInCnf / Connected / Disconnecting / Await2ndnr / ClearOut / ClearIn / Syncing / Capex / Synced / Unframed
and type = Vtlph
and protocol = H323 / SIP
and direction = Incoming / Outgoing
and logTag = x
the following will be included:
RemoteNumber:
RemoteSubAddress:
IncomingNumber:
Appears for incoming calls only
IncomingSubAddress:
Mute: On / Off
Microphone: On / Off
Duration: 0...
MuteOutgoing: On / Off
Rate: 64 / .. / 4096
Restrict: On / Off
<Nothing>
CheckCode:
<Nothing>
Rate:
RemoteIPAddress*:
LocalIPAddress*:
<Nothing>
RSVP*: On / Off
DynamicRate*:
TotalPackets*:
PacketLoss*:
Jitter*:
<Nothing>
Resolution: QCIF / SQCIF / CIF / 2CIF / 4CIF / ICIF / SIF / 4SIF /ISIF /VGA / SVGA / XGA / QVGA / 448p / 400p / w288p / w448p / w576p / w720p
Rate:
RemoteIPAddress*:
LocalIPAddress*:
<Nothing>
RSVP*: On / Off
DynamicRate*:
TotalPackets*:
PacketLoss*:
Jitter*:
<Nothing>
Type: LSD/MLP
Protocol: FECC
Rate:
RemoteIPAddress*:
LocalIPAddress*:
<Nothing>
RSVP*: On / Off
DynamicRate*:
TotalPackets*:
PacketLoss*:
Jitter*:
Example:
*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Incoming, logTag=6):
CallRate: 768
RemoteNumber: “5020019”
IncomingNumber: “5020059”
IncomingSubAddress: “”
Mute: Off
Microphone: On
Duration: 10
MuteOutgoing: Off
Channels 1 (type=Incoming):
Rate: 768
Restrict: Off
Encryption (status=On):
Type: AES-128
CheckCode: “C442803A9A470B7F”
Audio (status=Active):
Protocol: AAC-LD
Rate: 64
RemoteIPAddress: “”
LocalIPAddress: “10.47.20.59:2334”
Encryption (status=On):
Type: AES-128
RSVP: Off
RSVPRate: 0
DynamicRate: 64
TotalPackets: 474
PacketLoss: 0
Jitter: 1
PacketsDropped: 0
Video 1 (status=Active):
Protocol: H264
Resolution: Off
Rate: 704
RemoteIPAddress: “”
LocalIPAddress: “10.47.20.59:2336”
Encryption (status=On):
Type: AES-128
RSVP: Off
RSVPRate: 0
DynamicRate: 677
TotalPackets: 817
PacketLoss: 0
Jitter: 0
PacketsDropped: 0
Video 2 (status=Inactive): /
Data (status=Inactive): /
Channels 2 (type=Outgoing):
Rate: 768
Restrict: Off
Encryption (status=On):
Type: AES-128
CheckCode: “C442803A9A470B7F”
Audio (status=Active):
Protocol: AAC-LD
Rate: 64
RemoteIPAddress: “10.47.20.19:2334”
LocalIPAddress: “10.47.20.59:2334”
Encryption (status=On):
Type: AES-128
RSVP: Off
RSVPRate: 0
DynamicRate: 63
TotalPackets: 475
PacketLoss: 0
Jitter: 2
Video 1 (status=Active):
Protocol: H264
Resolution: 2.5SIF
Rate: 704
RemoteIPAddress: “10.47.20.19:2336”
LocalIPAddress: “10.47.20.59:2336”
Encryption (status=On):
Type: AES-128
RSVP: Off
RSVPRate: 0
DynamicRate: 701
TotalPackets: 936
PacketLoss: 0
Jitter: 6
Video 2 (status=Inactive): /
Data (status=Inactive): /
*s/end
Type:
ID:
Pan:
Tilt:
Zoom:
Focus:
Example:
*s Camera 1 (connected=True):
Type: WaveII
ID: “0c0e0006”
SoftwareID: “”
Pan: 647
Tilt: 172
Zoom: 0
Focus: 27501
*s/end
Example:
*s CameraSwUpgrade (status=NA): /
*s/end
<Nothing>
Example:
*s CameraTracking (status=Off): /
*s/end
*s CameraTracking (status=On): /
*s/end
<Nothing>
Example:
*s Conference (type=Idle): /
*s/end
Calls:
<Nothing>
LoudestParticipant:
CallRef: 0..11
Example:
*s Conference (type=PointToPoint):
Calls:
CallRef 1: 1
DuoVideo (status=Ready): /
LoudestParticipant:
CallRef: 1
*s/end
Calls:
<Nothing>
LoudestParticipant:
CallRef: 0..11
NumberOfSites: 1..191
MCUSiteList:
Site [1..191]:
MCUID:
TerminalID:
Name:
CallRef:
LocalSite:
Self:
MCUID:
TerminalID:
OnAir: On / Off
Floor: On / Off
Chair: UnSupported
View:
MCUID:
TerminalID:
Example:
*s Conference (type=PointToMultisite):
Calls:
CallRef 1: 1
DuoVideo (status=None): /
LoudestParticipant:
CallRef: 1
NumberOfSites: 3
MCUSiteList:
Site 1:
MCUID: 85
TerminalID: 3
Name: “Boardroom1”
CallRef: 1
Site 2:
MCUID: 85
TerminalID: 1
Name: “Boardroom2”
CallRef: None
Site 3:
MCUID: 85
TerminalID: 2
Name: “Boardroom3”
CallRef: None
LocalSite:
Self:
MCUID: 85
TerminalID: 3
OnAir: On
Floor: Off
Chair: UnSupported
View:
MCUID: 0
TerminalID: 0
*s/end
Calls:
<Nothing>
LoudestParticipant:
CallRef: 0..11
Current:
CallRef: 0..11
Previous:
CallRef: 0..11
Window [1..6]:
CallRef: 0..11
MCUID: 1..
NumberOfSites: 1..191
MCUSiteList:
Site [1..191]:
MCUID:
TerminalID:
Name:
CallRef:
LocalSite:
Self:
MCUID:
TerminalID:
OnAir: On/Off
Floor: On/Off
Chair: UnSupported
View:
MCUID: 1..
TerminalID: 1..
Example
*s Conference (type=Multisite):
Calls:
CallRef 1: 1
CallRef 2: 2
DuoVideo (status=Ready): /
LoudestParticipant:
CallRef: 2
Floor: None
Current:
CallRef: 2
Previous:
CallRef: 1
OutgoingPicture 1 (name=Current):
Layout (type=Full):
Window 1:
Picture: RemoteMain
CallRef: 2
OutgoingPicture 2 (name=Previous):
Layout (type=Full):
Window 1:
Picture: RemoteMain
CallRef: 1
OutgoingPicture 3 (name=Duo):
Layout (type=NA): /
MCUID: 1
CascadingMode: StandAlone
NumberOfSites: 3
MCUSiteList:
Site 1:
MCUID: 1
TerminalID: 2
Name: “john.doe”
CallRef: 1
Site 2:
MCUID: 1
TerminalID: 3
Continues overleaf...
Ethernet:
MacAddress:
Example:
*s Ethernet:
MacAddress: “00:50:60:01:85:F1”
Speed: 100full
*s/end
ExternalManager:
Address:
URL:
Example:
*s ExternalManager:
Address: “10.47.6.75”
Protocol: HTTP
URL: “tms/public/external/management/SystemManagementService.asmx”
*s/end
<Nothing>
ExternalClockRate:
<Nothing>
CallingNumber:
ConnectionTime:
CallingNumber:
CauseLocation:
ChannelCause:
ConnectionTime:
FarEndInformation:
<Nothing>
T140: Off
SString: Off
Example:
*s FarEndInformation:
FECC (status=Off): /
T140: Off
SString: Off
*s/end
NumberOfPresets: x
NumberOfSources: x
Source [1..x]:
Name:
Capabilities: “ptzfms”
CurrentSource:
BroadcastSwitch: On / Off
T140: On/Off
Sstring: On/Off
Example:
*s FarEndInformation:
FECC (status=On):
NumberOfPresets: 15
NumberOfSources: 5
Source 1:
Name: “main cam”
Capabilities: “ptzfms”
Source 2:
Name: “aux”
Capabilities: “ms”
Source 3:
Name: “doc cam”
Capabilities: “ms”
Source 4:
Name: “vcr”
Capabilities: “ms”
Source 5:
Name: “pc”
Capabilities: “ms”
CurrentSource: 1
BroadcastSwitch: On
T140: On
SString: On
*s/end
<Nothing>
Example:
*s Feedback 1 (status=Off): /
*s/end
URL:
Expression [1..15]:
Example:
*s Feedback 2 (status=On):
URL: “http://10.47.6.75/tms/public/feedback/code.aspx”
Expression 1: “/History/Call”
Expression 2: “/Status/Call[@status=’Synced’]”
Expression 3: “/Status/SoftwareUpgrade”
Expression 4: “/Status/BRI”
Expression 5: “/Configuration/Conference/PictureMode”
*s/end
Channel [1..24 / 31] (status = NA / Idle / Calling / Answering / Proceeding / Connect / Disconnecting / Disconnected)
<Nothing>
CallingNumber:
ConnectionTime:
CallingNumber:
CauseLocation:
ChannelCause:
ConnectionTime:
Example:
H323Gatekeeper (status = Required / Discovering / Discovered / Authenticating / Authenticated / Registering / Registered / Rejected / Inactive)
<Nothing>
Example:
*s H323Gatekeeper (status=Inactive): /
*s/end
If status = Required / Discovering / Discovered / Authenticating/ Authenticated / Registering / Registered the following will be included:
Alias:
Address:
Port:
Alternates:
Example:
*s H323Gatekeeper (status=Registered):
Alias: “5584582”
Address: “10.47.9.1”
Port: 1719
Alternates:
Server 1:
Address: “10.1.214.87”
Port: 1719
Server 2:
Address: “10.1.214.88”
Port: 1719
*s/end
Address:
Port:
Cause:
Alternates:
Example:
*s H323Gatekeeper (status=Rejected):
Address: “10.47.9.1”
Port: 0
Cause: “Duplicate alias”
Alternates: /
*s/end
IP
Address:
SubnetMask:
Gateway:
V6:
DNS:
Server [1..5]:
Address:
Domain:
Name:
Example:
*s IP
Address: “10.47.11.179”
SubnetMask: “255.255.248.0”
Gateway: “10.47.8.1”
V6:
Address 1 (type=NA): “”
Address 2 (type=NA): “”
DNS:
Server 1:
Address: “10.0.0.10”
Server 2:
Address: “10.0.0.2”
Server 3:
Address: “”
Server 4:
Address: “”
Server 5:
Address: “”
Domain:
Name: “eu.tandberg.int”
*s/end
NTP:
Address:
Example:
*s NTP:
Address: “10.0.0.2”
*s/end
Example:
*s PRI (ready=False):
Layer1Alarm: RedAlarm
*s/end
<Nothing>
If type = BChannel / DChannel and status = Idle the following will be included:
<Nothing>
If type = BChannel and status = Calling / Answering / Proceeding / Connect the following will be included:
CallingNumber:
ConnectionTime:
If type = BChannel and status = Disconnecting / Disconnected the following will be included:
CallingNumber
CauseLocation
ChannelCause
ConnectionTime
Example:
*s PRI (ready=True):
BChannelsTotal: 8
BChannelsFree: 8
H0ChannelsFree: 1
Channel 1 (type=BChannel, status=Connect):
CallingNumber: “6700”
ConnectionTime: 18
Channel 2 (type=BChannel, status=Idle): /
Channel 3 (type=BChannel, status=Disconnected):
CallingNumber: “6700”
CauseLocation: 1
ChannelCause: 1
ConnectionTime: 0
Channel 4 (type=BChannel, status=Disconnected):
CallingNumber: “08733”
CauseLocation: 0
ChannelCause: 16
ConnectionTime: 120
Channel 5 (type=BChannel, status=Disconnected):
CallingNumber: “08733”
CauseLocation: 0
ChannelCause: 16
ConnectionTime: 120
Channel 6 (type=BChannel, status=Disconnected):
CallingNumber: “08733”
CauseLocation: 0
ChannelCause: 16
ConnectionTime: 120
Channel 7 (type=BChannel, status=Disconnected):
CallingNumber: “08733”
CauseLocation: 0
ChannelCause: 16
ConnectionTime: 120
Channel 8 (type=BChannel, status=Disconnected):
CallingNumber: “08733”
CauseLocation: 0
ChannelCause: 16
ConnectionTime: 120
Channel 9 (type=BChannel, status=Disconnected):
CallingNumber: “08733”
CauseLocation: 0
ChannelCause: 16
ConnectionTime: 120
Continues overleaf
RemoteSwUpgrade (status = NA / Started / Checking / Completed / Aborted / NotValid / RestoringSettings / Failed/WrongPassword / Granted / NoDataLink / WrongFormat / ErrorWrite / WrongReleaseKey / Incompatible / FileToo-
Large / Requesting)
Progress:
Example:
*s RemoteSwUpgrade (status=Started):
Progress: 12
*s/end
If status = NA / Checking / Completed / Aborted / NotValid / RestoringSettings / Failed/WrongPassword / Granted / NoDataLink / WrongFormat / ErrorWrite / WrongReleaseKey / Incompatible / FileTooLarge / Requesting) the following
will be included:
<Nothing>
Example:
*s RemoteSwUpgrade (status=NA): /
*s/end
<Nothing>
Example:
*s Screensaver (status=On): /
*s/end
Timer:
Example:
*s Screensaver (status=Off):
Timer: 37
*s/end
SIP
<Nothing>
Address:
Authentication: On/Off
URI:
URI:
Cause:
Example:
*s SIP:
Server (status=Active):
Address: “10.47.8.88”
Authentication:
Registration (status=Registered):
URI: “[email protected]”
*s/end
Progress:
Example:
*s SoftwareUpgrade (status=Started):
Progress: 12
*s/end
If status = NA / Checking / Completed / Aborted / NotValid / RestoringSettings / Failed the following will be included:
<Nothing>
Example:
*s SoftwareUpgrade (status=NA): /
*s/end
Input:
Format:
Sync:
Sync 1:
Sync 2:
Sync 3:
Sync 4:
Example:
*s Switch (connected=True):
Input: 1
Format: 1280X720p60
Sync: True
Sync 1: True
Sync 2: True
Sync 3: False
Sync 4: False
*s/end
Info: xstatus switch will give information about sync status for the active input, the format, and sync status for all DVI-D inputs. Active input may differ from what is given in the xconfiguration Switch Source
setting. This is because an external control system may also change the input. Information about software version and ID will be given by xstatus camera 1.
SystemUnit:
ProductType:
ProductId:
Uptime:
Software:
Version:
Name:
ReleaseDate:
Configuration:
Telephony:
VideoTelephony:
TotalBandwidth
ISDNBandwidth:
LANBandwidth:
PresenterOption: True/False
MultisiteOption: True/False
StreamingSupport: True/False
Encryption: True/False
Hardware:
SerialNumber:
MainBoard:
AdditionalBoard:
BootSoftware:
Configuration:
PRI:
BRI:
ExternalNetwork:
VGA:
DataPorts:
AudioInputs:
Settop: True/False
TV-Standard: PAL/NTSC
TemperatureCelcius:
TemperatureFahrenheit:
Example:
*s SystemUnit:
ProductType: “TANDBERG Codec”
ProductId: “TANDBERG 6000MXP PORTABLE”
Uptime: 10136
Software:
Version: “F4.0Beta2 NTSC”
Name: “s50000”
ReleaseDate: “2005-11-17”
Configuration:
Telephony: 5
VideoTelephony: 5
TotalBandwidth: 6144
ISDNBandwidth: 1920
LANBandwidth: 4096
PresenterOption: True
MultisiteOption: True
StreamingSupport: True
Encryption: True
Hardware:
SerialNumber: “25A00309”
MainBoard: “100670 rev. 05”
AdditionalBoard: “”
BootSoftware: “Rev. 1.12, 2005-10-13”
Configuration:
PRI: 1
BRI: 6
ExternalNetwork: 1
VGA: 2
DataPorts: 2
AudioInputs: 6
Settop: False
TV-Standard: NTSC
TemperatureCelcius: 55
TemperatureFahrenheit: 131
*s/end
VirtualMonitor [1..4]:
Layout (type = Full / 2Split / 2+1Split / 3+1Split / 4Split / 5+1Split, persistent = On/Off):
Window [1..6]:
Picture: LocalMain / LocalDuo / Current /Previous / Duo / RemoteMain / RemoteDuo / JPEG / Still / None
CallRef: 1..11
Example:
*s VirtualMonitor 1:
Layout (type=3+1Split, persistent=Off):
Window 1:
Picture: RemoteMain
CallRef: 1
Window 2:
Picture: Local Main
CallRef: 0
Window 3:
Picture: NA
CallRef: 0
Window 4:
Picture: NA
CallRef: 0
PIP (status=Off): /
*s/end
*s VirtualMonitor 2:
Layout (type=Full, persistent=Off):
Window 1:
Picture: RemoteDuo
CallRef: 1
PIP (status=Off): /
*s/end
<Nothing>
Example:
*s Warning 7 (status=NA): /
*s/end
ID: 101 / 102 / 131 / 132 / 133 / 134 / 161 / 191 / 192 / 193 / 201 / 202 / 203 / 204 / 205 / 206 / 207 / 208 / 301 / 1001 / 1002 / 1003
Value: 1
Example:
*s Warning 1 (status=Active):
ID: 101
Value: 1
*s/end
ID Description
101 Warning BRI 1 Layer 1 Alarm: Line is disconnected
102 Warning BRI 2 Layer 1 Alarm: Line is disconnected
131 Warning PRI Layer 1 Red Alarm: Red alarm or Loss of signal (LOS) means that there is no signal and thus no framing information received (this has the same effect as pulling out the PRI cable)
132 Warning PRI Layer 1 Blue Alarm: Blue alarm indicates that the network on the far side of the CSU is unavailable
133 Warning PRI Layer 1 Yellow Alarm: Yellow alarm or Remote Alarm Indicator (RAI) may indicate a weak or noisy signal or a broken connector in the TX part of the system PRI cable
134 Warning PRI Layer 2 Not Active
161 Warning External Network, No Clock: If no clock is detected you will not be able to place calls
191 Warning G.703 Layer 1 Red Alarm: Red alarm or Loss of signal (LOS) means that there is no signal and thus no framing information received (this has the same effect as pulling out the PRI cable)
192 Warning G.703 Layer 1 Blue Alarm: Blue alarm indicates that the network on the far side of the CSU is unavailable
193 Warning G.703 Layer 1 Yellow Alarm: Yellow alarm or Remote Alarm Indicator (RAI) may indicate a weak or noisy signal or a broken connector in the TX part of the system PRI cable
201 Warning H.323 GateKeeper Rejected: Registration to the GateKeeper has been rejected. Please check GateKeeper setting
202 Warning H.323 GateKeeper Rejected, duplicate alias: GateKeeper registration is rejected because you try to register with an Alias, which is already registered on the GateKeeper
203 Warning H.323 GateKeeper Resources Unavailable
204 Warning H.323 GateKeeper Rejected, invalid alias: The alias you try to register with is not accepted by the GateKeeper
205 Warning H.323 GateKeeper Rejected Security Denial: The GateKeeper rejects registration because the user name and/or password is incorrect
206 Warning H.323 GateKeeper Rejected, Not Reachable
207 Warning H.323 GateKeeper Rejected, No Authenitcation Configuration
208 Warning H.323 GateKeeper Rejected, No Authenitcation Time
301 Warning IP No Net: The system does not detect any IP connection
1001 Warning High Packet Loss
1002 Warning High Jitter
1003 Warning High Packet Drop
If type = NA
and protocol = NA
and direction = NA
the following will be included:
<Nothing>
LogTag: 1
RemoteNumber:
EncryptionIn: Off/DES/AES-128
EncryptionOut: Off/DES/AES-128
CallRate:
DisconnectCauseValue*:
DisconnectCause*:
Duration:
UptimeAtEndOfCall:
BillingCode:
Audio**: PacketsReceived, PacketsLost, PacketsDropped, DurationLossLevel1, DurationJitterLevel1, NumberOfLevel1Bursts, DurationLossLevel2, DurationJitterLevel2, NumberOfLevel2Bursts
Video**: PacketsReceived, PacketsLost, PacketsDropped, DurationLossLevel1, DurationJitterLevel1, NumberOfLevel1Bursts, DurationLossLevel2, DurationJitterLevel2, NumberOfLevel2Bursts
The DisconnectCause may show as a result of the xhistory Call command and indicates the reason why the call was disconnected. See Call for an overview of the xhistory Call command.
The DisconnectCauseValue may show as a result of the xhistory Call com- munication user is temporarily not addressable at any user-network
mand and contains additional information to the DisconnectCause result. Cause No. 6 - Channel Unacceptable interface.
See Call for an overview of the xhistory Call command.
This cause indicates that the channel most recently identified is not
See DisconnectCause for an overview of the disconnect causes. acceptable to the sending party for use in this call. Cause No. 21 - Call Rejected
Cause No. 7 - call awarded, being delivered in an established chan- This cause indicates that the equipment sending this cause does not
Disconnect Cause Codes nel wish to accept this call, although it could have accepted the call be-
You can also find the list of disconnect causes by opening a web browser This cause indicates that the user has been awarded the incoming cause the equipment sending this cause is neither busy nor incompat-
and enter the IP address of the MPS followed by the filename: call, and that the incoming call is being connected to a channel already
causecd.htm. ible. This cause may also be generated by the network, indicating that
established to that user for similar calls (e.g. packet-mode x.25 virtual the call was cleared due to a supplementary service constraint. The
calls). diagnostic field may contain additional information about the supple-
Example:
http://<ip-address>/causecd.htm mentary service and reason for rejection.
Cause No. 31 - Normal, Unspecified indicated in the diagnostic. Cause No. 57 - Bearer Capability Not Authorized
This cause is used to report a normal event only when no other cause in This cause indicates that the user has requested a bearer capability
the normal class applies. which is implemented by their equipment but the user is not authorized
Cause No. 44 - Requested Circuit/Channel Not Available
to use.
This cause is returned when the circuit or channel indicated by the
Cause No. 34 - No Circuit/Channel Available requesting entity cannot be provided by the other side of the interface.
This cause indicates that there is no appropriate circuit/channel Cause No. 58 - Bearer Capability Not Presently Available
presently available to handle the call. Note: If you receive this call, try This cause indicates that the user has requested a bearer capability
Cause No. 46 - Precedence Call Blocked
another data-service, such as dropping from a 64K to 56K data rate. which is implemented by the equipment which generated this cause but
This cause indicates that there are no pre-emptable circuits or that the
which is not available at this time.
called user is busy with a call of equal or higher pre-emptable level.
Cause No. 35 - Call Queued
This cause indicates that the call has been queued for service by the Cause No. 62 - Inconsistency In Outgoing Information Element
Cause No. 47 - Resource Unavailable, Unspecified
next available device. This cause indicates an inconsistency in the designated outgoing ac-
This cause is used to report a resource unavailable event only when no
cess information and subscriber class.
other cause in the resource unavailable class applies.
Cause No. 38 - Network Out Of Order
This cause indicates that the network is not functioning correctly and Cause No. 63 - Service Or Option Not Available, Unspecified
Cause No. 49 - Quality Of Service Not Available
that the conditions are likely to last a relatively long period of time. This cause is used to report a service or option not available event
This cause is used to report that the requested Quality of Service can-
A call that is attempted soon afterwards will most likely not connect only when no other cause in the service or option not available class
not be provided (delay cannot be supported).
successfully. applies.
Cause No. 81 - Invalid Call Reference Value This cause indicates that the equipment sending this cause has equipment sending the cause to process the message.
This cause indicates that the equipment sending this cause has re- received a request to establish a call which has low layer compatibility,
ceived a message with a call reference which is not currently in use on high layer compatibility, or other compatibility attributes (e.g. data rate)
Cause No. 100 - Invalid Information Element Contents
the user-network interface. which cannot be accommodated.
This cause indicates that the equipment sending this cause has
received and information element which it has implemented; however,
Cause No. 82 - Identified Channel Does Not Exist Cause No. 90 - Non-Existent CUG one or more fields in the information elements are coded in such a way
This cause indicates that the equipment sending this cause has This cause indicates that the specified CUG does not exist. which has not been implemented by the equipment sending this cause.
received a request to use a channel not activated on the interface for
a call. For example, if the user only subscribed to channels 1 to 12
Cause No. 91 - Invalid Transit Network Selection Cause No. 101 - Message Not Compatible With Call State
and channel 13 through 23 is requested by either side, this cause is
This cause indicates that a transit network identification was received This cause indicates that a message has been received which is incom-
generated.
which is of an incorrect format as defined in Annex C/Q.931 patible with the call state.
Cause No. 83 - A Suspended Call Exists, But This Call Identify Does
Cause No. 95 - Invalid Message, Unspecified Cause No. 102 - Recovery On Timer Expiry
Not
This cause is used to report an invalid message event only when no This cause indicates that a procedure has been initiated by the expiry
This cause indicates that a call resume has been attempted with a
other cause in the invalid class applies. of a timer in association with Q.931 error handling procedures.
call identity which differs from that in use for any presently suspended
call(s).
Cause No, 96 - Mandatory Information Element Is Missing Cause No. 103 - Parameter Non-Existent Or Not Implemented -
This cause indicates that the equipment sending this cause has re- Passed On
Cause No. 84 - Call Identity In Use
ceived a message which is missing an information element which must This cause indicates that the equipment sending this cause has
This cause indicates that the network has received a call resume
be present in the message before that message can be processed. received a message which includes parameters not recognized because
request. The call resume request contained a call identity information
the parameters are not defined or are defined but not implemented by
element which presently does not indicate any suspended call within
the equipment sending this cause.
the domain of interfaces over which calls may be resumed. Cause No. 97 - Message Type Non-Existent Or Not Implemented
This cause indicates that the equipment sending this cause has
received a message with a message type it does not recognize either Cause No. 110 - Message With Unrecognized Parameter Discarded
Cause No. 85 - No Call Suspended
because this is a message not defined of defined but not implemented This cause indicates that the equipment sending this cause has
This cause indicates that the network has received a call resume
by the equipment sending this cause. discarded a received message which includes a parameter that is not
request containing a Call identity information element which presently
recognized.
does not indicate any suspended call within the domain of interfaces
over which calls may be resumed. Cause No. 98 - Message Not Compatible With Call State Or Message
Type Non-Existent Or Not Implemented Cause No. 111 - Protocol Error, Unspecified
This cause indicates that the equipment sending this cause has This cause is used to report a protocol error event only when no other
Cause No. 86 - Call Having The Requested Call Identity Has Been
received a message such that the procedures do not indicate that this cause in the protocol error class applies.
Cleared
is a permissible message to receive while in the call state, or a STATUS
This cause indicates that the network has received a call resume re-
message was received indicating an incompatible call state.
quest. The request contained a call identity information element which Cause No. 127 - Interworking, Unspecified
once indicated a suspended call, however, that the call was cleared This cause indicates that there has been interworking which does not
while suspended (either a network time-out or remote user). Cause No. 99 - Information Element / Parameter Non-Existent Or Not provide causes for actions. The precise cause for a message being sent
Implemented is not known.
This cause indicates that the equipment sending this cause has re-
Cause No. 87 - User Not A Member Of CUG
ceived a message which includes information element(s)/parameter(s)
This cause indicates that the called user for the incoming CUG call is
not recognized because the information element(s)/parameter name(s)
not a member of the specified CUG or that the calling user is an ordi-
are not defined or are defined but not implemented by the equip-
nary subscriber calling a CUG subscriber.
ment sending the cause. This cause indicates that the information
element(s)/parameter(s) were discarded. However, the information
Cause No. 88 - Incompatible Destination element is not required to be present in the message in order for the
AuthenticationFailure
Service:
RemoteIPAddress:
Uptime:
Example:
Polling:
*e AuthenticationFailure:
Service: /
RemoteIPAddress: /
Uptime: /
*e/end
Feedback:
*e AuthenticationFailure:
Service: FTP
RemoteIPAddress: “10.47.11.82:1459”
Uptime: 417490
*e/end
CallDisconnected:
CallRef:
LogTag:
Example:
Polling:
*e CallDisconnected:
CallRef: /
LogTag: /
*e/end
Feedback:
*e CallDisconnected:
CallRef: 2
LogTag: 11
*e/end
CallSuccessful:
CallRef:
LogTag:
Protocol:
Direction:
CallRate:
RemoteNumber:
Encryption:
Incoming:
Outgoing:
Example:
Polling:
*e CallSuccessful:
CallRef: /
LogTag: /
Protocol: /
Direction: /
CallRate: /
RemoteNumber: /
Encryption:
Incoming: /
Outgoing: /
*e/end
Feedback:
*e CallSuccessful:
CallRef: 1
LogTag: 12
Protocol: H323
Direction: Outgoing
CallRate: 768
RemoteNumber: “558458”
Encryption:
Incoming: Off
Outgoing: Off
*e/end
DownspeedingFinished:
CallRef:
LogTag:
Rate:
Example:
Polling:
*e DownspeedingFinished:
CallRef: /
LogTag: /
Rate: /
*e/end
Feedback:
*e DownspeedingFinished:
CallRef: 3
LogTag: 7
Rate: 384
*e/end
MessageBoxResult:
Button:
Example:
Polling:
*e MessageBoxResult:
Button: /
*e/end
Feedback:
*e MessageBoxResult:
Button: 1
*e/end
PacketlossDownSpeed:
CallRef:
LogTag:
Example:
Polling:
*e PacketlossDownSpeed:
CallRef: /
LogTag: /
*e/end
SString:
Example:
Polling:
*e SString: /
*e/end
Feedback:
SystemActivity:
Service:
RemoteIPAddress:
Uptime:
Description:
Example:
Polling:
*e SystemActivity:
Service: /
RemoteIPAddress: /
Uptime: /
Description: /
*e/end
Feedback:
*e SystemActivity:
Service: FTP
RemoteIPAddress: “Unknown”
Uptime: 417995
Description: “get all.prm”
*e/end
When you want the codec to startup with the same configura- Example 1
tion for one or more settings you can create startup script.
The script runs automatically when rebooting the codec.
There may be more than one startup script on the codec. To *P xconfiguration audio volume: 10
ensure the script isn’t run too early during the startup proce- *P xconfiguration autoanswer mode: mute
dure, use the following name on the file startup2.prm *P xconfiguration duovideosource: 5
D 13887.09
APRIL 2009 229
Controlling External Cameras
We recommend that you check out the Assume you have your cameras connected to an external
TANDBERG web site regularly for updated
versions of this manual: control system, and that you want to be able to control
http://www.tandberg.com/docs these cameras using the TANDBERG remote or from the
remote site using FECC (Far End Camera Control). To do
this you will need to make use of the Extcam Protocol.
This section of the Reference User Guide explains
Extcam Protocol Basics as well as how to interface to the
TANDBERG WAVE II camera and the TANDBERG Precision
HD camera.
Controlling External Cameras
Extcam Protocol Basics TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 231
Controlling External Cameras
Interfacing to the TANDBERG WAVE II Camera TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
The TANDBERG WAVE II camera uses a RS-232 control interface responses (messages) have the following format: Command and Response Exchange Sequence
that resembles the Sony VISCA protocol. Address byte (1) - Information bytes (1..14) - Terminating byte (1) When the camera receives a command, it responds with either an
The minimum length of any command or response is 3 bytes. ACKNOWLEDGE response, a COMPLETION response or an ERROR
RS232 Parameters 1. Address byte: Let us assume there is one host, i.e. the Codec
response:
The communication parameters for the RS232 interface must be (the host is the unit controlling the camera). The host has address • ACK message: 90-4Y-FF
set to: 0. The four least significant bits of the address byte contain the Returned by camera when it receives the command. No ACK is
• 9600 bits per second address of the receiver. In the case of a broadcast message, the returned for inquiries.
• 8 databits receiver address should be set to 8. When we are operating a • Completion message: 90-5Y-FF (commands) & 90-5Y-…-FF
• No parity single camera, the address is 1. Hence, address bytes in mes- (inquiries)
• 1 stopbit sages from the host are 0x81, and messages from the camera to Returned by the camera when execution of commands and
• No hardware flow control the host are 0x90 (the protocol allows for up to 7 cameras). inquiries are completed.
• No software flow control 2. Message bytes: Any number of bytes containing the actual mes- • Error packets: 90-6Y-…-FF
These parameters are fixed, and are not user configurable. All sage information. Bytes may have any value in the range 0...254. When command or inquiry failed to be executed.
databytes are pure binary information, i.e. the data is not ASCII- The value 255 (i.e. hexadecimal FF) is reserved for the terminating
• Y = socket number
encoded. byte.
Camera contains two buffers so that two commands, including
3. Terminating byte: All messages must be terminated with a byte the commands being executed, can be received.
Message Format containing all 1’s, i.e. decimal 255 (or hexadecimal FF).
There are of course exceptions to these rules:
Commands are initiated from the host (i.e. the codec or any other • An Initialize message will respond as indicated in the table
external controller) to the camera. After a camera has been issued below (this message is in fact a broadcast message, and any
a command, the camera will generate a response. Commands and unit other than the host receiving a broadcast message must
pass it on).
D 13887.09
APRIL 2009 232
Controlling External Cameras > Interfacing to the TANDBERG WAVE II Camera
Commands TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Manual focus on 81 01 04 38 03 FF
Focus in start 81 01 04 08 02 FF
Focus stop 81 01 04 08 00 FF
Zoom stop 81 01 04 07 00 FF
Dzoom off 81 01 04 06 03 FF
Pan/tilt stop 81 01 06 01 03 03 03 03 FF
Pan/tilt direct 81 01 06 02 0p 0t 00 0x 0y 0z 00 00 0u 0v FF p: pan speed, t: tilt speed xyz: pan position, left 1295 - centre 647 - right 0 uv: tilt position, up 248 - centre 172 - down 0
Pan/tilt home 81 01 06 04 FF
Pan/tilt inquiry 81 09 06 12 FF Response: 90 50 00 0x 0y 0z 00 00 0u 0v FF, xyz: pan posistion uv: tilt position
Preset inquiry 81 09 10 0p FF Response: 90 50 00 0x 0y 0z 00 00 0u 0v 00 0q 0r 0s FF, p: preset numer, xyz: pan position, uv: tilt position, qrs: zoom position
AE manual 81 01 04 39 03 FF
D 13887.09
APRIL 2009 233
Controlling External Cameras > Interfacing to the TANDBERG WAVE II Camera
Commands cont... TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
WB manual 81 01 04 35 05 FF
WB one push 81 01 04 10 05 FF
Backlight on 81 01 04 33 02 FF
Backlight off 81 01 04 33 03 FF
Shutter Reset 81 01 04 0A 00 FF
Shutter Up 81 01 04 0A 02 FF
Shutter Down 81 01 04 0A 03 FF
Gain Reset 81 01 04 0B 00 FF
Gain Up 81 01 04 0B 02 FF
Gain Down 81 01 04 0B 03 FF
Bright Reset 81 01 04 0D 00 FF
Bright Up 81 01 04 0D 02 FF
Bright Down 81 01 04 0D 03 FF
IR on 81 01 06 08 02 FF
IR off 81 01 06 08 03 FF
LED on 81 01 33 01 01 FF
LED off 81 01 33 01 00 FF
D 13887.09
APRIL 2009 234
Controlling External Cameras
Interfacing to the Precision HD Camera TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
This document describes how to communicate with the Precision Identification Directly changing the gain value is currently not supported.
HD camera using the VISCA protocol. The Wave 2 interface was The Wave 2 identification command, CAM _ Id _ Inq, is sup- Use the new CAM _ Bright _ Direct command to select a
specified on the previous pages. The Precision HD camera uses ported by the camera. Byte 2 in the reply, counting from 0, will be certain Iris/Gain combination when brightness is in manual mode.
the same interface, with the major differences specified below. 0x0f if this is a PrecisionHD camera.
To find out which software the camera is running, use the CAM _ Whitebalance
Connecting to the Camera Swid _ Inq inquiry command. Note that this inquiry can produce Whitebalance supports auto and manual settings. Currently one
If you intend to use the HDMI output of the camera only, you can a reply up to 128 bytes long. push mode and direct r/b-gain settings are not supported.
use the normal RJ45 connector to communicate with the camera Manual mode is enabled by issuing the CAM _ WB _ Man com-
using VISCA. Focus mand. The CAM _ WB _ Direct command is used to set the
In most cases, however, you probably want to use the high speed Autofocus will automatically be disabled when it locks. So you have value.
serial connection for best image quality. When the camera is oper- to issue a new “Autofocus on” command each time you start a
ated in this mode, you cannot separate the control pins for use in pan/tilt/zoom move. For best results, also issue an “Autofocus on” Gamma
an external control system, since the codec will send important when you stop a move, in case autofocus was locked while moving.
video control commands as VISCA messages over this connection. You may specify which gamma table to use by issuing the CAM _
Gamma _ Set command.
To overcome this problem, you can convert the daisy chain RJ11 Presets
connector on the camera to an extra VISCA control port with the Preset commands are currently not supported. The camera will not
following command: Other
store or activate any presets.
xconfiguration Camera 1 DualVisca: On The camera may be rebooted by issuing a CAM _ Boot command.
Use the CAM _ PTZF _ Set command to directly set the position
The RJ11 connector will then provide a full featured VISCA inter- in one operation.
face.
Brightness, Iris, Gain
Differences from the Wave II Camera
New Commands and Inquiries
Ranges
Command/Inquiry Packet Result/Comments
Pan range is 0..816.
Tilt range is 0..89. CAM_Id_Inq 8x 09 04 22 FF Result: y0 50 pp qq 00 rr FF
Zoom range is 0..2768. pp qq= camera rev
Focus range is 4096..4246. rr= firmware rev
pp = 0x0f for PrecisionHD
Movement Speed CAM_Swid_Inq 8x 09 04 48 FF Result: y0 50 [max 125 bytes of ascii text] ff
The camera does not automatically adjust movement speed CAM_PTZF_Set 8x 01 37 0p 0q 0r 0s 0t 0u 0v 0w 0x 0y 0z 0a ff pqr = pan, st = tilt, uvw= zoom, xyza=focus
depending on zoom level. It is suggested that you use the following
speed values when moving the camera:
CAM_Bright_Direct 8x 01 04 4d 0p 0q 0r 0s ff pqrs = brightness value, range 0..31
Zoom Level Pan Speed Tilt Speed
CAM_WB_Man 8x 01 04 35 05 FF Set manual whitebalance mode. Specify value with CAM_
0..922 6 7
WB_Direct.
923..1845 3 5
CAM_WB_Direct 8x 01 04 75 0p 0q 0r 0s ff pqrs = whitebalance value, range 0..16
1846..2768 1 3
CAM_Gamma_Set 8x 01 3a 0p 0q 0r 0s ff pqrs = gamma table to use, range 0..7
CAM_Boot 81 01 42 ff Reboot the camera.
D 13887.09
APRIL 2009 235
TANDBERG Video Switch
We recommend that you check out the The TANDBERG Video Switch (TVS) is a rack-mountable
TANDBERG web site regularly for updated
versions of this manual: hardware option for TANDBERG 6000 MXP and 3000 MXP
http://www.tandberg.com/docs codecs that delivers the ability to daisy chain multiple HD
cameras and provides support for third party HD cameras.
This section of the Reference User Guide explains the
TANDBERG Video Switch basics as well as how to set up
different daisy chained solutions.
TANDBERG Video Switch
Unpacking the Video Switch TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Rubber feet
(rubber pads)
D 13887.09
APRIL 2009 237
TANDBERG Video Switch
Connecting the Video Switch (I) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
3 Connecting up to four
TANDBERG Precision
HD cameras:
RJ11 – RJ45
RJ11 – RJ45
Primary chain
Connect TANDBERG Video
DB 9–RJ 45
Switch power supply here.
RJ 45 – DB 9
DVI – HDMI
DVI – HDMI
DVI – HDMI
1 2
1. Single 2. Single 3. Dual Mic.1 Mic.2
O DC in USB Audio out Net
D 13887.09
APRIL 2009 238
TANDBERG Video Switch
Connecting the Video Switch (II) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
4 This diagram shows the additional connections needed to expand from using up to four TANDBERG
Precision HD cameras (see previous page) to also include up to three TANDBERG WAVE II cameras
(i.e. up to seven cameras in total). Connect Video Switch power supply as shown overleaf.
S-video – S-video
RJ 45 – DB 9 RJ 45 – DB 9
Secondary chain
TANDBERG RJ 45 – RJ 11
1 8 1 8
2. Aux Video in
3. Doc 4. VCR
PC DVI-I in Audio in RJ45 RJ11
PC Card
3 4 1 2
I
Ethernet Top Top
Camera
Data Video out DVI-I out VCR
1 2
1. Single 2. Single 3. Dual Mic.1 Mic.2
O DC in USB Audio out Net
RJ45 RJ11
Front Front
1 8 1 6
1 2
2 1
3 3
The Codec must be equipped with RJ45–DB9 pinout is described in Camera Socket RJ45
6 4
RJ11
software version F6.1 or higher to sections for Codec 3000 MXP and Codec 6000 MXP. 7 5
D 13887.09
APRIL 2009 239
TANDBERG Video Switch
Connecting the Video Switch (III) TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
5 This diagram shows the connections needed to use a maximum of two analog sources equipped with
component video outputs. Connection diagram uses Sony EVI-HD1 cameras as example. System supports
1280X720p50, 1280X720p59,94, and 1280X720p60 only. For full VISCA control Sony EV1-HDI cameras
or true compatibles must be used. Other units may or may not be partly or fully controllable. Connect Video
Switch power supply as shown overleaf.
Control
Control in
in
RCA – RCA
RCA – RCA
DB 9– Mini DIN
RJ 45 – DB 9
The Codec must be equipped with RJ45–DB9 pinout is described in Camera Socket
SONY Part Numbers: DB9–Mini DIN cable Mini DIN–Mini DIN chain cable
software version F6.1 or higher to sections for Codec 3000 MXP and Codec 6000 MXP.
SONY part number RC893 SONY part number RC815
support the use of the Video Switch.
D 13887.09
APRIL 2009 240
TANDBERG Video Switch
Installation of the Video Switch TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Basic Functionality Since the switch is the first entry in both chains, there is a max of 6 Command Interface – New Commands
cameras per chain. This numbering scheme will be as compatible as
Physical inputs refer to explicit codec input and explicit switch input. Important: All camera commands will get new ranges, Camera
possible with existing camera support. We open up for the possibility
These can only be controlled from the command interface. The com- [1..13] instead of Camera [1..4] . This will work as specified in the
to chain more cameras than 4 in the secondary chain. This will also
mands xconfiguration MainVideoSource, vidin and xconfiguration section above.
be possible when the switch is not connected.
Switch Source always control the inputs directly.
The new commands below are also useful if there is no switch con-
Example: To select physical input 3 on the codec, use xconfiguration xconfiguration Preset [1..15] SwitchVideoSource <0..6> nected.
MainVideoSource: 3, as usual. To see inputs on the switch, select co- Will switch the TANDBERG Video Switch to the given input when the
dec input 1 with xconfiguration MainVideoSource: 1 and select switch preset is activated. xcommand CameraReconfigure
input with xconfiguration Switch Source <1..6>.
Re-configures all cameras connected to the switch or codec. This may
Logical inputs are used when accessing inputs from the menu, re- xconfiguration MainVideoSource/DuoVideoSource <1..6> be useful if you connect new cameras without turning the power off,
mote control and FECC. There are five input buttons on the top of Will not be changed. 1 will mean current input on the switch. since the switch does not auto detect such changes.
the TRC4 remote control, and these can be remapped to any switch
input you wish. The same five buttons are visible in the Presentation/ xconfiguration switch source: <1..6> xcommand CameraUpgrade <1..13> <filename>
Main Video menu, and these will be remapped in the same manner. If Upgrade camera or switch with new software. The software must
Specify which input source to use on the switch. This will only cause a
the switch is connected with no special configuration, selecting “main be put on either /tmp or /user. Camera software files are named
visible change if MainVideoSource is 1.
cam” in the menu will give the current input on the switch. s01692.pkg. Switch software files are named s51200.pkg. Currently
Example: There are two cameras connected to the switch, which we xconfiguration switch config primary: <on/off> only upgrading of the first camera/switch is supported.
want to access from the menu and remote using the “main cam” and
Default is on. If off, the codec will only do a basic setup of the primary
“aux” buttons:
chain and report what kind of cameras are connected. The codec will New Status
xconfiguration Switch LogicalInput 1 Mode: On not set up brightness, whitebalance, gamma etc. for each camera.
xstatus switch
xconfiguration Switch LogicalInput 1 Map: 1 Turn it off if an external control system handles all the configuration.
xconfiguration Switch LogicalInput 2 Mode: On Information about software version and ID will be given by xstatus
xconfiguration Switch LogicalInput 2 Map: 2 camera 1. xstatus switch will give information about sync status for
xconfiguration switch config secondary: <on/off>
the active input, the format, and sync status for all DVI-D inputs.
You can rename the inputs using the standard xconfiguration Vid- Default is on. If off, the codec will only do a basic setup of the second-
eo Inputs Source <1..6> Name or video name: ary chain and report what kind of cameras are connected. The codec xstatus switch
xconfiguration Video Inputs Source 1 Name: “HD Camera 1” will not set up brightness, whitebalance, gamma etc. for each camera.
*s Switch (connected=True):
xconfiguration Video Inputs Source 2 Name: “HD Camera 2” Turn it off if an external control system handles all the configuration.
Input: 1
Format: 1280X720p60
Note: If you select a switch input that has no mapping from the xConfiguration Switch LogicalInput [1..5] Mode: <On/Off> Sync: True
command interface, it will be called Switch-<1..6>. If you select a xConfiguration Switch LogicalInput [1..5] Map: <1..6> Sync 1: True
codec input that has been remapped to the switch from the com- Sync 2: True
Default is LogicalInput [1..5] Mode: Off.
mand interface, it will be called Codec-<1..5>. Sync 3: False
1. Main cam Sync 4: False
2. Aux
Command Interface – Configurations 3. Doc cam Active input may differ from what is given in the xconfiguration Switch
Important: All camera configurations will get new ranges, Camera 4. VCR Source setting. This is because an external control system may also
[1..13] instead of Camera [1..4]. These will behave as follows if a 5. PC change the input.
switch is connected: Remaps the source buttons on top of the extended remote control.
Will also remap inputs selected from the menu, and change FECC ac-
• 1 will be the switch.
cordingly. If mode for a key is on, the table entry will be used to specify
• 2..7 will be cameras connected to secondary chain (chain origi- which input on the switch to activate.
nating from Data port 2 of the switch).
• 8..13 will be cameras connected to the primary chain (chain
originating from Data port 1 of the switch).
D 13887.09
APRIL 2009 241
TANDBERG Video Switch
Communicating with the Video Switch TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Communicating Using VISCA This article covers the use of port 3 as the control VISCA Standard Commands
port for the switch. You may use port 0 if you do
Note! This section applies only to users wanting to
not intend to use the THSI interface, but only use Command Set Command Packet Comments
control the switch directly from an external control
HDMI out.
system connected to Data port 3 on the switch.
CAM_IF_Clear 8x 01 00 01 ff Clear command buffer. Stop any current
The following describes how to communicate with the operation in progress.
TANDBERG Video Switch using the VISCA protocol. Enhanced VISCA
For details about the protocol implementation, refer Since the switch has two possible camera chains, all CAM_Address_Set 8x 30 0p ff p = address for this device. If x=8 (broad-
to the System Integrators Guide – Interfacing to the normally formatted commands will be sent to the pri- cast), increase p with 1 before sending
TANDBERG Wave 2 Camera. mary chain. To access the secondary chain, you must to chain.
first turn Enhanced VISCA on with the SW_eVisca
command. CAM_Command_Cancel 8x 2p ff p = Socket ID. Not supported in TVS
VISCA Interface Basics
Commands going to the secondary chain must be CAM_Power 8x 01 04 00 0p ff p = 2: Power on. p = 3: Power off.
The TANDBERG Video Switch (TVS) uses a RS-232
prefixed with FE 01. Replies from the secondary
control interface that resembles the Sony VISCA
chain will also be prefixed with FE 01. You will only
protocol.
receive push messages from the secondary chain if VISCA Standard Inquiries
TVS is configured in exactly the same way as a Enhanced VISCA is turned on.
VISCA camera. TVS will always be located first in the Command Command Packet Comments
Important: Since the switch can receive VISCA from
camera chain(s).
either the codec or an external control system, and
The main jobs of the VISCA interface in the TVS are: IF_DeviceType_Inq 8x 09 00 02 ff y0 50 gg gg hh hh jj jj kk ff
since there are two possible camera chains, there
gggg = Vendor ID
• Select which video source to use are limitations on how commands are issued and
hhhh = Model ID
• Route VISCA messages to the connected cam- answered:
jjjj = ROM Revision
eras • Only one command can be processed at a time kk = Max sockets
• Control picture resolutions sent to the codec • Sending a new command when you receive an (No support for this in the TANDBERG
Cameras chained to the switch will start with id 2. ACK from a Sony camera is not allowed. ACK mes- Video Switch. Ignore it.)
The codec will automatically recognize this and map sages will be thrown away by the switch
CAM_Power_Inq 8x 09 04 00 ff y0 50 0p ff
the cameras accordingly. • Reply will always go to the source that issued the p = 2: Power on.
command.
p = 3: Power off.
VISCA Serial Ports • Sony push messages will be sent to both
sources.
The switch has a total of 4 serial ports that communi- VISCA Standard Push Messages
cate using the VISCA protocol. If this is not expected behaviour, an external control
system may, of course, be setw to control all con-
• Port 0, on the THSI interface, is always connected nected cameras directly via VISCA. Command Command Packet Comments
to the codec.
• Port 1 is the primary VISCA chain for cameras CAM_Network_Change x0 38 ff This indicates that cameras have been
connected to the Switch. VISCA Messages added to or removed from the camera
Commands that are prefixed with SW_ are new for chain.
• Port 2 is the secondary VISCA chain for the To avoid issues with (some) Sony cam-
cameras that normally are connected to codec the switch. The CAM_ prefix is used for commands
that are copied from TANDBERG Precision HD Cam- eras, the control system or codec should
video inputs 2-5. See the section on Enhanced
era, or are standard VISCA messages. delay 9 seconds before reconfiguring the
VISCA below.
chain.
• Port 3 is intended for external control systems,
and works in the same way as port 0, but with
some limitations on available commands. It is
comparable to running the daisy port on a TAND-
BERG Precision HD Camera in dualvisca mode.
D 13887.09
APRIL 2009 242
TANDBERG Video Switch
Communicating with the Video Switch TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Command Command Packet Comments Command set Command Packet Reply and comments
Command Set Command Packet Comments SW_Input_Push x0 01 40 20 0p ff The input has been changed.
p = the new input source
SW_Input_Set 8x 01 40 20 0p ff Sets which input to use.
p=0..5 SW_Sync_Push x0 01 40 e0 0p Sync state has changed on an input.
This will generate a SW_Input_Push on 0q ff This one will also be sent if the format is
the THSI Visca port if issued from the changed, so if sync is on, send a SW_For-
dual visca port and vice versa. mat_Inq.
p = source 0..5
q = state: 2 = sync, 3 = no sync
Misc.
Command Command Packet Comments
D 13887.09
APRIL 2009 243
TANDBERG Video Switch
Disclaimer and Safety Instructions TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.09
APRIL 2009 244
TANDBERG Video Switch
Product Declaration TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
声 明
此为 A 级产品,在生活环境中,该产品可能会造成无线电干扰。在这
种情况下,可能需要用户对其干扰采取切实可行的措施。
WARNING:
cause radio interference in which case the user may be required to take
adequate measures.
公司 Company Name:
TANDBERG Telecom AS
D 13887.09
APRIL 2009 245
Philip Pedersens vei 20, 1366 Lysaker, Norway
Telephone: +47 67 125 125
Fax: +47 67 125 234
Video: +47 67 117 777
E-mail: [email protected]