User manual POLYCOM VIEWSTATION EX

ViewStation® EX, ViewStation FX, and VS4000 API Guide VS4000 User's Guide April 2003 Edition Release 5.0 1725-10656-004 Trademark Information Polycom®, the Polycom logo design, and ViewStation® are registered trademarks of Polycom Inc. ARENATM, Global Management SystemTM, PathNavigatorTM, Polycom OneDialTM, and Visual ConcertTM are trademarks of Polycom, Inc. in the United States and various other countries. Internet ExplorerTM, NetMeeting®, Windows®, and Windows NT® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Intel®, Pentium®, and Celeron® are registered trademarks and TeamStationTM is a trademark of Intel Corporation. Adobe® Acrobat® is a registered trademark of Adobe Systems Incorporated. ADTRAN® is a registered trademark of ADTRAN, Inc. QuickTimeTM is a trademark of Apple Computer, Inc. Netscape® Navigator® is a registered trademark of Netscape Communications Corporation. IP/TV® is a registered trademark of Cisco Systems, Inc. All other trademarks are the property of their respective owners. Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not responsible for printing or clerical errors. Information in this document is subject to change without notice. Patent Information The accompanying product is protected by one or more U.S. and foreign patents and patents pending held by Polycom, Inc. © 2003 Polycom, Inc. All rights reserved. Polycom Inc. 4750 Willow Road Pleasanton, CA 94588-2708 USA No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Polycom, Inc. Under the law, reproducing includes translating into another language or format. As between the parties, Polycom, Inc. retains title to, and ownership of, all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision. Therefore, you must treat the software like any other copyrighted material (e.g. a book or sound recording). Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not Contents Contents........................................................................................................... i What's New in Release 5.0? ............................................................................ 2 Accessing the API Interface ............................................................................. 3 Using Telnet ........................................................................................ 3 Using the RS-232 Interface................................................................. 3 Connecting the Serial Cable .................................................. 3 Starting a Communications Session ...................................... 4 RS-232 Interface Information ........................................................................... 5 RS-232 User Interface Screen ............................................................ 5 Baud Rate ........................................................................................... 5 RS-232 Modes .................................................................................... 5 Flow Control ........................................................................................ 7 RS-232 Serial Cable Pinout and Connections (ViewStation EX and FX)8 RS-232 Serial Cable Pinout and Connections (VS4000) .................... 9 Status Display .................................................................................................. 10 Using the "listen" or "dial" Command .................................................. 10 B Channel Status Message Example.................................................. 10 Syntax Summary.............................................................................................. 13 About the "get" Subcommand .......................................................................... 14 System Commands.......................................................................................... 15 ! ........................................................................................................... 15 abk ...................................................................................................... 16 adminpassword ................................................................................... 17 advnetstats.......................................................................................... 18 allowabkchanges................................................................................. 20 allowdialing.......................................................................................... 21 allowmixedcalls ................................................................................... 21 allowremotemon.................................................................................. 22 allowusersetup .................................................................................... 22 answer................................................................................................. 23 audioquality ......................................................................................... 23 audioqualityg7221 ............................................................................... 24 autoanswer.......................................................................................... 25 autodiscovernat................................................................................... 26 autoh323dialing................................................................................... 26 backlightcompensation........................................................................ 27 button .................................................................................................. 28 callpreference...................................................................................... 30 © Polycom, Inc. 2003 i ViewStation EX, ViewStation FX, and VS4000 API Guide callstate ............................................................................................... 31 camera ................................................................................................ 32 camera1ptz.......................................................................................... 35 camera4ptz.......................................................................................... 36 cameradirection................................................................................... 36 camerainput......................................................................................... 37 chaircontrol.......................................................................................... 38 colorbar ............................................................................................... 40 country................................................................................................. 40 dataconferencetype............................................................................. 41 daylightsavings.................................................................................... 42 defaultgateway .................................................................................... 42 dhcp..................................................................................................... 43 dial....................................................................................................... 44 dialchannels ........................................................................................ 45 diffserv................................................................................................. 46 dir ........................................................................................................ 46 display call........................................................................................... 47 display whoami.................................................................................... 47 displaybolt ........................................................................................... 48 displayglobaladdresses ....................................................................... 49 displaygraphics.................................................................................... 49 displayipext.......................................................................................... 50 displayipisdninfo .................................................................................. 50 displayparams ..................................................................................... 51 dns....................................................................................................... 52 dynamicbandwidth............................................................................... 53 e164ext................................................................................................ 54 echocanceller ...................................................................................... 55 enablesnapshots ................................................................................. 56 enablesnmp......................................................................................... 56 exit....................................................................................................... 57 farcontrolnearcamera .......................................................................... 57 farloop ................................................................................................. 58 farnametimedisplay ............................................................................. 58 gabk batch........................................................................................... 59 gabpassword ....................................................................................... 59 gabserverip.......................................................................................... 60 gatekeeperip........................................................................................ 61 gatewayareacode ................................................................................ 62 gatewaycountrycode ........................................................................... 63 gatewayext .......................................................................................... 64 gatewaynumber................................................................................... 65 gatewaynumbertype ............................................................................ 66 ii www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayprefix ...................................................................................... 67 gatewaysetup ...................................................................................... 68 gatewaysuffix ...................................................................................... 69 gendial................................................................................................. 70 generatetone ....................................................................................... 70 get screen ........................................................................................... 71 gmscity ................................................................................................ 71 gmscontactemail ................................................................................. 72 gmscontactfax ..................................................................................... 73 gmscontactnumber.............................................................................. 74 gmscontactperson............................................................................... 75 gmscountry.......................................................................................... 76 gmsstate.............................................................................................. 77 gmstechsupport................................................................................... 78 gmsurl ................................................................................................. 79 graphicsmonitor................................................................................... 80 graphicsmonitorfxvga .......................................................................... 81 graphicsmonitortv................................................................................ 81 graphicsmonitorvisualconcert.............................................................. 82 h323name ........................................................................................... 83 hangup ................................................................................................ 84 help ..................................................................................................... 84 hires .................................................................................................... 86 history.................................................................................................. 87 hostname ............................................................................................ 88 ipaddress............................................................................................. 89 ipdialspeed .......................................................................................... 90 ipprecedence....................................................................................... 91 ipstat.................................................................................................... 92 keypadaudioconf ................................................................................. 93 language ............................................................................................. 93 lanport ................................................................................................. 94 lanstat.................................................................................................. 95 listen.................................................................................................... 97 maxgabinternationalcallspeed............................................................. 98 maxgabinternetcallspeed .................................................................... 99 maxgabisdncallspeed.......................................................................... 100 maxtimeincall ...................................................................................... 101 mcupassword ...................................................................................... 102 meetingpassword ................................................................................ 103 mpautoanswer..................................................................................... 104 mpmode .............................................................................................. 105 mute .................................................................................................... 106 muteautoanswercalls .......................................................................... 107 © Polycom, Inc. 2003 iii ViewStation EX, ViewStation FX, and VS4000 API Guide nearloop .............................................................................................. 107 netmeetingip........................................................................................ 108 netstats................................................................................................ 109 numdigitsdid ........................................................................................ 110 numdigitsext ........................................................................................ 111 numberofmonitors ............................................................................... 112 outboundcallroute................................................................................ 112 pause................................................................................................... 113 pcport .................................................................................................. 113 ping...................................................................................................... 114 pip........................................................................................................ 115 preferredalias ...................................................................................... 115 preset .................................................................................................. 116 primarycallchoice................................................................................. 117 primarycamera .................................................................................... 118 queuecommands................................................................................. 119 registerthissystem ............................................................................... 119 repeat .................................................................................................. 120 requireacctnumtodial ........................................................................... 121 roomphonenumber .............................................................................. 122 rs232 ................................................................................................... 123 run ....................................................................................................... 124 screen.................................................................................................. 124 secondarycallchoice ............................................................................ 125 sendonlypreferredalias ........................................................................ 126 serialnum............................................................................................. 126 setaccountnumber............................................................................... 127 showaddrsingab .................................................................................. 127 showpopup .......................................................................................... 128 sleep.................................................................................................... 129 slides ................................................................................................... 129 snapshot.............................................................................................. 130 snapshotcamera.................................................................................. 131 snapshottimeout .................................................................................. 132 snmpadmin.......................................................................................... 133 snmpcommunity .................................................................................. 134 snmpconsoleip .................................................................................... 135 snmplocation ....................................................................................... 135 soundeffectsvolume ............................................................................ 136 stdout................................................................................................... 137 stream ................................................................................................. 137 streamannounce.................................................................................. 138 streamaudioport .................................................................................. 139 streamenable....................................................................................... 140 iv www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide streammulticastip ................................................................................ 140 streamrestoredefaults ......................................................................... 141 streamrouterhops ................................................................................ 142 streamspeed ....................................................................................... 143 streamvideoport .................................................................................. 143 subnetmask......................................................................................... 144 systembehindnat ................................................................................. 145 systemname........................................................................................ 146 t120nameip ......................................................................................... 147 tcpports ............................................................................................... 148 techsupport ......................................................................................... 148 teleareacode ....................................................................................... 149 telecountrycode................................................................................... 150 telenumber .......................................................................................... 151 testlan arp ........................................................................................... 152 testlan dcuinfo ..................................................................................... 152 testlan dns........................................................................................... 153 testlan echo......................................................................................... 153 testlan ping.......................................................................................... 155 textinput............................................................................................... 156 timediffgmt........................................................................................... 156 typeofservice ....................................................................................... 157 udpports .............................................................................................. 157 usefixedports....................................................................................... 158 usegatekeeper .................................................................................... 159 usepathnavigator................................................................................. 160 validateacctnum .................................................................................. 162 vcbutton............................................................................................... 162 vcraudioout.......................................................................................... 163 vcrrecordsource .................................................................................. 164 version................................................................................................. 164 vgahorizpos......................................................................................... 165 vgaoffmode ......................................................................................... 165 vgaphase............................................................................................. 166 vgaresolution....................................................................................... 167 vgavertpos........................................................................................... 167 volume................................................................................................. 168 waitfor.................................................................................................. 169 wake.................................................................................................... 170 wanipaddress ...................................................................................... 170 whoami................................................................................................ 171 widescreenvideo ................................................................................. 171 winsresolution ..................................................................................... 172 winsserver ........................................................................................... 173 © Polycom, Inc. 2003 v ViewStation EX, ViewStation FX, and VS4000 API Guide ISDN BRI Commands ...................................................................................... 174 isdnareacode....................................................................................... 174 isdncountrycode .................................................................................. 175 isdndialingprefix................................................................................... 176 isdndialspeed ...................................................................................... 177 isdnnum............................................................................................... 178 spidnum............................................................................................... 179 ISDN PRI Commands ...................................................................................... 180 priareacode ......................................................................................... 180 pricallbycall.......................................................................................... 181 prichannel............................................................................................ 182 pricsu................................................................................................... 184 pridialchannels .................................................................................... 185 priintlprefix ........................................................................................... 186 prilinebuildout ...................................................................................... 187 prilinesignal ......................................................................................... 188 prinumber ............................................................................................ 189 prinumberingplan................................................................................. 190 prioutsideline ....................................................................................... 191 priswitch .............................................................................................. 192 V.35/RS-449/RS-530/RS-366 Commands ....................................................... 193 cts........................................................................................................ 193 dcd....................................................................................................... 193 dcdfilter................................................................................................ 194 dsr ....................................................................................................... 195 dsranswer............................................................................................ 195 dtr ........................................................................................................ 196 h331audiomode................................................................................... 197 h331framerate ..................................................................................... 198 h331videoprotocol ............................................................................... 199 h331videoformat.................................................................................. 199 rs366dialing ......................................................................................... 200 rt .......................................................................................................... 201 rts ........................................................................................................ 201 st.......................................................................................................... 202 v35broadcastmode.............................................................................. 203 v35debug............................................................................................. 203 v35dialingprotocol ............................................................................... 204 v35num................................................................................................ 204 v35portsused....................................................................................... 205 v35prefix.............................................................................................. 206 v35profile............................................................................................. 207 v35suffix .............................................................................................. 209 vi www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide This document describes the CGI-based ViewStation EX, ViewStation FX, and VS4000 API (Application Programming Interface). This API is a set of commands implemented within the shell. The commands are available for advanced users who want to automate some of the control features of the ViewStation EX, ViewStation FX, and VS4000 systems. This API can be used via a Telnet session or via the RS-232 interface. It is presumed that users are familiar with Web programming, specifically the CGI POST command and its use from the application programming language of their choice. © Polycom, Inc. 2003 1 ViewStation EX, ViewStation FX, and VS4000 API Guide What's New in Release 5.0? The following table lists the major changes for Release 5.0. Type of Command system Command allowmixedcalls audioqualityg7221 camera near move Change new command new command When you are not in a call: All camera near move commands need to be preceded by a button near command. removed removed new command new command new command new command new command new command new command new command new command new command new command All V.35 commands can also be used to configure the RS-449, RS-530, and RS-366 serial interfaces. display tmon display multiwaymode displaygraphics enablesnapshots graphicsmonitorfxvga graphicsmonitortv graphicsmonitorvisualconcert maxgabinternationalcallspeed maxgabinternetcallspeed sendonlypreferredalias sleep usepathnavigator wake V.35 all V.35 commands 2 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Accessing the API Interface Using Telnet To start a Telnet session from Windows: 1. From your computer desktop, click Start and Run. 2. In the Run window, enter the following information in the Open field: telnet 24 Note Telneting to port 24 keeps the user from seeing all the debug outputs which can be extensive and inconvenient. 3. Click OK. The Telnet window appears, and a welcome message is displayed (Ex: ''Hi, My name is: John_System''). This message is followed by information specific to your system. 4. You are now in an active Telnet session. To display the list of available API commands, type help. To start a Telnet session from MS-DOS: 1. Start an MS-DOS session on your PC and type: telnet 24 2. Press the Enter key. A welcome message is displayed (Ex: ''Hi, My name is: John_System''). This message is followed by information specific to your system. 3. You are now in an active Telnet session. To display the list of available API commands, type help. Using the RS-232 Interface Connecting the Serial Cable VS4000 The RS-232 serial cable has a 9-pin DB-9 connector on both ends. It is used to connect the VS4000 system to a terminal or another communications device. To connect your PC to the VS4000 system: © Polycom, Inc. 2003 3 ViewStation EX, ViewStation FX, and VS4000 API Guide 1. Locate the RS-232 serial cable (DB9-to-DB9 straight through). 2. Connect one end of the cable to the serial port of your PC. 3. Connect the other end to the RS-232 serial port on the back panel of the VS4000 system. ViewStation EX and ViewStation FX Connect your PC to the ViewStation EX or FX system as follows: 1. Locate the RS-232 serial cable (DB9-to-8-pin mini-DIN). 2. Connect the 9-pin DB-9 connector to the serial port of your PC. 3. Plug in the 8-pin mini-DIN connector to the RS-232 port on the back panel of the system. Starting a Communications Session Several communications programs are available to access the RS-232 interface. The following explains how to start a HyperTerminal session on your PC. 1. From your PC desktop, select Start>Programs>Accessories> Communications>HyperTerminal. 2. In the Connection Description window, enter a Name. Select an icon. Click OK. 3. In the Connect To window, from the Connect Using list, select the proper comport (usually com1). Click OK. 4. In the Com1 Properties window, under Port Settings, select the following settings: · · · · · Bits per second=should match that of the system (default is 9600) Data bit=8 Parity=none Stop bits=1 Flow control=should match the system's. None is the default. Some third-party control panels may require to be set to Hardware. A carriage return is required before an RS-232 communications session with a system can proceed. 5. Click OK. Note 4 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide RS-232 Interface Information The following provides additional information about the ViewStation EX, ViewStation FX, and VS4000 systems' RS-232 interface. RS-232 User Interface Screen The RS-232 user interface screen is used to set the baud rate and the modes for the serial port on the back of the system. To access the RS-232 screen on your system, select System Info>Admin Setup>Software/Hardware> RS-232. On the RS-232 screen, you can configure the Baud Rate, the RS-232 Mode and the Flow Control options. Baud Rate The following baud rates are supported by the RS-232 port on the ViewStation EX, ViewStation FX, and the VS4000 system: · · · · · · · · 1200 2400 9600 14400 19200 38400 57600 115200 RS-232 Modes The RS-232 port on the ViewStation EX, ViewStation FX, and the VS4000 system supports two modes: Control and Pass-Thru. In Control Mode, a device (for example, a PC) connected to the RS-232 port can control the system using the Remote Control API. In Pass-Thru Mode, the operational modes of both endpoints' RS-232 ports depend on the port configuration of each endpoint. Thus, two operational situations might arise: © Polycom, Inc. 2003 5 ViewStation EX, ViewStation FX, and VS4000 API Guide · · Pass-Thru Mode to Pass-Thru Mode: Both endpoints are set to Pass-Thru Mode. Pass-Thru Mode to Control Mode: The near site is set to Pass-Thru Mode and the far site is set to Control Mode. Operational Modes: The following information describes operational modes in more detail. · Pass-Thru Mode to Pass-Thru Mode--Two stations set to Pass-Thru Mode behave essentially as a null-modem between their respective externally connected devices. These two stations can be two ViewStation EX systems, two ViewStation FX systems, two VS4000 systems, or one ViewStation EX system and one ViewStation FX or VS4000 system. The RS-232 port is used as a data channel over an H.320 video call. Data received from the RS-232 port on the near-end system is pushed through the call to the far-end endpoint and then transmitted to the endpoint's RS-232 port. Similarly, data from the far-end endpoint is transmitted back to the near-end system (through the H.320 call) and then transmitted to the near-end RS-232 port. The data channel speed is dynamically allocated. The maximum data flow rate is based on the bandwidth of the call. Because data throughput has priority over video throughput, video bandwidth may be restricted to support data requirements. Audio is not compromised. Pass-Thru Mode is a proprietary feature that is only supported when both endpoints are either ViewStation EX, ViewStation FX, or VS4000 systems. The RS-232 port only supports data Pass-Thru in H.320 mode (ISDN or V.35/RS-449/RS-530/RS-366/RS-366). Data Pass-Thru in an H.323 (IP) video call or multipoint call is not supported, as alternative file transfer methods such as ftp or Telnet are widely available. Note In Pass-Thru mode, both local and remote stations need to be set to the same data rate. · Pass-Thru Mode to Control Mode--If the near site is set to Pass-Thru Mode, but the far site is set to Control Mode, then the device connected to the near site RS-232 port can be used to 6 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide control the far site system, using the far site's Command Line Interface. The following table summarizes the port operation based on the RS-232 mode configured by each endpoint. Near-Side Mode Control Pass-Thru Pass-Thru Far-Side Mode N/A Control Pass-Thru Resulting Operation Near-side CLI (Command Line Interface) The near-side controls the CLI of the far side The data is passed in full-duplex mode from the near-side RS-232 port to the far-side RS-232 port Flow Control The system support hardware flow control. Users should make sure that hardware flow control settings are consistent between the systems and the external devices on both sides of the connection. © Polycom, Inc. 2003 7 ViewStation EX, ViewStation FX, and VS4000 API Guide RS-232 Serial Cable Pinout and Connections (ViewStation EX and FX) The RS-232 serial cable has a 9-pin DB-9 connector on one end and an 8-pin mini-DIN connector on the other end. It is used to connect the ViewStation EX or ViewStation FX to a terminal or another communications device. Pin Number 1 - DCD 2 - RX 3 - TX 4 - DTR 5 - GND 6 - DSR 7 - RTS 8 - CTS 9 - RI Function Data Carrier Detect Receive Transmit Data Terminal Ready Ground Data Set Ready Ready to Send Clear to Send This pin is not used. 8 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide RS-232 Serial Cable Pinout and Connections (VS4000) The RS-232 serial cable has a 9-pin DB-9 connector on both ends. It is used to connect the VS4000 to a terminal or another communications device. Pin Number 1 - DCD 2 - RX 3 - TX 4 - DTR 5 - GND 6 - DSR 7 - RTS 8 - CTS 9 - RI Function Data Carrier Detect Receive Transmit Data Terminal Ready Ground Data Set Ready Ready to Send Clear to Send This pin is not used. © Polycom, Inc. 2003 9 ViewStation EX, ViewStation FX, and VS4000 API Guide Status Display The call status can be displayed in a number of ways. The display call status command shows table of current calls. Using the "listen" or "dial" Command To display real-time status on individual B channels (incoming/outgoing calls), either register the terminal session with the listen command or start an outbound call with the dial command. These two commands will cause the system to re-direct the B channel status messages to the session which has issued one of these two commands. For example, if the RS-232 device issues a dial or listen command, then call status is directed to the RS-232 port; if a later session on a Telnet port issues a dial or listen command, then call status is also directed to that Telnet port. B Channel Status Message Example Following is an output example for B channel status messages, where: cs RINGING indicates call status for one B channel. indicates a ring-in or ring-out and is equivalent to a 25% blue sphere on the graphical user interface. is equivalent to a 50% yellow sphere. indicates the bonding protocol is operational on the channel and is equivalent to a 75% orange sphere. is equivalent to a 100% green sphere. CONNECTED BONDING COMPLETE Example: ->dial man 384 5551212 ISDN Dialing manual Dialing 5551212 384 none ISDN cs: call[0] chan[0] dialstr[95551212] state[RINGING] cs: call[0] chan[0] dialstr[95551212] state[CONNECTED] 10 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide cs: call[0] chan[0] dialstr[95551212] state[BONDING] cs: call[0] chan[0] dialstr[95551212] state[COMPLETE] cs: call[0] chan[1] dialstr[95551212] state[RINGING] cs: call[0] chan[1] dialstr[95551212] state[CONNECTED] cs: call[0] chan[2] dialstr[95551212] state[RINGING] cs: call[0] chan[3] dialstr[95551212] state[RINGING] cs: call[0] chan[2] dialstr[95551212] state[CONNECTED] cs: call[0] chan[3] dialstr[95551212] state[CONNECTED] cs: call[0] chan[4] dialstr[95551212] state[RINGING] cs: call[0] chan[5] dialstr[95551212] state[RINGING] cs: call[0] chan[4] dialstr[95551212] state[CONNECTED] cs: call[0] chan[5] dialstr[95551212] state[CONNECTED] cs: call[0] chan[1] dialstr[95551212] state[BONDING] cs: call[0] chan[2] dialstr[95551212] state[BONDING] cs: call[0] chan[3] dialstr[95551212] state[BONDING] cs: call[0] chan[4] dialstr[95551212] state[BONDING] cs: call[0] chan[5] dialstr[95551212] state[BONDING] cs: call[0] chan[0] dialstr[95551212] state[COMPLETE] cs: call[0] chan[1] dialstr[95551212] state[COMPLETE] cs: call[0] chan[2] dialstr[95551212] state[COMPLETE] cs: call[0] chan[3] dialstr[95551212] state[COMPLETE] cs: call[0] chan[4] dialstr[95551212] state[COMPLETE] cs: call[0] chan[5] dialstr[95551212] state[COMPLETE] active: call[0] speed[384] -> ->hangup video 0 hanging up video call cleared:call[0] line[1] bchan[0] cause[16] dialstring[95551212] cleared:call[0] line[2] bchan[0] cause[16] dialstring[95551212] cleared:call[0] line[0] bchan[0] cause[16] dialstring[95551212] cleared:call[0] line[1] bchan[1] cause[16] dialstring[95551212] cleared: call[0] line[2] bchan[1] cause[16] dialstring[] cleared: call[0] line[0] bchan[1] cause[16] dialstring[95551212] ended call[0] -> listen video listen video registered © Polycom, Inc. 2003 11 ViewStation EX, ViewStation FX, and VS4000 API Guide -> ->listen video ringing // there is an incoming call, auto answer is on ->cs: call[0] chan[0] dialstr[8005551212] state[RINGING] cs: call[0] chan[0] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[0] dialstr[8005551212] state[BONDING] cs: call[0] chan[0] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[1] dialstr[8005551212] state[RINGING] cs: call[0] chan[1] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[2] dialstr[8005551212] state[RINGING] cs: call[0] chan[3] dialstr[8005551212] state[RINGING] cs: call[0] chan[2] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[3] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[6] dialstr[8005551212] state[RINGING] cs: call[0] chan[6] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[4] dialstr[8005551212] state[RINGING] cs: call[0] chan[5] dialstr[8005551212] state[RINGING] cs: call[0] chan[4] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[5] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[7] dialstr[8005551212] state[RINGING] cs: call[0] chan[7] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[1] dialstr[8005551212] state[BONDING] cs: call[0] chan[2] dialstr[8005551212] state[BONDING] cs: call[0] chan[3] dialstr[8005551212] state[BONDING] cs: call[0] chan[6] dialstr[8005551212] state[BONDING] cs: call[0] chan[4] dialstr[8005551212] state[BONDING] cs: call[0] chan[5] dialstr[8005551212] state[BONDING] cs: call[0] chan[7] dialstr[8005551212] state[BONDING] cs: call[0] chan[0] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[1] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[2] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[3] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[6] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[4] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[5] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[7] dialstr[8005551212] state[COMPLETE] active: call[0] speed[512] 12 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Syntax Summary The following syntactic notation is used for the API shell control commands. Note All defined commands are case sensitive. A required parameter. The text between the angled brackets is one or more parameter(s) that can occur at the specified point in the command. Multiple parameters are listed separated by the "|" character (pipe) which is a notational shortcut for "or." If the text between the angled brackets is in parenthesis, then it is a user comment of the expected parameter, rather than an enumeration of the valid parameters. Example allowdialing [x] An optional parameter. As with required parameters, optional parameters may be presented with a '|' character (pipe) to indicate choices. Example gabpassword ["password"] .. Indicates a range of values. Example displaybolt "x" String parameters to be supplied by the user are denoted with quoted strings (example: "symbol"). In general, parameters are supplied from a set of defined string values that are specifically enumerated. These values are command specific. Note: a quoted string parameter can contain any value. Example The command gabpassword ["password"] requires that the user supply the string parameter password as shown in the following example: gabpassword set MyPassword © Polycom, Inc. 2003 13 ViewStation EX, ViewStation FX, and VS4000 API Guide If the string parameter contains a compound name or spaces, use quotation marks, as in the following examples: gabpassword set "My FX Password" gabpassword set "111 222 333" {a..b} A number ranging from a to b. About the "get" Subcommand In most cases, the get subcommand returns the command name and the current setting if one has been set. Example 1 gmscountry get Response gmscountry france The current setting for the command gmscountry is france. Example 2 gmscountry get Response gmscountry The current setting for the command gmscountry is meaning that no parameter has been set. 14 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide System Commands This section describes each shell command and its parameters. All commands are listed with their parameters spelled out. ! !<"str"|{1..64}> Description This command allows you to execute a previously used command starting with a specific number or letter from the history list. For more information about the history list, refer to history. str 1..64 Executes the last command that begins with the specified str from the history list. Range of command entries in the history list. Executes the specified Nth command in the history list. There is no space between the ! command and the following parameter (for example, !gat or !5 are correct. ! gat is incorrect). Note Example The following is a Telnet session sample: ->gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? ->hangup video hanging up video call ->history 1 gatewaynumber set 123456789 2 hangup video 3 history Consequently, each of the following ! commands execute the command and print its output from the history list. ->!1 © Polycom, Inc. 2003 15 ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? ->!2 hangup video hanging up video call ->!h hangup video hanging up video call ->!hi history 1 gatewaynumber set 123456789 2 hangup video 3 history 4 gatewaynumber set 123456789 5 hangup video 6 hangup video 7 history ->!gat gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? ->history 1 gatewaynumber set 123456789 2 hangup video 3 history 4 gatewaynumber set 123456789 5 hangup video 6 hangup video 7 history 8 gatewaynumber set 123456789 9 history abk abk Subcommands abk batch <{0..59}> 16 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide abk all abk letter <{a..z}> abk range <{a..b}> Description This command displays local Address Book entries. batch all letter range a..z a..b Displays a batch of 10 records. The maximum number of batches that can be displayed is 59. Displays all the records in the Address Book. Displays entries beginning with the letter specified from the range {a..z}. Displays local Address Book entries numbered a through b. Requires a parameter from {a..b}. Valid characters are: -, _, /, ;, @, ,, ., \, 0 through 9, a through z. Integers specifying a range of local entries. Examples abk batch 0 Displays records 0 through 9. abk range 2 8 Displays Address Book entries 2 through 8. adminpassword adminpassword ["password"] adminpassword set ["password"] adminpassword set adminpassword get Description This command is used to set the administrator password. © Polycom, Inc. 2003 17 ViewStation EX, ViewStation FX, and VS4000 API Guide Note This command cannot be accessed through the RS-232 port. Sets the password used for remote management of the system if followed by the password parameter. If you want to erase the current setting, omit the password parameter. The system must have an admin password set before this command works. Displays the current admin password. set get password Valid characters are: a through z (lower and uppercase), -, _, @, /, ;, ,, ., \, 0 through 9. The length is limited to 10 characters. Note Use quotation marks around a compound name or strings containing spaces (Ex: "united states" or "111 222 333"). Examples adminpassword set MyFXpsswd adminpassword set "EX 2003" User Interface Screen Location System Info>Admin Setup>Security: Admin Password advnetstats advnetstats [{0..2}] advnetstats Description This command is used to get advanced network statistics for each call. 0..2 Range of selectable calls in a multipoint call (maximum number of concurrent calls=3, where 0 is call #1, 1 is call #2, and 2 is call #3). Select a number from this range to specify a remote site call for which you want to obtain advanced network statistics. 18 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Examples advnetstats advnetstats 1 Sample Output call:1 tar:24k rar:24k tvr:64.3k rvr:104k tvru:63.8k rvru:114.6k tvfr:15.0 rvfr:15.0 vfe --tapl:66 rapl:0 taj:46mS raj:40mS tvpl:122 rvpl:0 tvj:21mS rvj:60mS dc:--- rsid:Polycom_VS4000_5.0 where: tar rar tvr rvr tvru rvru tvfr rvfr vfe tapl tlsdp rapl rlsdp taj tlsdr raj rlsdp tvpl tmlpp rvpl rmlpp tvj Transmit audio rate Receive audio rate Transmit video rate Receive video rate Transmit video rate used Receive video rate used Transmit video frame rate Receive video frame rate Video FEC errors Transmit audio packet loss (H.323 calls only) Transmit LSD protocol (H.320 calls only) Receive audio packet loss (H.323 calls only) Receive LSD protocol (H.320 calls only) Transmit audio jitter (h.323 calls only) Transmit LSD rate (H.320 calls only) Receive audio jitter (H.323 calls only) Receive LSD rate (H.320 calls only) Transmit video packet loss (H.323 calls only) Transmit MLP protocol (H.320 calls only) Receive video packet loss (H.323 calls only) Receive MLP protocol (H.320 calls only) Transmit video jitter (H.323 calls only) © Polycom, Inc. 2003 19 ViewStation EX, ViewStation FX, and VS4000 API Guide tmlpr rvj rmlpr dc rsid Transmit MLP rate (H.320 calls only) Receive video jitter (H.323 calls only) Receive MLP rate (H.320 calls only) Data conference Remote system id User Interface Screen Location System Info>Diagnostics>Advanced Stats allowabkchanges allowabkchanges Description This command enables or disables the Allow Address Book Changes option. If this option is enabled, the user has access to the New, Edit, and Delete icons in the Address Book screen. yes no get Enables the Allow Address Book Changes option. Disables the Allow Address Book Changes option. Displays the current setting (yes or no). Example allowabkchanges get User Interface Screen Location System Info>Admin Setup>General Setup (page 2-Next): Allow Address Book Changes 20 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide allowdialing allowdialing Description This command enables or disables the Allow Dialing option. yes no get Allows users to place calls. Disables dialing. Your system can only receive calls. Displays the current setting (yes or no). Example allowdialing get User Interface Screen Location System Info>Admin Setup>General Setup: Allow Dialing allowmixedcalls allowmixedcalls Description This command allows the administrator to disable the ability to place or received mixed-protocol (IP and ISDN), multipoint calls for security reasons. Note The option Allow H.320 and H.323 Mixed Calls is only visible on screen if the the ISDN Video Calls (H.320) option has been enabled on the Call Preferences screen. Allows mixed IP and ISDN calls. Disables mixed IP and ISDN calls. Displays the current setting (yes or no). yes no get © Polycom, Inc. 2003 21 ViewStation EX, ViewStation FX, and VS4000 API Guide Example allowmixedcalls yes User Interface Screen Location System Info>Admin Setup>Video Network > Call Preferences: Allow H.320 and H.323 Mixed Calls allowremotemon allowremotemon Description This command displays the current state of the Allow Remote Monitoring option. get Displays the current setting (yes or no). Example allowremotemon get User Interface Screen Location System Info>User Setup: Allow Remote Monitoring allowusersetup allowusersetup Description This command enables or disables the User Setup icon on the System Information screen of the user interface, thus allowing or preventing access to the User Setup screen. This option is useful to prevent users from changing the User Setup functions. yes no get Enables the User Setup option. Disables the User Setup option. Displays the current setting (yes or no). 22 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Example allowusersetup yes User Interface Screen Location System Info>Admin Setup>General Setup (page 2-Next): Allow User Setup answer answer Description This command answers incoming video or POTS calls. phone video Answers incoming POTS calls. Answers incoming video calls when the Auto Answer Point to Point or Auto Answer Multipoint option is set to No. Example answer phone audioquality audioquality audioquality set <64|112|128|168|192|224|256| 280|320|336|384|392|448|512> audioquality get Description This command sets the call speed threshold that determines which audio protocol is used. At the selected speed or lower, the system uses the G.728 audio protocol. Above the selected speed, the system uses the G.722 audio protocol. © Polycom, Inc. 2003 23 ViewStation EX, ViewStation FX, and VS4000 API Guide set Sets the call speed threshold value. Requires a parameter from <64|112|128|168|192|224|256|280| 320|336|384|392|448|512>. Displays the current threshold value of the call. Range of selectable speeds. get 64..512 Example audioquality set 168 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Audio Quality audioqualityg7221 audioqualityg7221 audioqualityg7221 set <64|112|128|168|192|224| 256|280|320|336|384|392|448|512> audioqualityg7221 get Description This command sets the call speed threshold that determines which audio protocol is used. At the selected speed or lower, the system uses the G.722.1 audio protocol. Above the selected speed, the system uses the G.722 audio protocol. G.722.1 supports enhanced frame loss concealment and works automatically and transparently between systems supporting this audio standard. This is based on an algorithm that detects and replaces missing speech data, thus maintaining high-quality audio. set Sets the call speed threshold value. Requires a parameter from <64|112|128|168|192|224|256|280| 320|336|384|392|448|512>. Displays the current threshold value of the call. Range of selectable speeds. get 64..512 24 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Example audioqualityg7221 set 256 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Audio Quality autoanswer autoanswer Description This command sets the Auto Answer Point to Point mode which determines how the system will handle an incoming call in a point-to-point video conference. yes no If the option Auto Answer Point to Point is set to yes, any incoming call will be connected automatically. If the option Auto Answer Point to Point is set to no and there is an incoming call, the user will be prompted with a message "You have a video call. Would you like to answer?". This message can be followed by a far-site video number and a far-site name if they are available. If the user selects yes, the call will be answered. If the user selects no, the call will be rejected. The factory default is set to yes. donotdisturb If the option Auto Answer Point to Point is set to donotdisturb, the user is not notified of the incoming call. The site which placed the call receives a Far Site Busy code (H.320) or Call Rejected (H.323). get Displays the status of the option (yes, no, or donotdisturb). Example autoanswer donotdisturb User Interface Screen Location System Info>Admin Setup>Genera Setupl: Auto Answer Point to Point © Polycom, Inc. 2003 25 ViewStation EX, ViewStation FX, and VS4000 API Guide autodiscovernat autodiscovernat Description This command enables or disables the Auto Discover NAT option. yes Enables the option to automatically assign the WAN IP address that is used to place and receive calls outside the WAN. Disables the option. Displays the current setting (yes or no). no get Example autodiscovernat yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>Firewall/LAN Connection: Auto Discover NAT autoh323dialing autoh323dialing Description This command enables or disables the Auto H.323 Dialing option. This option is enabled by default to let the system auto-detect the type of call you are placing (IP or ISDN) based on the video number format. yes Enables the option. When this option is enabled, the ISDN and H.323 fields are not visible on the Video Phone screen. Disables the option. no 26 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide get Displays the current setting (yes or no). Example autoh323dialing yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Setup: Auto H.323 Dialing backlightcompensation backlightcompensation Description This command enables or disables the Backlight Compensation option. yes no get Enables Backlight Compensation. The camera automatically adjusts for a bright background. Disables the option. Displays the current setting (yes or no). Example backlightcompensation no User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras: Backlight Compensation © Polycom, Inc. 2003 27 ViewStation EX, ViewStation FX, and VS4000 API Guide button button <#|*|1|2|3|4|5|6|7|8|9|0|auto| callhangup|camera|delete|directory|down|far| home|info|keyboard|left|lowbattery| menu|mute|near|period|pickedup|pip|preset| putdown|right|select|slides|snapshot|up| volume+|volume-|zoom+|zoom-> Description This command allows the user to send the same command as the Polycom remote control to the user interface. Note that several parameters can be combined in the same command in any order. The command is not checked prior to being sent to the user interface. Care should be used because a bong (a warning noise) sound is sent from the system if there is no function for that button on the currently active screen. # * 1 2 3 4 5 6 7 8 9 0 auto camera Issues the # key to the user interface. Issues the * key to the user interface. Issues the 1 key to the user interface. Issues the 2 key to the user interface. Issues the 3 key to the user interface. Issues the 4 key to the user interface. Issues the 5 key to the user interface. Issues the 6 key to the user interface. Issues the 7 key to the user interface. Issues the 8 key to the user interface. Issues the 9 key to the user interface. Issues the 0 key to the user interface. Sends the Auto key to the user interface. Not implemented. callhangup Sends the Call.Hang-Up key to the user interface. 28 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide delete directory down far home info Not implemented. Takes the user to the Address Book screen. Sends the down key to the user interface (down arrow). Sends the Far key to the user interface. Takes the user to the main screen. Sends the Info command to the user interface. keyboard Brings up the on-screen keyboard if the cursor is on a text field. left Sends the left (left arrow) command to the user interface. Sends the Menu key to the user interface causing it to back up one screen. Sends the Mute key to the user interface causing a toggle of mute state. Sends the Near key to the user interface. Types a period if the cursor is on a text field. Sends a signal indicating that the remote control has been picked up (remote control feet are out). Sends signal indicating that the remote control has been set down (remote control feet are pushed in). Not implemented. Assigns a preset number when followed by a number from 0 through 9. Sends the right key to the user interface (right arrow). Sends the select key (center button) command to the user interface. Sends the Slide key to the user interface. Sends the up (up arrow) key to the user interface. Sends the Volume up key to the user interface. Sends the Volume down key to the user interface. lowbattery Sends the remote control low battery signal. menu mute near period pickedup putdown pip preset right select slides up volume+ volume- snapshot Sends the Snapshot key to the user interface. © Polycom, Inc. 2003 29 ViewStation EX, ViewStation FX, and VS4000 API Guide zoom+ zoom- Sends the Zoom in key to the user interface. Sends the Zoom out key to the user interface. Example 1 button up This command sends the up arrow command to the user interface. Example 2 button near left right callhangup This valid command combines the following commands: button near button left button right button callhangup callpreference callpreference Description This command specifies the supported call types (ISDN, IP, or both). Changes necessitate a system reboot. h320 h323 both get Selects H.320 (ISDN) as the supported call type. Selects H.323 (IP) as the supported call type. Both H.320 and H.323 are selected. Displays the selected call types. Example callpreference h323 User Interface Screen Location System Info>Admin Setup>Video Network>Call Preference: ISDN Video Calls (H.320), LAN/Internet Calls (H.323), or both options. 30 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide callstate callstate Description This command registers the Telnet or RS-232 session to receive notifications about call state activities. register Registers the system to give notification of call activities. Displays the selected call state mode (register or unregister). unregister Disables the register mode. get Example callstate register Output to Example callstate registered Acknowledgment that the session is now registered to list call state activities. Sample Output cs: call[0] chan[0] dialstr[192.168.1.103] state [RINGING] cs: call[0] chan[0] dialstr[192.168.1.103] state [RINGING] cs: call[0] chan[0] dialstr[192.168.1.103] state [CONNECTED] cs: call[0] chan[0] dialstr[192.168.1.103] state [COMPLETE] active: call[0] speed[128] cleared: call[0] line[0] bchan[0] cause[16] dialstring[192.168.1.103] ended: call[0] © Polycom, Inc. 2003 31 ViewStation EX, ViewStation FX, and VS4000 API Guide camera camera Subcommands camera near <{1..4}|source|move|stop|getposition| setposition|tracking> camera far <{1..5}|source|move|stop|tracking> camera source camera move camera stop camera near camera tracking camera Description This command and its subcommands control the position and zoom of the near-end camera, and the view (camera input) that is presented. Note When you are not in a call, all camera near move commands need to be preceded by a button near command. near subcommands near 1..4 near source Selects a near camera as the main video source (Camera source 1-4). Returns the number of the camera source currently selected. near move zoom+Near camera direction change (start zooming in). near move zoom-Near camera direction change (start zooming out). 32 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide near move left Near camera direction change (start moving left). near move rightNear camera direction change (start moving right). near move up Near camera direction change (start moving up). near move downNear camera direction change (start moving down) near move stop Near camera direction change stops. near move continuous Switches near camera move mode to continuous mode. Camera will move in direction specified until a camera near move stop command is sent. near move discrete Switches near camera move mode to discrete mode. Camera will move a small, discrete amount in the direction specified and then stop. No "camera near move stop" command is required. near stop Stops the near camera movement when in continuous mode. near Sets or gets the x, y, and z coordinates of the currently selected ptz camera. Camera ptz range: -880 <= x <= 880 (pan) -300 <= y <= 300 (tilt) 0 <= z <= 1023 (zoom) Note Some D30 cameras might not be able to reach the designed range limit. For example, although the pan limit is 880, the camera might only be able to reach 860. near tracking on Turns on the near camera tracking mode. near tracking off Turns off the near camera tracking mode. near tracking to_presets Turns on the near camera tracking to presets. near tracking get Gets the near camera tracking mode. © Polycom, Inc. 2003 33 ViewStation EX, ViewStation FX, and VS4000 API Guide far subcommands far 1..5 far source Selects a far camera as the main video source (Camera source 1-5). Returns the number of the camera source currently selected. far move zoom+Far camera direction change (start zooming in). far move zoom- Far camera direction change (start zooming out). far move left far move up Far camera direction change (start moving left). Far camera direction change (start moving up). far move right Far camera direction change (start moving right). far move down Far camera direction change (start moving down). far move stop Far camera direction change stops. far move continuous Switches far camera move mode to continuous mode. Camera will move in direction specified until a ''camera far move stop'' command is sent. far move discrete Switches far camera move mode to discrete mode. Camera will move a small, discrete amount in the direction specified and then stop. No ''camera far move stop'' command is required. far stop Stops the far camera movement when in continuous mode. far tracking on Turns on the far camera tracking mode. far tracking off Turns off the far camera tracking mode. far tracking to_presets Turns on the far camera tracking to presets. far tracking get Gets the far camera tracking mode. register subcommand register Registers to receive feedback when the user changes the camera source. Unregisters to receive feedback when the user changes the camera source. unregister subcommand unregister 34 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Example 1 camera far 2 This command causes the remote terminal to begin sending its camera 2. Example 2 camera far move left This command causes the far camera to start panning to the left. Example 3 camera near move zoom+ This command causes the near camera to zoom in. camera1ptz camera1ptz Description This command sets camera source 1 to pan-tilt-zoom mode. This command is specific to the VS4000 system. Note See the command camerainput to set your VS4000 camera source to S-video or composite mode. Enables pan-tilt-zoom mode. Disables pan-tilt-zoom mode. Displays the current setting (yes or no). yes no get Example camera1ptz yes User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras>VS4000 Camera Setup © Polycom, Inc. 2003 35 ViewStation EX, ViewStation FX, and VS4000 API Guide camera4ptz camera4ptz Description This command sets camera source 4 to pan-tilt-zoom mode. This command is specific to the VS4000 system. Note See the command camerainput on page 37 to set your VS4000 camera source to S-video or composite mode. Enables pan-tilt-zoom mode. Disables pan-tilt-zoom mode. Displays the current setting (yes or no). yes no get Example camera4ptz get User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras>VS4000 Camera Setup cameradirection cameradirection Description This command selects whether the camera moves in the same direction (normal) as the arrows on the remote control or in opposite (reversed) direction. normal reversed get Sets the direction of the camera to normal. Sets the direction of the camera to reversed. Displays current settings (normal or reversed). 36 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Example cameradirection normal User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras: Camera Direction camerainput camerainput <1|2|3|4> camerainput 1 camerainput 2 camerainput 3 camerainput 4 Description This command sets video inputs on cameras 1-4 for the VS4000 system only. You can connect four cameras to your VS4000 system. Note See the commands camera1ptz on page 35 and camera4ptz on page 36 to set the VS4000 system's camera source 1 and 4 to pan-tilt-zoom mode. Selects the camera source. Disables the selected camera source. Enables S-video inputs on the selected camera source. Note that you can only set three cameras (1, 2, and 4) to S-video. 1|2|3|4 off s-video composite Enables composite inputs on the selected camera source. get Displays the current camera input status for the selected camera source. © Polycom, Inc. 2003 37 ViewStation EX, ViewStation FX, and VS4000 API Guide Example 1 camerainput 1 s-video Example 2 camerainput 4 get Output to Example 2 camerainput 4 off User Interface Screen Location System Info>Admin Setup>Video/Cameras>Cameras>VS4000 Camera Setup: Primary Camera chaircontrol chaircontrol Subcommands chaircontrol chaircontrol chaircontrol chaircontrol <"term_name"> chaircontrol <"unique string"> chaircontrol Description This command and subcommands are used for various chair control functions while the system is in an MCU call. 38 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide rel_chair req_chair req_floor Releases the chair. Requests the chair. Requests the floor. req_term_name Requests the terminal name for the terminal numbered term_no. req_vas Requests voice activated switching. view Views the terminal term_no. view_broadcasterViews the broadcaster. list Lists terminals in the conference. set_broadcaster Requests the terminal term_no to become the broadcaster. set_term_name <''term_name''> Sets the terminal name term_name for the terminal numbered term_no. set_password <" string''> Sets the chaircontrol password. It must be followed by the parameter string. This password is the Meeting Password (System Info>Admin Setup> Security: Meeting Password). To clear the chaircontrol password, omit the parameters string. hangup_term Disconnects the terminal term_no from the conference. end_conf register unregister Ends the conference. Registers to receive feedback on all chair control operations. Unregisters (do not receive feedback on all chair control operations). Note Use quotation marks around a compound name or strings containing spaces (Ex: "united states" or "111 222 333"). Example chaircontrol req_term_name 2 © Polycom, Inc. 2003 39 ViewStation EX, ViewStation FX, and VS4000 API Guide colorbar colorbar Description This command turns the diagnostic color bars on or off. on off Turns on the color bars. Turns off the color bars. Example colorbar on User Interface Screen Location System Info>Diagnostics>Color Bar: View Color Bars country country country set country get Description This command selects the country or displays the name of the country. This allows you to specify country-specific calling parameters for your location. set get Sets the country. A country name parameter from the range is required. Displays the current setting. algeria..zimbabwe Range of selectable countries. Select the country where the system is located. For a complete listing, type country set in the API help. 40 www.polycom.com ViewStation EX, ViewStation FX, and VS4000 API Guide Note Use quotation marks around a compound name or strings containing spaces (Ex: "united states" or "111 222 333"). Examples country set germany country set "united states" User Interface Screen Location System Info>Admin Setup>General Setup: Country dataconferencetype