Page 1 ® ViewStation EX, ViewStation FX, and VS4000 API Guide VS4000 User’s Guide April 2003 Edition Release 5.0 1725-10656-004...
Page 2: Trademark Information
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.
Page 3: Table Of Contents
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...
Page 4 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 ...
Page 5 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...
Page 6 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...
Page 7 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...
Page 8 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 ...
Page 9 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.
Page 10: What's New In Release 5.0
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 V.35 Command allowmixedcalls audioqualityg7221 camera near move display tmon display multiwaymode displaygraphics enablesnapshots...
Page 11: Accessing The Api Interface
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 Note 3.
Page 12: Starting A Communications Session
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.
Page 13: Rs-232 Interface Information
ViewStation EX, ViewStation FX, and the VS4000 system: 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.
Page 14 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.
Page 15: Flow Control
ViewStation EX, ViewStation FX, and VS4000 API Guide Near-Side Mode 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.
Page 16: Serial Cable Pinout And Connections (Viewstation Ex And
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...
Page 17: Serial Cable Pinout And Connections (Vs4000)
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.
Page 18: Status Display
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...
Page 19 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]...
Page 20 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]...
Page 21: Syntax Summary
ViewStation EX, ViewStation FX, and VS4000 API Guide Syntax Summary The following syntactic notation is used for the API shell control commands. Note <x> "x" © Polycom, Inc. 2003 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.
Page 22: About The "Get" Subcommand
ViewStation EX, ViewStation FX, and VS4000 API Guide {a..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.
Page 23: System Commands
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.
Page 24: Abk
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect. restart now? <y,n> ->!2 hangup video hanging up video call ->!h hangup video hanging up video call ->!hi history gatewaynumber set 123456789...
Page 25: Adminpassword
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 letter range a..z a..b Examples abk batch 0 Displays records 0 through 9. abk range 2 8 Displays Address Book entries 2 through 8.
Page 26: Advnetstats
ViewStation EX, ViewStation FX, and VS4000 API Guide Note password Valid characters are: a through z (lower and Note Examples adminpassword set MyFXpsswd adminpassword set “EX 2003“ User Interface Screen Location System Info>Admin Setup>Security: Admin Password advnetstats advnetstats [{0..2}] advnetstats...
Page 27 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: tvru rvru tvfr rvfr...
Page 28: Allowabkchanges
ViewStation EX, ViewStation FX, and VS4000 API Guide tmlpr rmlpr rsid User Interface Screen Location System Info>Diagnostics>Advanced Stats allowabkchanges allowabkchanges <yes|no|get> 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.
Page 29: Allowdialing
ViewStation EX, ViewStation FX, and VS4000 API Guide allowdialing allowdialing <yes|no|get> Description This command enables or disables the Allow Dialing option. Example allowdialing get User Interface Screen Location System Info>Admin Setup>General Setup: Allow Dialing allowmixedcalls allowmixedcalls <yes|no|get> Description This command allows the administrator to disable the ability to place or received mixed-protocol (IP and ISDN), multipoint calls for security reasons.
Page 30: Allowremotemon
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 <get> Description This command displays the current state of the Allow Remote Monitoring option.
Page 31: Answer
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 <phone|video> Description This command answers incoming video or POTS calls. phone video Example answer phone audioquality audioquality <set|get>...
Page 32: Audioqualityg7221
ViewStation EX, ViewStation FX, and VS4000 API Guide 64..512 Example audioquality set 168 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Audio Quality audioqualityg7221 audioqualityg7221 <set|get> 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.
Page 33: Autoanswer
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 <yes|no|donotdisturb|get> 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.
Page 34: Autodiscovernat
ViewStation EX, ViewStation FX, and VS4000 API Guide autodiscovernat autodiscovernat <yes|no|get> Description This command enables or disables the Auto Discover NAT option. Example autodiscovernat yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>Firewall/LAN Connection: Auto Discover NAT autoh323dialing autoh323dialing <yes|no|get> Description This command enables or disables the Auto H.323 Dialing option.
Page 35: Backlightcompensation
ViewStation EX, ViewStation FX, and VS4000 API Guide Example autoh323dialing yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Setup: Auto H.323 Dialing backlightcompensation backlightcompensation <yes|no|get> Description This command enables or disables the Backlight Compensation option. Example backlightcompensation no User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras: Backlight...
Page 36: Button
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.
Page 37 ViewStation EX, ViewStation FX, and VS4000 API Guide delete directory down home info keyboard Brings up the on-screen keyboard if the cursor is on a left lowbattery Sends the remote control low battery signal. menu mute near period pickedup Sends a signal indicating that the remote control has...
Page 38: Callpreference
ViewStation EX, ViewStation FX, and VS4000 API Guide zoom+ zoom- 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...
Page 39: Polycom, Inc. 2003 I
ViewStation EX, ViewStation FX, and VS4000 API Guide callstate callstate <register|unregister|get> Description This command registers the Telnet or RS-232 session to receive notifications about call state activities. register unregister Disables the register mode. Example callstate register Output to Example callstate registered Acknowledgment that the session is now registered to list call state activities.
Page 40: Camera
ViewStation EX, ViewStation FX, and VS4000 API Guide camera camera <near|far|register|unregister> Subcommands camera near <{1..4}|source|move|stop|getposition| setposition|tracking> camera far <{1..5}|source|move|stop|tracking> camera <near|far> source camera <near|far> move <zoom+|zoom-|left|right| up|down|stop|continuous|discrete> camera <near|far> stop camera near <setposition|getposition> <x> <y> <z> camera <near|far> tracking <on|off|to_presets|get>...
Page 41 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 near move stop Near camera direction change stops.
Page 42 ViewStation EX, ViewStation FX, and VS4000 API Guide far subcommands far 1..5 Selects a far camera as the main video source (Camera source 1-5). far source Returns the number of the camera source currently selected. far move zoom+Far camera direction change (start zooming in).
Page 43: Camera1Ptz
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.
Page 44: Camera4Ptz
ViewStation EX, ViewStation FX, and VS4000 API Guide camera4ptz camera4ptz <yes|no|get> Description This command sets camera source 4 to pan-tilt-zoom mode. This command is specific to the VS4000 system. Note Example camera4ptz get User Interface Screen Location System Info>Admin Setup>Video/Camera>Cameras>VS4000...
Page 45: Camerainput
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> <off|s-video| composite|get> camerainput 1 <off|s-video|composite|get> camerainput 2 <off|s-video|composite|get> camerainput 3 <off|composite|get> camerainput 4 <off|s-video|composite|get> Description This command sets video inputs on cameras 1-4 for the VS4000 system only.
Page 46: Chaircontrol
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 <rel_chair|req_chair|req_floor| req_term_name|req_vas|view|view_broadcast er|list|set_password|set_broadcaster|set_ter m_name|hangup_term|end_conf><register|un...
Page 47 ViewStation EX, ViewStation FX, and VS4000 API Guide rel_chair req_chair req_floor req_term_name <term_no> req_vas view <term_no>Views the terminal term_no. view_broadcasterViews the broadcaster. list set_broadcaster <term_no> set_term_name <term_no><''term_name''> set_password <“ string''> hangup_term <term_no> end_conf register unregister Note Example chaircontrol req_term_name 2 ©...
Page 48: Colorbar
ViewStation EX, ViewStation FX, and VS4000 API Guide colorbar colorbar <on|off> Description This command turns the diagnostic color bars on or off. Example colorbar on User Interface Screen Location System Info>Diagnostics>Color Bar: View Color Bars country country <set|get> <algeria..zimbabwe> country set <algeria..zimbabwe>...
Page 49: Dataconferencetype
ViewStation EX, ViewStation FX, and VS4000 API Guide Note Examples country set germany country set “united states“ User Interface Screen Location System Info>Admin Setup>General Setup: Country dataconferencetype dataconferencetype <off|netmeeting|t120| get> Description This command sets the data conference type. If a setting is changed, the system has to be restarted for changes to take effect.
Page 50: Daylightsavings
ViewStation EX, ViewStation FX, and VS4000 API Guide daylightsavings daylightsavings <yes|no|get> Description This command sets the Global Management System daylight savings time. Example daylightsavings yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup: Daylight Savings Time defaultgateway defaultgateway <set|get> ["xxx.xxx.xxx.xxx"] defaultgateway set ["xxx.xxx.xxx.xxx"]...
Page 51: Dhcp
ViewStation EX, ViewStation FX, and VS4000 API Guide xxx.xxx.xxx.xxx Default gateway IP address. Example defaultgateway set 192.168.1.5 User Interface Screen Location System Info>AdminSetup>LAN/H.323>LAN/Intranet> LAN&Intranet: Default Gateway dhcp dhcp <off|client|server|get> Description This command is used to select or get DHCP options. After a change has been made to the DHCP settings, the user is prompted for restart.
Page 52: Dial
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>LAN &Intranet: DHCP dial dial <addressbook|auto|manual|phone> dial addressbook <"addr book name"> dial auto <speed> <“dialstr”> dial manual<"speed"><"dialstr1">["dialstr2"] [<h323|h320|ip|isdn>] dial phone <"dialstring"> Description This command lets you dial video or audio calls either manually or from the Address Book.
Page 53: Dialchannels
ViewStation EX, ViewStation FX, and VS4000 API Guide h323|h320|ip|isdnType of call. The parameters ip and isdn are phone dialstring Note Examples dial phone 5551212 dial manual 2x64 5551212 5551213 h320 dial addressbook dialchannels dialchannels <parallel|oneatatime|get> Description This command lets you define how each ISDN channel will be dialed.
Page 54: Diffserv
ViewStation EX, ViewStation FX, and VS4000 API Guide diffserv diffserv <set|get><{0..63}> diffserv set <{0..63}> diffserv get Description This command lets you enable the DiffServ option and specify a number that represents a priority level for the Type of Service (Quality of Service). The priority level value can be between 0 and 0..63...
Page 55: Display Call
ViewStation EX, ViewStation FX, and VS4000 API Guide Note Examples dir dat dir abk display call display call Description This command displays call ID, status, speed, and the number to which this system is connected. Example display call Output Sample...
Page 56: Displaybolt
ViewStation EX, ViewStation FX, and VS4000 API Guide Ouput Hi, my name is: Here is what I know about myself: Serial Number: Brand: Software Version: Model: Network Interface: MP Enabled: H323 Enabled: IP Address: Time In Last Call: Total Time In Calls: 87:17:17...
Page 57: Displayglobaladdresses
ViewStation EX, ViewStation FX, and VS4000 API Guide displayglobaladdresses displayglobaladdresses <yes|no|get> Description This command enables or disables the display of global addresses in the system’s Address Book. Example displayglobaladdresses yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Address>Server: Display Global Addresses displaygraphics displaygraphics <yes|no|get>...
Page 58: Displayipext
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Video/Cameras>Monitors>TV Monitors: Display Icons in a Call displayipext displayipext <yes|no|get> Description This command enables or disables the display of the IP extension field This extension is needed when placing a call through a gateway.
Page 59: Displayparams
ViewStation EX, ViewStation FX, and VS4000 API Guide Displays the current setting (yes or no). Example displayipisdninfo yes User Interface Screen Location System Info>Admin Setup>General Setup: Display My IP and ISDN Information displayparams displayparams Description This command outputs the list of all the system settings.
Page 60: Dns
ViewStation EX, ViewStation FX, and VS4000 API Guide gmsurl 9 <empty> gmsurl 10 <empty> gmscontactperson <empty> gmscontactnumber <empty> gmscontactemail <empty> gmscontactfax <empty> gmstechsupport <empty> gmscity <empty> gmsstate <empty> gmscountry <empty> gabserverip <empty> gabpassword <empty> displayglobaladdresses no registerthissystem no showaddrsingab both...
Page 61: Dynamicbandwidth
ViewStation EX, ViewStation FX, and VS4000 API Guide Description This command is used to configure DNS servers (up to 4 DNS servers can be configured). After a change is made, the system prompts the user for restart. Note set <{1..4}>...
Page 62: E164Ext
ViewStation EX, ViewStation FX, and VS4000 API Guide Example dynamicbandwidth yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>QOS: Dynamic Bandwidth e164ext e164ext <set|get> ["e.164name"] e164ext set ["e.164name"] e164ext set e164ext get Description This command is used to specify an H.323 (IP) extension (aka E.164).
Page 63: Echocanceller
ViewStation EX, ViewStation FX, and VS4000 API Guide Response e164ext <empty> restart system for changes to take effect. Restart now? <y, n> User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway: Gateway Number>Extension echocanceller echocanceller <yes|no|get> Description This command is used to prevent the user from hearing his or her voice loop back from the remote site.
Page 64: Enablesnapshots
ViewStation EX, ViewStation FX, and VS4000 API Guide enablesnapshots enablesnmp <yes|no|get> Description This command enables or disables the ability to take or send snapshots. This option is enabled by default. Example enablesnmp yes User Interface Screen Location System Info>Admin Setup>Video/Cameras>Cameras: Enable...
Page 65: Exit
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>SNMP: Enable SNMP exit exit Description This command ends an API command session. Example exit farcontrolnearcamera farcontrolnearcamera <yes|no|get> Description This command sets far control of the near camera, thus allowing remote sites to control the camera on your system.
Page 66: Farloop
ViewStation EX, ViewStation FX, and VS4000 API Guide farloop farloop <on|off> Description This command turns the far-end loop on or off, when in a call. Example farloop on User Interface Screen Location System Info>Diagnostics>Far End Loop farnametimedisplay farnametimedisplay <set|get> [0-9999] farnametimedisplay set ["time"]...
Page 67: Gabk Batch
ViewStation EX, ViewStation FX, and VS4000 API Guide Examples farnametimedisplay set farnametimedisplay set 120 User Interface Screen Location System Info>User Setup: Far Site Name Display gabk batch gabk batch <{0..59}> Description This command displays Global Address Book entries in batches.
Page 68: Gabserverip
ViewStation EX, ViewStation FX, and VS4000 API Guide password Password used to access the GAB server. Valid Note Example gabpassword set gabPass User Interface Screen Location System Info>User Setup>LAN/H.323>Global Address>Server: Server Password gabserverip gabserverip <set|get> ["xxx.xxx.xxx.xxx"] gabserverip set ["xxx.xxx.xxx.xxx"] gabserverip set...
Page 69: Gatekeeperip
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>User Setup>LAN/H.323>Global Address>Server: Server IP Address gatekeeperip gatekeeperip <set|get> ["xxx.xxx.xxx.xxx"] gatekeeperip set ["xxx.xxx.xxx.xxx"] gatekeeperip set gatekeeperip get Description This command sets the IP address of the gatekeeper. When this option is changed, the user is prompted to restart the system.
Page 70: Gatewayareacode
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayareacode gatewayareacode <set|get> ["areacode"] gatewayareacode set ["areacode"] gatewayareacode set gatewayareacode get Description This command sets the gateway area code. areacode Numeric string specifying the gateway area code. Example 1 gatewayareacode set 512...
Page 71: Gatewaycountrycode
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaycountrycode gatewaycountrycode <set|get> ["number"] gatewaycountrycode set ["number"] gatewaycountrycode set gatewaycountrycode get Description This command sets the gateway country code. number Note Example gatewaycountrycode set 1 User Interface Screen Location System Info>User Setup>LAN/H.323>H.323>Gateway: Gateway Number>Country Code...
Page 72: Gatewayext
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayext gatewayext <set|get> ["gateway extension"] gatewayext set ["gateway extension"] gatewayext set gatewayext get Description This command sets the gateway extension number. You need to restart the system for changes to take effect.
Page 73: Gatewaynumber
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaynumber gatewaynumber <set|get> ["number"] gatewaynumber set ["number"] gatewaynumber set gatewaynumber get Description This command sets the gateway number. number Note Example gatewaynumber set 5555454 User Interface Screen Location System Info>User Setup>LAN/H.323>H.323>Gateway: Gateway Number>Number...
Page 74: Gatewaynumbertype
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewaynumbertype gatewaynumbertype <did|number+extension|get> Description This command specifies the Gateway Number Type. It can be either Direct Inward Dial (DID) or Number + Extension. number+extension Example gatewaynumbertype number+extension User Interface Screen Location System Info>User Setup>LAN/H.323>H.323>Gateway: Gateway...
Page 75: Gatewayprefix
<“valid speed”> Note 1 Use quotation marks around a compound name or strings Note 2 The ViewStation EX system supports speeds up to 768 © Polycom, Inc. 2003 Sets the gateway prefix when followed by the value parameter. If you want to erase the current setting, omit value.
Page 76: Gatewaysetup
ViewStation EX, ViewStation FX, and VS4000 API Guide Example gatewayprefix set 168 90 User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway (page 2): Prefix gatewaysetup gatewaysetup Description This command lists all the available speeds at once. Example gatewaysetup Output 2x56 2x64 etc...
Page 77: Gatewaysuffix
<“valid speed”> Note 1 Use quotation marks around a compound name or strings Note 2 The ViewStation EX system supports speeds up to 768 © Polycom, Inc. 2003 Sets the gateway suffix when followed by the value parameter. If you want to erase the current setting, omit value.
Page 78: Gendial
ViewStation EX, ViewStation FX, and VS4000 API Guide Example gatewaysuffix set 192 11 User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gateway (page 2): Suffix gendial gendial [{0..9|#|*}] Description This command generates DTMF dialing tones to POTS line. 0..9|#|* Example gendial 2 generatetone generatetone <on|off>...
Page 79: Get Screen
ViewStation EX, ViewStation FX, and VS4000 API Guide get screen get screen Description This command returns the name of the current screen. It is intended to let the control panel programmer know which screen the user interface is currently displaying.
Page 80: Gmscontactemail
ViewStation EX, ViewStation FX, and VS4000 API Guide Example gmscity set Paris User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Info 1: City gmscontactemail gmscontactemail <set|get> ["email"] gmscontactemail set ["email"] gmscontactemail set gmscontactemail get Description This command sets the GMS contact E-mail information.
Page 81: Gmscontactfax
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscontactfax gmscontactfax <set|get> ["fax"] gmscontactfax set ["fax"] gmscontactfax set gmscontactfax get Description This command sets the GMS contact fax information. Note Example gmscontactfax ”512 555 5555” User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management>...
Page 82: Gmscontactnumber
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscontactnumber gmscontactnumber <set|get> ["number"] gmscontactnumber set ["number"] gmscontactnumber set gmscontactnumber get Description This command sets the GMS contact number information. number Note Example gmscontactnumber set ”512 555 1212” User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management>...
Page 83: Gmscontactperson
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscontactperson gmscontactperson <set|get> ["person"] gmscontactperson set ["person"] gmscontactperson set gmscontactperson get Description This command sets the GMS contact person information. person Note Example gmscontactperson set ”John GMSguy” User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management>...
Page 84: Gmscountry
ViewStation EX, ViewStation FX, and VS4000 API Guide gmscountry gmscountry <set|get> ["country"] gmscountry set ["country"] gmscountry set gmscountry get Description This command sets the GMS country information. country Note Example gmscountry set Argentina User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management>...
Page 85: Gmsstate
ViewStation EX, ViewStation FX, and VS4000 API Guide gmsstate gmsstate <set|get> ["state"] gmsstate set ["state"] gmsstate set gmsstate get Description This command sets the GMS state information. state Note Example gmsstate set Texas User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management>...
Page 86: Gmstechsupport
ViewStation EX, ViewStation FX, and VS4000 API Guide gmstechsupport gmstechsupport <set|get> ["tech support digits"] gmstechsupport set ["tech support digits"] gmstechsupport set gmstechsupport get Description This command sets the GMS technical support phone number information. tech support digits Note Example gmstechsupport set ”123 456 7890”...
Page 87: Gmsurl
ViewStation EX, ViewStation FX, and VS4000 API Guide gmsurl gmsurl <set|get> <{1..10}> ["xxx.xxx.xxx.xxx"] gmsurl set <{1..10}> ["xxx.xxx.xxx.xxx"] gmsurl set <{1..10}> gmsurl get <{1..10}> Description This command sets the URL of the GMS server that manages your system. When you are registered with the GMS, this information is automatically configured.
Page 88: Graphicsmonitor
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup>Select Server URLs... graphicsmonitor graphicsmonitor <tv|fxvga|visualconcert|get> Description This command sets the graphics monitor. fxvga visualconcert Example graphicsmonitor fxvga User Interface Screen Location System Info>Admin Setup>Video/Camera>Monitors>Graphics Monitor Selects the TV monitor as the graphics monitor.
Page 89: Graphicsmonitorfxvga
ViewStation EX, ViewStation FX, and VS4000 API Guide graphicsmonitorfxvga graphicsmonitorfxvga <on|off|get> Description This command enables or disables the system’s VGA graphics monitor. Example graphicsmonitorfxvga on User Interface Screen Location System Info>Admin Setup>Video/Camera>Monitors>Graphics Monitor: FX VGA graphicsmonitortv graphicsmonitortv <on|off|get> Description This command enables or disables the system’s TV monitor as the graphics monitor.
Page 90: Graphicsmonitorvisualconcert
ViewStation EX, ViewStation FX, and VS4000 API Guide Example graphicsmonitortv on User Interface Screen Location System Info>Admin Setup>Video/Camera>Monitors>Graphics Monitor: TV Monitor graphicsmonitorvisualconcert graphicsmonitorvisualconcert <on|off|get> Description This command enables or disables Visual Concert FX as the graphics monitor. Enable this option if Visual Concert FX is connected to your system and the graphics monitor is directly connected to Visual Concert FX.
Page 91: H323Name
ViewStation EX, ViewStation FX, and VS4000 API Guide h323name h323name <set|get> ["H.323name"] h323name set ["H.323name"] h323name set h323name get Description This command sets the H.323 name. H.323name Character string specifying the H.323 name. Note Example h323name set ”My System” User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Setup: H.323 name...
Page 92: Hangup
ViewStation EX, ViewStation FX, and VS4000 API Guide hangup hangup <phone|video> hangup phone hangup video [{1..3}] hangup video Description This command hangs up a telephone or video call. phone video 1..3 Example 1 hangup phone Example 2 hangup video 2 help help <all|help|verbose|terse|"string"|syntax>...
Page 93 ViewStation EX, ViewStation FX, and VS4000 API Guide help verbose terse string syntax Note Example 1 help all Output to Example 1 (partial) !<“str“> -Repeat the last command in the history list which begins with “str“. !<{1..64}> -Repeat the Nth command in the history list when N is 1 through 64.
Page 94: Hires
ViewStation EX, ViewStation FX, and VS4000 API Guide Output to Example 2 (partial) adminpassword advnetstats allowabkchanges allowdialing allowmixedcalls allowremotemon allowusersetup answer audioquality audioqualityg7221 autoanswer autodiscovernat hires hires <{2|3}> <yes|no|get> Description This command sets the high-resolution state for camera 2 or 3.
Page 95: History
ViewStation EX, ViewStation FX, and VS4000 API Guide Output to Example 2 camera 2 hires No User Interface Screen Location System Info>Admin Setup>Video Cameras>Cameras: High Resolution Cameras history history Description This command lists the last commands used in the current session.
Page 96: Hostname
ViewStation EX, ViewStation FX, and VS4000 API Guide hostname hostname <set|get> ["hostname"] hostname set ["hostname"] hostname set hostname get Description This command sets the LAN host name. This is the name assigned to the system for TCP/IP configuration and it can be used in place of an IP address when dialing IP calls.
Page 97: Ipaddress
ViewStation EX, ViewStation FX, and VS4000 API Guide Example 1 hostname set MySystem Example 2 hostname set Output to Example 2 hostname ADMIN User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>LAN & Intranet: Host Name ipaddress ipaddress <set|get> ["xxx.xxx.xxx.xxx"] ipaddress set ["xxx.xxx.xxx.xxx"]...
Page 98: Ipdialspeed
This command enables or disables the IP dialing speed valid speed. Note valid speedValid speeds are: 56, 64, 2x56, 112, 2x64, 128, 168, The ViewStation EX system supports speeds up to 768 Kbps. Sets the IP dialing speed. The parameters valid speed and on or off are required.
Page 99: Ipprecedence
ViewStation EX, ViewStation FX, and VS4000 API Guide Note Example ipdialspeed get 168 Output ipdialspeed 168 off User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Dialing Speeds ipprecedence ipprecedence <set|get> <{0..5}> ipprecedence set <{0..5}> ipprecedence get Description This command lets you enable the IP Precedence option and specify a priority level for the Type of Service (Quality of Service and Firewalls).
Page 100: Ipstat
ViewStation EX, ViewStation FX, and VS4000 API Guide ipstat ipstat Description This command outputs the same information that is displayed on the LAN & Intranet and Advanced LAN Settings screens: LAN host name, WINS resolution, DHCP, IP address, DNS servers 1-4, default gateway, subnet mask, and WINS server.
Page 101: Keypadaudioconf
ViewStation EX, ViewStation FX, and VS4000 API Guide keypadaudioconf keypadaudioconf <yes|no|get> Description This command sets the keypad audio confirmation. When this option is enabled, an audio response is echoed when a numeric key is depressed on the remote control. Example...
Page 102: Lanport
ViewStation EX, ViewStation FX, and VS4000 API Guide englishus, englishuk, french, german, italian, spanish, japanese, chinese, portuguese, norwegian Example language set german User Interface Screen Location System Info>Admin Setup>General Setup: Language lanport lanport <auto|10|10hdx|10fdx|100|100hdx| 100fdx|get> Description This command sets the system’s LAN port settings.
Page 103: Lanstat
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet> Advanced LAN Settings lanstat lanstat <min|misc|reset|sec|tmin|total> lanstat min lanstat min [{0..60}] lanstat misc lanstat reset lanstat sec lanstat tmin lanstat tmin [{0..60}] lanstat total Description This command displays local area network statistics.
Page 104 ViewStation EX, ViewStation FX, and VS4000 API Guide 0..60 Maximum number of minutes that can be specified is Example 1 lanstat min 1 Output to Example 1 lanstat: LAN statistics for minute -1 lanstat: lanstat: rx_bytes lanstat: tx_bytes lanstat: rx_packets...
Page 105: Listen
ViewStation EX, ViewStation FX, and VS4000 API Guide lanstat: Max tx iterations lanstat: Max rx iterations lanstat: Max interrupt iters lanstat: Total interrupts lanstat: Max interrupt delay lanstat: Last interrupt delay = 214835 lanstat: end listen listen <phone|video|sleep> Description This command registers the Telnet or RS-232 session to listen for...
Page 106: Maxgabinternationalcallspeed
Preferences: Maximum Line Speed for Global Address: International ISDN Calls Sets the maximum speed for international calls when followed by a valid speed value. and 1472 Kbps. Displays the current valid speed. The ViewStation EX system supports speeds up to 768 Kbps. www.polycom.com...
Page 107: Maxgabinternetcallspeed
Preferences: Maximum Line Speed for Global Address: LAN/Internet Calls (H.323) © Polycom, Inc. 2003 Sets the maximum speed for international calls when followed by a valid speed value. and Kbps. Displays the current valid speed. The ViewStation EX system supports speeds up to 768 Kbps.
Page 108: Maxgabisdncallspeed
Preferences: Maximum Line Speed for Global Address: ISDN Video Calls (H.320) Sets the maximum speed for ISDN calls when followed by a valid speed value. and 1472. Displays the current valid speed. The ViewStation EX system supports speeds up to 768 Kbps. www.polycom.com...
Page 109: Maxtimeincall
ViewStation EX, ViewStation FX, and VS4000 API Guide maxtimeincall maxtimeincall <set|get> [{0..99999}] maxtimeincall set [{0..99999}] maxtimeincall set maxtimeincall get Description This command sets the maximum number of minutes allowed for call length. When that time has expired in a call, you see a message asking you if you want to hang up or stay in the call.
Page 110: Mcupassword
MCU conference password. password Alphanumeric string. Valid characters are: 0-9, a-z Note 1 Use quotation marks around a compound name or strings Note 2 ViewStation EX: this multipoint option is not available Examples mcupassword vs4000MPpasswd This command sends the MCU password vs4000MPpasswd to the MCU.
Page 111: Meetingpassword
ViewStation EX, ViewStation FX, and VS4000 API Guide meetingpassword meetingpassword <set|get> ["password"] meetingpassword set ["password"] meetingpassword set meetingpassword get Description This command sets the meeting password. password Can be an alphanumeric string. Valid characters are: Note Example meetingpassword set EXpasswd User Interface Screen Location System Info>User Setup: Meeting Password -or- System...
Page 112: Mpautoanswer
Far Site Busy code (H.320) or Call Rejected (H.323). Displays the current setting (yes, no, donotdisturb). ViewStation EX: this multipoint option is not available unless you update your ViewStation EX system to support multipoint capabilities. For more information, refer to the ViewStation EX User Guide.
Page 113: Mpmode
Displays the current setting for this option. ViewStation EX: this multipoint option is not available unless you update your ViewStation EX system to support multipoint capabilities. For more information, refer to the...
Page 114: Mute
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>User Setup: Multipoint Mode mute mute <near|far|register|unregister> mute near <on|off|toggle|get> mute far get mute register mute unregister Description This command sets the near or far site mute mode. It can also set the system to register or unregister mode.
Page 115: Muteautoanswercalls
ViewStation EX, ViewStation FX, and VS4000 API Guide muteautoanswercalls muteautoanswercalls <yes|no|get> Description This command sets the system to Mute Auto Answer Calls mode. When this option is selected, the microphone pod is turned off to prevent the far site from hearing the near site when the system is in Auto Answer mode.
Page 116: Netmeetingip
ViewStation EX, ViewStation FX, and VS4000 API Guide Example nearloop on User Interface Screen Location System Info>Diagnostics>Near End Loop netmeetingip netmeetingip <set|get> ["xxx.xxx.xxx.xxx"] netmeetingip set ["xxx.xxx.xxx.xxx"] netmeetingip set netmeetingip get Description This command sets the NetMeeting IP address. After a change is made, the system prompts the user for a restart.
Page 117: Netstats
ViewStation EX, ViewStation FX, and VS4000 API Guide netstats netstats [{0..2}] netstats Description This command is used to get network statistics for each call. 0..2 Examples netstats netstats 2 Output Example call:1 txrate:128k rxrate:128k pktloss:0 %pktloss:0.00% tvp:H.263+FIT rvp:H.263+FIT tvf:CIF rvp:CIF tap:G.728 rap:G.728 tcp:H.323 rcp:H.323...
Page 118: Numdigitsdid
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Diagnostics>Network Stats numdigitsdid numdigitsdid <{0..24}|get> numdigitsdid <{0..24}> numdigitsdid get Description This command sets the number of digits in the DID Gateway number (E.164 dialing). The number of digits in the DID is that portion of the full DID that the Gateway will be given from the ISDN service provider as the Called Party Line Identifier.
Page 119: Numdigitsext
ViewStation EX, ViewStation FX, and VS4000 API Guide numdigitsext numdigitsext <{0..24}|get> numdigitsext <{0..24}> numdigitsext get Description This command sets the number of digits in the Number+Extension Gateway number (E.164 dialing). The number of digits in that number is that portion of the full Number+Extension number that the Gateway will be given from the ISDN service provider as the Called Party Line Identifier.
Page 120: Numberofmonitors
ViewStation EX, ViewStation FX, and VS4000 API Guide numberofmonitors numberofmonitors <{1..4}|get> numberofmonitors <{1..4}> numberofmonitors get Description This command sets the number of TV monitors that are connected to the system. 1..4 Example numberofmonitors 2 User Interface Screen Location System Info>Admin Setup>Video/Cameras>Monitors>TV Monitors:...
Page 121: Pause
ViewStation EX, ViewStation FX, and VS4000 API Guide Example outboundcallroute gateway User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gatekeeper: Outbound Call Route pause pause <0..65535> Description This command causes the command interpreter to pause before executing the next command. Pauses are useful when commands are retrieved from a script file.
Page 122: Ping
ViewStation EX, ViewStation FX, and VS4000 API Guide 100hdx 100fdx Example pcport 100fdx User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet> Advanced LAN Settings ping ping <ip_addr> [count] Description This command pings the IP address of a device to check if it can be reached.
Page 123: Pip
ViewStation EX, ViewStation FX, and VS4000 API Guide pip <on|off|auto|get> Description This command sets the on-screen PIP mode. The PIP feature allows the near site to adjust near-camera views while in a videoconference. auto Example pip auto User Interface Screen Location System Info>User Setup: PIP...
Page 124: Preset
ViewStation EX, ViewStation FX, and VS4000 API Guide switchnumber Sends the Gateway Switch Number as the didextnumber Sends the DID Extension Number as the preferred extension Example preferredalias isdnnumber User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Address> Preferences: Preferred Alias (E.164). Select this field to access the Preferred Alias screen.
Page 125: Primarycallchoice
ViewStation EX, ViewStation FX, and VS4000 API Guide This command sets the presets or goes to presets for the near or far camera source. It can also register or unregister the Telnet or RS-232 session to give notification when the user sets or goes to presets.
Page 126: Primarycamera
Selects IP as the Primary Call Type Choice. No call type is selected. Displays the current setting (isdn, ip, or manual). Selectable cameras. Displays the current setting (1, 2, 3, or 4). Option 4 (camera 4) is not available for the ViewStation EX. www.polycom.com...
Page 127: Queuecommands
ViewStation EX, ViewStation FX, and VS4000 API Guide queuecommands queuecommands <yes|no|get> Description This command allows the system to queue up commands that cannot be processed during call progress or popup window states (that is, when the system is showing the call progress screen or is displaying a popup window).
Page 128: Repeat
ViewStation EX, ViewStation FX, and VS4000 API Guide to the GAB, but does not appear in the Global Address Book of other systems. Example registerthissystem yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Address>Server: Register this System When Powered On repeat repeat <{1..64}>...
Page 129: Requireacctnumtodial
ViewStation EX, ViewStation FX, and VS4000 API Guide requireacctnumtodial requireacctnumtodial <yes|no|get> Description This command enables or disables the Require Account Number to Dial option. It is used to log calls to a specific account so that they can be tracked and billed to the appropriate departments. When this option is selected, you cannot make a call without first entering an account number.
Page 130: Roomphonenumber
ViewStation EX, ViewStation FX, and VS4000 API Guide roomphonenumber roomphonenumber <set|get> ["room phone number"] roomphonenumber set ["room phone number"] roomphonenumber set roomphonenumber get Description This command lets you enter the number of the phone that is located in the same room as the system.
Page 131: Rs232
ViewStation EX, ViewStation FX, and VS4000 API Guide rs232 rs232<mode|flowcontrol|baud|> Subcommands rs232 mode <passthru|control|get> rs232 flowcontrol <none|hardware|get> rs232 baud <1200| 2400|9600|14400|19200|38400| 57600|115200|get> Description This command configures and monitors the RS-232 port. For more detailed information about the RS-232 interface, see “Using the RS-232 Interface,”...
Page 132: Run
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Software/Hardware>RS-232 run <"scriptfilename"> Description This command loads a file from the flash file system and then executes the API commands contained in it. Each command needs to be placed on a single line with a <CR><LF>...
Page 133: Secondarycallchoice
ViewStation EX, ViewStation FX, and VS4000 API Guide speeddial disableui enableui chaircontrol sleep wake Example screen sysinfo secondarycallchoice secondarycallchoice <isdn|ip|none|get> Description This command sets the Global Address Book (GAB) Secondary Call Type Choice. It sets which call type the system will try second when dialing a site (which can be reached via H.320 and H.323) from the...
Page 134: Sendonlypreferredalias
ViewStation EX, ViewStation FX, and VS4000 API Guide sendonlypreferredalias sendonlypreferredalias <yes|no|get> Description This command enables the option Send Only Preferred Alias. It allows you to select which E.164 alias to send to the gatekeeper. Any change forces a system reboot.
Page 135: Setaccountnumber
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Software/Hardware>Software: System Serial Number setaccountnumber setaccountnumber <"account number"> Description This command sets the account number that is required for dialing out. The account number is saved in the GMS database and is generally assigned by the GMS administrator.
Page 136: Showpopup
ViewStation EX, ViewStation FX, and VS4000 API Guide both Example showaddrsingab both User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Address> Preferences: Show Addresses in Address Book showpopup showpopup <"text to display"> Description This command displays a popup message box in the user interface.
Page 137: Sleep
Web browser. For more information about loading a slide presentation using the Web browser, refer to the ViewStation FX/VS4000 User Guide or the ViewStation EX User Guide. To download the latest User Guide, go to www.polycom.com. thumbnails...
Page 138: Snapshot
ViewStation EX, ViewStation FX, and VS4000 API Guide list select < password start register unregister Note Example slides select presPC snapshot snapshot <0|1|2|3|4|register|unregister> Description This command sends a snapshot of the near site to the far site (or if 0 is specified, sends a snapshot of the far site to the near site if you are in a video call).
Page 139: Snapshotcamera
ViewStation EX, ViewStation FX, and VS4000 API Guide register unregister Unregisters the Telnet or RS-232 session to receive Example snapshot 1 snapshotcamera snapshotcamera <1|2|3|4|get> Description This command selects the default camera from which you want to send snapshots. 1|2|3|4 Example...
Page 140: Snapshottimeout
ViewStation EX, ViewStation FX, and VS4000 API Guide snapshottimeout snapshottimeout <yes|no|get> Description This command enables or disables the Snapshot Timeout option. By default, all slides and snapshots are displayed for a period of four minutes. When the display times out after four minutes, the system automatically returns to live video.
Page 141: Snmpadmin
ViewStation EX, ViewStation FX, and VS4000 API Guide snmpadmin snmpadmin <set|get> ["admin name"] snmpadmin set ["admin_name"] snmpadmin set snmpadmin get Description This command sets the SNMP administrator name. admin name Note Example snmpadmin set User Interface Screen Location System Info>Admin Setup>LAN/H.323>SNMP: Administrator Contact Name ©...
Page 142: Snmpcommunity
ViewStation EX, ViewStation FX, and VS4000 API Guide snmpcommunity snmpcommunity <set|get> ["community name"] snmpcommunity set ["community name"] snmpcommunity set snmpcommunity get Description This command sets the SNMP community name. community name Note Example snmpcommunity set Public User Interface Screen Location System Info>Admin Setup>LAN/H.323>SNMP: Community Name...
Page 143: Snmpconsoleip
ViewStation EX, ViewStation FX, and VS4000 API Guide snmpconsoleip snmpconsoleip <set|get> ["xxx.xxx.xxx.xxx"] snmpconsoleip set ["xxx.xxx.xxx.xxx"] snmpconsoleip set snmpconsoleip get Description This command sets the SNMP console IP address. xxx.xxx.xxx.xxxIP address of the console. Example snmpconsoleip set 192.168.1.111 User Interface Screen Location System Info>Admin Setup>LAN/H.323>SNMP: SNMP Console IP...
Page 144: Soundeffectsvolume
ViewStation EX, ViewStation FX, and VS4000 API Guide location name SNMP location name. Note Example snmplocation set User Interface Screen Location System Info>Admin Setup>LAN/H.323>SNMP: Location Name soundeffectsvolume soundeffectsvolume <set|get|test> <{0..10}> soundeffectsvolume set <{0..10}> soundeffectsvolume get soundeffectsvolume test Description This command allows you to adjust and test the volume of the sounds made by the system when you select an object on the screen with the remote control.
Page 145: Stdout
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Phone/Audio: Sound Effects Volume (select the Sound Effects Volume field. Adjust the volume setting by using the volume control buttons on the remote control). stdout stdout <on|off>...
Page 146: Streamannounce
ViewStation EX, ViewStation FX, and VS4000 API Guide Note streamannounce streamannounce <yes|no|get> Description This command enables or disables streaming announcement. When this option is enabled, the names of users logged on to your system are displayed on screen. Example streamannounce yes User Interface Screen Location System Info>Admin Setup>LAN/H.323>Streaming: Enable...
Page 147: Streamaudioport
ViewStation EX, ViewStation FX, and VS4000 API Guide streamaudioport streamaudioport <set|get> ["stream audio port"] streamaudioport set ["stream audio port"] streamaudioport set streamaudioport get Description This command sets the stream audio port. By default, the audio port is a fixed port. This may be changed if a user needs to go through the firewall.
Page 148: Streamenable
This command sets the multicast IP address. A default address is entered for you based on your system’s serial number. This ensures that you do not have the same multicast address as another Polycom system. You can change this default address using this command. Enables streaming.
Page 149: Streamrestoredefaults
ViewStation EX, ViewStation FX, and VS4000 API Guide Displays the current setting. ip address Multicast IP address. Example streammulticastip get User Interface Screen Location System Info>Admin Setup>LAN/H.323>Streaming: IP Multicast Address streamrestoredefaults streamrestoredefaults Description This command restores the stream Speed, IP Multicast Address, Number of Router Hops, Audio Port, and Video Port defaults and prints out the values.
Page 150: Streamrouterhops
ViewStation EX, ViewStation FX, and VS4000 API Guide streamrouterhops streamrouterhops <set|get> ["number router hops"] streamrouterhops set ["number router hops"] streamrouterhops set streamrouterhops get Description This command sets the number of routers you want the streaming video to pass through. This allows you to control who can see your streaming video.
Page 151: Streamspeed
ViewStation EX, ViewStation FX, and VS4000 API Guide streamspeed streamspeed <192|256|384|512|get> Description This command sets the speed of the video stream Example streamspeed 256 User Interface Screen Location System Info>Admin Setup>LAN/H.323>Streaming: Speed streamvideoport streamvideoport <set|get> ["video port"] streamvideoport set ["video port"]...
Page 152: Subnetmask
ViewStation EX, ViewStation FX, and VS4000 API Guide video port Video port number. Example streamvideoport 16386 User Interface Screen Location System Info>Admin Setup>LAN/H.323>Streaming: Video Port subnetmask subnetmask <set|get> ["xxx.xxx.xxx.xxx"] subnetmask set ["xxx.xxx.xxx.xxx"] subnetmask set subnetmask get Description This command sets the system’s subnet mask. After a change is made, the system prompts the user for restart.
Page 153: Systembehindnat
ViewStation EX, ViewStation FX, and VS4000 API Guide systembehindnat systembehindnat <yes|no|get> Description This command sets the system behind a NAT (Network Address Translation) device. Select this option if your system is behind a NAT device that is not H.323 aware. If your system is behind an H.323-aware NAT device, make sure this option is not selected or...
Page 154: Systemname
ViewStation EX, ViewStation FX, and VS4000 API Guide systemname systemname <set|get> ["system name"] systemname set ["system name"] systemname get Description This command sets the name of your system. The first character has to be a numeric (a digit) or alphabetical (a letter) character including foreign language characters.
Page 155: T120Nameip
ViewStation EX, ViewStation FX, and VS4000 API Guide t120nameip t120nameip <set|get> ["name or ip"] t120nameip set ["name or ip"] t120nameip set t120nameip get Description This command sets the t120 data conference name or IP address. The user is prompted for restart if this setting is changed.
Page 156: Tcpports
ViewStation EX, ViewStation FX, and VS4000 API Guide tcpports tcpports <set|get> [{1024..49150}] tcpports set [{1024..49150}] tcpports set tcpports get Description This command sets the TCP ports for Quality of Service on your system. 1024..49150Range of available TCP ports. Example tcpports set 3233 User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>Firewall/LAN...
Page 157: Teleareacode
ViewStation EX, ViewStation FX, and VS4000 API Guide phone numPhone number at which the user wants to be contacted. Note Example techsupport User Interface Screen Location Press the INFO button on the remote control>Technical Support Note teleareacode teleareacode <set|get> ["telephone area code"]...
Page 158: Telecountrycode
ViewStation EX, ViewStation FX, and VS4000 API Guide Note Example teleareacode set 703 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Area Code telecountrycode telecountrycode <set|get> ["telephone country code"] telecountrycode set ["telephone country code"] telecountrycode set telecountrycode get Description This command sets the system’s telephone country code. This code is associated with the country where the system is used.
Page 159: Telenumber
ViewStation EX, ViewStation FX, and VS4000 API Guide telenumber telenumber <set|get> ["telephone number"] telenumber set ["telephone number"] telenumber set telenumber get Description This command sets the system’s telephone number. telephone number Note Example telenumber set 5551212 User Interface Screen Location System Info>Admin Setup>Phone/Audio: Number...
Page 160: Testlan Arp
ViewStation EX, ViewStation FX, and VS4000 API Guide testlan arp testlan arp Description This command prints the ARP (Address Resolution Protocol) table contents. Example testlan arp testlan dcuinfo testlan dcuinfo Description This command displays miscellaneous DCU information. Example testlan dcuinfo...
Page 161: Testlan Dns
ViewStation EX, ViewStation FX, and VS4000 API Guide testlan dns testlan dns <name or ip> Description This command looks up a domain name or an IP address. name or ip Domain name or IP address. Example 1 testlan dns microsoft.com Output to Example 1 testlan: microsoft.com is 207.46.197.101...
Page 162 ViewStation EX, ViewStation FX, and VS4000 API Guide from [length|mps|reps|wait|echoport|locaport]. To print an echo message showing only the default settings, omit the parameter. length Message length in bytes. Number of messages per second. reps Number of times to repeat the message.
Page 163: Testlan Ping
ViewStation EX, ViewStation FX, and VS4000 API Guide testlan: waiting 100000us for next message testlan: sent=30, received=0, lost=30, delayed=0, corrupt=0 testlan: waiting 100000us for next message testlan: sent=40, received=0, lost=40, delayed=0, corrupt=0 testlan: waiting 100000us for next message testlan: sent=50, received=0, lost=50, delayed=0, corrupt=0...
Page 164: Textinput
ViewStation EX, ViewStation FX, and VS4000 API Guide textinput textinput <"text to input"> Description This command inserts text into a user interface edit box that you have already selected using the remote control. text to input Note Example textinput This command would insert the text "My Test VS4000" into a selected user interface edit box (for example, the System Name edit box in the General Setup screen of the user interface).
Page 165: Typeofservice
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>Global Management> Setup: Time Difference from GMT typeofservice typeofservice <ipprecedence|diffserv|get> Description This command selects the type of service for Quality of Service. ipprecedence diffserv Example typeofservice diffserv User Interface Screen Location System Info>Admin Setup>LAN/H.323>QOS: Type of Service...
Page 166: Usefixedports
ViewStation EX, ViewStation FX, and VS4000 API Guide Description This command sets the system’s UDP ports. 1024..49150Range of available UDP ports. Example udpports set 3230 User Interface Screen Location System Info>Admin Setup>LAN/H.323>LAN/Intranet>Firewall/LAN Connection: Use Fixed Ports> UDP Ports usefixedports usefixedports <yes|no|get>...
Page 167: Usegatekeeper
ViewStation EX, ViewStation FX, and VS4000 API Guide usegatekeeper usegatekeeper <off|specify|auto|get> Description This command selects the gatekeeper mode (off, specify or auto). After a change, the user is prompted for system restart. Note specify auto Example usegatekeeper specify User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gatekeeper: Use...
Page 168: Usepathnavigator
Note 1 This option is only accessible if PathNavigator is used. Note 2 ViewStation EX: this multipoint option is not available Example usepathnavigator required Always use PathNavigator to place a multipoint call. Never use the external MCU.
Page 169 ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>LAN/H.323>H.323>Gatekeeper: Dial Multipoint Calls from PathNavigator? © Polycom, Inc. 2003...
Page 170: Validateacctnum
ViewStation EX, ViewStation FX, and VS4000 API Guide validateacctnum validateacctnum <yes|no|get> Description This command sets the validation for the GMS account number that is used when dialing out. When the call connects, the system verifies that the account exists with the Global Management System (GMS) server.
Page 171: Vcraudioout
ViewStation EX, ViewStation FX, and VS4000 API Guide register unregister Unregisters the Telnet or RS-232 session to receive Example vcbutton play vcraudioout vcraudioout <yes|no|get> Description This command sets the VCR Audio Out Always On option. When this option is enabled, the system can operate with two VCRs, one for recording and one for play.
Page 172: Vcrrecordsource
ViewStation EX, ViewStation FX, and VS4000 API Guide vcrrecordsource vcrrecordsource <auto|near|far|get> Description This command sets the VCR record source. auto near Example vcrrecordsource auto User Interface Screen Location System Info>Admin Setup>Video/Cameras>VCR: VCR Record Source version version Description This command displays the current system’s version information.
Page 173: Vgahorizpos
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info: Software Version vgahorizpos vgahorizpos <left|right|get> Description This command is used to calibrate the VGA input in the horizontal position. left right Example vgahorizpos right User Interface Screen Location System Info>Admin Setup>Video/Cameras>VGA Input: Horizontal...
Page 174: Vgaphase
ViewStation EX, ViewStation FX, and VS4000 API Guide Example vgaoffmode nosignal User Interface Screen Location System Info>Admin Setup>Video/Cameras>Monitors>Graphics Monitor>FX VGA>Setup: VGA Output with No Graphics vgaphase vgaphase <increase|decrease|get> Description This command is used to calibrate the VGA input phase. increase...
Page 175: Vgaresolution
ViewStation EX, ViewStation FX, and VS4000 API Guide vgaresolution vgaresolution <800x600|1024x768| 1280x1024|get> Description This command is used to set the system’s VGA output resolution. Select the maximum resolution that your monitor or projector can support. Consult the user manual provided with the VGA monitor or projector for performance.
Page 176: Volume
ViewStation EX, ViewStation FX, and VS4000 API Guide down Example vgavertpos down User Interface Screen Location System Info>Admin Setup>Video/Cameras>VGA Input: Vertical Position This screen is only visible if a Visual Concert FX unit is connected to your system. volume volume <set|up|down|get|register| unregister>...
Page 177: Waitfor
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location Press the Volume UP or DOWN key on the remote control to see the audio level slider appear on screen. waitfor waitfor <callcomplete|systemready| receivingcall> Description This command is useful within script files (see the run command on page 124) to wait for a specific event before executing the next statement.
Page 178: Wake
ViewStation EX, ViewStation FX, and VS4000 API Guide wake wake Description This command wakes the system from sleep mode. To put the system in sleep mode, use the command sleep. Example wake wanipaddress wanipaddress <set|get> ["xxx.xxx.xxx.xxx"] wanipaddress set ["xxx.xxx.xxx.xxx"] wanipaddress set...
Page 179: Whoami
ViewStation EX, ViewStation FX, and VS4000 API Guide whoami whoami Description This command displays banner information. Example display whoami Ouput Hi, my name is: Here is what I know about myself: Serial Number: Brand: Software Version: Model: Network Interface: MP Enabled:...
Page 180: Winsresolution
ViewStation EX, ViewStation FX, and VS4000 API Guide Note Example widescreenvideo yes User Interface Screen Location System Info>Admin Setup>Video/Cameras>Monitors>TV Monitors: 60 fields/sec at >=512 Kbps (Wide Screen Video) winsresolution winsresolution <yes|no|get> Description This command sets WINS resolution. After a change is made, the system prompts the user for restart.
Page 181: Winsserver
ViewStation EX, ViewStation FX, and VS4000 API Guide winsserver winsserver <set|get> ["xxx.xxx.xxx.xxx"] winsserver set ["xxx.xxx.xxx.xxx"] winsserver set winsserver get Description This command sets the WINS server. After a change is made, the system prompts the user for restart. xxx.xxx.xxx.xxx WINS server IP address.
Page 182: Isdn Bri Commands
ViewStation EX, ViewStation FX, and VS4000 API Guide ISDN BRI Commands The following commands are specific to the ISDN BRI network interface. isdnareacode isdnareacode <set|get> ["area code"] isdnareacode set ["area code"] isdnareacode set isdnareacode get Description This command sets the ISDN area code or STD code associated with the area where the system is used.
Page 183: Isdncountrycode
ViewStation EX, ViewStation FX, and VS4000 API Guide isdncountrycode isdncountrycode <set|get> ["country code"] isdncountrycode set ["country code"] isdncountrycode set isdncountrycode get Description This command sets the ISDN country code associated with the country where the system is used. The system is generally able to automatically determine the country code based on the country you selected during initial system setup.
Page 184: Isdndialingprefix
ViewStation EX, ViewStation FX, and VS4000 API Guide isdndialingprefix isdndialingprefix <set|get> ["isdn prefix"] isdndialingprefix set ["isdn prefix"] isdndialingprefix set isdndialingprefix get Description This command sets the ISDN dialing prefix used to access an outside line if the system is behind a PBX.
Page 185: Isdndialspeed
ViewStation EX, ViewStation FX, and VS4000 API Guide isdndialspeed isdndialspeed <set|get> <"valid speed"> <on|off> isdndialspeed set <"valid speed"> <on|off> isdndialspeed get <"valid speed"> Description This command enables or disables the ISDN dialing speed valid speed. valid speedValid speeds are: 56, 2x56, 112, 168, 224, 280, 336,...
Page 186: Isdnnum
ViewStation EX, ViewStation FX, and VS4000 API Guide isdnnum isdnnum <set|get><1b1|1b2|2b1|2b2|3b1| 3b2|4b1|4b2> ["isdn number"] isdnnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> ["isdn number"] isdnnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> isdnnum get <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> Description This command sets the ISDN video number or numbers assigned to the system. set <1b1..4b2> Sets the ISDN video number for a B channel line get <1b1..4b2>...
Page 187: Spidnum
ViewStation EX, ViewStation FX, and VS4000 API Guide spidnum spidnum <set|get><1b1|1b2|2b1|2b2|3b1| 3b2|4b1|4b2> ["spid number"] spidnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> ["spid number"] spidnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> spidnum get <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> Description This command sets the ISDN SPID number or numbers assigned to the system. SPIDs generally apply only in the United States and Canada.
Page 188: Isdn Pri Commands
ViewStation EX, ViewStation FX, and VS4000 API Guide ISDN PRI Commands The following commands are specific to the ISDN PRI network interface. priareacode priareacode <set|get> ["area code"] priareacode set ["area code"] priareacode set priareacode get Description This command sets the PRI area code.
Page 189: Pricallbycall
ViewStation EX, ViewStation FX, and VS4000 API Guide pricallbycall pricallbycall <set|get> [{0..31}] pricallbycall set [{0..31}] pricallbycall set pricallbycall get Description This command sets the PRI area code. Call-by-call is a number from 1 to 31, which is optionally sent to an upstream telephone company switch, if required.
Page 190: Prichannel
ViewStation EX, ViewStation FX, and VS4000 API Guide prichannel prichannel <set|get> <all|{1..<23|30>}> <on|off> prichannel set all <on|off> prichannel set <{1..23}> <on|off> prichannel set <{1..30}> <on|off> prichannel set prichannel get all <on|off> prichannel get <{1..23}> <on|off> prichannel get <{1..30}> <on|off> Description This command selects the PRI channels that will be active for the PRI line.
Page 191 ViewStation EX, ViewStation FX, and VS4000 API Guide Example 2 prichannel set Example 3 prichannel get 3 User Interface Screen Location System Info>Admin Setup>Video Network>IMUX>PRI Network> PRI Status This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system.
Page 192: Pricsu
ViewStation EX, ViewStation FX, and VS4000 API Guide 17-31. But the PRI Status screen numbers these channels contiguously in the range 1-30. Therefore, on the PRI Status screen, channels 1-15 control the status of timeslots 1-15, and channels 16-30 control the status of timeslots 17-31.
Page 193: Pridialchannels
ViewStation EX, ViewStation FX, and VS4000 API Guide pridialchannels pridialchannels <set|get> <{1..12|15}> pridialchannels set <{1..12}> pridialchannels set <{1..15}> pridialchannels set pridialchannels get Description This command sets the number of PRI channels to dial in parallel. By default, ISDN channels are dialed three at a time. On PRI systems, you can choose the number of channels to dial in parallel.
Page 194: Priintlprefix
ViewStation EX, ViewStation FX, and VS4000 API Guide priintlprefix priintlprefix <set|get> ["prefix"] priintlprefix set ["prefix"] priintlprefix set priintlprefix get Description This command sets the PRI international dialing prefix.The international prefix defaults to 011 for North America and 00 for European countries. The default depends on the country.
Page 195: Prilinebuildout
ViewStation EX, ViewStation FX, and VS4000 API Guide prilinebuildout prilinebuildout <set|get><0|-7.5|-15|-22.5>| <0-133|134-266|267-399|400-533|534-665> prilinebuildout set <0|-7.5|-15|-22.5> prilinebuildout set <0-133|134-266|267-399| 400-533|534-665> prilinebuildout get Description This command sets the PRI line buildout for a T1 interface. If you are using an internal CSU, enter the output attenuation in dB. If you are using an external CSU, enter the output attenuation in feet.
Page 196: Prilinesignal
ViewStation EX, ViewStation FX, and VS4000 API Guide prilinesignal prilinesignal <set|get><esf/b8zs|crc4/hdb3| hdb3> prilinesignal set <esf/b8zs|crc4/hdb3|hdb3> prilinesignal get Description This command sets the PRI line signal. esf/b8zs crc4/hdb3 A method of signal encoding used with an E1 interface. hdb3 Example prilinesignal set esf/b8zs User Interface Screen Location System Info>Admin Setup>Video Network>IMUX>PRI Network>...
Page 197: Prinumber
ViewStation EX, ViewStation FX, and VS4000 API Guide prinumber prinumber <set|get> ["pri number"] prinumber set ["pri number"] prinumber set prinumber get Description This command sets the PRI video number. pri number Numeric string. This number is provided by your Example...
Page 198: Prinumberingplan
ViewStation EX, ViewStation FX, and VS4000 API Guide prinumberingplan prinumberingplan <isdn|unknown|get> Description This command sets the PRI numbering plan. isdn unknown The default selection is unknown. With this option, the Example prinumberingplan isdn User Interface Screen Location System Info>Admin Setup>Video Network>IMUX>PRI network>...
Page 199: Prioutsideline
ViewStation EX, ViewStation FX, and VS4000 API Guide prioutsideline prioutsideline <set|get> ["outside_line"] prioutsideline set ["outside_line"] prioutsideline set prioutsideline get Description This command sets the PRI number that is dialed for outside line access. This number is needed if your system is on a PBX.
Page 200: Priswitch
ViewStation EX, ViewStation FX, and VS4000 API Guide priswitch priswitch <set|get> <att5ess|att4ess| norteldms|ni2|net5/ctr4> priswitch set <att5ess|att4ess|norteldms|ni2| net5/ctr4> priswitch get Description This command sets the PRI switch. If more than one switch protocol is supported, you must find out from your telephone service provider which protocol to select.
Page 201: V.35/Rs-449/Rs-530/Rs-366 Commands
ViewStation EX, ViewStation FX, and VS4000 API Guide V.35/RS-449/RS-530/RS-366 Commands The following commands are specific to the V.35/RS-449/RS-530/ RS-366 network interface. cts <normal|inverted|get> Description This command lets you configure the cts serial interface control signal (clear to send). The default setting for this signal is normal.
Page 202: Dcdfilter
ViewStation EX, ViewStation FX, and VS4000 API Guide inverted Example dcd inverted User Interface Screen Location System Info>Admin Setup>Video Network>Advanced V.35: DCD This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. dcdfilter dcdfilter <on|off|get>...
Page 203: Dsr
ViewStation EX, ViewStation FX, and VS4000 API Guide dsr <normal|inverted|get> Description This command lets you configure the dsr serial interface control signal (data set ready). The default setting for this signal is normal. normal inverted Example dsr get User Interface Screen Location System Info>Admin Setup>Video Network>Advanced V.35: DSR...
Page 204: Dtr
ViewStation EX, ViewStation FX, and VS4000 API Guide Example dsranswer on User Interface Screen Location System Info>Admin Setup>Video Network>Advanced V.35: DSR>Answer This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. dtr <normal|inverted|on|get> Description This command lets you configure the dtr serial interface control signal (data terminal ready).
Page 205: H331Audiomode
ViewStation EX, ViewStation FX, and VS4000 API Guide h331audiomode h331audiomode <g728|g711u|g711a|g722-56| g722-48|off|get> Description This command sets the H.331 audio protocol for transmitting audio in broadcast mode. Broadcast configuration parameters should be set to accommodate the lowest common denominator of the systems which are receiving the broadcast.
Page 206: H331Framerate
ViewStation EX, ViewStation FX, and VS4000 API Guide User Interface Screen Location System Info>Admin Setup>Video Network>Video Network> Broadcast Mode Setup: Audio Mode This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. h331framerate h331framerate <30|15|10|7.5|get>...
Page 207: H331Videoprotocol
ViewStation EX, ViewStation FX, and VS4000 API Guide h331videoprotocol h331videoprotocol <h263|h261|get> Description This command sets the H.331 video protocol for the broadcast transmission. Broadcast configuration parameters should be set to accommodate the lowest common denominator of the systems which are receiving the broadcast.
Page 208: Rs366Dialing
ViewStation EX, ViewStation FX, and VS4000 API Guide fcif Example h331videoformat fcif User Interface Screen Location System Info>Admin Setup>Video Network>Video Network> Broadcast Mode Setup: Video Format This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system.
Page 209: Rts
ViewStation EX, ViewStation FX, and VS4000 API Guide rt <normal|inverted|get> Description This command lets you configure the rt serial interface control signal (receive timing: clock). The default setting for this signal is normal. normal inverted Example rt inverted User Interface Screen Location System Info>Admin Setup>Video Network>Advanced V.35: RT...
Page 210 ViewStation EX, ViewStation FX, and VS4000 API Guide Example rts normal User Interface Screen Location System Info>Admin Setup>Video Network>Advanced V.35: RTS This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. st <normal|inverted|get> Description This command lets you configure the st serial interface control signal (send timing: clock).
Page 211: V35Broadcastmode
ViewStation EX, ViewStation FX, and VS4000 API Guide v35broadcastmode v35broadcastmode <on|off|get> Description This command sets H.331 broadcast mode for transmissions via satellite. Example v35broadcastmode on User Interface Screen Location System Info>Admin Setup>Video Network>Video Network: Broadcast Mode This screen is only accessible if you have a V.35/RS-449/RS-530/ RS-366 network interface connected to your system.
Page 212: V35Dialingprotocol
ViewStation EX, ViewStation FX, and VS4000 API Guide v35dialingprotocol v35dialingprotocol <rs366|get> Description This command selects the V.35/RS-449/RS-530/RS-366 dialing protocol. Selecting a dialing protocol is not needed if you are using your DCE to dial the call or if you have a dedicated connection to the far site.
Page 213: V35Portsused
ViewStation EX, ViewStation FX, and VS4000 API Guide nomenclature of the user interface and the command isdnnum (see page 178). set <1b1|1b2> Sets the ISDN video number for a B channel line get <1b1|1b2> Displays the current ISDN video number...
Page 214: V35Prefix
ViewStation EX, ViewStation FX, and VS4000 API Guide Example v35portsused 1+2 User Interface Screen Location System Info>Admin Setup>Video Network>Video Network: V.35 Ports Used This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your system. v35prefix v35prefix <set|get>...
Page 215: V35Profile
V.35/RS-449/RS-530/RS-366 prefix. The prefix is a function of your DCE. Please consult the DCE user guide for additional information. " " valid speed > Displays the current setting for valid speed. The ViewStation EX system supports speeds up to 768 Kbps.
Page 216 ViewStation EX, ViewStation FX, and VS4000 API Guide V.35/RS-449/RS-530/RS-366 profiles (equipment/manufacturer) available. Consult your DCE user guide for additional information on setting dialing profiles. Displays the current profile. view Displays all the settings (speed, prefix or suffix) of the current profile.
Page 217: V35Suffix
V.35/RS-449/RS-530/RS-366 suffix. The suffix is a function of your DCE. Please consult the DCE user guide for additional information. " " valid speed > Displays the current setting for valid speed. The ViewStation EX system supports speeds up to 768 Kbps.
Page 218 ViewStation EX, ViewStation FX, and VS4000 API Guide Example v35suffix set 128 ”#4#2” This command associates the dialing suffix #4#2 to the speed 128. User Interface Screen Location System Info>Admin Setup>Video Network>Video Network> Advanced Dialing This screen is only accessible if you have a V.35/RS-449/RS-530/RS-366 network interface connected to your...
Page 219: Safety And Legal Notices
Sublicense Agreement without Polycom’s prior consent. Title to all Subject Programs shall at all times remain and vest solely with Polycom and its licensors. Buyer acknowledges Polycom, Inc.’s claim that the Subject Programs are its trade secret and confidential property, and shall treat them as such.
Page 220: Fcc Notice
Polycom, Inc. authorized service facility/dealer. The warranty is limited to the original purchaser and is not transferable. Any liability of Polycom, Inc. or its suppliers with respect to the product or the performance thereof under any warranty, negligence, strict liability or other theory will be limited exclusively to product repair or replacement as provided above.
Page 221 This equipment may not be used on a coin service or party line. If you experience trouble with your ViewStation EX/FX/VS4000, disconnect it from the telephone line to determine if the registered equipment is malfunctioning. For repair or warranty information, please contact Polycom Inc.
Page 222: Declaration Of Conformity
EEA Regulatory Notices CE Mark This ViewStation EX/FX/VS4000 has been marked with the CE mark. This mark indicates compliance with EEC Directives 1999/5/EC. A full copy of the Declaration of Conformity can be obtained from Polycom Ltd., 270 Bath Road, Slough UK SL1 4DX.
Page 223 Safety and Legal Notices Dichiarazione di conformità: Con la presente Polycom Ltd. dichiara che il ViewStation EX/FX/VS4000 soddisfa i requisiti essenziali e le altre disposizioni pertinenti della direttiva 1999/5/CE. Verklaring van overeenstemming: Hierbij verklaart Polycom Ltd. dat diens ViewStation EX/FX/VS4000 voldoet aan de basisvereisten en andere relevante voorwaarden van EG-richtlijn 1999/5/EG.
Page 224 ViewStation EX, ViewStation FX, and VS4000 API Guide Underwriters Laboratories Statement The system is intended to be powered only by the supplied power supply unit. Special Safety Instructions Follow existing safety instructions and observe all safeguards as directed. Installation Instructions Installation must be performed in accordance with all relevant national wiring rules.

This manual is also suitable for:

Viewstation fx Vs4000

Polycom ViewStation EX Api Manual

Quick Links

Need help?

Questions and answers

Related Manuals for Polycom ViewStation EX

Summary of Contents for Polycom ViewStation EX