User manual POLYCOM VIEWSTATION FX - SOFTWARE GUIDE

API Guide for ViewStation EX, ViewStation FX, and VS4000 March 2004 Edition Release 6.0 1725-10656-006 Trademark Information Polycom®, the Polycom logo design, ViewStation®, and Vortex® are registered trademarks of Polycom, Inc. Global Management SystemTM, SirenTM 14, PowerCamTM, Pro-MotionTM, and Visual ConcertTM are trademarks of Polycom, Inc. in the United States and various other countries. All other trademarks are the property of their respective owners. Patent Information The accompanying product is protected by one or more U.S. and foreign patents and patents pending held by Polycom, Inc. © 2004 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 responsible for printing or clerical errors. Information in this document is subject to change without notice. ii www.polycom.com/videodocumentation Contents Introduction ................................................................................................................... 1 What's New in Release 6.0?.......................................................................................................................2 New Commands ............................................................................................................................2 Enhanced Commands ...................................................................................................................3 System Commands ...................................................................................................... 5 ! ...................................................................................................................................................................6 abk ...............................................................................................................................................................8 adminpassword .......................................................................................................................................10 advnetstats ...............................................................................................................................................11 all register .................................................................................................................................................13 all unregister ............................................................................................................................................14 allowabkchanges .....................................................................................................................................15 allowcamerapresetssetup .......................................................................................................................16 allowdialing ..............................................................................................................................................17 allowmixedcalls .......................................................................................................................................18 allowremotemon .....................................................................................................................................19 allowusersetup .........................................................................................................................................20 answer ......................................................................................................................................................21 audioquality .............................................................................................................................................22 audioqualityg7221 ...................................................................................................................................23 audiotransmitlevel ...................................................................................................................................24 autoanswer ...............................................................................................................................................25 autodiscovernat .......................................................................................................................................26 autoh323dialing .......................................................................................................................................27 autoshowcontent .....................................................................................................................................28 backlightcompensation ...........................................................................................................................29 button .......................................................................................................................................................30 callencryption ...........................................................................................................................................32 callpreference ...........................................................................................................................................33 callstate .....................................................................................................................................................34 camera ......................................................................................................................................................35 camera1ptz ...............................................................................................................................................38 camera4ptz ...............................................................................................................................................39 cameradirection .......................................................................................................................................40 camerainput .............................................................................................................................................41 chaircontrol ..............................................................................................................................................42 colorbar ....................................................................................................................................................44 country ......................................................................................................................................................45 dataconferencetype .................................................................................................................................46 daylightsavings ........................................................................................................................................47 defaultgateway ........................................................................................................................................48 dhcp ..........................................................................................................................................................49 dial ............................................................................................................................................................50 dialchannels .............................................................................................................................................52 diffserv ......................................................................................................................................................53 © Polycom, Inc. iii API Guide for ViewStation EX, ViewStation FX, and VS4000 dir ..............................................................................................................................................................54 display ......................................................................................................................................................55 displaybolt ................................................................................................................................................57 displayglobaladdresses ...........................................................................................................................58 displaygraphics ........................................................................................................................................59 displayipext ..............................................................................................................................................60 displayipisdninfo .....................................................................................................................................61 displayparams ..........................................................................................................................................62 dns ............................................................................................................................................................64 dynamicbandwidth ..................................................................................................................................65 e164ext .....................................................................................................................................................66 echocanceller ...........................................................................................................................................67 enablesnapshots ......................................................................................................................................68 enablesnmp ..............................................................................................................................................69 exit ............................................................................................................................................................70 farcontrolnearcamera ..............................................................................................................................71 farloop ......................................................................................................................................................72 farnametimedisplay .................................................................................................................................73 gabk ..........................................................................................................................................................74 gabpassword ............................................................................................................................................76 gabserverip ..............................................................................................................................................77 gatekeeperip .............................................................................................................................................78 gatewayareacode .....................................................................................................................................79 gatewaycountrycode ...............................................................................................................................80 gatewayext ...............................................................................................................................................81 gatewaynumber .......................................................................................................................................82 gatewaynumbertype ...............................................................................................................................83 gatewayprefix ..........................................................................................................................................84 gatewaysetup ...........................................................................................................................................85 gatewaysuffix ...........................................................................................................................................86 gendialtone ..............................................................................................................................................87 gendialtonepots .......................................................................................................................................88 generatetone ............................................................................................................................................89 getcallstate ...............................................................................................................................................90 get screen .................................................................................................................................................91 gmscity .....................................................................................................................................................92 gmscontactemail .....................................................................................................................................93 gmscontactfax ..........................................................................................................................................94 gmscontactnumber .................................................................................................................................95 gmscontactperson ...................................................................................................................................96 gmscountry ..............................................................................................................................................97 gmsstate ...................................................................................................................................................98 gmstechsupport .......................................................................................................................................99 gmsurl .....................................................................................................................................................100 graphicsmonitor ....................................................................................................................................101 graphicsmonitorfxvga ...........................................................................................................................102 graphicsmonitortv .................................................................................................................................103 graphicsmonitorvisualconcert ..............................................................................................................104 h323name ...............................................................................................................................................105 hangup ....................................................................................................................................................106 help .........................................................................................................................................................107 hires ........................................................................................................................................................109 history .....................................................................................................................................................110 hostname ................................................................................................................................................111 iv www.polycom.com/videodocumentation Contents ipaddress ................................................................................................................................................112 ipdialspeed .............................................................................................................................................113 ipprecedence ..........................................................................................................................................114 ipstat .......................................................................................................................................................115 ispopupup ..............................................................................................................................................116 isuserinputup .........................................................................................................................................117 keypadaudioconf ...................................................................................................................................118 language .................................................................................................................................................119 lanport ....................................................................................................................................................120 lanstat .....................................................................................................................................................121 listen .......................................................................................................................................................123 maxgabinternationalcallspeed .............................................................................................................124 maxgabinternetcallspeed ......................................................................................................................125 maxgabisdncallspeed ............................................................................................................................126 maxtimeincall .........................................................................................................................................127 mcupassword .........................................................................................................................................128 meetingpassword ..................................................................................................................................129 mpautoanswer .......................................................................................................................................130 mpmode .................................................................................................................................................131 mute ........................................................................................................................................................132 muteautoanswercalls ............................................................................................................................133 nearloop .................................................................................................................................................134 netmeetingip ..........................................................................................................................................135 netstats ...................................................................................................................................................136 ntpmode .................................................................................................................................................137 ntpserver ................................................................................................................................................138 numberofmonitors ................................................................................................................................139 numdigitsdid ..........................................................................................................................................140 numdigitsext ..........................................................................................................................................141 outboundcallroute .................................................................................................................................142 pause ......................................................................................................................................................143 pcport ......................................................................................................................................................144 phone ......................................................................................................................................................145 ping .........................................................................................................................................................146 pip ...........................................................................................................................................................147 popup ......................................................................................................................................................148 preferredalias .........................................................................................................................................149 preset ......................................................................................................................................................150 primarycallchoice ..................................................................................................................................151 primarycamera .......................................................................................................................................152 queuecommands ...................................................................................................................................153 reboot .....................................................................................................................................................154 registerall ................................................................................................................................................155 registerthissystem .................................................................................................................................156 repeat ......................................................................................................................................................157 requireacctnumtodial ............................................................................................................................158 roomphonenumber ...............................................................................................................................159 rs232 .......................................................................................................................................................160 run ...........................................................................................................................................................161 screen .....................................................................................................................................................162 secondarycallchoice ..............................................................................................................................163 sendonlypreferredalias .........................................................................................................................164 serialnum ................................................................................................................................................165 setaccountnumber .................................................................................................................................166 www.polycom.com/videodocumentation v API Guide for ViewStation EX, ViewStation FX, and VS4000 showaddrsingab ....................................................................................................................................167 showpopup ............................................................................................................................................168 sleep ........................................................................................................................................................169 slides .......................................................................................................................................................170 snapshot .................................................................................................................................................171 snapshotcamera ....................................................................................................................................172 snapshottimeout ....................................................................................................................................173 snmpadmin ............................................................................................................................................174 snmpcommunity ....................................................................................................................................175 snmpconsoleip .......................................................................................................................................176 snmplocation .........................................................................................................................................177 soundeffectsvolume ..............................................................................................................................178 speeddial list ..........................................................................................................................................179 speeddial lock or speeddial unlock ......................................................................................................180 stdout ......................................................................................................................................................181 stream .....................................................................................................................................................182 streamannounce ....................................................................................................................................183 streamaudioport ....................................................................................................................................184 streamenable .........................................................................................................................................185 streammulticastip ..................................................................................................................................186 streamrestoredefaults ...........................................................................................................................187 streamrouterhops ..................................................................................................................................188 streamspeed ...........................................................................................................................................189 streamvideoport ....................................................................................................................................190 subnetmask ............................................................................................................................................191 sysinfo ....................................................................................................................................................192 systembehindnat ...................................................................................................................................193 systemhastelephone .............................................................................................................................194 systemname ...........................................................................................................................................195 t120nameip .............................................................................................................................................196 tcpports ...................................................................................................................................................197 techsupport ............................................................................................................................................198 teleareacode ...........................................................................................................................................199 telecountrycode .....................................................................................................................................200 telenumber .............................................................................................................................................201 testlan arp ...............................................................................................................................................202 testlan dcuinfo .......................................................................................................................................203 testlan dns ..............................................................................................................................................204 testlan echo ............................................................................................................................................205 testlan ping .............................................................................................................................................207 textinput .................................................................................................................................................208 timediffgmt .............................................................................................................................................209 typeofservice ..........................................................................................................................................210 udpports .................................................................................................................................................211 unregisterall ...........................................................................................................................................212 usefixedports .........................................................................................................................................213 usegatekeeper ........................................................................................................................................214 usepathnavigator ...................................................................................................................................215 validateacctnum .....................................................................................................................................216 vcbutton ..................................................................................................................................................217 vcfxvgacontentpreview .........................................................................................................................218 vcraudioout ............................................................................................................................................219 vcrrecordsource .....................................................................................................................................220 vcstream .................................................................................................................................................221 vi www.polycom.com/videodocumentation Contents version ....................................................................................................................................................222 vgahorizpos ............................................................................................................................................223 vgaoffmode ............................................................................................................................................224 vgaphase ................................................................................................................................................225 vgaresolution .........................................................................................................................................226 vgavertpos ..............................................................................................................................................227 volume ....................................................................................................................................................228 waitfor .....................................................................................................................................................229 wake ........................................................................................................................................................230 wanipaddress .........................................................................................................................................231 whoami ...................................................................................................................................................232 widescreenvideo ....................................................................................................................................233 winsresolution .......................................................................................................................................234 winsserver ..............................................................................................................................................235 ISDN Commands ....................................................................................................... 237 isdnareacode ..........................................................................................................................................238 isdncountrycode ....................................................................................................................................239 isdndialingprefix ....................................................................................................................................240 isdndialspeed .........................................................................................................................................241 isdnnum ..................................................................................................................................................242 priareacode ............................................................................................................................................243 pricallbycall ............................................................................................................................................244 prichannel ...............................................................................................................................................245 pricsu ......................................................................................................................................................247 pridialchannels .......................................................................................................................................248 priintlprefix .............................................................................................................................................249 prilinebuildout ........................................................................................................................................250 prilinesignal ............................................................................................................................................251 prinumber ...............................................................................................................................................252 prinumberingplan ..................................................................................................................................253 prioutsideline .........................................................................................................................................254 priswitch .................................................................................................................................................255 spidnum ..................................................................................................................................................256 V.35/RS-449/RS-530 Commands ................................................................................................................ 259 cts ............................................................................................................................................................260 dcd ..........................................................................................................................................................261 dcdfilter ...................................................................................................................................................262 dsr ...........................................................................................................................................................263 dsranswer ...............................................................................................................................................264 dtr ............................................................................................................................................................265 h331audiomode .....................................................................................................................................266 h331framerate ........................................................................................................................................267 h331videoformat ....................................................................................................................................268 h331videoprotocol .................................................................................................................................269 rs331dialing ............................................................................................................................................270 rt ..............................................................................................................................................................271 rts ............................................................................................................................................................272 st ..............................................................................................................................................................273 v35broadcastmode ................................................................................................................................274 v35debug ................................................................................................................................................275 www.polycom.com/videodocumentation vii API Guide for ViewStation EX, ViewStation FX, and VS4000 v35dialingprotocol .................................................................................................................................276 v35num ...................................................................................................................................................277 v35portsused ..........................................................................................................................................278 v35prefix .................................................................................................................................................279 v35profile ................................................................................................................................................280 v35suffix .................................................................................................................................................282 Appendix: Status Display ......................................................................................... 283 B Channel Status Message Example ....................................................................................................284 viii www.polycom.com/videodocumentation Introduction This document describes the API (Application Programming Interface) for the ViewStation EX, ViewStation FX, and VS4000. This API is a set of commands implemented within the shell. The commands are available for advanced users who want to customize 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. The commands are grouped under the following sections: "System Commands" on page 5 "ISDN Commands" on page 237 "V.35/RS-449/RS-530 Commands" on page 259 © Polycom, Inc. 1 API Guide for ViewStation EX, ViewStation FX, and VS4000 What's New in Release 6.0? New and enhanced API commands in 6.0 provide greater control over system behaviors. For example, the system now provides registration data to the control device when call states, camera states, and certain other states change. States of registered system parameters are preserved through system restarts. Registered parameters also now report their current state as well as registering to report future changes. The new commands and the commands that have been enhanced in Release 6.0 are listed in the tables in this section. New Commands The following table lists the new commands in Release 6.0. Note Shortcuts are no longer allowed for new commands. All shortcuts that were available in Release 5.0 are still available. Command all register, all unregister OR registerall, unregisterall allowcamerapresetssetup audiotransmitlevel Action Registers or unregisters commands for all user feedback. The commands all register or registerall, which can be used interchangeably, also return current values. Sets or gets whether camera presets can be changed. Sets or gets the audio volume transmitted to the far site. It is used to increase the audio gain level of DTMF dialing tones being sent to a gateway. Sets or gets whether content can be shown when a PC is connected to Visual Concert FX. Sets or gets the encryption mode (required when available or disabled). Dials a Speed Dial entry. Generates DTMF dialing tones to a POTS line Gets the state of current calls. Indicates whether a popup screen is currently displayed. Indicates whether a user input screen is currently displayed. autoshowcontent callencryption dial speeddial gendialtonepots getcallstate ispopupup isuserinputup 2 www.polycom.com/videodocumentation Introduction Command ntpmode Action Sets or gets whether an NTP time server is used and, if so, whether it is selected manually or automatically. Lets you set or get an NTP time server, using its IP address or DNS name. Either switches the phone channel to the next channel to add another telephone call to a video call, or clears any dialstring from the text box on the Telephone screen of the user interface Registers or unregisters the shell session to receive popup notifications. Lists the current Speed Dial entries, or locks and unlocks a specified Speed Dial entry. Registers or unregisters the shell session to receive ISDN, IP and gatekeeper status , notifications. Set whether or not the system has a POTS line connected. Gets the current status of the Visual Concert stream, or registers or unregisters state changes to the stream. Sets or gets the ability to preview content on the near Visual Concert FX monitor. ntpserver phone popup speeddial sysinfo systemhastelephone vcstream vcfxvgacontentpreview Enhanced Commands The following table lists the commands that have been enhanced in Release 6.0. Command abk dial addressbook gabk gendialtone Enhancement New parameters to specify searches in the local Address Book. New IP and ISDN parameters to filter for one or the other call type. New parameters to specify searches in the Global Address Book. Generates DTMF dialing tones to a POTS line while in a video call. This command is identical to the gendial command of the previous release. Now has subcommand values {1..4} for camera selection. hires © Polycom, Inc. 3 API Guide for ViewStation EX, ViewStation FX, and VS4000 listen New "off" parameter adds the ability to unregister the listen command. New "swap" parameter adds ability to toggle the content of PIP and main display between near-site and far-site view. New "phone" parameter takes you to the Telephone screen where you can dial or disconnect a telephone call. The screen enableui and screen disableui commands are now retained after a system restart. pip screen 4 www.polycom.com/videodocumentation System Commands This section describes each system shell command and its parameters. © Polycom, Inc. 5 API Guide for ViewStation EX, ViewStation FX, and VS4000 ! Description This command allows you to execute a previously used command starting with a specific number or letter(s) from the history list. For more information about the history list, refer to history on page 110. Syntax !<"str"|{1..64}> Parameter "str" {1..64} Definition Specifies the most recent command from the history list that begins with this string Specifies the nth command in the history list. Note There is no space between the ! command and the following parameter. For example, !gat or !5 are correct. ! gat is incorrect). Example ->gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? ->hangup video hanging up video call ->history 1 2 3 gatewaynumber set 123456789 hangup video history Consequently, each of the following ! commands executes the command and prints its output from the history list. ->!1 gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? ->!2 hangup video 6 www.polycom.com/videodocumentation System Commands hanging up video call ->!h hangup video hanging up video call ->!hi history 1 2 3 4 5 6 7 gatewaynumber set 123456789 hangup video history gatewaynumber set 123456789 hangup video hangup video history ->!gat gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? ->history 1 2 3 4 5 6 7 8 9 gatewaynumber set 123456789 hangup video history gatewaynumber set 123456789 hangup video hangup video history gatewaynumber set 123456789 history © Polycom, Inc. 7 API Guide for ViewStation EX, ViewStation FX, and VS4000 abk Description This command displays local Address Book entries. For information about Global Address Book entries, see gabk on page 74. Syntax abk batch|all|letter|range> abk batch <{0..59}> abk batch search <"s1"> <"n1"> abk batch define <"n1"> <"n2"> abk all abk letter <"character"> abk range <"n1"> <"n2"> Parameter batch Definition Returns a batch of 10 entries. Requires a batch number, which must be an integer in the range {0..59}. {0..59} The number of batches to be displayed, each batch consisting of 10 entries. The maximum number of batches that can be displayed is 59. Example: abk batch 1 returns entries 10-19. search Returns entries starting with the search string "s1" and continuing with the next "n1" entries. Example: abk batch search p 5 displays the first entry beginning with p and the next 4 entries. define Returns entries starting with entry in the "n1" position and continuing with the next "n2" entries. Example: abk batch define 10 5 starts at the 10th entry and returns the next 4 entries. "s1" "n1" "n2" all An alphanumeric character or string that returned entries are to begin with. The ordinal position of an entry in the local Address Book, with the entries being listed in alphabetical order. The ordinal position of a second entry in the local Address Book. Returns all the entries in the local Address Book. 8 www.polycom.com/videodocumentation System Commands Parameter letter Definition Returns entries beginning with the alphanumeric "character" specified. Requires an alphanumeric character. An alphanumeric character. Valid characters are: -_/;@,.\ 0 through 9 a through z "character" range Returns local Address Book entries in positions "n1" through "n2. Requires two integers to represent the " first and last number of the entry. Examples abk batch 0 Returns the first batch, which consists of entries 1 through 9. (Subsequent entries contain 10 entries each.) abk range 2 8 returns Address Book entries 2 through 8. abk batch search p 5 returns the first entry beginning with p and the next 4 entries. abk batch define 10 5 returns the 10th entry and the following 4 entries. © Polycom, Inc. 9 API Guide for ViewStation EX, ViewStation FX, and VS4000 adminpassword Description This command is used to change the administrator password. Note This command cannot be accessed through the RS-232 port. Syntax adminpassword ["password"] Parameter set Definition Sets the password used for remote management of the system if followed by the "password" parameter. To erase the current setting, omit the password parameter. The system must have an admin password set before this command works. Note: If you erase the password, you will need to reset it through the user interface. get "password" Returns the current admin password. Valid characters are: a through z (lower and uppercase), -, _, @, /, ;, ,, ., \, 0 through 9. The length is limited to 10 characters. Note: If the password string includes spaces, enclose it in quotation marks. Examples adminpassword set MyFXpsswd adminpassword set "EX 2004" User Interface Screen Location System Info > Admin Setup > Security: Admin Password 10 www.polycom.com/videodocumentation System Commands advnetstats Description This command is used to get advanced network statistics for each call. Syntax advnetstats [{0..2}] Parameter {0..2} Definition Calls in a multipoint call, 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. Omit this parameter when retrieving statistics for a point-to-point call. Examples advnetstats advnetstats 1 returns information similar to this: 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 © Polycom, Inc. 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) 11 API Guide for ViewStation EX, ViewStation FX, and VS4000 tlsdp rapl rlsdp taj tlsdr raj rlsdp tvpl 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) tmlpp Transmit MLP protocol (H.320 calls only) rvpl Receive video packet loss (H.323 calls only) rmlpp Receive MLP protocol (H.320 calls only) tvj tmlpr rvj Transmit video jitter (H.323 calls only) Transmit MLP rate (H.320 calls only) Receive video jitter (H.323 calls only) rmlpr Receive MLP rate (H.320 calls only) dc rsid Data conference Remote system id User Interface Screen Location System Info > Diagnostics > Advanced Stats 12 www.polycom.com/videodocumentation System Commands all register Description This command simultaneously registers all user feedback, that is all changes that have been made to any of the parameter types listed in the following table. This allows you to be informed via the API interface of all user actions and is particularly useful when two different control systems are being used simultaneously, such as the web and API commands. The system maintains the registration changes through restarts. The all register command also returns all current settings. To unregister user feedback, use the all unregister command. Syntax all register Parameter all register Definition Registers changes to any of the following types of parameters: · Current near end or far end source · State of privacy · Current volume level · Active camera presets · Status of point-to-point or multipoint calls · Status of physical ISDN/IP connection to codec · PIP state · Visual Concert state · Chair control · System information · Gatekeeper status © Polycom, Inc. 13 API Guide for ViewStation EX, ViewStation FX, and VS4000 all unregister Description This command simultaneously unregisters all registered user feedback, so that you will not be informed in the API interface of changes that have been made to any of the parameter types listed in the following table. Note The function and syntax of all unregisterall and unregisterall are identical. Syntax all unregister Parameter all unregister Definition Unregisters any registered parameters so that the API interface no longer reports changes to the parameters. The following types of parameters are unregistered: · Current near end or far end source · State of privacy · Current volume level · Active camera presets · Status of point-to-point or multipoint calls · Status of physical ISDN/IP connection to codec · PIP state · Visual Concert state · Chair control · System information · Gatekeeper status 14 www.polycom.com/videodocumentation System Commands 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. Syntax allowabkchanges Parameter yes no get Definition Enables the Address Book Changes option. Disables the Address Book Changes option. Returns 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 © Polycom, Inc. 15 API Guide for ViewStation EX, ViewStation FX, and VS4000 allowcamerapresetssetup Description This command gets or sets whether camera presets can be changed. Syntax allowcamerapresetssetup Parameter yes no get Definition Allows presets to be changed. Does not allow presets to be changed Returns the current setting (yes or no). Example allowcamerapresetssetup no User Interface Screen Location System Info > Admin Setup > General Setup > Allow Modifications to Camera Presets 16 www.polycom.com/videodocumentation System Commands allowdialing Description This command sets or gets the Allow Dialing option, which determines whether the user can use the user interface to dial. Syntax allowdialing Parameter yes no get Definition Allows users to place calls. Disables dialing. Your system can only receive calls. Returns the current setting (yes or no). Example allowdialing get User Interface Screen Location System Info > Admin Setup > General Setup: Allow Dialing © Polycom, Inc. 17 API Guide for ViewStation EX, ViewStation FX, and VS4000 allowmixedcalls Description This command sets or gets the ability to place and receive mixed protocol multipoint calls (IP and ISDN). It allows the administrator to disable this ability for security reasons. Syntax allowmixedcalls Parameter yes no get Definition Allows mixed IP and ISDN calls. Disables mixed IP and ISDN calls. Returns the current setting (yes or no). Example allowmixedcalls yes User Interface Screen Location System Info > Admin Setup > Video Network > Call Preferences: Allow H.320 and H.323 Mixed Calls Note The option Allow H.320 and H.323 Mixed Calls is only visible on screen if the ISDN Video Calls option and the LAN/Internet Calls option have both been enabled on the Call Preferences screen. 18 www.polycom.com/videodocumentation System Commands allowremotemon Description This command displays the current state of the Allow Remote Monitoring option. For security reasons, it can only be set from the user interface. Syntax allowremotemon Parameter get Definition Returns the current setting (yes or no). Example allowremotemon get User Interface Screen Location System Info > User Setup: Allow Remote Monitoring © Polycom, Inc. 19 API Guide for ViewStation EX, ViewStation FX, and VS4000 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. Syntax allowusersetup Parameter yes no get Definition Enables the User Setup option. Disables the User Setup option. Returns the current setting (yes or no). Example allowusersetup yes User Interface Screen Location System Info > Admin Setup > General Setup (page 2): Allow User Setup 20 www.polycom.com/videodocumentation System Commands answer Description This command answers incoming video or POTS calls. Syntax answer Parameter phone video Definition 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 © Polycom, Inc. 21 API Guide for ViewStation EX, ViewStation FX, and VS4000 audioquality Description This command sets or gets 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. Syntax audioquality <{64..512}> Parameter set get {64..512} Definition Sets the call speed threshold value. Requires a parameter from the {64..512} range. Returns the current threshold value of the call. Required value from the range of selectable speeds. The available speeds are 64, 112, 128, 168, 192, 224, 256, 280, 320, 336, 384, 392, 448, and 512. Example audioquality set 168 User Interface Screen Location System Info > Admin Setup > Phone/Audio: Audio Quality 22 www.polycom.com/videodocumentation System Commands audioqualityg7221 Description This command sets or gets 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. Syntax audioqualityg7221 <{64..512}> Parameter set get {64..512} Definition Sets the call speed threshold value. Requires a parameter from the {64..512} range. Returns the current threshold value of the call. Required value from the range of selectable speeds. The available speeds are 64, 112, 128, 168, 192, 224, 256, 280, 320, 336, 384, 392, 448, and 512. Example audioqualityg7221 set 256 User Interface Screen Location System Info > Admin Setup > Phone/Audio: Audio Quality © Polycom, Inc. 23 API Guide for ViewStation EX, ViewStation FX, and VS4000 audiotransmitlevel Description This command sets or gets the audio volume transmitted to the far site. It is used when a control system needs to increase the audio gain level of DTMF tones being sent to a gateway. Syntax audiotransmitlevel Parameter up down set "db level" get Definition Sets the volume 1 decibel higher than the current setting. Sets the volume 1 decibel lower than the current setting. Sets the volume to the specified "db level" Valid values . are: {-20..30} Returns the current audio volume of the far site. Example audiotransmitlevel up 24 www.polycom.com/videodocumentation System Commands autoanswer Description This command sets or gets the Auto Answer Point to Point mode which determines how the system will handle an incoming call in a point-to-point video conference. Syntax autoanswer Parameter yes Definition Allows any incoming call to be connected automatically. This is the factory default autoanswer setting. no Prompts the user to answer incoming calls 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. Notifies the user of incoming calls but does not connect them. The site which placed the call receives a Far Site Busy code (H.320) or Call Rejected (H.323). Returns the status of the option (yes, no, or donotdisturb). donotdisturb get Example autoanswer donotdisturb User Interface Screen Location System Info > Admin Setup > General Setup: Auto Answer Point to Point © Polycom, Inc. 25 API Guide for ViewStation EX, ViewStation FX, and VS4000 autodiscovernat Description This command sets or gets the Auto Discover NAT option. Syntax autodiscovernat Parameter yes Definition Enables the option to automatically assign the WAN IP address that is used to place and receive calls outside the WAN. Disables the option. Returns 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 26 www.polycom.com/videodocumentation System Commands autoh323dialing Description This command sets or gets 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. Syntax autoh323dialing Parameter yes Definition 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. Returns the current setting (yes or no). no get Example autoh323dialing yes User Interface Screen Location System Info > Admin Setup > LAN/H.323 > H.323 > Setup: Auto H.323 Dialing © Polycom, Inc. 27 API Guide for ViewStation EX, ViewStation FX, and VS4000 autoshowcontent Description This command sets or gets the ability to show content automatically when a user connects a PC to the Visual Concert FX. (To set the ability to preview content on the near Visual Concert FX monitor, see vcfxvgacontentpreview on page 218.) Syntax autoshowcontent Parameter off on get Definition Turns off the ability to automatically display content when a PC is first connected to the Visual Concert FX. Turns on the ability to automatically display content. Returns the current setting. Example autoshowcontent on User Interface Screen Location System Info > Admin Setup > Video/Cameras > Graphics Monitor > Send Content When PC Connects 28 www.polycom.com/videodocumentation System Commands backlightcompensation Description This command sets or gets the Backlight Compensation option. Syntax backlightcompensation Parameter yes no get Definition Enables Backlight Compensation. The camera automatically adjusts for a bright background. Disables the option. Returns the current setting (yes or no). Example backlightcompensation no User Interface Screen Location System Info > Admin Setup > Video/Camera > Cameras: Backlight Compensation © Polycom, Inc. 29 API Guide for ViewStation EX, ViewStation FX, and VS4000 button Description This command and its parameters let you send the same command as buttons on the Polycom remote control to the user interface. The button commands are not checked prior to being sent to the user interface. Note The button commands are available only for backward compatibility, and are not recommended. Note A warning tone is sent from the system if there is no function for a button on the currently active screen. Syntax button <"name"> Value for "name" Definition # * 0-9 auto callhangup camera delete directory down far home info keyboard left lowbattery Sends the # key to the user interface. Sends the * key to the user interface. Sends the corresponding numeric key to the user interface. Sends the Auto key to the user interface. Sends the Call Hang-Up key to the user interface. Not implemented. Not implemented. Takes you to the Address Book screen. Sends the down arrow key to the user interface. Sends the Far key to the user interface. Takes you to the main screen. Sends the Info command to the user interface. Brings up the on-screen keyboard if the cursor is on a text field. Sends the left (left arrow) command to the user interface. Sends the remote control low battery signal. 30 www.polycom.com/videodocumentation System Commands Value for "name" Definition menu mute near period pickedup pip preset putdown right select slides snapshot up volumevolume+ zoomzoom+ Takes you to the previous menu 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 (dot) 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 the PIP key to the user interface. Sends the Preset key to the user interface. Sends signal indicating that the remote control has been set down (remote control feet are pushed in). 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. Not implemented. Sends the up (up arrow) key to the user interface. Sends the Volume - key to the user interface. Sends the Volume + key to the user interface. Sends the Zoom Out key on the near video screen to the user interface. Sends the Zoom In key on the near video screen to the user interface. Example 1 button up This command sends the up arrow command to the user interface. Example 2 button near left callhangup This valid command combines the following commands: button near button left button callhangup © Polycom, Inc. 31 API Guide for ViewStation EX, ViewStation FX, and VS4000 callencryption Description This command sets or gets the encryption mode. Use encryption when the far site is capable of encryption. Syntax callencryption Parameter required disabled get Definition Sets call encryption to be used for every call when it is available. Disables call encryption. Returns the current setting (required or disabled). Example callencryption required User Interface Screen Location System Info > Admin Setup > Security > Encryption Note The Encryption options are only visible on the user interface if an encryption key has been entered. 32 www.polycom.com/videodocumentation System Commands callpreference Description This command specifies the supported call types (ISDN, IP or both). Changes , require a system restart. Syntax callpreference Parameter h320 h323 both get Definition 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. Returns 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. © Polycom, Inc. 33 API Guide for ViewStation EX, ViewStation FX, and VS4000 callstate Description This command registers the shell session to receive notifications about call state activities. (For information on the state of current calls, use command getcallstate on page 90.) Syntax callstate Parameter register unregister get Definition Registers the system to give notification of call activities. Unregisters the system to give notification of call activities. Returns the selected call state mode (register or unregister). Example callstate register returns callstate registered (Acknowledgment that the session is now registered to list call state activities.) 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] 34 www.polycom.com/videodocumentation System Commands camera Description This command and its subcommands control the position and zoom of the near-site camera, and the view (camera input) that is presented. Syntax camera camera camera near <{1..4}|source|move|stop> camera far <{1..5}|source|move|stop|tracking> camera move camera far tracking Parameter register unregister near far Definition Registers to receive feedback when the user changes the camera source. Unregisters to receive feedback when the user changes the camera source. Specifies that the command selects or controls the near camera. Specifies that the command selects or controls the far camera. camera Parameter {1..4} {1..5} source Definition Specifies a near or far camera as the main video source. Returns the number of the near or far camera source currently selected. © Polycom, Inc. 35 API Guide for ViewStation EX, ViewStation FX, and VS4000 camera Parameter Definition move Changes the near or far camera's direction or zoom. Valid directions are: continuousSelects continuous movement mode. The camera will move in direction specified until a camera move stop command is sent. discreteSelects discrete movement mode. The camera will move a small amount in the direction specified and then stop. No stop command is required. left right up starts moving the camera to the left starts moving the camera to the right starts moving the camera up down starts moving the camera down zoom- starts zooming out zoom+ starts zooming in stop near stops the camera motion in progress 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. stop tracking Stops the near or far camera when in continuous mode. Tracking mode: on Turns on the far camera tracking mode. The far-site system must have the option Far Control of Near Camera enabled and auto tracking turned on. off get Turns off the far camera tracking mode. Returns the far camera tracking mode. to_presetsTurns on the far camera tracking to presets. Example 1 camera far 2 This command causes the remote terminal to begin sending its camera 2. 36 www.polycom.com/videodocumentation System Commands 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. © Polycom, Inc. 37 API Guide for ViewStation EX, ViewStation FX, and VS4000 camera1ptz Description This command sets camera source 1 to pan-tilt-zoom mode. Note This command is specific to the VS4000 system. Note See the command camerainput on page 41 to set your VS4000 camera source to S-video or composite mode. Syntax camera1ptz Parameter yes no get Definition Enables pan-tilt-zoom mode. Disables pan-tilt-zoom mode. Returns the current setting (yes or no). Example camera1ptz yes User Interface Screen Location System Info > Admin Setup > Video/Camera > Cameras > VS4000 Camera Setup 38 www.polycom.com/videodocumentation System Commands