Home

FX/VS4000 ARENA API Programmer`s Guide 5.0

Contents

1. button callhangup callpreference callpreference lt h320 h323 both get gt Description This command specifies the supported call types ISDN IP or both Changes necessitate a system reboot h320 Selects H 320 ISDN as the supported call type h323 Selects H 323 IP as the supported call type both Both H 320 and H 323 are selected get Displays the selected call types Example callpreference h323 User Interface Screen Location System Info gt Admin Setup gt Video Network gt Call Preference ISDN Video Calls H 320 LAN Internet Calls H 323 or both options 30 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide callstate Polycom Inc 2003 callstate lt register unregister get gt Description This command registers the Telnet or RS 232 session to receive notifications about call state activities register Registers the system to give notification of call activities unregister Disables the register mode get Displays the selected call state mode register or unregister Example callstate register Output to Example callstate registered Acknowledgment that the session is now registered to list call state activities Sample Output cs cal1 0 chan 0 dialstr 192 168 1 103 state RINGING cs cal 0 chan 0 dialstr 192 168 1 103 state RINGING cs Cal 0
2. get Displays the current setting increase or decrease Example vgaphase decrease User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt VGA Input Phase This screen is only visible if a Visual Concert FX unit is connected to your system 166 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide vgaresolution vgaresolution lt 800x600 1024x768 1280x1024 get gt 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 800x600 Sets the resolution to 800 pixels per line and 600 lines per video image 1024x768 Sets the resolution to 1024 pixels per line and 768 lines per video image 1280x1024 Sets the resolution to 1280 pixels per line and 1024 lines per video image get Displays the current setting Example vgaresolution 1280x1024 User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Monitors gt Graphics Monitor gt FX VGA gt Setup VGA Resolution vgavertpos Polycom Inc 2003 vgavertpos lt up down get gt Description This command is used to calibrate the VGA input in the vertical position up Moves the calibration frame up 167 ViewStation EX ViewStation FX and VS4000 API Guide down Moves the calibration frame do
3. 128 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide sleep sleep Description This command puts the system in sleep mode To wake the system use the command wake Example sleep slides Polycom Inc 2003 slides lt thumbnails next previous first last resend list select password start register unregister gt slides select lt pres gt Description This command and its subcommands let you select and control a slide presentation To use the following slides subcommands you must first load the slide presentation via the 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 Shows the slide thumbnail page next Selects the next slide in the presentation previous Selects the previous slide in the presentation first Selects the first slide in the presentation last Selects the last slide in the presentation resend Resends the last slide 129 ViewStation EX ViewStation FX and VS4000 API Guide list List all loaded presentations displays names and IP addresses available for viewing The names are the names of the PCs from which the presentations are loaded select lt pres gt Selects slide presentation pres from the list by name pres is generally the name of your comput
4. SpoyoAoyntns ViewStation EX FX VS4000 trAnpoi tig Baoik arraroels Kal aMec Bacik c TpOUTTOBEGEIS TNS OSnyiac 1999 5 EK Vaatimustenmukaisuusvakuutus Polycom Ltd vakuuttaa t ten ett ViewStation EX FX VS4000 on direktiivin 1999 5 EC keskeisten vaatimusten ja sen muiden t t koskevien s nn sten mukainen D claration de conformit Par la pr sente Polycom Ltd d clare que ce ViewStation EX FX VS4000 est conforme aux conditions essentielles et toute autre modalit pertinente de la Directive 1999 5 CE www polycom com Safety and Legal Notices Dichiarazione di conformita 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 Declarac o de Conformidade Atrav s da presente a Polycom Ltd declara que este ViewStation EX FX VS4000 se encontra em e Oaee com os requisitos essenciais e outras disposi es relevantes da Directiva 1999 5 CE Declaraci n de conformidad Por la presente declaraci n Polycom Ltd declara que este ViewStation EX FX VS4000 cumple los requisitos esenciales y otras cl usulas importantes de la directiva 1999 5 CE Overensst mmelsef rklaring Polycom Ltd f rklarar harmed att d
5. or 111 222 333 Example techsupport 1 512 555 1212 User Interface Screen Location Press the INFO button on the remote control gt Technical Support Note The Technical Support icon is visible only when the system is registered with the Polycom Global Management System teleareacode O Polycom Inc 2003 teleareacode lt set get gt telephone area code teleareacode set telephone area code teleareacode set teleareacode get Description This command sets the system s telephone area code set Sets the telephone area code when followed by the telephone area code parameter If you want to erase the current setting omit the parameter get Displays the current setting telephone area code Area code associated with the location where the system is used 149 ViewStation EX ViewStation FX and VS4000 API Guide Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example teleareacode set 703 User Interface Screen Location System Info gt Admin Setup gt Phone Audio Area Code telecountrycode telecountrycode lt set get gt 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 The system is ge
6. 28x64 1848 1856 1904 and 1920 Kbps on Enables the specified speed off Disables the specified speed 90 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example ipdialspeed get 168 Output ipdialspeed 168 off User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Dialing Speeds ipprecedence Polycom Inc 2003 ipprecedence lt set get gt lt 0 5 gt ipprecedence set lt 0 5 gt 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 The value can be between 0 and 7 set Sets the IP precedence A priority level from the range 0 5 is required 0 7 Priority level range get Displays the current setting Example ipprecedence set 5 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt QOS Type of Service ToS Value gt IP Prec 91 ViewStation EX ViewStation FX and VS4000 API Guide ipstat ipstat Description This command outputs the same information that is displayed on the LAN amp 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 Exa
7. e164ext e164ext lt set get gt e 164name el64ext set e 164name e164ext set e164ext get Description This command is used to specify an H 323 IP extension aka E 164 H 323 extensions are needed for inbound calls going through a Gateway The extension number is associated with a specific LAN device Changes require that you restart the system set Sets the E 164 extension when followed by the parameter e 164name If you want to erase the current setting omit e 164name get Displays the current setting for this option E 164 name or empty e 164name A valid E 164 extension usually a four digit number Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example el64ext set 54 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Response el64ext lt empty gt restart system for changes to take effect Restart now lt y n gt User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gateway Gateway Number gt Extension echocanceller echocanceller lt yes no get gt Description This command is used to prevent the user from hearing his or her voice loop back from the remote site This option is enabled by default Note We strongly recommend that you do not turn off echo cancellation yes Enables the option no Disables the option get Displays the curre
8. to the gateway number The prefix identifies which gateway is used to dial a call at a particular data rate set lt valid speed gt Sets the gateway prefix when followed by the value parameter If you want to erase the current setting omit value valid speedValid speeds are 56 64 2x56 112 2x64 128 168 192 224 256 280 320 336 384 392 7x64 8x56 504 512 560 576 616 640 672 704 728 768 784 832 840 16x56 14x64 952 960 1008 1024 1064 1088 1120 1152 1176 1216 1232 1280 1288 24x56 21x64 1400 1408 1456 1472 1512 1536 1568 1600 1624 1664 1680 1728 1736 32x56 28x64 1848 1856 1904 and 1920 Kbps value Prefix code used for a particular call speed Consult your gateway instruction manual to determine which codes are appropriate get lt valid speed gt Displays the current value for this speed Note 1 Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Note 2 The ViewStation EX system supports speeds up to 768 Kbps 67 ViewStation EX ViewStation FX and VS4000 API Guide Example gatewayprefix set 168 90 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gateway page 2 Prefix gatewaysetup gatewaysetup Description This command lists all the available speeds at once Example gatewaysetup Output 56 12 64 14 2x
9. The PIP feature allows the near site to adjust near camera views while in a videoconference on Enables PIP mode The system shows a PIP window which remains in the lower right corner of the TV screen until the video call is completed off Disables PIP mode auto The system shows a PIP window when the call is first connected and when the remote control is not resting on a flat surface get Displays the current setting for PIP mode on off or auto Example pip auto User Interface Screen Location System Info gt User Setup PIP preferredalias Polycom Inc 2003 preferredalias lt isdnnumber fulldidnumber switchnumber didextnumber extension get gt Description This command sends only one alias to the Gatekeeper isdnnumber Sends the ISDN number as the preferred alias fulldidnumber Sends the Full DID number as the preferred alias 115 ViewStation EX ViewStation FX and VS4000 API Guide switchnumber Sends the Gateway Switch Number as the preferred alias didextnumber Sends the DID Extension Number as the preferred alias extension Sends the H 323 Extension Number E 164 as the preferred alias get Displays the current setting isdnnumber fulldidnumber switchnumber didextnumber or extension Example preferredalias isdnnumber User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Preferences Preferred Alias E 164 Select this field to a
10. This command displays banner information Example display whoami Ouput Hi my name is Superman Here is what I know about myself Serial Number XXXXX Brand Polycom Software Version Release 5 0 FX 14 Mar 2003 Model VSFX4 Network Interface PRI_T1 MP Enabled Yes H323 Enabled Yes IP Address 192 168 1 101 Time In Last Call 0 25 30 Total Time In Calls 77 17 17 Total Calls 819 Country Code f Area Code 512 PRI Number 5555555 widescreenvideo widescreenvideo lt yes no get gt Description This command sets wide screen video When wide screen video is enabled the monitor displays in wide screen video format in H 323 or H 320 calls at 512 Kbps and above Polycom Inc 2003 171 ViewStation EX ViewStation FX and VS4000 API Guide Note This option only works between ViewStation EX ViewStation FX or VS4000 systems with software version 4 0 and higher Otherwise if one of the systems has a software version older than 4 0 the proprietary letter box format is supported yes Enables wide screen video 60 fields sec ITU at gt 512Kbps no Disables wide screen video get Displays the current setting yes or no Example widescreenvideo yes User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Monitors gt TV Monitors 60 fields sec at gt 512 Kbps Wide Screen Video winsresolution winsresolution lt yes no get gt Description This command sets
11. 2 get 86 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Output to Example 2 camera 2 hires No User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Cameras High Resolution Cameras history Polycom Inc 2003 history Description This command lists the last commands used in the current session The maximum number of commands that can be displayed is 64 Example history Sample Output 1 ipaddress set 192 168 1 105 2 hostname set MyFX 3 lanport 100fdx 4 callstate register 5 lanport get 87 ViewStation EX ViewStation FX and VS4000 API Guide hostname hostname lt set get gt 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 ALAN host name is required It cannot be deleted or left blank When the LAN host name is changed the system prompts the user for a reboot set Sets the system s LAN host name when followed by the hostname parameter If hostname is omitted the system automatically sets it to Admin get Displays the current setting hostname Character string specifying the LAN host name of the system The LAN host name follows these format rules e lt starts and ends with an English letter A a to Z z It is not case
12. 256 384 512 get gt Description This command sets the speed of the video stream 192 Sets the streaming speed at 192 Kbps 256 Sets the streaming speed at 256 Kbps 384 Sets the streaming speed at 384 Kbps 512 Sets the streaming speed at 512 Kbps get Displays the current setting Example streamspeed 256 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Streaming Speed streamvideoport streamvideoport lt set get gt video port streamvideoport set video port streamvideoport set streamvideoport get Description This command sets the stream video port By default the video port is a fixed port This may be changed if a user needs to go through the firewall Polycom Inc 2003 143 ViewStation EX ViewStation FX and VS4000 API Guide set Sets the stream video port when followed by the video port parameter If you want to erase the current setting omit the parameter get Displays the current setting video port Video port number Example streamvideoport 16386 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Streaming Video Port subnetmask subnetmask lt set get gt 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 set Sets the system s subnet mask when
13. AdminSetup gt LAN H 323 gt LAN Intranet gt LAN amp Ilntranet Default Gateway dhcp Polycom Inc 2003 dhcp lt off client server get gt 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 If the user or administrator has chosen not to allow the DHCP server option when updating software using the Softupdate application the API shell command only displays the lt off client get gt options If the DHCP server option is enabled during Softupdate the API shell command displays the lt off client server get gt options After a change is made the system prompts the user for restart off Disables DHCP client Enables DHCP client The system is set to obtain an IP address from a server on your network server Enables DHCP server The system is set to provide IP addresses to the other computers on your network get Displays the selected DHCP option off client or server Example dhcp client 43 ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet DHCP dial dial lt addressbook auto manual phone gt dial addressbook lt addr book name gt dial auto lt speed gt lt dialstr gt dial manual lt speed gt lt dialstri gt dialstr2 lt h323 h320 ip isdn gt dial phone lt di
14. Data Carrier Detect 2 RX Receive 3 TX Transmit 4 DTR Data Terminal Ready 5 GND Ground 6 DSR Data Set Ready 7 RTS Ready to Send 8 CTS Clear to Send 9 RI This pin is not used 8 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide RS 232 Serial Cable Pinout and Connections VS4000 The RS 232 serial cable has a 9 pin DB 9 connector on both ends It is used to connect the VS4000 to a terminal or another communications device DB 9 FEMALE DB 9 DB 9 FEMALE DB 9 FEMALE SOCKET FEMALE SOCKET VIEW VIEW 3 Pe 2 SSE JACK SCREW je 25 FEET 2 Pe vu i DRAIN WIRE i Pin Number Function 1 DCD Data Carrier Detect 2 RX Receive 3 TX Transmit 4 DTR Data Terminal Ready 5 GND Ground 6 DSR Data Set Ready 7 RTS Ready to Send 8 CTS Clear to Send 9 RI This pin is not used Polycom Inc 2003 9 ViewStation EX ViewStation FX and VS4000 API Guide Status Display The call status can be displayed in a number of ways The display call status command shows table of current calls Using the listen or dial Command To display real time status on individual B channels incoming outgoing calls either register the termina
15. Plug in the 8 pin mini DIN connector to the RS 232 port on the back panel of the system Starting a Communications Session Several communications programs are available to access the RS 232 interface The following explains how to start a HyperTerminal session on your PC 1 From your PC desktop select Start gt Programs gt Accessories gt Communications gt HyperTerminal 2 Inthe Connection Description window enter a Name Select an icon Click OK 3 Inthe Connect To window from the Connect Using list select the proper comport usually com1 Click OK 4 Inthe Com1 Properties window under Port Settings select the following settings e Bits per second should match that of the system default is 9600 e Data bit 8 e Parity none e Stop bits 1 e Flow control should match the system s None is the default Some third party control panels may require to be set to Hardware 5 Click OK Note A carriage return is required before an RS 232 communications session with a system can proceed 4 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide RS 232 Interface Information The following provides additional information about the ViewStation EX ViewStation FX and VS4000 systems RS 232 interface RS 232 User Interface Screen Baud Rate The RS 232 user interface screen is used to set the baud rate and the modes for the serial port on the back of the system To access the RS 232 screen
16. 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 If the account does not exist the call is disconnected yes Enables the GMS account number validation option no Disables the GMS account number validation option get Displays the current setting yes or no Example validateacctnum yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Setup Validate Account Number vcbutton vcbutton lt play stop get register unregister gt Description This command simulates the Visual Concert FX play and stop buttons lt can also register unregister to receive notification of Visual Concert FX events play Starts sending the video stream from the Visual Concert PX stop Stops sending the video stream from the Visual Concert PX get Displays the current mode setting play or stop 162 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide register Registers the Telnet or RS 232 session to receive notifications about Visual Concert FX events unregister Unregisters the Telnet or RS 232 session to receive notifications about Visual Concert FX events Example vcbutton play vcraudioout Polycom Inc 2003 vcraudioout lt yes no get gt Description This command sets the VCR Audio O
17. Type gt Streaming Call 137 ViewStation EX ViewStation FX and VS4000 API Guide Note The Call Type icon is only visible on the main user interface screen if you have previously enabled Allow Streaming System Info gt AdminSetup gt LAN H 323 gt Streaming Allow Streaming streamannounce streamannounce lt yes no get gt 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 yes Enables streaming announcement no Disables streaming announcement get Displays the current setting yes or no Example streamannounce yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Streaming Enable Streaming Announcement 138 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide streamaudioport streamaudioport lt set get gt 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 set Sets the stream audio port when followed by the stream audio port parameter If you want to erase the current setting omit the parameter get Displays the current setting stream audio port Audio port number Note Use quotation marks around co
18. VS4000 API Guide snmpadmin snmpadmin lt set get gt admin name snmpadmin set admin_name snmpadmin set snmpadmin get Description This command sets the SNMP administrator name set Sets the administrator name when followed by the admin name parameter If you want to erase the current setting omit admin name get Displays the current setting admin name SNMP administrator contact name Character string Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example snmpadmin set John Admin User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt SNMP Administrator Contact Name Polycom Inc 2003 133 ViewStation EX ViewStation FX and VS4000 API Guide snmpcommunity snmpcommunity lt set get gt community name snmpcommunity set community name snmpcommunity set snmpcommunity get Description This command sets the SNMP community name set Sets the SNMP community name when followed by the community name parameter If you want to erase the current setting omit the parameter get Displays the current setting community name SNMP community name Character string Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example snmpcommunity set Public User Interface Screen Location System Info gt A
19. a change is made the system prompts the user for restart Note This setting can only be changed when DHCP is off set Sets the LAN IP address when followed by the XXX XXX XXX XXX parameter If you want to erase the current setting omit xxx xxx XXX XXX get Displays the current setting for this option 89 ViewStation EX ViewStation FX and VS4000 API Guide XXX XXX XXX XXXIP address of the system Example ipaddress set 192 168 1 111 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet IP Address ipdialspeed ipdialspeed lt set get gt lt valid speed gt lt on off gt ipdialspeed lt set gt lt valid speed gt lt on off gt ipdialspeed get lt valid speed gt Description This command enables or disables the IP dialing speed valid speed Note The ViewStation EX system supports speeds up to 768 Kbps set Sets the IP dialing speed The parameters valid speed and on or off are required get Displays the current setting on or off The parameter valid speed is required valid speedValid speeds are 56 64 2x56 112 2x64 128 168 192 224 256 280 320 33 6 384 392 7x64 8x56 504 512 560 576 616 640 672 704 728 768 784 832 840 16x56 14x64 952 960 1008 1024 1064 1088 1120 1152 1176 1216 1232 1280 1288 24x56 21x64 1400 1408 1456 1472 1512 1536 1568 1600 1624 1664 1680 1728 1736 32x56
20. and a far site name if they are available If the user selects yes the call will be answered If the user selects no the call will be rejected The factory default is set to yes donotdisturb If the option Auto Answer Point to Point is set to get Example donotdisturb the user is not notified of the incoming call The site which placed the call receives a Far Site Busy code H 320 or Call Rejected H 323 Displays the status of the option yes no or donotdisturb autoanswer donotdisturb User Interface Screen Location System Info gt Admin Setup gt Genera Setupl Auto Answer Point to Point 25 ViewStation EX ViewStation FX and VS4000 API Guide autodiscovernat autodiscovernat lt yes no get gt Description This command enables or disables the Auto Discover NAT option yes Enables the option to automatically assign the WAN IP address that is used to place and receive calls outside the WAN no Disables the option get Displays the current setting yes or no Example autodiscovernat yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Firewall LAN Connection Auto Discover NAT autoh323dialing autoh323dialing lt yes no get gt Description This command enables or disables the Auto H 323 Dialing option This option is enabled by default to let the system auto detect the type of call you are placing IP or ISDN based on th
21. any order The command is not checked prior to being sent to the user interface Care should be used because a bong a warning noise sound is sent from the system if there is no function for that button on the currently active screen Issues the key to the user interface Issues the key to the user interface Issues the 1 key to the user interface Issues the 2 key to the user interface Issues the 3 key to the user interface Issues the 4 key to the user interface Issues the 5 key to the user interface Issues the 6 key to the user interface Issues the 7 key to the user interface Issues the 8 key to the user interface Issues the 9 key to the user interface O O ON OO Fk WO DY Issues the 0 key to the user interface auto Sends the Auto key to the user interface callhangup Sends the Call Hang Up key to the user interface camera Not implemented 28 www polycom com Polycom Inc 2003 ViewStation EX ViewStation FX and VS4000 API Guide delete directory down far home info keyboard left Not implemented Takes the user to the Address Book screen Sends the down key to the user interface down arrow Sends the Far key to the user interface Takes the user to the main screen Sends the Info command to the user interface Brings up the on screen keyboard if the cursor is ona text field Sends the left left arrow command to the user interface lowbattery Sends the remote control
22. carrier_deltas end lanstat misc Output to Example 2 0 o0oo0O0O0O0Oo0Oo0oOoo0o Miscellaneous LAN Counters lanstat lanstat lanstat Free buffer count 2043 Lowest free count 2034 Packets discarded 0 96 Port 1 o o000O0O0O0O00O00O00O00O00O000000000000o www polycom com ViewStation EX ViewStation FX and VS4000 API Guide lanstat Max tx iterations 8 lanstat Max rx iterations 4 lanstat Max interrupt iters 3 lanstat Total interrupts 113137865 lanstat Max interrupt delay 441170 lanstat Last interrupt delay 214835 lanstat end listen Polycom Inc 2003 listen lt phone video sleep gt Description This command registers the Telnet or RS 232 session to listen for incoming video calls POTS phone calls or system sleep or awake state and consequently to give notification when the registered state occurs phone Instructs the session to listen for incoming phone calls When this event occurs the message listen audio ringing is received video Instructs the session to listen for incoming video calls When this event occurs the message listen video ringing is received sleep Instructs the session to listen for when the system goes into sleep mode When this event occurs the message listen going to sleep is received When the system wakes up the message listen wake up is received Example listen sleep Output to Example liste
23. cause 16 dialstring 95551212 ended cal1 0 gt listen video listen video registered O Polycom Inc 2003 11 ViewStation EX ViewStation FX and VS4000 API Guide gt gt listen video ringing there is an incoming call auto answer is on P 8 Ga es call ess call cs call est call est call cst Gall cs call csi call cs call esi call cs call est call ees Gall esi call Es cali cs call est call est call esi call cs call csi call cs call csi call cs call est call ess call esi call es call cs call est call cs call esi call active TI O O O O O 6 O O O 0 0 0 amp oO 0 0 O O O 0 0 00 0 co 0O Ol cal 0 chan chan 0 dial chan 0 dial chan 0 dial chan 1 dial chan 1 dial chan 2 dial chan 3 dial chan 2 dial chan 3 dial chan 6 dial chan 6 dial chan 4 dial chan 5 dial chan 4 dial chan 5 dial chan 7 dial chan 7 dial chan 1 dial chan 2 dial chan 3 dial chan 6 dial chan 4 dial chan 5 dial chan 7 dial chan 0 dial chan 1 dial chan 2 dial chan 3 dial chan 6 dial chan 4 dial chan 5 dial chan 7 dial 11 0 speed 5 12 0 dialstr 800555 Ss Ss Ss 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 800555 8
24. causes the command interpreter to pause before executing the next command Pauses are useful when commands are retrieved from a script file 0 65535 Maximum length of pause is 65535 seconds Example pause 3 In this example the command pauses an integer number of seconds 3 before the next command pcport Polycom Inc 2003 pcport lt auto 10 10hdx 10fdx 100 100hdx 100fdx get gt Description This command sets the PC port speed of the system auto Auto negotiates the LAN speed 10 10 Mbps auto duplex 10hdx 10 Mbps half duplex 10fdx 10 Mbps full duplex 113 ViewStation EX ViewStation FX and VS4000 API Guide 100 100 Mbps auto duplex 100hdx 100 Mbps half duplex 100fdx 100 Mbps full duplex get Displays the current setting Example pcport 100fdx User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Advanced LAN Settings ping ping lt ip_addr gt count Description This command pings the IP address of a device to check if it can be reached This command is similar to the command testlan ping on page 155 ip addr IP address of the device count Optional parameter defining the number of times the device is to be pinged Example ping 192 168 100 2 114 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide pip pip lt on off auto get gt Description This command sets the on screen PIP mode
25. code associated with the area where the system is used set Sets the ISDN area code when followed by the area code parameter If you want to erase the current setting omit area code get Displays the area code information area code Numeric value Example isdnareacode set 512 User Interface Screen Location System Info gt Admin Setup gt Video Network gt ISDN Network ISDN Video Numbers gt Area Code Note This screen is only accessible if you have a Quad BRI network interface connected to your system 174 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide isdncountrycode isdncountrycode lt set get gt 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 set Sets the ISDN country code when followed by the country code parameter If you want to erase the current setting omit country code get Displays the country code information country codeNumeric value This code is the same as the telephone country code Example isdncountrycode set 1 User Interface Screen Location System Info gt Admin Setup gt Video Network gt ISDN Network ISDN Video Numbers gt Country Code Note This screen is only acc
26. eed te E EE 164 Vga hoz it a a ie bea ue adeae cela lata ae 165 VOAOMMONS 3 04 needed sees nl aed eat 165 NVOADNASC cid ee 166 A O 167 VGAVEIMPOS ocio tailandia 167 AU a ea ay ete 168 ETEL PEA tote tee tit e e o A alee 169 WAKE oahi iea leciOlbid chuck tedde suet a A habs aed lel og cachesdda siete 170 Wanhlpaddresss caos catas dinarama nicas Das ina 170 WHO MM do els baths bel ten 171 widescreenvideo ecccccecceceeceeeeeeeeeeceeeeaeceeceeeeeeeeeeeseceecnaeeaeeeeeeeeess 171 WINSFESOlUtION seniausi tases tated wadbackeada tad ade aia iaaa aaa 172 WINSSONVEN sfecsk e ata ast eats sat een eh tae Shad N cat tae es 173 Polycom Inc 2003 v ViewStation EX ViewStation FX and VS4000 API Guide ISDN BRI Commands sno a E a 174 ISANAareACOdS wes TO 174 ISUNGOUNTY CODE siinne ces tude E Hanhaeenetadceeeieral cde 175 isdndialingpretD curro dos 176 sandialspeed acti is 177 O ee a Ee IRs ee EE E ie Ma eae a ete A 178 SPINK scsi eee E T E chigts Plea hide cdecdall da vacelveiansce 179 ISBN PRI Commands iveco aed ede 180 priareacode daneli ii eclee dad adds 180 pricallbyCalll s nerriet a A 181 PICA AMO A nel ed ibas 182 DC lit adie tala 184 pridialchannels is a a aaa ahea iaa aa aaa ea raaa a 185 PUM PROTX 2 ati da 186 prilinebuildOut nsss neie aa in dada 187 prilinesional exi aci dada 188 prin mbere aaka dada 189 PrINUMberingplan ecceccecceeeeeeeeeeeeccececeeceeeeeeeeeseceeeseeneeeeeeeeeeeeeess 190 prioUt
27. esther a a abd cate ee 113 DING eater O iran 114 O tatads 115 SS 115 O AE testa het stele nad ties eat ee eat 116 primarycallGChOiCe 0 00 DA edie a ae dee 117 PIIMANy CAIMOM a eaaa addict AE pede edadt idees 118 QUCUCCOMMANAS 2 cc eee ceeececeeeeeee cee ee eee ee sede eesenaeeeeceeeeeeeeeteseeesenaaees 119 registernthiss Mii 119 ST 120 requireacctnumtodial ooooococccccccccoccococooonononoconcnnnnnnnnnnnnnnnn ono a a ian 121 FOOMPNONENUMDEL cooococcccocccnccccncncncnnnnnnnn ono nnnnnnnnnnnnnnnnn sanan nn nnnnnnncnnnnnnn 122 LI e e lead a deta ci e en IA 123 A te aaa ete fe I ee O 124 O 124 secondarycallchoiCe ocionemocissseniiienercrnrrnnrrnet eden rnnrrr nacen 125 sendonlypreferredaliaS oooononccccnnnoccccccnnnonccccnnnnancccnnnnnn Eria 126 SAN a a fad eae la ee ee 126 setacc ounthuUMbDeT ase e saazasicadt aad a aaa atete del aia 127 SHOWAGrSINGAD irc tado 127 SROWPOpuUP3 uti iio 128 sleeps eee terete RO PR 129 SNIG S i E NR 129 ETE aa EE telat asthe tees Mab EE E A etal bts az hes 130 SnapshotCameraes ci a a vete A TE 131 SnapsShottiMeout aa EAE E 132 snmpadmMiM se oesie e eaa a aea a aaa i 133 SIMPCON MU Vai A ORS 134 SAMPCONSOlSIP reei e a 135 SIMP CO A ead Meee ee eae 135 SOUNCeTIECtSVOIW ME a a ieedtA dad a aa e EE AA shes 136 STOO Ut EREE E EATE e E 137 A a ae a a dee ened gta ede ee eased eet 137 SMEAMANNOUNCE AEAEE ass dr eng eae 138 StrEAMAUGIOPOM ss adis pee ae iaa Madd cdta 139 EI A 140 iv www
28. followed by the parameter xxx xxx xxx xxx If you want to erase the current setting omit Xxx xxX XXX XXX get Displays the current setting XXX XXX XXX XXXIP address of the GAB server Can be a numeric or character string Example gabserverip set gab polycom com 60 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt User Setup gt LAN H 323 gt Global Address gt Server Server IP Address gatekeeperip gatekeeperip lt set get gt 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 set Sets the gatekeeper IP address when followed by the parameter XXX XXX XXX XXX If you want to erase the current setting omit xxX XXX XXX XXX get Displays the current setting XXX XXX XXX XXXIP address of the gatekeeper Example gatekeeperip set 192 168 1 1 User Interface Screen Location System Info gt User Setup gt LAN H 323 gt H 323 gt Gatekeeper Gatekeeper IP Address Polycom Inc 2003 61 ViewStation EX ViewStation FX and VS4000 API Guide gatewayareacode gatewayareacode lt set get gt areacode gatewayareacode set areacode gatewayareacode set gatewayareacode get Description This command sets the gateway area code set Sets the area cod
29. followed by a valid speed value valid speedValid speeds are 128 256 384 512 768 1024 1472 and Kbps get Displays the current valid speed Note The ViewStation EX system supports speeds up to 768 Kbps Example maxgabinternetcallspeed set 384 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Preferences Maximum Line Speed for Global Address LAN Internet Calls H 323 O Polycom Inc 2003 99 ViewStation EX ViewStation FX and VS4000 API Guide maxgabisdncallspeed maxgabisdncallspeed lt set get gt lt valid speed gt maxgabisdncallspeed get Description This command sets the maximum speed for ISDN H 320 calls made from the Global Address Book set Sets the maximum speed for ISDN calls when followed by a valid speed value valid speedValid speeds are 2x64 128 256 384 512 768 1024 and 1472 get Displays the current valid speed Note The ViewStation EX system supports speeds up to 768 Kbps Example maxgabisdntcallspeed set 384 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Preferences Maximum Line Speed for Global Address ISDN Video Calls H 320 100 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide maxtimeincall maxtimeincall lt set get gt 0 99999 maxtimeincall set 0 99999 maxtimeincall set maxtimeincall get Description T
30. gmscontactfax get Description This command sets the GMS contact fax information set Sets the GMS contact fax information when followed by the fax parameter If you want to erase the current setting omit fax get Displays the current contact fax information fax Character string specifying the contact fax Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gmscontactfax 512 555 5555 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 Contact Fax Polycom Inc 2003 73 ViewStation EX ViewStation FX and VS4000 API Guide gmscontactnumber gmscontactnumber lt set get gt number gmscontactnumber set number gmscontactnumber set gmscontactnumber get Description This command sets the GMS contact number information set Sets the GMS contact number information when followed by the number parameter If you want to erase the current setting omit number get Displays the current contact number information number Numeric string specifying the contact number Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gmscontactnumber set 512 555 1212 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 Contact Number 74 www poly
31. in a Call displayipext displayipext lt yes no get gt Description This command enables or disables the display of the IP extension field This extension is needed when placing a call through a gateway When this option is selected the Extension field is visible in the Video Call screen yes Enables the display of the IP extension no Disables the display of the IP extension get Displays the current setting yes or no Example displayipext yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Setup Display IP Dialing Extension displayipisdninfo displaygraphics lt yes no get gt Description This command displays IP and ISDN information on the main user interface page yes Enables the display of IP and ISDN information no Disables the display of IP and ISDN information 50 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide get Displays the current setting yes or no Example displayipisdninfo yes User Interface Screen Location System Info gt Admin Setup gt General Setup Display My IP and ISDN Information displayparams Polycom Inc 2003 displayparams Description This command outputs the list of all the system settings Example displayparams Output partial systemname Jw hostname Jw ipaddress 192 168 1 104 wanipaddress 192 168 1 111 version Release 5 0 FX 14 Mar 20 serialnum X
32. inconvenient Click OK The Telnet window appears and a welcome message is displayed Ex Hi My name is John_System This message is followed by information specific to your system You are now in an active Telnet session To display the list of available API commands type help To start a Telnet session from MS DOS 1 Start an MS DOS session on your PC and type telnet lt system IP address gt 24 Press the Enter key A welcome message is displayed Ex Hi My name is John_System This message is followed by information specific to your system You are now in an active Telnet session To display the list of available API commands type help Using the RS 232 Interface Polycom Inc 2003 Connecting the Serial Cable VS4000 The RS 232 serial cable has a 9 pin DB 9 connector on both ends It is used to connect the VS4000 system to a terminal or another communications device To connect your PC to the VS4000 system ViewStation EX ViewStation FX and VS4000 API Guide Locate the RS 232 serial cable DB9 to DB9 straight through Connect one end of the cable to the serial port of your PC 3 Connect the other end to the RS 232 serial port on the back panel of the VS4000 system ViewStation EX and ViewStation FX Connect your PC to the ViewStation EX or FX system as follows 1 Locate the RS 232 serial cable DB9 to 8 pin mini DIN 2 Connect the 9 pin DB 9 connector to the serial port of your PC 3
33. low battery signal menu mute near period pickedup putdown pip preset right select slides snapshot up volume volume Sends the Menu key to the user interface causing it to back up one screen Sends the Mute key to the user interface causing a toggle of mute state Sends the Near key to the user interface Types a period if the cursor is on a text field Sends a signal indicating that the remote control has been picked up remote control feet are out Sends signal indicating that the remote control has been set down remote control feet are pushed in Not implemented Assigns a preset number when followed by a number from 0 through 9 Sends the right key to the user interface right arrow Sends the select key center button command to the user interface Sends the Slide key to the user interface Sends the Snapshot key to the user interface Sends the up up arrow key to the user interface Sends the Volume up key to the user interface Sends the Volume down key to the user interface 29 ViewStation EX ViewStation FX and VS4000 API Guide zoom Sends the Zoom in key to the user interface zoom Sends the Zoom out key to the user interface Example 1 button up This command sends the up arrow command to the user interface Example 2 button near left right callhangup This valid command combines the following commands button near button left button right
34. polycom com ViewStation EX ViewStation FX and VS4000 API Guide StreammiUultiGAastip cia ici 140 streamrestoredefaultS oooooooconnnncnncnnonconcncconononnnnnnnnnnnnnnnnnnnnnnnnncnnnnnnns 141 StFEAMMOUTEMNOPS eain e e a tail 142 StrEAMSPEEA EA EEE AAA rra ranas 143 streamvideoport amuinan ea eden a N E E A 143 O R E PEA EEEE ETT 144 systemiboniNanA esera aE A EAA E EE 145 s stemna Med a aaia a aia aaa in o rie 146 TA ZOMAMEIP a e aid 147 COPOS a a a dae 148 techsupPo iia aida 148 tele araceli add 149 telecountry Code ui nen ule akan 150 telenumber acs Ai iin hice eat ead eee eee tele 151 LESAN ARP isaiciisierci n allas ada ion lad pieeueh lass iaa a iig 152 testam ACUN Os cctises secs ln ri Sage sat a a ia leant eect 152 testan dns ser eset etek E sod Behera cae at r a feats 153 TESTA OST 153 tostlan PING eiei eaae nit wenadaceie tian E AEAEE 155 CONUS EE Shs a oe ne eae nase a eat akon cat toes oda qeda tate Maa alee O 156 IMM eee ein aia 156 tYPCOISEIVICG ure aes ita 157 WAP POMS suits ie soteaddd fete aa a td Piatra Sect elids pects klaa dealt ad lada 157 LISETIXEU POMS cnn dee E A E 158 usegatekeeperis ic sii Ml in ta iii etait 159 usepathnavigatol es arira a es 160 validateaccihuM cecocica tarso sheds aia a eiee iii 162 Ael oTi ura D acts Bieta hse ent a Me ata oot nai ta hed a ate ee Hoenn a Ott ele AD oe aaa a 162 VCPAUdlOOUt cates cia na 163 VCITECOSOUICE EAE E Scat needa a pe eae 164 VERSION ENAT EEEE E EATE E EAE
35. sensitive It ends with an English letter A a to Z z or a number 0 to 9 e The characters inside the LAN host name can be English letters numbers and hyphen e t cannot be longer than 63 characters Note 1 Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Note 2 The LAN host name is initialized as follows during the out of box setup sequence If the system name is a valid LAN host name meaning that it follows the preceding format rules then the LAN host name is the same as the system name If the system name is not a valid LAN host name meaning that it does not follow the preceding format rules the 88 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide invalid characters are removed from the system name to obtain a valid LAN host name If the resulting string is empty the default LAN host name is Admin Example 1 hostname set MySystem Example 2 hostname set Output to Example 2 hostname ADMIN User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet Host Name ipaddress Polycom Inc 2003 ipaddress lt set get gt XXX XXX XXX XXX ipaddress set XXX XXX XXX XXX ipaddress set ipaddress get Description This command sets the LAN IP address of the system Use this command when you need to allocate a static IP address to your system After
36. system and one ViewStation FX or VS4000 system The RS 232 port is used as a data channel over an H 320 video call Data received from the RS 232 port on the near end system is pushed through the call to the far end endpoint and then transmitted to the endpoint s RS 232 port Similarly data from the far end endpoint is transmitted back to the near end system through the H 320 call and then transmitted to the near end RS 232 port The data channel speed is dynamically allocated The maximum data flow rate is based on the bandwidth of the call Because data throughput has priority over video throughput video bandwidth may be restricted to support data requirements Audio is not compromised Pass Thru Mode is a proprietary feature that is only supported when both endpoints are either ViewStation EX ViewStation FX or VS4000 systems The RS 232 port only supports data Pass Thru in H 320 mode ISDN or V 35 RS 449 RS 530 RS 366 RS 366 Data Pass Thru in an H 323 IP video call or multipoint call is not supported as alternative file transfer methods such as ftp or Telnet are widely available Note In Pass Thru mode both local and remote stations need to be set to the same data rate Pass Thru Mode to Control Mode lf the near site is set to Pass Thru Mode but the far site is set to Control Mode then the device connected to the near site RS 232 port can be used to 6 www polycom com ViewStation EX ViewStation FX and VS4000
37. the range is 1 12 Example pridialchannels set 3 User Interface Screen Location System Info gt AdminSetup gt Video Network gt IMUX gt Advanced Dialing This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system Polycom Inc 2003 185 ViewStation EX ViewStation FX and VS4000 API Guide priintlprefix priintlprefix lt set get gt 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 set Sets the PRI international dialing prefix when followed by the parameter prefix If you want to erase the current setting omit the parameter get Displays the current setting prefix Numeric string Example priintlprefix set 011 User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI Network gt PRI Setup gt Advanced PRI Setup International Dialing Prefix This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system 186 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide prilinebuildout Polycom Inc 2003 prilinebuildout lt set get gt lt 0 7 5 15 22 5 gt lt 0 133 134 266 267 399 400 533 534 665 gt pr
38. the terminal name for the terminal numbered term_no req_vas Requests voice activated switching view lt term_no gt Views the terminal term_no view_broadcasterViews the broadcaster list Lists terminals in the conference set_broadcaster lt term_no gt Requests the terminal term_no to become the broadcaster set_term_name lt term_no gt lt term_name gt Sets the terminal name term_name for the terminal numbered term_no set_password lt string gt Sets the chaircontrol password It must be followed by the parameter string This password is the Meeting Password System Info gt Admin Setup gt Security Meeting Password To clear the chaircontrol password omit the parameters string hangup_term lt term_no gt Disconnects the terminal term_no from the conference end_conf Ends the conference register Registers to receive feedback on all chair control operations unregister Unregisters do not receive feedback on all chair control operations Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example chaircontrol req_term_name 2 39 ViewStation EX ViewStation FX and VS4000 API Guide colorbar colorbar lt on off gt Description This command turns the diagnostic color bars on or off on Turns on the color bars off Turns off the color bars Example colorbar on User Interface Screen Location Syste
39. you can only set three cameras 1 2 and 4 to S video composite Enables composite inputs on the selected camera source get Displays the current camera input status for the selected camera source 37 ViewStation EX ViewStation FX and VS4000 API Guide Example 1 camerainput 1 s video Example 2 camerainput 4 get Output to Example 2 camerainput 4 off User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Cameras gt VS4000 Camera Setup Primary Camera chaircontrol chaircontrol lt 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 gt lt register un register gt Subcommands chaircontrol lt req_term_name gt lt term_no gt chaircontrol lt view gt lt term_no gt chaircontrol lt set_broadcaster gt lt term_no gt chaircontrol lt set_term_name gt lt term_no gt lt term_name gt chaircontrol lt set_password gt lt meeting unique gt lt unique string gt chaircontrol lt hangup_term gt lt term_no gt Description This command and subcommands are used for various chair control functions while the system is in an MCU call 38 www polycom com Polycom Inc 2003 ViewStation EX ViewStation FX and VS4000 API Guide rel_chair Releases the chair req_chair Requests the chair req_floor Requests the floor req_term_name lt term_no gt Requests
40. 00 115200 get gt 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 on page 3 of this manual mode passthru Sets the RS 232 port to passthru mode mode control Sets the RS 232 port to control mode mode get Displays the current mode setting passthru or control flowcontrol noneSets the RS 232 hardware flow control to none flowcontrol hardware Sets the RS 232 hardware flow control to hardware flowcontrol get Displays the current flowcontrol setting none or hardware baud lt 1200 115200 gt Sets the RS 232 port baud rate Supported baud rates are 1200 2400 9600 14400 19200 38400 57600 115200 Examples rs232 mode passthru rs232 baud 9600 rs232 flowcontrol hardware 123 ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt Software Hardware gt RS 232 run run lt scriptfilename gt 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 lt CR gt lt LF gt as a terminator scriptfilename Name of the script file containing the API commands to be executed Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example r
41. 003 primarycallchoice lt isdn ip manual get gt Description This command sets the Global Address Book GAB Primary Call Type Choice It sets which call type the ViewStation system will try first when dialing a site which can be reached via H 320 and H 323 from the Address Book It is automatically reset to manual if the setting matches that of the Secondary Call Type Choice see the command secondarycallchoice on page 125 isdn Selects ISDN as the Primary Call Type Choice 117 ViewStation EX ViewStation FX and VS4000 API Guide ip Selects IP as the Primary Call Type Choice manual No call type is selected get Displays the current setting isdn ip or manual Example primarycallchoice isdn User Interface Screen Location System Info gt Admin Setup gt Video Network gt Call Preferences Primary Call Type Choice primarycamera primarycamera lt 1 2 3 4 get gt Description This command sets the primary camera lt selects the camera that is used when you power on the system You cannot disconnect the main camera but you do not have to set it as the primary camera 1 2 3 4 Selectable cameras get Displays the current setting 1 2 3 or 4 Note Option 4 camera 4 is not available for the ViewStation EX Example primarycamera 1 User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Cameras Primary Camera 118 www polycom com ViewStation EX ViewStation FX and VS
42. 00555 800555 800555 o Be CIN IND o ING IN OIG Be NO IND Be INDE IN IN CBN IN IN INS eB IS A gt gt INS RO IN IN OBR IN ONG ON BO N NO NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY NY 2 state RINGING state state state state state state state state state state state state state state state state state state state state state state state state state state state state state state state state CONNECTED BONDING COMPLETE RINGING CONNECTED RINGING RINGING CONNECTED CONNECTED RINGING CONNECTED RINGING RINGING CONNECTED CONNECTED RINGING CONNECTED BONDING BONDING BONDING BONDING BONDING BON BON COMPLETE COMPLETE COMPLETE COMPLETE COMPLETE COMPLETE COMPLETE COMPLETE www polycom com Syntax Summary ViewStation EX ViewStation FX and VS4000 API Guide Polycom Inc 2003 The following syntactic notation is used for the API shell control commands Note lt x gt x All defined commands are case sensitive A required parameter The text between the angled brackets is one or more parameter s that can occur at the specified point in the command Multiple parameters are listed separated by the character pipe which is a notational shortcut for or If the text between the angled brackets is in parenthesis then it is a user comment of the expected parameter rathe
43. 03 dialchannels lt parallel oneatatime get gt Description This command lets you define how each ISDN channel will be dialed Normally channels are dialed in parallel parallel All ISDN channels are dialed simultaneously oneatatime Each ISDN channel is dialed after the previous channel connects Use this option if the network is having problems dialing all the channels at one time get Displays the selected option parallel or oneatatime Example dialchannels parallel User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt Advanced Dialing 45 ViewStation EX ViewStation FX and VS4000 API Guide diffserv diffserv lt set get gt lt 0 63 gt diffserv set lt 0 63 gt 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 63 set Sets the command A priority level from the range 0 63 is required 0 63 Priority level range get Displays the current setting Example diffserv set 0 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt QOS Type of Service ToS Field gt DiffServ dir dir string dir Description This command lists flash files No wild cards are allowed string Alphanumeric characters The limit is 252 characters Lists flash files which partially mat
44. 04 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt General Setup Auto Answer Multipoint or System Info gt User Setup Auto Answer Multipoint mpmode Polycom Inc 2003 mpmode lt auto discussion presentation fullscreen get gt Description This command sets the multipoint conference mode for the system in a multipoint call The multipoint mode can be set to auto discussion presentation or fullscreen By default it is set to auto auto In Auto mode the system determines the optimal viewing mode based on the interaction between the sites presentationIn Presentation mode also called voice activated switching the person who is speaking appears full screen to the far sites discussion In Discussion mode all of the sites can see everyone in the meeting at the same time This feature is sometimes referred to as Continuous Presence Mode You see yourself as one of the sites fullscreen In Full Screen mode every site in the call sees the speaker full screen get Displays the current setting for this option Note 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 Example mpmode discussion 105 ViewStation EX ViewStation FX and VS4000 API Guide User Inter
45. 33 Example gmscountry set Argentina User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 Country 76 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide gmsstate gmsstate lt set get gt state gmsstate set state gmsstate set gmsstate get Description This command sets the GMS state information set Sets the GMS state information when followed by the state parameter If you want to erase the current setting omit the parameter get Displays the current state information state Character string specifying the state information Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gmsstate set Texas User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 State Polycom Inc 2003 77 ViewStation EX ViewStation FX and VS4000 API Guide gmstechsupport gmstechsupport lt set get gt tech support digits gmstechsupport set tech support digits gmstechsupport set gmstechsupport get Description This command sets the GMS technical support phone number information set Sets the technical support information when followed by the tech support digits parameter If you want to erase the current setting omit tech support digits get Displays the current tech suppor
46. 4000 API Guide queuecommands queuecommands lt yes no get gt 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 Once those states have cleared the commands can be executed Note Certain commands can still be executed while the system is in a call progress or popup window state They generally correspond to commands that can be sent via the remote control during those states for example moving the camera or muting the microphone yes The commands will be queued and then executed when the state has cleared no The commands will be discarded and the system will proceed to the next command once the state has cleared get Displays the current setting yes or no Example queuecommands yes registerthissystem Polycom Inc 2003 registerthissystem lt yes no get gt Description This command sets the system s IP address to be registered and displayed in the Global Address Book GAB when the system is powered on If you do not enable this option the system has access 119 ViewStation EX ViewStation FX and VS4000 API Guide to the GAB but does not appear in the Global Address Book of other systems yes Enables this option register this system no Disables this option get Displays the current setting yes o
47. 5551212 state RINGING cs cal1 0 chan 3 dialstr 95551212 state RINGING cs cal1 0 chan 2 dialstr 95551212 state CONNECTED cs cal1 0 chan 3 dialstr 95551212 state CONNECTED cs cal1 0 chan 4 dialstr 95551212 state RINGING cs call 0 chan 5 dialstr 95551212 state RINGING cs cal1 0 chan 4 dialstr 95551212 state CONNECTED cs cal1 0 chan 5 dialstr 95551212 state CONNECTED cs cal1 0 chan 1 dialstr 95551212 state BONDING cs cal1 0 chan 2 dialstr 95551212 state BONDING cs cal1 0 chan 3 dialstr 95551212 state BONDING cs cal1 0 chan 4 dialstr 95551212 state BONDING cs cal1 0 chan 5 dialstr 95551212 state BONDING cs cal1 0 chan 0 dialstr 95551212 state COMPLETE cs cal1 0 chan 1 dialstr 95551212 state COMPLETE cs cal1 0 chan 2 dialstr 95551212 state COMPLETE cs cal1 0 chan 3 dialstr 95551212 state COMPLETE cs cal1 0 chan 4 dialstr 95551212 state COMPLETE cs cal1 0 chan 5 dialstr 95551212 state COMPLETE active call 0 speed 384 gt gt hangup video 0 hanging up video call cleared cal1 0 line 1 bchan 0 cause 16 dialstring 95551212 cleared cal1 0 line 2 bchan 0 cause 16 dialstring 95551212 cleared cal1 0 line 0 bchan 0 cause 16 dialstring 95551212 cleared cal1 0 line 1 bchan 1 cause 16 dialstring 95551212 cleared call 0 line 2 bchan 1 cause 16 dialstring cleared call 0 line 0 bchan 1
48. 56 222 112 444 2x64 128 168 192 224 256 CEC ois 68 13 16 333 555 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide gatewaysuffix Polycom Inc 2003 gatewaysuffix lt set get gt lt valid speed gt value gatewaysuffix set lt valid speed gt value gatewaysuffix set lt valid speed gt gatewaysuffix get lt valid speed gt Description This command sets the gateway suffix Some gateways require a number to be appended suffix to the gateway number The suffix identifies which gateway is used to dial a call at a particular data rate set lt valid speed gt Sets the gateway suffix when followed by the value parameter If you want to erase the current setting omit value valid speedValid speeds are 56 64 2x56 112 2x64 128 168 192 224 256 280 320 336 384 392 7x64 8x56 504 512 560 576 616 640 672 704 728 768 784 832 840 16x56 14x64 952 960 1008 1024 1064 1088 1120 1152 1176 1216 1232 1280 1288 24x56 21x64 1400 1408 1456 1472 1512 1536 1568 1600 1624 1664 1680 1728 1736 32x56 28x64 1848 1856 1904 and 1920 value Suffix code used for a particular call speed Consult your gateway instruction manual to determine which codes are appropriate get lt valid speed gt Displays the current value for this speed Note 1 Use quotation marks around a compound name or st
49. 9 restart system for changes to take effect restart now lt y n gt gt 12 hangup video hanging up video call gt h hangup video hanging up video call gt hi history gatewaynumber set 123456789 hangup video history gatewaynumber set 123456789 hangup video hangup video JO OB ONE history gt gat gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect restart now lt y n gt gt history 1 gatewaynumber set 123456789 2 hangup video 3 history 4 gatewaynumber set 123456789 5 hangup video 6 7 8 9 hangup video history gatewaynumber set 123456789 history abk abk lt batch all letter range gt Subcommands abk batch lt 0 59 gt 16 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide abk all abk letter lt a z gt abk range lt a b gt Description This command displays local Address Book entries batch Displays a batch of 10 records The maximum number of batches that can be displayed is 59 all Displays all the records in the Address Book letter Displays entries beginning with the letter specified from the range a z range Displays local Address Book entries numbered a through b Requires a parameter from a b a Z Valid characters are _ O through 9 a through z a b Integers specifying a range of local entries Examples abk batch 0 Displa
50. API Guide control the far site system using the far site s Command Line Interface The following table summarizes the port operation based on the RS 232 mode configured by each endpoint Near Side Mode Far Side Mode Resulting Operation Control N A Near side CLI Com mand Line Interface Pass Thru Control The near side controls the CLI of the far side Pass Thru Pass Thru The data is passed in full duplex mode from the near side RS 232 port to the far side RS 232 port Flow Control The system support hardware flow control Users should make sure that hardware flow control settings are consistent between the systems and the external devices on both sides of the connection Polycom Inc 2003 7 ViewStation EX ViewStation FX and VS4000 API Guide RS 232 Serial Cable Pinout and Connections ViewStation EX and FX The RS 232 serial cable has a 9 pin DB 9 connector on one end and an 8 pin mini DIN connector on the other end It is used to connect the ViewStation EX or ViewStation FX to a terminal or another communications device DB 9 FEMALE P5 Ea Moa es e TTS uz JACK SCREW nat 10 FEET 2 PS P3 oma Jas da e ae He GRE fers Pin Number Function 1 DCD
51. Interface Screen Location System Info gt Admin Setup gt Video Camera gt Cameras gt VS4000 Camera Setup cameradirection cameradirection lt normal reversed get gt Description This command selects whether the camera moves in the same direction normal as the arrows on the remote control or in opposite reversed direction normal Sets the direction of the camera to normal reversed Sets the direction of the camera to reversed get Displays current settings normal or reversed 36 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Example cameradirection normal User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Cameras Camera Direction camerainput Polycom Inc 2003 camerainput lt 1 2 3 4 gt lt off s video composite get gt camerainput 1 lt off s video composite get gt camerainput 2 lt off s video composite get gt camerainput 3 lt off composite get gt camerainput 4 lt off s video composite get gt Description This command sets video inputs on cameras 1 4 for the VS4000 system only You can connect four cameras to your VS4000 system Note See the commands camera1ptz on page 35 and camera4ptz on page 36 to set the VS4000 system s camera source 1 and 4 to pan tilt zoom mode 1 2 3 4 Selects the camera source off Disables the selected camera source s video Enables S video inputs on the selected camera source Note that
52. NY POLYCOM ViewStation EX ViewStation FX and VS4000 API Guide Trademark Information Polycom the Polycom logo design and ViewStation are registered trademarks of Polycom Inc ARENA Global Management System PathNavigator Polycom OneDial and Visual Concert are trademarks of Polycom Inc in the United States and various other countries Internet Explorer NetMeeting Windows and Windows NTO are either registered trademarks or trademarks of Microsoft Corporation in the United States and or other countries Intel Pentium and Celeron are registered trademarks and TeamStation is a trademark of Intel Corporation Adobe Acrobat is a registered trademark of Adobe Systems Incorporated ADTRANG is a registered trademark of ADTRAN Inc QuickTime is a trademark of Apple Computer Inc Netscape Navigator is a registered trademark of Netscape Communications Corporation IP TV is a registered trademark of Cisco Systems Inc All other trademarks are the property of their respective owners Every effort has been made to ensure that the information in this manual is accurate Polycom Inc is not responsible for printing or clerical errors Information in this document is subject to change without notice Patent Information The accompanying product is protected by one or more U S and foreign patents and patents pending held by Polycom Inc 2003 Polycom Inc All rights reserved P
53. Polycom Inc 2003 209 ViewStation EX ViewStation FX and VS4000 API Guide Example v35suffix set 128 H4 2 This command associates the dialing suffix 4 2 to the speed 128 User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network gt Advanced Dialing This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system 210 www polycom com Satety and Legal Notices Important Safeguards Read and understand the following instructions before using the system e Close supervision is necessary when the system is used by or near children Do not leave unattended while in use e Only use electrical extension cords with a current rating at least equal to that of the system Always disconnect the system from power before cleaning and servicing and when not in use Do not spray liquids directly onto the system when cleaning Always apply the liquid first to a static free cloth Do not immerse the system in any liquid or place any liquids on it Do not disassemble this system except as instructed in the manufacturer s instructions To reduce the risk of shock and to maintain the warranty on the system a qualified technician must perform service or repair work e Connect this appliance to a grounded outlet Incase of lightning storms disconnect the telephone line cord from the system and only connect the system to surge protected po
54. Setup gt General Setup page 2 Next Allow User Setup answer answer lt phone video gt Description This command answers incoming video or POTS calls phone Answers incoming POTS calls video Answers incoming video calls when the Auto Answer Point to Point or Auto Answer Multipoint option is set to No Example answer phone audioquality Polycom Inc 2003 audioquality lt set get gt audioquality set lt 64 112 128 168 192 224 256 280 320 336 384 392 448 512 gt audioquality get Description This command sets the call speed threshold that determines which audio protocol is used At the selected speed or lower the system uses the G 728 audio protocol Above the selected speed the system uses the G 722 audio protocol 23 ViewStation EX ViewStation FX and VS4000 API Guide set Sets the call speed threshold value Requires a parameter from lt 64 112 128 168 192 224 256 280 320 336 384 392 448 512 gt get Displays the current threshold value of the call 64 512 Range of selectable speeds Example audioquality set 168 User Interface Screen Location System Info gt Admin Setup gt Phone Audio Audio Quality audioqualityg7221 audioqualityg7221 lt set get gt audioqualityg7221 set lt 64 112 128 168 192 224 256 280 320 336 384 392 448 512 gt audioqualityg7221 get Description This command sets the call speed threshold that determines which audio prot
55. Station 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 far move zoom Far camera direction change start zooming out far move left Far camera direction change start moving left far move right Far camera direction change start moving right far move up Far camera direction change start moving up far move down Far camera direction change start moving down far move stop Far camera direction change stops far move continuous Switches far camera move mode to continuous mode Camera will move in direction specified until a camera far move stop command is sent far move discrete Switches far camera move mode to discrete mode Camera will move a small discrete amount in the direction specified and then stop No camera far move stop command is required far stop Stops the far camera movement when in continuous mode far tracking on Turns on the far camera tracking mode far tracking off Turns off the far camera tracking mode far tracking to_presets Turns on the far camera tracking to presets far tracking get Gets the far camera tracking mode register subcommand register Registers to receive feedback when the user changes the camera source unregister subcommand unregister Unregisters to rece
56. WINS resolution After a change is made the system prompts the user for restart yes Enables WINS resolution no Disables WINS resolution get Displays the current setting yes or no Example winsresolution no User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet WINS Resolution 172 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide winsserver winsserver lt set get gt 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 set Sets the WINS server IP address when followed by the XXx xXXX XXX Xxx parameter If you want to erase the current setting omit the parameter get Displays the WINS server setting XXX XXX XXX XXX WINS server IP address Example winsserver set 192 168 1 57 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet WINS Server Polycom Inc 2003 173 ViewStation EX ViewStation FX and VS4000 API Guide ISDN BRI Commands The following commands are specific to the ISDN BRI network interface isdnareacode isdnareacode lt set get gt area code isdnareacode set area code isdnareacode set isdnareacode get Description This command sets the ISDN area code or STD
57. XXXX allowremotemonitoring no daylightsavings yes requireacctnumtodial no validateacctnum no timediffgmt 12 00 gmsurl 1 lt empty gt gmsurl 2 lt empty gt gmsurl 3 lt empty gt gmsurl 4 lt empty gt gmsurl 5 lt empty gt gmsurl 6 lt empty gt gmsurl 7 lt empty gt gmsurl 8 lt empty gt 51 ViewStation EX ViewStation FX and VS4000 API Guide msurl 9 lt empty gt msurl 10 lt empty gt mscontactperson lt empty gt mscontactnumber lt empty gt mscontactemail lt empty gt mscontactfax lt empty gt mstechsupport lt empty gt mscity lt empty gt msstate lt empty gt mscountry lt empty gt gabserverip lt empty gt gabpassword lt empty gt displayglobaladdresses no registerthissystem no showaddrsingab both primarycallchoice manual secondarycallchoice none preferredalias extension gatewaynumbertype number extension outboundcallroute isdn usegatekeeper off numdigitsdid 7 numdigitsext 4 gatewaycountrycode lt empty gt gatewayareacode lt empty gt gatewaynumber lt empty gt gatekeeperip lt empty gt h323name Jw el64ext 59715 gatewayext 59715 usepathnavigator required 99030000000 dns dns lt set get gt lt 1 4 gt XXX XXX XXX XXX dns set lt 1 4 gt XXX XXX XXX XXX dns set lt 1 4 gt dns get lt 1 4 gt 52 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Description This command is used to config
58. adcast configuration parameters should be set to accommodate the lowest common denominator of the systems which are receiving the broadcast 199 ViewStation EX ViewStation FX and VS4000 API Guide fcif Full Common Interchange Format 352 x 288 resolution get Displays the current setting Example h331lvideoformat fcif User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network gt 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 rs366dialing rs366dialing lt on off get gt Description This command sets RS 366 dialing Enable this option if you want to call from the system through the DCE connection to the far end video conferencing system Disable this option if you are using your DCE to dial the call or if you have a dedicated connection to the far site on Enables RS 366 dialing off Disables RS 366 dialing get Displays the current setting on or off Example rs366dialing on User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network RS 366 Dialing This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system 200 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide rt rt lt normal inverted get gt Description This command lets you co
59. address Example 1 gmsurl set 1 192 168 1 123 Example 2 gmsurl get 1 Output to Example 2 192 168 1 123 pwx vs_status asp 79 ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Setup gt Select Server URLs graphicsmonitor graphicsmonitor lt tv fxvga visualconcert get gt Description This command sets the graphics monitor tv fxvga visualconcert get Example Selects the TV monitor as the graphics monitor The graphics and video are displayed on the TV monitor The command graphicsmonitor tv is similar to graphicsmonitortv on Selects the ViewStation FX VGA monitor as the graphics monitor Enable this option if you have a high resolution VGA monitor or projector connected to the rear panel of the system The command graphicsmonitor fxvga is similar to graphicsmonitorfxvga on Selects 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 This allows your system to display your computer desktop on your system s VGA monitor The command graphicsmonitor visualconcert is similar to graphicsmonitorvisualconcert on Displays the current setting graphicsmonitor fxvga User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Monitors gt Graph
60. alstring gt Description This command lets you dial video or audio calls either manually or from the Address Book addressbook Dials an Address Book entry Requires the parameter addr book name addr book nameName of a valid Address Book entry The maximum number of characters is 25 auto Dials the number dialstr at the speed speed using the Auto H 323 Dialing feature which 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 auto must be followed by the parameters speed and dialstr manual Dials a video call number dialstr1 at speed of type h323 or h320 the parameters ip and isdn are deprecated Requires the parameters speed and dialstr1 speed Valid data rate for the network dialstr Valid switched or IP directory number dialstr1 Valid switched or IP directory number dialstr2 Valid switched or IP directory number 44 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide h323 h320 ip isdnType of call The parameters ip and isdn are deprecated phone Dials a POTS number Requires the parameter dialstring dialstring Valid POTS directory number Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Examples dial phone 5551212 dial manual 2x64 5551212 5551213 h320 dial addressbook Monday meeting dialchannels Polycom Inc 20
61. ample numdigitsext 10 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gateway Number of digits in extension Polycom Inc 2003 111 ViewStation EX ViewStation FX and VS4000 API Guide numberofmonitors numberofmonitors lt 1 4 get gt numberofmonitors lt 1 4 gt numberofmonitors get Description This command sets the number of TV monitors that are connected to the system 1 4 Sets the number of monitors allowed Maximum number is 4 for ViewStation FX and VS4000 systems and 2 for ViewStation EX systems get Displays the current setting 1 2 3 or 4 Example numberofmonitors 2 User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Monitors gt TV Monitors Number of Monitors outboundcallroute outboundcallroute lt gateway isdn get gt Description This command sets the default outbound calling route gateway Use gateway if your outbound call needs to be handled by a gateway isdn Use isdn if your system is connected to an ISDN line ISDN is the default get Displays the current setting gateway or isdn 112 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Example outboundcallroute gateway User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gatekeeper Outbound Call Route pause pause lt 0 65535 gt Description This command
62. ant to see displayed on your system 93 ViewStation EX ViewStation FX and VS4000 API Guide set Sets the command It requires a parameter from lt englishus englishuk french german italian spanish japanese chinese portuguese norwegian gt get Displays the current language on the system englishus englishuk french german italian spanish japanese chinese portuguese norwegian Supported languages Example language set german User Interface Screen Location System Info gt Admin Setup gt General Setup Language lanport lanport lt auto 10 10hdx 10fdx 100 100hdx 100fdx get gt Description This command sets the system s LAN port settings auto Auto negotiates the LAN speed 10 10 Mbps auto duplex 10hdx 10 Mbps half duplex 10fdx 10 Mbps full duplex 100 100 Mbps auto duplex 100hdx 100 Mbps half duplex 100fdx 100 Mbps full duplex get Displays the current setting Example lanport auto 94 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Advanced LAN Settings lanstat Polycom Inc 2003 lanstat lt min misc reset sec tmin total gt 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 statisti
63. apshots that are sent or received Example snapshot 1 snapshotcamera snapshotcamera lt 1 2 3 4 get gt Description This command selects the default camera from which you want to send snapshots 1 2 3 4 Sets camera 1 2 3 or 4 get Displays the current setting 1 2 3 or 4 Example snapshotcamera 1 User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Cameras Snapshot Camera Polycom Inc 2003 131 ViewStation EX ViewStation FX and VS4000 API Guide snapshottimeout snapshottimeout lt yes no get gt 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 However when this option is disabled the snapshot or slide stays on screen indefinitely until the user presses the SNAPSHOT button on the remote control to return to live video yes Enables the option the display times out after four minutes and the system returns to live video no Disables the option the snapshot stays on screen indefinitely get Displays the current setting yes or no Example snapshottimeout no User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Monitors gt TV Monitors Snapshot Timeout 132 www polycom com ViewStation EX ViewStation FX and
64. as EET A ENNE 58 gabk batch TA TA 59 gabpass woe a nd 59 a EE a t EE A E tere Na E iia ee 60 gatekeeper pi eee a eaa A saan a i aa deste id a A la aaa a aA 61 Gatewayareacode A A 62 GatewayCOuUntry Code saer aE REE E cnn tacna rca EE 63 O cece a kite hae eee ce Od ee 64 GalewaynuUlMbersiesentids cocceet adapta ae a a Bes hhh weld Aaaa ata 65 QatewaynNUMbe rtyPe iseyi Srei A AEE ERA TERRA CEREA AAA AERAR nn cnn 66 ii www polycom com ViewStation EX ViewStation FX and VS4000 API Guide JAS WAY ssc oes baci di 67 GatewaySetup init nena 68 Gateway Sumtix si cii skee aa E RE N 69 gendal are ear T T 70 g neratetone nie lawns Shes aie oie a ai a 70 A A ei ee ea 71 O O 71 gmscontactoal cueca a paeaone toral 72 OMSCONtA CH iia 73 QMSCONtACHNUMDE ecceeeeeeeeneeeeeeeeneeeeteeeeneeeeeeeeensueseeedeenerteneeeneners 74 OMSCONTACIPELSON ridini ianiai anaidai aa iaia 75 OIMSCOUNUY AAEE EEEE T AEE AT 76 IMSS iii E tn diese Meet T 77 gmstechsuppoltecissen s caddie ee eee 78 O 79 graphicsmoOnitO Naco icon debo 80 OraphicsMONItOM XVYA ae r EE E non non nn cn nn nn nr nc cnn nn 81 graphics monitore earr e di 81 QgraphicsmonitorvisualCONnCelt eceeeeeeeeeeeeeeeeeteeeneeeeeseeeeeeeeseeeeaeees 82 MS 2SMAMC NN 83 E O marie terre errr es 84 C EAE er a e A coa 84 PIP OS ics cock etced a A ett eb eeentead ded 86 A hehe deni aleaeeti tenes cakteven a martes 87 NOStMAMG it heeled atari eek teas devine eet ia 88 IPACCIESS ica s e
65. ater to use this option yes Enables the option no Disables the option get Displays the current setting yes or no Example requireacctnumtodial yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Setup Require Account Number to Dial Polycom Inc 2003 121 ViewStation EX ViewStation FX and VS4000 API Guide roomphonenumber roomphonenumber lt set get gt 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 set Sets the room phone number when followed by the room phone number parameter If you want to erase the current setting omit the parameter get Displays the current setting room phone number Numeric string Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example roomphonenumber 512 5551212 User Interface Screen Location System Info gt Admin Setup gt Phone Audio Room Phone Number 122 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide rs232 Polycom Inc 2003 rs232 lt mode flowcontrol baud gt Subcommands rs232 mode lt passthru control get gt rs232 flowcontrol lt none hardware get gt rs232 baud lt 1200 2400 9600 14400 19200 38400 576
66. ccess the Preferred Alias screen preset preset lt near far register unregister gt preset near lt set go gt lt 0 9 gt preset near set lt 0 9 gt preset near go lt 0 9 gt preset far lt set go gt lt 0 9 gt preset far set lt 0 9 gt preset far go lt 0 9 gt preset register preset unregister Description 116 www polycom com 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 You can set and store up to ten preset camera positions These ten camera presets can be distributed across the far camera and up to four near site cameras near set near go far set far go register unregister 0 9 Example Sets a near camera preset number Requires a parameter from 0 9 Selects a near camera preset number Requires a parameter from 0 9 Sets a far camera preset number Requires a parameter from 0 9 Selects a far camera preset number Requires a parameter from 0 9 Registers the system to give notification when the user sets or goes to presets Disables register mode Range of available preset numbers preset near set 2 The current location position of the near end camera is saved in near slot 2 primarycallchoice Polycom Inc 2
67. ch string To list all the files omit string 46 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Examples dir dat dir abk dir 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 Call ID Status Speed Dialed Num 01 CM_CALLINFO_CONNECTED 128 192 168 1 2 display whoami O Polycom Inc 2003 display whoami Description This command displays banner information Example display whoami 47 ViewStation EX ViewStation FX and VS4000 API Guide Ouput Hi my name is Jw_System Here is what I know about myself Serial Number XXXXX Brand Polycom Software Version Release 5 0 FX 14 Mar 2003 Model VSFX4 Network Interface PRI_E1l MP Enabled Yes H323 Enabled Yes IP Address 192 168 1 104 Time In Last Call 0 43 50 Total Time In Calls 87 17 17 Total Calls 819 Country Code 1 Area Code 512 PRI Number 5555555 displaybolt displaybolt dd Description This command sets the frequency at which the lightning bolt packet loss indicator is displayed The lightning bolt is only a visual indicator that informs you about WAN or LAN network problems It does not indicate pe
68. 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 cal1 0 line 0 bchan 0 cause 16 dialstring 192 168 1 103 ended call 0 31 ViewStation EX ViewStation FX and VS4000 API Guide camera camera lt near far register unregister gt Subcommands camera near lt 1 4 source move stop getposition setposition tracking gt camera far lt 1 5 source move stop tracking gt camera lt near far gt source camera lt near far gt move lt zoom zoom left right up down stop continuous discrete gt camera lt near far gt stop camera near lt setposition getposition gt lt x gt lt y gt lt z gt camera lt near far gt tracking lt on off to_presets get gt camera lt register unregister gt Description This command and its subcommands control the position and zoom of the near end camera and the view camera input that is presented Note When you are not in a call all camera near move commands need to be preceded by a button near command near subcommands near 1 4 Selects a near camera as the main video source Camera source 1 4 near source Returns the number of the camera source currently selected near move zoom Near camera direction change start zooming in near move zoom Near camera direction change start zooming out 32 www polycom com Polycom Inc 2003 ViewStati
69. claim that the Subject Programs are its trade secret and confidential property and shall treat them as such Buyer will not attempt to disassemble decompile reverse engineer or otherwise endeavor to discover or disclose the methods and concepts embodied in the Subject Programs Except as expressly allowed under this Agreement the Buyer shall not copy modify transcribe store translate sell lease or otherwise transfer or distribute any of the Subject Programs in whole or in part without prior authorization in writing from Polycom Buyer shall not remove or destroy any copyright patent trademark or other proprietary mark or notice on Computer Equipment and shall reproduce any such marks on any copies of Subject Programs that it makes hereunder You shall not and shall not allow any third party to 1 decompile disassemble or otherwise reverse engineer or attempt to reconstruct or discover any source code or underlying ideas or algorithms of the software by any means whatsoever or 2 remove any product O Polycom Inc 2003 211 ViewStation EX ViewStation FX and VS4000 API Guide Warranty Polycom Inc warrants its products to be free of defects in materials and factory workmanship for a period of twelve 12 months from date of purchase This warranty does not apply to damage to products resulting from accident misuse service or modification by anyone other than a Polycom Inc authorized service facility dealer The warranty is
70. com com ViewStation EX ViewStation FX and VS4000 API Guide gmscontactperson gmscontactperson lt set get gt person gmscontactperson set person gmscontactperson set gmscontactperson get Description This command sets the GMS contact person information set Sets the GMS contact person information when followed by the person parameter If you want to erase the current setting omit person get Displays the current contact person information person Character string specifying the contact person Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gmscontactperson set John GMSguy User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 Contact Person Polycom Inc 2003 75 ViewStation EX ViewStation FX and VS4000 API Guide gmscountry gmscountry lt set get gt country gmscountry set country gmscountry set gmscountry get Description This command sets the GMS country information set Sets the GMS country information when followed by the country parameter If you want to erase the current setting omit country get Displays the current country information country Character string specifying the country information Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 3
71. cs min misc reset sec tmin total Displays the last minutes of LAN statistics When no parameter is specified the last 10 minutes of statistics are displayed by default A parameter can be specified from the range 0 60 Displays miscellaneous LAN VLAN statistics Resets cumulative LAN statistics Displays the accumulating total of LAN statistics for the current minute Displays the last minutes of LAN statistics totals When no parameter is specified lanstat tmin displays by default the last 10 minutes of statistics A parameter from the range 0 60 can be specified Displays cumulative LAN statistic 95 ViewStation EX ViewStation FX and VS4000 API Guide 0 60 Example 1 Maximum number of minutes that can be specified is 60 lanstat min 1 Output to Example 1 lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans lans Example 2 ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta ta LAN statistics for minute 1 rx_bytes tx_bytes rx_packets tx_packets rx_errors rx_unicasts rx_polycasts Port 0 985 351 rx_polycasts_filtered 0 rx_resource_error 0 rx_collisions 0 rx _oversize frame 0 rx_runt_errors rxX_crc_errs rx_align_errs rx_overruns rx_no_buffer rx_multiframe tx_underruns tx_timeouts tx_restarts tx_ring_full
72. d selects the type of service for Quality of Service ipprecedence Selects IP precedence service See the command ipprecedence on page 91 diffserv Selects diffServ service See the command diffserv on page 46 get Displays the current setting ipprecedence or diffserv Example typeofservice diffserv User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt QOS Type of Service ToS Field udpports Polycom Inc 2003 udpports lt set get gt 1024 49150 udpport set 1024 49150 udpports set udpports get 157 ViewStation EX ViewStation FX and VS4000 API Guide Description This command sets the system s UDP ports set Sets the UDP ports when followed by a value from the range 1024 49150 If you want to erase the current setting omit the value get Displays the current UDP port setting 1024 49150Range of available UDP ports Example udpports set 3230 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Firewall LAN Connection Use Fixed Ports gt UDP Ports usefixedports usefixedports lt yes no get gt Description This command selects the Use Fixed Ports option yes Enables the use of Used Fixed Ports no Disables the use of Used Fixed Ports get Displays the current setting yes or no Example usefixedports yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Int
73. dmin Setup gt LAN H 323 gt SNMP Community Name 134 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide snmpconsoleip snmpconsoleip lt set get gt xxx xxx XXX XXX snmpconsoleip set XXX XXX XXX XXX snmpconsoleip set snmpconsoleip get Description This command sets the SNMP console IP address set Sets the SNMP console IP address when followed by the xxx xxx xxx xxx parameter If you want to erase the current setting omit the parameter get Displays the current setting XXX XXX XXX XXXIP address of the console Example snmpconsoleip set 192 168 1 111 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt SNMP SNMP Console IP Address snmplocation Polycom Inc 2003 snmplocation lt set get gt location name snmplocation set location name snmplocation set snmplocation get Description This command sets the SNMP location name 135 ViewStation EX ViewStation FX and VS4000 API Guide set Sets the SNMP location name when followed by the location name parameter If you want to erase the current setting omit the parameter get Displays the current setting location name SNMP location name Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example snmplocation set john_EX at United States User Interface Screen Location System Info gt Ad
74. ds are 56 2x56 112 168 224 280 336 392 64 8x56 2x64 128 192 256 320 384 7x64 512 on Enables the specified speed valid speed off Disables the specified speed valid speed Example isdndialspeed set 256 on User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt Dialing Speeds Note This screen is only accessible if you have a Quad BRI network interface connected to your system Polycom Inc 2003 177 ViewStation EX ViewStation FX and VS4000 API Guide isdnnum isdnnum lt set get gt lt 1b1 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt isdn number isdnnum set lt 1ibi 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt isdn number isdnnum set lt 1b1 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt isdnnum get lt 1b1 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt Description This command sets the ISDN video number or numbers assigned to the system set lt 1b1 4b2 gt Sets the ISDN video number for a B channel line when followed by the isdn number parameter If you want to erase the current setting omit isdn number get lt 1b1 4b2 gt Displays the current ISDN number associated with a B channel of a particular line 1b1 4b2 Range of configurable B channels 1b1 designates line 1 B channel 1 B1 1b2 designates line 1 B channel 2 B2 isdn number Numeric string This is the ISDN video number s provided by your network service provider Example isdnnum set 1b1 5125551212 User Interface Scre
75. e ViewStation EX User Guide Examples mcupassword vs4000MPpasswd This command sends the MCU password vs4000MPpasswd to the MCU mcupassword This command erases the current MCU password if one has been set If none has been set mcupassword lt empty gt is returned User Interface Screen Location System Info gt Admin Setup gt Security Meeting Password 102 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide meetingpassword meetingpassword lt set get gt password meetingpassword set password meetingpassword set meetingpassword get Description This command sets the meeting password set Sets the meeting password when followed by the password parameter If you want to erase the current setting omit password get Displays the current setting password Can be an alphanumeric string Valid characters are 0 9 a z lower and uppercase _ Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example meetingpassword set EXpasswd User Interface Screen Location System Info gt User Setup Meeting Password or System Info gt Admin Setup gt Security Meeting Password Polycom Inc 2003 103 ViewStation EX ViewStation FX and VS4000 API Guide mpautoanswer mpautoanswer lt yes no donotdisturb get gt Description This command sets the Auto Answer Multipoint mod
76. e Ast daa a aa aa eaa a engi asada 30 Polycom Inc 2003 i ViewStation EX ViewStation FX and VS4000 API Guide Callstate ii is 31 CAM a E E E E ie ea 32 Camera Ditto piccinncill acordada lidia a aa a eara aaia 35 A O 36 cameradirectiiON iaa 36 CAM A AEA 37 chalco tro lucio decoracion hbk iad ected Maybe elad lcciria ds 38 A O 40 COMO ii O ed cia 40 dataconferencetype arurae i ATEA O R TAA 41 daylighisaving S renanira e r E AET RERA REN AARE NEERA EENE 42 defaultgate Way ima a da 42 e intet eraa a ener pre errr reper arr ere one rey prea ery E 43 6 f amar eae Neder eer e eee are 44 GlalGhaninelsS2siaissecseeccsheate ts tiara cidade decia a E aa aaa 45 ITS CIV e ad la antes na id Ea 46 o M EA EE a e od 46 display Call A ket ieee 47 display WHOA cc c bac tacto idad 47 displaybDOl oasis illa 48 displayglobaladdresses oooononcccccnnnoccccccnononcnccnnnnannnccnonanoncnnnnnnnnnncninnns 49 ASP MAPAS add 49 A cad shacks kacaiacu led a dd Abed ahah eds aa iaaea 50 displayipisONiN O 2 cece cece ee ceeeceeee a a a Aea a SAREE E 50 displayparamS ii cetera ash E 51 O ed te a a 52 AynamMicbandwidthises ieira ea Aa se cli EE ENEE 53 INGA OX is Fak TEE A AEA E AN 54 echocanceller cia ol e a 55 enablesnapshots e EEE E EET 56 enableSiMp ici a aa a a e aa aaea Eiaa 56 ES A Nae o ce ree eer E A EEEE AT 57 farcontrolnearcaMera i nnen arane ae oe aaa aaa aaaea Eaa an 57 TAN OOD RAE ETE E EE 58 farnametimedisplay aere
77. e TOA 89 IPAIAISPCSG eke ctuteciidhens tedaasiccet eaaa o e lisis 90 PPC CINCO A EE EA A ice cemene eaten de 91 Pi a Readies ated ends 92 keypadaudiocont nce Seth inetd en diet O 93 JAIN QUAGG iana Me rckeccdy ae aa piecueteged nica ctl eietierds EE 93 O TS 94 Stata a aia 95 E O E E er erere ret E EE E prere errr errr TA 97 maxgabinternationalcallSpeed o oooccccnnnnnicincnnicnncccnnnnannnccnnnnancn nora 98 maxgabinternetcallSpeed ooooocconnnocicccnnncocccoccnanaoncncc conan cnn rc nana nnnnn rca 99 maxgabisdncallSpeed ccccccesecccceeeseecceceeeseeceeeeeeneeceeeeesssneeeeneneaaees 100 MA een eae aa eee ee 101 INCUPASSWOIM teccionndo tesina caleta lecitina da ias 102 MOECtINGDASSWOMK ceccccccseececcceeceesseceeeteecccceeteneseceenennessseeetenenseceneneeeese 103 MpaulOanSwelis n tiecc ii iets aie dida 104 MPIM OGG or eet aie eae 105 A sine aa ia a nbhagavies a aaa aaa aaa diese aiaa 106 mu tea toanswercallS iiipin Sere in eeaeee AA AREE ERATE EREA 107 Polycom Inc 2003 iii ViewStation EX ViewStation FX and VS4000 API Guide A NS 107 NEMESIO ii A ee eee 108 NetstatS cic citan iii atol n 109 PVG GIES Iciar tinc 110 NUMAN di dais 111 numberofmonitors cocoocococcococccccncnnccocnnnnnnnnn cnn nn nnnnnnnnnnnnnnnnnnnnn nn nnnncnnnnnnn 112 outboundcallroUte cccccicccnoci cioni lociones recital unete ia deeteeadalace 112 Pa io ale tale rasa cea Oe yak i cieuaee dado ate cio eek ee 113 PCPOl tres sean a ead aca cte
78. e has already been selected see the command v35profile on page 207 set lt valid speed gt Sets the V 35 RS 449 RS 530 RS 366 prefix when followed by a value parameter If you want to erase the current setting omit the parameter valid speedValid speeds are 56 64 2x56 112 2x64 128 168 192 224 256 280 320 336 384 392 7x64 504 512 560 576 616 640 672 704 728 768 784 832 840 14x64 952 960 1008 1024 1064 1088 1120 1152 1176 1216 1232 1280 1288 21x64 1400 1408 1456 1472 1512 1536 1568 1600 1624 1664 1680 1728 28x64 1856 1920 all The parameter all lists all the available speeds and their associated dialing prefixes 206 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide value 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 get lt valid speed gt Displays the current setting for valid speed Note The ViewStation EX system supports speeds up to 768 Kbps Example v35prefix set 112 005 This command associates the dialing prefix 005 to the speed 112 User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network gt Advanced Dialing This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system v35profile Polycom Inc 2003 v35profile lt
79. e is to be pinged Example testlan ping 192 168 1 200 5 155 ViewStation EX ViewStation FX and VS4000 API Guide textinput textinput lt text to input gt Description This command inserts text into a user interface edit box that you have already selected using the remote control text to input Alphanumeric string to be inserted into the selected edit box Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example textinput My Test vs4000 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 timediffgmt timediffgmt lt 12 00 00 00 12 00 get gt Description This command sets the time difference from where the system is installed and Greenwich Mean Time GMT This allows the GMS Global Management System to view the local time of the managed system 12 00 00 00 12 00 Range of time differences 00 00 is GMT time get Displays the current setting Example timediffgmt 6 00 156 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Setup Time Difference from GMT typeofservice typeofservice lt ipprecedence diffserv get gt Description This comman
80. e video number format yes Enables the option When this option is enabled the ISDN and H 323 fields are not visible on the Video Phone screen no Disables the option 26 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide get Displays the current setting yes or no Example autoh323dialing yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Setup Auto H 323 Dialing backlightcompensation backlightcompensation lt yes no get gt Description This command enables or disables the Backlight Compensation option yes Enables Backlight Compensation The camera automatically adjusts for a bright background no Disables the option get Displays the current setting yes or no Example backlightcompensation no User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Cameras Backlight Compensation Polycom Inc 2003 27 ViewStation EX ViewStation FX and VS4000 API Guide button button lt 1 2 3 4 5 6 7 8 9 O auto callhangup camera delete directory down far home info keyboard left lowbattery menu mute near period pickedup pip preset putdown right select slides snapshot up volume volume zoom zoom gt 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
81. e when followed by the areacode parameter If you want to erase the current setting omit areacode get Displays the current setting for this option areacode Numeric string specifying the gateway area code Example 1 gatewayareacode set 512 Example 2 gatewayareacode set Erases the current setting User Interface Screen Location System Info gt User Setup gt LAN H 323 gt H 323 gt Gateway Gateway Number gt Area Code 62 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide gatewaycountrycode gatewaycountrycode lt set get gt number gatewaycountrycode set number gatewaycountrycode set gatewaycountrycode get Description This command sets the gateway country code set Sets the gateway country code when followed by the number parameter If you want to erase the current setting omit number get Displays the current setting number Numeric string specifying the gateway country code Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gatewaycountrycode set 1 User Interface Screen Location System Info gt User Setup gt LAN H 323 gt H 323 gt Gateway Gateway Number gt Country Code Polycom Inc 2003 63 ViewStation EX ViewStation FX and VS4000 API Guide gatewayext gatewayext lt set get gt gateway extension gatewayext set gateway extension gatewaye
82. e which determines how the system will handle an incoming call in a multipoint videoconference yes If Auto Answer Multipoint is set to Yes any incoming call will be connected automatically The screen will split into a multipoint call progress screen as the incoming call is answered no User Interface If Auto Answer Multipoint is set to No and there is an incoming call the user will be prompted with a message You have a video call Would you like to answer This message can be followed by a far site video number and a far site name if they are available If the user selects Yes the call will be added into the ongoing conference If the user selects No the call will be rejected The factory default is set to No API Interface If Auto Answer Multipoint is set to No there is an incoming call and the user has previously issued the listen video command the string listen video ringing will be printed in the Telnet session donotdisturb If Auto Answer Multipoint is set to donotdisturb the user is not notified of the incoming call The site which placed the call receives a Far Site Busy code H 320 or Call Rejected H 323 get Displays the current setting yes no donotdisturb Note 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 Example mpautoanswer donotdisturb 1
83. ear camera no Disables the far control option of the near camera get Displays the current setting on or off Example farcontrolnearcamera yes User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Cameras Far Control of Near Camera or System Info gt User Setup Far Control of Near Camera 57 ViewStation EX ViewStation FX and VS4000 API Guide farloop farloop lt on off gt Description This command turns the far end loop on or off when in a call on Turns the option on off Turns the option off Example farloop on User Interface Screen Location System Info gt Diagnostics gt Far End Loop farnametimedisplay farnametimedisplay lt set get gt 0 9999 farnametimedisplay set time farnametimedisplay set farnametimedisplay get Description This option displays the length of time the far site name is to be displayed set Sets the display time when followed by the parameter time If you want to erase the current setting omit time The far site name is displayed by default for 15 seconds farnametimedisplay set displays the far site name until the call is ended get Displays the current setting 0 9999 Time value specified in seconds 58 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Examples farnametimedisplay set farnametimedisplay set 120 User Interface Screen Location System Info gt User Setup Far Si
84. en Location System Info gt Admin Setup gt Video Network gt IMUX gt Numbers This screen is only accessible if you have a Quad BRI network interface connected to your system 178 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide spidnum Polycom Inc 2003 spidnum lt set get gt lt 1b1 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt spid number spidnum set lt 1ib1 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt spid number spidnum set lt 1b1 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt spidnum get lt 1b1 1b2 2b1 2b2 3b1 3b2 4b1 4b2 gt Description This command sets the ISDN SPID number or numbers assigned to the system SPIDs generally apply only in the United States and Canada If you are behind an internal phone system PBX you may not need to enter SPID numbers set lt 1b1 4b2 gt Sets the SPID number for a B channel line when followed by the spid number parameter If you want to erase the current setting omit spid number get lt 1b1 4b2 gt Displays the current SPID number associated with a B channel of a particular line 1b1 4b2 Range of configurable B channels 1b1 designates line 1 B channel 1 B1 1b2 designates line 1 B channel 2 B2 spid number Numeric string SPID numbers are generally provided by your network service provider Example spidnum set 1b1 5125551212 User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt SPIDS This screen is only accessible if yo
85. enna ViewStation EX FX VS4000 verensst mmer med de vasentliga kraven och vriga relevanta stadganden i direktiv 1999 5 EG WARNING This is a Class A product In a domestic environment this product may cause radio interference in which case the user may be required to take adequate measures Australia Mains Powered POTS Voice Telephony Without Emergency 000 Dialing Warning This equipment will be inoperable when mains power fails Japan OAL TREES CRABES VCCI oir PAARRAPEE CT Z RE COAT L ERES HOT BEVET COURIER BAW eT o k ER NDE d O Polycom Inc 2003 215 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 216 www polycom com
86. ephone company service provider to determine whether a call by call value is required for a particular PRI line For most cases the default value of 0 is correct Always use the value 0 when connected to a PBX A non zero value should not be required in Europe Values greater than 31 are reserved for internal use and must not be used set Sets PRI call by call when followed by a value from 0 31 If you want to erase the current setting omit the value get Displays the current setting 0 31 Range of call by call values Example pricallbycall set 1 User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI Network gt PRI Setup gt Advanced PRI Setup Call by Call This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system ViewStation EX ViewStation FX and VS4000 API Guide prichannel prichannel lt set get gt lt all 1 lt 23 30 gt gt lt on off gt prichannel set all lt on off gt prichannel set lt 1 23 gt lt on off gt prichannel set lt 1 30 gt lt on off gt prichannel set prichannel get all lt on off gt prichannel get lt 1 23 gt lt on off gt prichannel get lt 1 30 gt lt on off gt Description This command selects the PRI channels that will be active for the PRI line set get all 1 23 30 on off Example 1 Sets the PRI channels to be active when f
87. er on the network This name appears in the pcPresent Enter your Name field password Enters the presentation password start Displays the first slide register Registers the Telnet or RS 232 session to receive notifications about slides that are sent or received unregister Unregisters the Telnet or RS 232 session to receive notifications about slides that are sent or received Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example slides select presPC snapshot snapshot lt 0 1 2 3 4 register unregister gt 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 If you are not in a call it displays the snapshot on the near site until you clear it 0 Generates a snapshot from the far site camera 1 Generates a snapshot from the near camera 1 2 Generates a snapshot from the near camera 2 document camera 130 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide 3 Generates a snapshot from the near camera 3 VCR 4 Generates a snapshot from the near camera 4 auxiliary camera register Registers the Telnet or RS 232 session to receive notifications about snapshots that are sent or received unregister Unregisters the Telnet or RS 232 session to receive notifications about sn
88. essible if you have a Quad BRI network interface connected to your system Polycom Inc 2003 175 ViewStation EX ViewStation FX and VS4000 API Guide isdndialingprefix isdndialingprefix lt set get gt 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 set Sets the ISDN prefix when followed by the isdn prefix parameter If you want to erase the current setting omit isdn prefix get Displays the prefix information isdn prefix Numeric value Example isdndialingprefix set 9 User Interface Screen Location System Info gt Admin Setup gt Video Network gt ISDN Network ISDN Dialing Prefix Note This screen is only accessible if you have a Quad BRI network interface connected to your system 176 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide isdndialspeed isdndialspeed lt set get gt lt valid speed gt lt on off gt isdndialspeed set lt valid speed gt lt on off gt isdndialspeed get lt valid speed gt Description This command enables or disables the ISDN dialing speed valid speed set Sets the command The parameters valid speed and on or off are required get Displays the current setting for this option on or off The parameter valid speed is required valid speedValid spee
89. essive RENs on the telephone line may result in the devices not ringing in response to an incoming call In most but not all areas the sum of RENs of all devices that may be connected to a line is determined by the total RENs contact the local telephone company FCC compliant telephone cords and modular plugs are provided with this equipment This equipment is designed to be connected to the telephone network or premises wiring using a compatible modular jack which is Part 68 compliant See installation instructions for details WHEN PROGRAMMING EMERGENCY NUMBERS AND OR MAKING TEST CALLS TO EMERGENCY NUMBERS 1 Remain on the line and briefly explain to the dispatcher the reason for the call 2 Perform such activities in the off peak hours such as early morning or late evening Industry Canada IC This class A digital apparatus complies with Canadian ICES 003 Cet appareil numerique de la classe A est conforme a la norme NMB 003 du Canada The Industry Canada label identifies certified equipment This certification means that the equipment meets telecommunications network protective operational and safety requirements as prescribed in the appropriate Terminal Equipment Technical Requirements documeni s The Department does not guarantee the equipment will operate to the user s satisfaction Before installing this equipment users should ensure that it is permissible to be connected to the facilities of the local telecommunications c
90. etup gt Video Network gt IMUX gt Numbers This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system O Polycom Inc 2003 189 ViewStation EX ViewStation FX and VS4000 API Guide prinumberingplan prinumberingplan lt isdn unknown get gt Description This command sets the PRI numbering plan isdn unknown get Example With isdn the numbering plan is identified to the upstream switch as ISDN and the number type which is either national or international is determined from the dialed phone number If the dialed phone number starts with the international dialing prefix that is currently selected the type is set to the international and the prefix is removed from the number before the number is sent to the upstream switch Otherwise the number is marked as national and passed to the upstream switch without modification The default selection is unknown With this option the numbering plan and number type are sent to the upstream as unknown and the dialed phone number is sent without notification The default value unknown is preferred and should work in most cases Unknown should work with all properly configured PBXs and with most telephone company switches One notable exception in North America is an ATT 5ESS switch which is provisioned with Accunet or an ATT 4ESS switch For these switches set the numbering type to ISDN Displays the curren
91. face Screen Location System Info gt User Setup Multipoint Mode mute mute lt near far register unregister gt mute near lt on Joff toggle get gt 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 In register mode the system sends notification to the RS 232 or Telnet session when the far or near site is muted or unmuted near Sets the command for the near site It requires one of the following parameters on off toggle or get far Sets the command for the far site It requires the parameter get register Registers the system to give notification when the mute mode changes unregister Disables register mode on Turns on the mute mode for the near site mute near off Turns off the mute mode for the near site mute near toggle If in mute near on mode switches to the other mode setting mute near off and vice versa get Displays the current setting for the near or far site mute near far get Example mute near on 106 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide muteautoanswercalls muteautoanswercalls lt yes no get gt 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 An
92. followed by the XXX xXXX XXX XXxX parameter If you want to erase the current setting omit the parameter get Displays the current setting XXX XXX XXX XXXSystem s subnet mask Example subnetmask 255 255 255 0 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet Subnet Mask 144 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide systembehindnat systembehindnat lt yes no get gt 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 your system will not be able to make or receive calls When using a Virtual Private Network VPN for your network connection make sure this option is not selected yes Sets the system to be behind a NAT and use the NAT Outside WAN Address no Disables the option get Displays the current setting yes or no Example systembehindnat yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Firewall LAN Connection System is Behind a NAT Polycom Inc 2003 145 ViewStation EX ViewStation FX and VS4000 API Guide systemname systemname lt set get gt system name systemname set system name systemname get Descriptio
93. h specific information when followed by a parameter 153 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 mps Number of messages per second reps Number of times to repeat the message wait Number of seconds to wait echoport Port numbers to use localport Port numbers to use Example 1 testlan echo 192 168 1 159 Output to Example 1 testlan testlan testlan testlan testlan testlan testlan testlan testlan testlan testlan testlan echo d836969f 100 10 10 100 7 1024 returned length is 100 byte sent 10 received 10 lost 0 delayed 0 corrupt 0 sent 20 received 20 lost 0 delayed 0 corrupt 0 sent 30 received 30 lost 0 delayed 0 corrupt 0 sent 40 received 40 lost 0 delayed 0 corrupt 0 sent 50 received 50 lost 0 delayed 0 corrupt 0 sent 60 received 60 lost 0 delayed 0 corrupt 0 sent 70 received 70 lost 0 delayed 0 corrupt 0 sent 80 received 80 lost 0 delayed 0 corrupt 0 sent 90 received 90 lost 0 delayed 0 corrupt 0 sent 100 received 100 lost 0 delayed 0 corrupt 0 Example 2 testlan echo 207 46 197 101 Output to Example 2 This output shows a failure condition testlan testlan testlan testlan testlan echo cf2ec565 100 10 10 100 7 1024 waiting 100000
94. he current setting omit the parameter get Displays the current setting XXX XXX XXX XxXxIP address of the PC on which NetMeeting resides Example netmeeting set 192 168 100 7 User Interface Screen Location System Info gt Admin Setup gt Data Conference NetMeeting 108 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide netstats Polycom Inc 2003 netstats 0 2 netstats Description This command is used to get network statistics for each call 0 2 Range of selectable calls in a multipoint call maximum number of concurrent calls 3 where 0 is call 1 1 is call 2 and 2 is call 3 Select a number from this range to specify a remote site call for which you want to obtain network statistics Examples netstats netstats 2 Output Example call 1 txrate 128k rxrate 128k pktloss 0 spktloss 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 where txrate transmit clock rate rxrate receive clock rate pktloss number of packet loss errors pktloss percentage of packet loss errors tvp transmit video protocol rvp receive video protocol tvf transmit video format rvf receive video format tap transmit audio protocol rap receive audio protocol 109 ViewStation EX ViewStation FX and VS4000 API Guide tcp transmit comm protocol rcp receive comm protocol User Interface Screen Location System Info gt Diagnostics gt Netw
95. he dcd filter get Displays the current setting on or off Example dcdfilter on User Interface Screen Location System Info gt Admin Setup gt Video Network gt Advanced V 35 DCD gt Filter This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system 194 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide dsr dsr lt normal inverted get gt Description This command lets you configure the dsr serial interface control signal data set ready The default setting for this signal is normal normal Sets the signal to normal high voltage is logic 1 inverted Sets the signal to inverted low voltage is logic 1 get Displays the current setting normal or inverted Example dsr get User Interface Screen Location System Info gt Admin Setup gt Video Network gt Advanced V 35 DSR This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system dsranswer Polycom Inc 2003 dsranswer lt on off get gt Description This command sets the dsr serial interface control signal as a ring in indicate on Turns on the option off Turns off the option get Displays the current status on or off 195 ViewStation EX ViewStation FX and VS4000 API Guide Example dsranswer on User Interface Screen Location System Info gt Admin Setup gt Video Network gt Advanced V 35 DSR gt A
96. her information the FCC registration number and ringer equivalence number REN for this equipment If requested this information must be provided to the telephone company 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 at 1 888 248 4143 or 4750 Willow Road Pleasanton CA 94588 2708 USA Contact information may also be found at http www polycom com If the system is causing harm to the network the telephone company may request that you disconnect it until the problem is corrected If your ViewStation EX FX VS4000 causes harm to the telephone network the telephone company will notify you in advance that temporary discontinuance of service may be required However if advance notice is not practical you will be notified as soon as possible You will be advised of your right to file a complaint with the FCC if you believe it is necessary Your telephone company may make changes in its facilities equipment operations or procedures that could affect the operation of your equipment If they do you will be given advance notice so that you may make any changes necessary to maintain uninterrupted service The REN is useful to determine the quantity of devices that may be connected to the telephone line Exc
97. his 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 If you do not answer within one minute the call automatically disconnects set Sets the maximum time for calls when followed by a parameter from 0 99999 If you want to erase the current setting omit the parameter the call will stay up indefinitely get Displays the current setting 0 99999 Maximum number of minutes is 99999 Example maxtimeincall set 180 User Interface Screen Location System Info gt Admin Setup gt General Setup Maximum Time in a Call Polycom Inc 2003 101 ViewStation EX ViewStation FX and VS4000 API Guide mcupassword mcupassword password mcupassword Description This command sends the MCU password when the MCU prompts system for an MCU password The Meeting Password can be configured as the multipoint MCU conference password password Alphanumeric string Valid characters are 0 9 a z lower and upper case _ If you want to erase the current setting omit the parameter Note 1 Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Note 2 ViewStation EX this multipoint option is not available unless you update your ViewStation EX system to support multipoint capabilities For more information refer to th
98. ics Monitor 80 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide graphicsmonitorfxvga graphicsmonitorfxvga lt on off get gt Description This command enables or disables the system s VGA graphics monitor on Enables the VGA monitor as the graphics monitor Enable this option if you have a high resolution VGA monitor or projector connected to the rear panel of the system The command graphicsmonitorfxvga on is similar to graphicsmonitor fxvga off Disables the VGA monitor as the graphics monitor get Displays the current setting on or off Example graphicsmonitorfxvga on User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Monitors gt Graphics Monitor FX VGA graphicsmonitortv Polycom Inc 2003 graphicsmonitortv lt on off get gt Description This command enables or disables the system s TV monitor as the graphics monitor on Enables the TV monitor as the graphics monitor The command graphicsmonitorftv on is similar to graphicsmonitor tv 81 ViewStation EX ViewStation FX and VS4000 API Guide off Disables the TV monitor as the graphics monitor get Displays the current setting on or off Example graphicsmonitortv on User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Monitors gt Graphics Monitor TV Monitor graphicsmonitorvisualconcert graphicsmonitorvisualconcert lt on off get g
99. iewStation FX and VS4000 API Guide v35dialingprotocol v35dialingprotocol lt rs366 get gt 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 rs366 Enables RS 366 as the dialing protocol At this time RS 366 is the only supported dialing protocol on the system get Displays the current setting Example v35dialingprotocol rs366 User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network Dialing Protocol This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system v35num v35num lt set get gt lt 1b1 1b2 gt v35 number v35num set lt 1ibi 1b2 gt v35 number v35num set lt 1b1 1b2 gt v35num get lt 1b1 1b2 gt Description This command sets the ISDN video numbers assigned to the system The 1b1 and 1b2 parameters follow the convention and 204 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide nomenclature of the user interface and the command isdnnum see page 178 set lt 1b1 1b2 gt Sets the ISDN video number for a B channel line when followed by a v35 number parameter If you want to erase the current setting omit the parameter get lt 1b1 1b2 gt Displays the current ISDN video number ass
100. ilinebuildout set lt O 7 5 15 22 5 gt prilinebuildout set lt 0 133 134 266 267 399 400 533 534 665 gt 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 set Sets the PRI line buildout It requires a parameter from lt 0 7 5 15 22 5 gt or from lt 0 133 134 266 267 399 400 533 534 665 gt get Displays the current setting 0 7 5 15 22 5 Available output attenuation values in dB For internal CSUs 0 133 134 266 267 399 400 533 534 665 Available output attenuation values in feet For external CSUs Example prilinebuildout set 7 5 User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI Network gt PRI Setup Line Buildout This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system 187 ViewStation EX ViewStation FX and VS4000 API Guide prilinesignal prilinesignal lt set get gt lt esf b8zs crc4 hdb3 hdb3 gt prilinesignal set lt esf b8zs crc4 hdb3 hdb3 gt prilinesignal get Description This command sets the PRI line signal set Sets the PRI line signal It requires a parameter from lt esf b8zs crc4 hdb3 hdb3 gt get Displays the current PRI line signal setting esf b8zs A method of signal encoding
101. ing for the command gmscountry is lt empty gt meaning that no parameter has been set 14 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide System Commands This section describes each shell command and its parameters All commands are listed with their parameters spelled out Polycom Inc 2003 1 lt str 1 64 gt Description This command allows you to execute a previously used command starting with a specific number or letter from the history list For more information about the history list refer to history str Executes the last command that begins with the specified str from the history list 1 64 Range of command entries in the history list Executes the specified 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 The following is a Telnet session sample gt gatewaynumber set 123456789 gatewaynumber 123456789 restart system for changes to take effect restart now lt y n gt gt hangup video hanging up video call gt history 1 gatewaynumber set 123456789 2 hangup video 3 history Consequently each of the following lt letter or number gt commands execute the command and print its output from the history list A ViewStation EX ViewStation FX and VS4000 API Guide gatewaynumber set 123456789 gatewaynumber 12345678
102. ive feedback when the user changes the camera source 34 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Example 1 camera far 2 This command causes the remote terminal to begin sending its camera 2 Example 2 camera far move left This command causes the far camera to start panning to the left Example 3 Camera near move zoom This command causes the near camera to zoom in camera ptz Polycom Inc 2003 cameraiptz lt yes no get gt Description This command sets camera source 1 to pan tilt zoom mode This command is specific to the VS4000 system Note See the command camerainput to set your VS4000 camera source to S video or composite mode yes Enables pan tilt zoom mode no Disables pan tilt zoom mode get Displays the current setting yes or no Example cameralptz yes User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Cameras gt VS4000 Camera Setup 35 ViewStation EX ViewStation FX and VS4000 API Guide camera4ptz camera4ptz lt yes no get gt Description This command sets camera source 4 to pan tilt zoom mode This command is specific to the VS4000 system Note See the command camerainput on page 37 to set your VS4000 camera source to S video or composite mode yes Enables pan tilt zoom mode no Disables pan tilt zoom mode get Displays the current setting yes or no Example camera4ptz get User
103. l session with the listen command or start an outbound call with the dial command These two commands will cause the system to re direct the B channel status messages to the session which has issued one of these two commands For example if the RS 232 device issues a dial or listen command then call status is directed to the RS 232 port if a later session on a Telnet port issues a dial or listen command then call status is also directed to that Telnet port B Channel Status Message Example Following is an output example for B channel status messages where cs indicates call status for one B channel RINGING indicates a ring in or ring out and is equivalent to a 25 blue sphere on the graphical user interface CONNECTED is equivalent to a 50 yellow sphere BONDING indicates the bonding protocol is operational on the channel and is equivalent to a 75 orange sphere COMPLETE is equivalent to a 100 green sphere Example gt dial man 384 5551212 ISDN Dialing manual Dialing 5551212 384 none ISDN cs call 0 chan 0 dialstr 95551212 state RINGING cs cal1 0 chan 0 dialstr 95551212 state CONNECTED 10 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide cs cal1 0 chan 0 dialstr 95551212 state BONDING cs cal1 0 chan 0 dialstr 95551212 state COMPLETE cs cal1 0 chan 1 dialstr 95551212 state RINGING cs cal1 0 chan 1 dialstr 95551212 state CONNECTED cs cal1 0 chan 2 dialstr 9
104. l use the next available active channel in the range which could be 9 and so on Incoming Calls For incoming calls the ViewStation FX or VS4000 system may use the highest numbered channel in the range and if needed proceed to the next channel number in a decremental order depending on the type of third party equipment attached to the system For example an incoming call arrives on channel 23 then 22 21 and so on Dedicated full PRI T1 or E1 Line All channels should be active for a full T1 or E1 line dedicated to your ViewStation FX or VS4000 system Fractional PRI T1 or E1 Channel selection should be handled by your PRI network administrator PRI E1 Channel Information The PRI Status screen for E1 shows 30 channels However E1 trunk lines have 32 timeslots numbered 0 31 Timeslot 0 is used for framing and timeslot 16 is used for call signaling the D channel The remaining 30 timeslots are used as bearer data channels In call signaling between our equipment and the switch these channels are numbered 1 15 183 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 pricsu pricsu lt internal external get gt Description This command sets the PRI CSU mode for a T1 i
105. 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 Except for the foregoing the product is provided as is without warranty of any kind including without limitation any warranty of merchantability or fitness for a particular purpose The entire risk of the quality and performance of the software programs contained in the system is with you Limitation of Remedies and Damages Warning Polycom Inc its agents employees suppliers dealers and other authorized representatives shall not be responsible or liable with respect to the product or any other subject matter related thereto under any contract negligence strict liability or other theory for any indirect incidental or consequential damages including but not limited to loss of information business or profits The law of certain states or nations does not permit limitation or exclusion of implied warranties and consequential damages so the above limitations disclaimers or exclusion may not apply to you This warranty gives you special legal rights You may also have other rights that vary by state and nation This is a Class A product In a domestic environment this product may cause radio interference in which case the user
106. m Info gt Admin Setup gt LAN H 323 gt 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 Example streamrestoredefaults Output Sample streamspeed 192 streammulticastip 231 0 231 01 streamrouterhops 1 streamaudioport 16384 streamvideoport 16386 streamannounce yes streamenable no Polycom Inc 2003 141 ViewStation EX ViewStation FX and VS4000 API Guide streamrouterhops streamrouterhops lt set get gt 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 set Sets the number of routers when followed by the number router hops parameter If you want to erase the current setting omit the parameter get Displays the current setting number router hops Numeric value Number of routers the streaming video has to pass through Example streamrouterhops set 1 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Streaming Number of Router Hops 142 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide streamspeed streamspeed lt 192
107. m Info gt Diagnostics gt Color Bar View Color Bars country country lt set get gt lt algeria zimbabwe gt country set lt algeria zimbabwe gt country get Description This command selects the country or displays the name of the country This allows you to specify country specific calling parameters for your location set Sets the country A country name parameter from the range lt algeria zimbabwe gt is required get Displays the current setting algeria zimbabwe Range of selectable countries Select the country where the system is located For a complete listing type country set in the API help 40 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Examples country set germany country set united states User Interface Screen Location System Info gt Admin Setup gt General Setup Country dataconferencetype dataconferencetype lt off netmeeting t120 get gt Description This command sets the data conference type If a setting is changed the system has to be restarted for changes to take effect The user is prompted to restart the system off No data conference type is selected netmeeting Selects NetMeeting as the data conference type t120 Selects t120 as the data conference type get Displays the status for this option off ne
108. mal normal Sets the signal to normal falling edge sends data inverted Sets the signal to inverted rising edge sends data get Displays the current setting for this option normal or inverted Example st get User Interface Screen Location System Info gt Admin Setup gt Video Network gt Advanced V 35 ST This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system 202 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide v35broadcastmode v35broadcastmode lt on off get gt Description This command sets H 331 broadcast mode for transmissions via satellite on Enables broadcast mode off Disables broadcast mode get Displays the current setting on or off Example v35broadcastmode on User Interface Screen Location System Info gt Admin Setup gt Video Network gt 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 v35debug Polycom Inc 2003 v35debug lt 0 3 gt lt on off gt Description This command enables or disables V 35 RS 449 RS 530 RS 366 debug tracing for a V 35 RS 449 device 0 through 3 0 3 Range of V 35 RS 449 RS 530 RS 366 devices on Enables V 35 RS 449 RS 530 RS 366 debug tracing off Disables V 35 RS 449 RS 530 RS 366 debug tracing Example v35debug 1 on 203 ViewStation EX V
109. may be required to take adequate measures USA and Canadian Regulatory Notices 212 FCC Notice Part 15 FCC Rules This device complies with part 15 of the FCC rules Operation is subject to the following two conditions 1 This device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Class A Digital Device This equipment has been tested and found to comply with the limits for a Class A digital device pursuant to Part 15 of the FCC Rules These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instruction manual may cause harmful interference to radio communications Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his own expense In accordance with Part 15 of the FCC rules the user is cautioned that any changes or modifications not expressly approved by Polycom Inc could void the user s authority to operate this equipment www polycom com Safety and Legal Notices Part 68 FCC Rules This equipment complies with Part 68 of the FCC rules On the label of this equipment is a label that contains among ot
110. me when followed by the city parameter If you want to erase the current setting omit city get Displays the current setting city Character string specifying the city Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 71 ViewStation EX ViewStation FX and VS4000 API Guide Example gmscity set Paris User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 City gmscontactemail gmscontactemail lt set get gt email gmscontactemail set email gmscontactemail set gmscontactemail get Description This command sets the GMS contact E mail information set Sets the GMS contact E mail information when followed by the email parameter If you want to erase the current setting omit email get Displays the current contact E mail information email Alphanumeric string specifying the contact E mail Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gmscontactemail set JohnGMSguy whatever com User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 Contact Email 72 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide gmscontactfax gmscontactfax lt set get gt fax gmscontactfax set fax gmscontactfax set
111. min Setup gt LAN H 323 gt SNMP Location Name soundeffectsvolume soundeffectsvolume lt set get test gt lt 0 10 gt soundeffectsvolume set lt 0 10 gt 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 set Sets the volume of sound effects It requires a parameter from 0 10 get Displays the current setting test Tests the volume of sound effects Example soundeffectsvolume set 6 136 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt 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 lt on off gt Description This command redirects the standard output to the port from which you are issuing the stdout command on Turns on the standard output off Turns off the standard output Example stdout on stdout off stream Polycom Inc 2003 stream lt start stop gt Description This command starts or stops streaming from your system start Starts streaming A meeting password may be required stop Stops streaming Example stream start User Interface Screen Location On the main screen Call
112. mple ipstat Output to Example hostname MyEX winsresolution no dhcp client ipaddress 192 168 1 111 dns 1 192 168 1 2 dns 2 192 168 1 3 dns 3 192 168 1 4 dns 4 0 0 0 0 defaultgateway 192 168 1 5 subnetmask 255 255 255 0 winsserver 192 168 1 6 lanport auto pcport auto User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet all information displayed on this screen System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Advanced LAN Settings 92 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide keypadaudioconf keypadaudioconf lt yes no get gt 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 yes Enables audio confirmation no Disables audio confirmation get Displays the current setting yes or no Example keypadaudioconf yes User Interface Screen Location System Info gt Admin Setup gt General Setup Keypad Audio Confirmation Page 2 language Polycom Inc 2003 language lt set get gt lt englishus englishuk french german italian spanish japanese chinese portuguese norwegian gt language set lt englishus englishuk french german italian spanish japanese chinese portuguese norwe gian gt language get Description This command selects the language that you w
113. mpound names or strings containing spaces Ex united states Example streamaudioport set 16384 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Streaming Audio Port Polycom Inc 2003 139 ViewStation EX ViewStation FX and VS4000 API Guide streamenable streamenable lt yes no get gt Description This command enables or disables streaming on the system yes Enables streaming no Disables streaming get Displays the current setting yes or no Example streamenable yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Streaming Allow Streaming streammulticastip streammulticastip lt set get gt ip address streammulticastip set ip address streammulticastip set streammulticastip get Description 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 set Sets the multicast IP address when followed by the ip address parameter If you want to erase the current setting omit the parameter 140 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide get Displays the current setting ip address Multicast IP address Example streammulticastip get User Interface Screen Location Syste
114. n 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 The name can be any combination of alphanumeric characters up to 34 characters in length The system name cannot be blank set Sets the system name It must be followed by the system name parameter get Displays the current system name system name The name can be up to 34 characters in length Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Examples systemname set MyOwnFX systemname set New EX on the Block User Interface Screen Location System Info gt Admin Setup gt General Setup System Name 146 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide t120nameip t120nameip lt set get gt 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 Note Data conferencing is only available during IP H 320 calls and must be supported by far site systems set Sets the t120 name or IP address when followed by the name or ip parameter If you want to erase the current setting omit the parameter get Displays the current setting name or ip t120 device name or IP address Note Use q
115. n number In the case that the REN is included in the FCC number the user should use the following key to determine the value The FCC number is formatted as US AAAEQ T XXX is the Ringer Equivalence Number without a decimal point e g REN of 1 0 will be shown as 10 REN of 0 3 will be shown as 03 In the case of a Z ringer ZZ shall appear In the case of approved equipment without a network interface or equipment not to be connected to circuits with analog ringing supplied NA shall appear EEA Regulatory Notices 214 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 Declaration of Conformity Hereby Polycom Ltd declares that this ViewStation EX FX VS4000 is in compliance with the essential requirements and other relevant provisions of Directive 1999 5 EC Konformitetserklzring Hermed erkleerer Polycom Ltd at indest ende ViewStation EX FX VS4000 er i overensstemmelse med de grundl ggende krav og de relevante punkter i direktiv 1999 5 EF Konformitatserklarung Hiermit erklart Polycom Ltd dass der ViewStation EX FX VS4000 die grundlegenden Anforderungen und sonstige maBgebliche Bestimmungen der Richtlinie 1999 5 EG erf llt Andwon 2uppopqwonc Ala tou Trapovtos n etaipeia Polycom Ltd SnAwvel oT n Tapouca gugKeu
116. n sleep registered Acknowledgment that the session is now registered to listen for sleep mode listen going to sleep Notification of event the system is going to sleep mode 97 ViewStation EX ViewStation FX and VS4000 API Guide listen waking up Notification of event the system is waking up maxgabinternationalcallspeed maxgabinternationalcallspeed lt set get gt lt valid speed gt maxgabinternationalcallspeed get Description This command sets the maximum speed for international ISDN calls made from the Global Address Book set Sets the maximum speed for international calls when followed by a valid speed value valid speedValid speeds are 2x64 128 256 384 512 768 1024 and 1472 Kbps get Displays the current valid speed Note The ViewStation EX system supports speeds up to 768 Kbps Example maxgabinternationalcallspeed set 512 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Preferences Maximum Line Speed for Global Address International ISDN Calls 98 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide maxgabinternetcallspeed maxgabinternetcallspeed lt set get gt lt valid speed gt maxgabinternetcallspeed get Description This command sets the maximum speed for Internet IP H 323 calls made from the Global Address Book set Sets the maximum speed for international calls when
117. nerally able to automatically determine the country code based on the country you selected during initial system setup set Sets the telephone country code when followed by the telephone country code parameter If you want to erase the current setting omit the parameter get Displays the country code information telephone country code Numeric value This code is the same as the ISDN country code Example telecountrycode set 33 User Interface Screen Location System Info gt Admin Setup gt Phone Audio Country Code 150 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide telenumber telenumber lt set get gt telephone number telenumber set telephone number telenumber set telenumber get Description This command sets the system s telephone number set Sets the telephone number when followed by the telephone number parameter If you want to erase the current setting omit the parameter get Displays the current setting telephone number System s telephone number Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example telenumber set 5551212 User Interface Screen Location System Info gt Admin Setup gt Phone Audio Number Polycom Inc 2003 151 ViewStation EX ViewStation FX and VS4000 API Guide testlan arp testlan arp Description This command prints the ARP Addres
118. nfigure the rt serial interface control signal receive timing clock The default setting for this signal is normal normal Sets the signal to normal rising edge receives data inverted Sets the signal to inverted falling edge receives data get Displays the current setting for this option normal or inverted Example rt inverted User Interface Screen Location System Info gt Admin Setup gt Video Network gt Advanced V 35 RT This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system rts Polycom Inc 2003 rts lt normal inverted get gt Description This command lets you configure the rts serial interface control signal request to send The default setting for this signal is normal normal Sets the signal to normal high voltage is logic 1 inverted Sets the signal to inverted low voltage is logic 1 get Displays the current setting normal or inverted 201 ViewStation EX ViewStation FX and VS4000 API Guide Example rts normal User Interface Screen Location System Info gt Admin Setup gt Video Network gt 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 st lt normal inverted get gt Description This command lets you configure the st serial interface control signal send timing clock The default setting for this signal is nor
119. nnncnnnnnna non 5 Bald Rates a in ad hee 5 RS 232 MOdeS ciclista eii 5 Flow Control codiciada cdt add Rata anita 7 RS 232 Serial Cable Pinout and Connections ViewStation EX and FX 8 RS 232 Serial Cable Pinout and Connections VS4000 0 9 Status Display cic ROO eee reese ees 10 Using the listen or dial Command cceeeceeeeeeeeeteeeeeeeettaeeeeeeeaes 10 B Channel Status Message Example eeecccceeessereeeeeeenteeeeeeeenaaes 10 Syntax SUMMA ecne eieiei aa raa aa ea i ea 13 About the get SUDCOMMANG 1 00 0 eee cette terete etter enaA rani RRA RAELA AAAA EEA 14 System Commands criminal rain 15 A dada 15 AI ds A a laica 16 adminpassword ici ii a 17 advnetstalS it eee ie eo al ede 18 all0WwabkChanges oocoonooccciconoconcccconaonncnncnonncnnc conan ncn nc na nan o nn cc canaria ncccnnns 20 allowdialiNg lt bid 21 allowmixedcalls oooooooccnnnnonnnioncococcconcnncnoncnnnnnnnnn ono nnnnnnn cnn nica nnnnnnn nine 21 allowremotemon cooooocccccccccccccnnccnncnnnnno non nnnnnnnnnnn cnn cnn nnnnnnn cnn nnnnn narran 22 AIIOWUSEFSETUP cti decada abad 22 AMS tii EEE EE A AA A AAA 23 audioquallity ooo a A 23 audioqualityo 22 Miracle 24 AUD AA Wei seee 25 a t discoyernat s mrss a da ati 26 AULONSZ3dIAlING envai a ene dees aude eee idea 26 backlightcompensattion ccccccccceeeeeeeeeeeeeeeeceeeeeeeesaeeeeeeeiaeeeeeeeaaas 27 Dutra nen deed hig niet sie eee des 28 CallpreterenCe nerean i
120. normal high voltage is logic 1 inverted Sets the signal to inverted low voltage is logic 1 get Displays the current setting normal or inverted Example cts normal User Interface Screen Location System Info gt Admin Setup gt Video Network gt Advanced V 35 CTS This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system dcd Polycom Inc 2003 dcd lt normal inverted get gt Description This command lets you configure the dcd serial interface control signal data carrier detect The default setting for this signal is normal normal Sets the signal to normal high voltage is logic 1 193 ViewStation EX ViewStation FX and VS4000 API Guide inverted Sets the signal to inverted low voltage is logic 1 get Displays the current setting normal or inverted Example dcd inverted User Interface Screen Location System Info gt Admin Setup gt Video Network gt 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 lt on off get gt Description This command lets you configure the filter of the dcd serial interface control signal data carrier detect When this filter is enabled dcd drops for 60 seconds before changing the call state The default setting for this signal is off on Enables the dcd filter off Disables t
121. ns Note The option Allow H 320 and H 323 Mixed Calls is only visible on screen if the the ISDN Video Calls H 320 option has been enabled on the Call Preferences screen yes Allows mixed IP and ISDN calls no Disables mixed IP and ISDN calls get Displays the current setting yes or no 21 ViewStation EX ViewStation FX and VS4000 API Guide Example allowmixedcalls yes User Interface Screen Location System Info gt Admin Setup gt Video Network gt Call Preferences Allow H 320 and H 323 Mixed Calls allowremotemon allowremotemon lt get gt Description This command displays the current state of the Allow Remote Monitoring option get Displays the current setting yes or no Example allowremotemon get User Interface Screen Location System Info gt User Setup Allow Remote Monitoring allowusersetup allowusersetup lt yes no get gt Description This command enables or disables the User Setup icon on the System Information screen of the user interface thus allowing or preventing access to the User Setup screen This option is useful to prevent users from changing the User Setup functions yes Enables the User Setup option no Disables the User Setup option get Displays the current setting yes or no 22 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Example allowusersetup yes User Interface Screen Location System Info gt Admin
122. nswer This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system dtr dtr lt normal inverted on get gt Description This command lets you configure the dtr serial interface control signal data terminal ready The default setting for this signal is normal normal Sets the signal to normal high voltage is logic 1 inverted Sets the signal to inverted low voltage is logic 1 on Sets constant high voltage If this option is selected inverted is not an option get Displays the current setting normal or inverted Example dtr get User Interface Screen Location System Info gt Admin Setup gt Video Network gt Advanced V 35 DTR This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system 196 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide h331audiomode h331audiomode lt g728 g711u g711a g722 56 g722 48 off get gt 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 g728 g711u g711a g722 56 g722 48 off get Example ITU T Recommendation for audio encoding using Low Delay Code Excited Linear Prediction CELP The bandwidth of the analog audio signal is 3 4 kHz
123. nt setting on or off Example echocanceller yes User Interface Screen Location System Info gt Admin Setup gt Phone Audio Echo Canceller Polycom Inc 2003 55 ViewStation EX ViewStation FX and VS4000 API Guide enablesnapshots enablesnmp lt yes no get gt Description This command enables or disables the ability to take or send snapshots This option is enabled by default yes Enables the option no Disables the option get Displays the current setting on or off Example enablesnmp yes User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Cameras Enable Snapshot enablesnmp enablesnmp lt yes no get gt Description This command is used to enable or disable SNMP This option is enabled by default yes Enables the option no Disables the option get Displays the current setting on or off Example enablesnmp yes 56 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt SNMP Enable SNMP exit exit Description This command ends an API command session Example exit farcontrolnearcamera O Polycom Inc 2003 farcontrolnearcamera lt yes no get gt Description This command sets far control of the near camera thus allowing remote sites to control the camera on your system yes Enables the far control option of the n
124. nterface By default the T1 PRI network interface module is set for internal CSU mode internal Sets the internal CSU mode This is the default external Sets the external CSU mode When selected you must specify the PRI line buildout see the prilinebuildout command on page 187 get Displays the current CSU setting internal or external Example pricsu external User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI Network gt PRI Setup CSU This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system 184 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide pridialchannels pridialchannels lt set get gt lt 1 12 15 gt pridialchannels set lt 1 12 gt pridialchannels set lt 1 15 gt 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 set Sets the number of PRI channels to be dialed in parallel when followed by a parameter from lt 1 12 15 gt If you want to erase the current setting omit the parameter get Displays the current number of channels dialed in parallel 1 12 15 Range of numbers of PRI channels that can be dialed in parallel For PRI E1 the range is 1 15 For PRI T1
125. ociated with a B channel of a particular line 1b1 1b2 B1 and B2 channels 1b1 designates line 1 B channel 1 B1 1b2 designates line 1 B channel 2 B2 v35 number Numeric string This is the ISDN video number s provided by your network service provider Example v35num set 1b1 5125551212 User Interface Screen Location System Info gt Admin Setup gt Video Network gt Numbers This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system v35portsused Polycom Inc 2003 v35portsused lt 1 1 2 get gt Description This command selects the number of V 35 RS 449 RS 530 RS 366 ports to use 1 Selects one port for one channel calls 1 2 Selects two ports for two channel calls 2 x 56 Kbps or 2 x 64 Kbps get Displays the current setting 1 or 1 2 205 ViewStation EX ViewStation FX and VS4000 API Guide Example v35portsused 1 2 User Interface Screen Location System Info gt Admin Setup gt Video Network gt 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 lt set get gt lt valid speed gt value v35prefix set lt valid speed gt value v35prefix set lt valid speed gt v35prefix get lt valid speed gt Description This command sets the V 35 RS 449 RS 530 RS 366 dialing prefix It assumes that a profil
126. ocol is used At the selected speed or lower the system uses the G 722 1 audio protocol Above the selected speed the system uses the G 722 audio protocol G 722 1 supports enhanced frame loss concealment and works automatically and transparently between systems supporting this audio standard This is based on an algorithm that detects and replaces missing speech data thus maintaining high quality audio set Sets the call speed threshold value Requires a parameter from lt 64 112 128 168 192 224 256 280 320 336 384 392 448 512 gt get Displays the current threshold value of the call 64 512 Range of selectable speeds 24 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Example audioqualityg7221 set 256 User Interface Screen Location System Info gt Admin Setup gt Phone Audio Audio Quality autoanswer Polycom Inc 2003 autoanswer lt yes no donotdisturb get gt Description This command sets the Auto Answer Point to Point mode which determines how the system will handle an incoming call in a point to point video conference yes no If the option Auto Answer Point to Point is set to yes any incoming call will be connected automatically If the option Auto Answer Point to Point is set to no and there is an incoming call the user will be prompted with a message You have a video call Would you like to answer This message can be followed by a far site video number
127. ollowed by a parameter from lt all 1 lt 23 30 gt gt and from lt onloff gt If you want to erase the current settings omit the parameters Displays the current setting on or off Requires a parameter from lt all 1 lt 23 30 gt gt Selects all PRI channels Range of available PRI channels For PRI E1 the range is 1 30 For PRI T1 the range is 1 23 Activates the selected PRI channels Disables the selected PRI channels prichannel set all on 182 www polycom com Polycom Inc 2003 ViewStation EX ViewStation FX and VS4000 API Guide Example 2 prichannel set Example 3 prichannel get 3 User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI Network gt PRI Status This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system Important PRI Channel Information Outgoing Call For an outgoing call the ViewStation FX or VS4000 system uses the first active and available channel starting with the lowest number from the channel range 1 23 for a PRI T1 and 1 30 for a PRI E1 If an additional channel is needed the system chooses the next incremental number For example if channels 1 through 7 are inactive but 8 is active and available then 8 is the first channel that can be used by the ViewStation ViewStation FX or VS4000 system to place an outgoing call If an additional channel is needed the system wil
128. olycom Inc 4750 Willow Road Pleasanton CA 94588 2708 USA No part of this document may be reproduced or transmitted in any form or by any means electronic or mechanical for any purpose without the express written permission of Polycom Inc Under the law reproducing includes translating into another language or format As between the parties Polycom Inc retains title to and ownership of all proprietary rights with respect to the software contained within its products The software is protected by United States copyright laws and international treaty provision Therefore you must treat the software like any other copyrighted material e g a book or sound recording Every effort has been made to ensure that the information in this manual is accurate Polycom Inc is not Contents What s New in Release 5 0 c ccccccecceceeeceeeeeeneecaeceeeeeeeeeeeeeeesecenccaeeeeeeeeeeees 2 Accessing the API Interface cccecccccccecesscccceeteneneeeeeteeseccereteeaceceeeeesneaeeeresee 3 Using Telnet o Adi 3 Using the RS 232 Interface oocoonoonicccnnnnocccccnnnnoncncccnanancnnn nana rca ronca nn 3 Connecting the Serial Cable ooooooononncnnnnanoccccccnccnnncnccninnns 3 Starting a Communications Session cccceeeeeeeeeeees 4 RS 232 Interface Information c ccccceceeceeeeeeeeeeeeeeneceeeeeeeeeeeeeeeeeesensnaaeees 5 RS 232 User Interface Screen ooococccccinocccicccononcnnncnanancnnnona
129. om Inc 2003 65 ViewStation EX ViewStation FX and VS4000 API Guide gatewaynumbertype gatewaynumbertype lt did number extension get gt Description This command specifies the Gateway Number Type It can be either Direct Inward Dial DID or Number Extension did 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 This in turn will be passed to the gatekeeper for address resolution The endpoint needs to register this portion of the DID as an E 164 alias with the gatekeeper in order for this to work number extension This option allows the call to go through directly it dials the gateway number extension as one number get Displays the current setting did or number extension Example gatewaynumbertype number extension User Interface Screen Location System Info gt User Setup gt LAN H 323 gt H 323 gt Gateway Gateway Number Type 66 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide gatewayprefix Polycom Inc 2003 gatewayprefix lt set get gt lt valid speed gt value gatewayprefix set lt valid speed gt value gatewayprefix set lt valid speed gt gatewayprefix get lt valid speed gt Description This command sets the gateway prefixes for the corresponding speeds Some gateways require a number to be prepended prefix
130. ompany The equipment must also be installed using an acceptable method of connection The customer should be aware that compliance with the above conditions may not prevent degradation of service in some situations Repairs to certified equipment should be coordinated by a representative designated by the supplier Any repairs or alterations made by the user to this equipment or equipment malfunctions may give the telecommunications company cause to request the user to disconnect the equipment Users should ensure for their own protection that the electrical ground connections of the power utility telephone lines and internal metallic water pipe system if present are connected together This precaution may be particularly important in rural areas Caution Users should not attempt to make such connections themselves but should contact the appropriate electric inspection authority or electrician as appropriate Polycom Inc 2003 213 ViewStation EX ViewStation FX and VS4000 API Guide The Ringer Equivalence Number REN assigned to each relevant terminal device provides an indication of the maximum number of terminals allowed to be connected to a telephone interface The termination on an interface may consist of any combination of devices subject only to the requirement that the sum of the RENs of all the devices does not exceed 5 The REN of this equipment is either marked on the unit or included in the new style USA FCC registratio
131. on EX ViewStation FX and VS4000 API Guide near move left Near camera direction change start moving left near move rightNear camera direction change start moving right near move up Near camera direction change start moving up near move downNear camera direction change start moving down near move stop Near camera direction change stops near move continuous Switches near camera move mode to continuous mode Camera will move in direction specified until a camera near move stop command is sent near move discrete Switches near camera move mode to discrete mode Camera will move a small discrete amount in the direction specified and then stop No camera near move stop command is required near stop Stops the near camera movement when in continuous mode near lt setposition getposition gt lt x gt lt y gt lt z gt Sets or gets the x y and z coordinates of the currently selected ptz camera Camera ptz range 880 lt x lt 880 pan 300 lt y lt 300 tilt 0 lt z lt 1023 zoom Note Some D30 cameras might not be able to reach the designed range limit For example although the pan limit is 880 the camera might only be able to reach 860 near tracking on Turns on the near camera tracking mode near tracking off Turns off the near camera tracking mode near tracking to_presets Turns on the near camera tracking to presets near tracking get Gets the near camera tracking mode 33 View
132. on your system select System Info gt Admin Setup gt Software Hardware gt RS 232 On the RS 232 screen you can configure the Baud Rate the RS 232 Mode and the Flow Control options The following baud rates are supported by the RS 232 port on the ViewStation EX ViewStation FX and the VS4000 system e 1200 e 2400 e 9600 e 14400 e 19200 e 38400 e 57600 e 115200 RS 232 Modes Polycom Inc 2003 The RS 232 port on the ViewStation EX ViewStation FX and the VS4000 system supports two modes Control and Pass Thru In Control Mode a device for example a PC connected to the RS 232 port can control the system using the Remote Control API In Pass Thru Mode the operational modes of both endpoints RS 232 ports depend on the port configuration of each endpoint Thus two operational situations might arise ViewStation EX ViewStation FX and VS4000 API Guide Pass Thru Mode to Pass Thru Mode Both endpoints are set to Pass Thru Mode Pass Thru Mode to Control Mode The near site is set to Pass Thru Mode and the far site is set to Control Mode Operational Modes The following information describes operational modes in more detail Pass Thru Mode to Pass Thru Mode Two stations set to Pass Thru Mode behave essentially as a null modem between their respective externally connected devices These two stations can be two ViewStation EX systems two ViewStation FX systems two VS4000 systems or one ViewStation EX
133. ork Stats numdigitsdid numdigitsdid lt 0 24 get gt numdigitsdid lt 0 24 gt 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 This in turn will be passed to the Gatekeeper for address resolution Note This option becomes visible when Direct Inward Dial DID has been selected 0 24 Range of allowed digits get Displays the current setting Example numdigitsdid 7 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gateway Number of digits in DID Number 110 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide numdigitsext numdigitsext lt 0 24 get gt numdigitsext lt 0 24 gt 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 This in turn will be passed to the Gatekeeper for address resolution 0 24 Range of allowed digits get Displays the current setting Note This option becomes visible when Direct Inward Dial DID has been selected Ex
134. pound name or strings containing spaces Ex united states or 111 222 333 Example 1 help all Output to Example 1 partial lt str gt Repeat the last command in the history list which begins with str lt 1 64 gt Repeat the Nth command in the history list when N is 1 through 64 abk all Display all the local address book entries abk batch lt 0 60 gt Display local address book entries in batches of 10 or the whole address book at once abk letter lt fa z gt Display local address book entries beginning with the letter specified abk range lt a gt lt b gt Display local address book entries numbered a through b Example 2 help 85 ViewStation EX ViewStation FX and VS4000 API Guide Output to Example 2 partial abk adminpassword advnetstats lowabkchanges lowdialing lowmixedcalls lowremotemon Y o p po p lowusersetup answer audioquality audioqualityg7221 autoanswer autodiscovernat hires hires lt 2 3 gt lt yes no get gt Description This command sets the high resolution state for camera 2 or 3 2 3 Selectable high resolution cameras yes Enables high resolution mode for the selected camera no Disables high resolution mode for the selected camera get Displays the current state for the selected camera yes or no Example 1 hires 2 no Example 2 hires
135. r no Example registerthissystem yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Server Register this System When Powered On repeat repeat lt 1 64 gt Description This command allows you to repeat a specified command from the history list For more information about the history list refer to the command history 1 64 Range of command entries in the history list Repeats the specified Nth command in the history list Examples The following is a sample history list containing the command entries 1 dynamicbandwidth get 2 get screen 3 language get 4 ipdialspeed set 128 on 5 lanstat min 1 Consequently the command repeat 4 will repeat command 4 whichis ipdialspeed set 128 on from the preceding history list 120 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide requireacctnumtodial requireacctnumtodial lt yes no get gt 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 This account number is saved in the GMS server database along with information specific to the call Typically the GMS administrator assigns the account number You must use GMS 2 0 or l
136. r than an enumeration of the valid parameters Example allowdialing lt yes no get gt An optional parameter As with required parameters optional parameters may be presented with a character pipe to indicate choices Example gabpassword lt set get gt password Indicates a range of values Example displaybolt lt n 0 100 gt String parameters to be supplied by the user are denoted with quoted strings example symbol In general parameters are supplied from a set of defined string values that are specifically enumerated These values are command specific Note a quoted string parameter can contain any value Example The command gabpassword lt set get gt password requires that the user supply the string parameter password as shown in the following example gabpassword set MyPassword ViewStation EX ViewStation FX and VS4000 API Guide If the string parameter contains a compound name or Spaces use quotation marks as in the following examples gabpassword set My FX Password gabpassword set 111 222 333 a b A number ranging from a to b About the get Subcommand In most cases the get subcommand returns the command name and the current setting if one has been set Example 1 gmscountry get Response gmscountry france The current setting for the command gmscountry is france Example 2 gmscountry get Response gmscountry lt empty gt The current sett
137. r with the system The API shell echoes the message call complete when the call connects or is aborted callcomplete Causes the API shell to wait until a call being placed either connects or fails systemready Causes the system to return the message system is ready when the system is ready to make a call receivingcall Causes the API shell to wait until an incoming ring is detected and returns the message waitfor receiving call Example waitfor callcomplete Polycom Inc 2003 169 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 lt set get gt XXX XXX XXX XXX wanipaddress set XXX XXX XXX XXX wanipaddress set wanipaddress get Description This command sets the WAN IP address set Sets the WAN IP address when followed by the XXX XXX XXX XXX parameter If you want to erase the current setting omit the parameter get Displays the WAN IP address XXX XXX XXX XXX WAN IP address Example wanipaddress set 192 168 1 122 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Firewall LAN Connection NAT Outside WAN Address 170 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide whoami whoami Description
138. ranet gt Firewall LAN Connection Use Fixed Ports 158 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide usegatekeeper usegatekeeper lt off specify auto get gt Description This command selects the gatekeeper mode off specify or auto After a change the user is prompted for system restart Note A gatekeeper is not required to make IP to IP LAN calls In these situations select the off option off Select this option if no gatekeeper is required or if you make IP to IP LAN calls specify Specifies a gatekeeper If this option is selected you need to enter the gatekeeper IP address or name with the command gatekeeperip see page 61 auto Sets the system to automatically find an available Gatekeeper get Displays the current setting off specify or auto Example usegatekeeper specify User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gatekeeper Use Gatekeeper Polycom Inc 2003 159 ViewStation EX ViewStation FX and VS4000 API Guide usepathnavigator usepathnavigator lt always never required get gt Description This command selects the PathNavigator mode if PathNavigator is used with the system Because PathNavigator uses an MGC it can handle videoconferences with more participants and higher speeds than an embedded MCU PathNavigator which supports ad hoc multipoint videoconferencing is required to implemen
139. rformance problems with your system dd Decimal value between 10000 and 100 A positive integer represents the percentage of lost packets A negative integer represents the number of lost packets Examples displaybolt 5 The lightning bolt is displayed when 5 of the packets is lost displaybolt 50 The lightning bolt is displayed after 50 packets are lost 48 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide displayglobaladdresses displayglobaladdresses lt yes no get gt Description This command enables or disables the display of global addresses in the system s Address Book yes Enables the display of global addresses no Disables the display of global addresses get Displays the current setting yes or no Example displayglobaladdresses yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Server Display Global Addresses displaygraphics Polycom Inc 2003 displaygraphics lt yes no get gt Description This command enables or disables the display of the graphics in a call yes Enables the display of graphics no Disables the display of graphics get Displays the current setting yes or no Example displaygraphics yes 49 ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Monitors gt TV Monitors Display Icons
140. rings containing spaces Ex united states or 111 222 333 Note 2 The ViewStation EX system supports speeds up to 768 Kbps 69 ViewStation EX ViewStation FX and VS4000 API Guide Example gatewaysuffix set 192 11 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gateway page 2 Suffix gendial gendial 0 9 Description This command generates DTMF dialing tones to POTS line 0 9 Represents valid buttons Example gendial 2 generatetone generatetone lt on off gt Description This command turns the test tone on or off The tone is used to check the monitor audio cable connections or to monitor the volume level on Turns on the test tone off Turns off the test tone Example generatetone on User Interface Screen Location System Info gt Diagnostics gt Audio gt Generate Tone 70 www polycom com 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 Example get screen Output Example CGenToneScreen gmscity Polycom Inc 2003 gmscity lt set get gt city gmscity set city gmscity set gmscity get Description This command sets the GMS city information set Sets the GMS city na
141. s 10 Sets the frame rate at 10 fps 7 5 Sets the frame rate at 7 5 fps get Displays the current setting for this option Example h331framerate 30 User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network gt Broadcast Mode Setup Frame Rate This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system 198 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide h331videoprotocol h331videoprotocol lt h263 h261 get gt 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 h263 Video protocol based on an enhanced video algorithm Only far end systems that support H 263 can receive H 263 h261 Standard video protocol used to transmit video get Displays the current setting Example h331videoprotocol h263 User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network gt Broadcast Mode Setup Video Protocol This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system h331videoformat Polycom Inc 2003 h331videoformat lt fcif get gt Description This command sets the H 331 video format for the broadcast transmission Bro
142. s generally assigned by the GMS administrator See also the related command requireacctnumtodial on page 121 account numberNumber that is needed to validate the account before dialing out Note Use quotation marks around compound names or strings containing spaces Ex united states or 111 222 333 Example setaccountnumber 1234 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Setup showaddrsingab Polycom Inc 2003 showaddrsingab lt h320 h323 both get gt Description This command displays video numbers in the system s Global Address Book GAB h320 Displays only H 320 ISDN video numbers in the GAB h323 Displays only H 323 IP numbers in the GAB 127 ViewStation EX ViewStation FX and VS4000 API Guide both Displays both ISDN and IP numbers in the GAB get Displays the current setting h320 h323 or both Example showaddrsingab both User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Preferences Show Addresses in Address Book showpopup showpopup lt text to display gt Description This command displays a popup message box in the user interface text to display Alphanumeric text Must be between quotation marks Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example showpopup This is fun
143. s Resolution Protocol table contents Example testlan arp testlan dcuinfo testlan dcuinfo Description This command displays miscellaneous DCU information Example testlan dcuinfo Output Sample DCUs for 0 2044 DCUs for 36 1 DCUs for 37 1 DCUs for 44 1 DCUs for 49 2048 DCUs for 52 1 DCU IP counts ip_xchg_count 590 list_input_count 590 Total TX offered 316 processed 316 DCU Badrequestor 0 Badpointer 0 Badindex 0 total 4096 152 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide testlan dns testlan dns lt name or ip gt 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 Example 2 testlan dns 216 115 108 243 Output to Example 2 testlan yahoo com is 216 115 108 243 testlan echo Polycom Inc 2003 testlan echo lt ip_addr gt length mps reps wait echoport localport testlan echo lt ip_addr gt Description This command generates a series of UDP packets which request the echo server on the far end to echo the packet contents The echo message displays the number of packets that were echoed and that were corrupted ip_addr Generates UDP packets to this destination IP address remote UDP echo server and prints an echo message wit
144. s only rmlpr Receive MLP rate H 320 calls only de Data conference rsid Remote system id User Interface Screen Location System Info gt Diagnostics gt Advanced Stats allowabkchanges allowabkchanges lt yes no get gt Description This command enables or disables the Allow Address Book Changes option If this option is enabled the user has access to the New Edit and Delete icons in the Address Book screen yes Enables the Allow Address Book Changes option no Disables the Allow Address Book Changes option get Displays the current setting yes or no Example allowabkchanges get User Interface Screen Location System Info gt Admin Setup gt General Setup page 2 Next Allow Address Book Changes 20 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide allowdialing allowdialing lt yes no get gt Description This command enables or disables the Allow Dialing option yes Allows users to place calls no Disables dialing Your system can only receive calls get Displays the current setting yes or no Example allowdialing get User Interface Screen Location System Info gt Admin Setup gt General Setup Allow Dialing allowmixedcalls Polycom Inc 2003 allowmixedcalls lt yes no get gt Description This command allows the administrator to disable the ability to place or received mixed protocol IP and ISDN multipoint calls for security reaso
145. se from the application programming language of their choice What s New in Release 5 0 ViewStation EX ViewStation FX and VS4000 API Guide The following table lists the major changes for Release 5 0 Type of Command Command system allowmixedcalls new command audioqualityg7221 new command camera near move When you are not in a call All camera near move commands need to be preceded by a button near command display tmon removed display multiwaymode removed displaygraphics new command enablesnapshots new command graphicsmonitorfxvga new command graphicsmonitortv new command graphicsmonitorvisualconcert new command maxgabinternationalcallspeed new command maxgabinternetcallspeed new command sendonlypreferredalias new command sleep new command usepathnavigator new command wake new command V 35 all V 35 commands All V 35 commands can also be used to configure the RS 449 RS 530 and RS 366 serial interfaces www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Accessing the API Interface Using Telnet To start a Telnet session from Windows 1 2 From your computer desktop click Start and Run In the Run window enter the following information in the Open field telnet lt system IP address gt 24 Note Telneting to port 24 keeps the user from seeing all the debug outputs which can be extensive and
146. sideliNe neen eee dh he deg nde 191 PRIS Witch ira di 192 V 35 RS 449 RS 530 RS 366 Commands coocoococconoccccnnccncconcnnnnannnoncnnnonnnnncnnnnn 193 CUS sas cecavtaatevccts ede chectehaet det tcadtavetanlibbiacis a a a tiara 193 O 193 AC A ad e 194 O A Ne ca aa os Nt 195 dsra S Wer eeii eedan a aaae a aana a e e e add aea 195 a a a a A a a ier 196 hSSTaudiomodE ii a 197 ANIME ate oc Pick oo ae Raa e al 198 PA A O 199 hI3IVideofo Mat ocio tiren idad 199 A A stags E E aazeees ea adanes 200 ae a ee he Re a Reece sa ane ne lea 201 AEE aan eibeds dap tilde initial caia anillo tdi 201 Sea a eh tts scatter tet te aa oak 202 vo bbroadCastMode iii liado 203 Vode DU ite on Ae eile Sea aaa ee cera 203 v3odialingprotocol saire EE AE AEA EEE EE N 204 O 204 A O 205 a O 206 A A ten detedadatectinal aaa a a e a 207 A EA AE E E A EE 209 vi www polycom com ViewStation EX ViewStation FX Polycom Inc 2003 and VS4000 API Guide This document describes the CGl based ViewStation EX ViewStation FX and VS4000 API Application Programming Interface This API is a set of commands implemented within the shell The commands are available for advanced users who want to automate some of the control features of the ViewStation EX ViewStation FX and VS4000 systems This API can be used via a Telnet session or via the RS 232 interface It is presumed that users are familiar with Web programming specifically the CGI POST command and its u
147. special_1 special_2 adtran adtran_isu512 ascend ascend_vsx ascend_mb ascend_max avaya_mcu fvc com initia lucent_mcu madge_teleos promptus get view gt Description This command sets a V 35 RS 449 RS 530 RS 366 profile associated with dialing through a DCE It can also display all the settings speed prefix or suffix of the current V 35 RS 449 RS 530 RS 366 profile special_1 special_2 adtran adtran_isu512 ascend ascend_vsx ascend_mb ascend_max avaya_mcul fvc comlinitia lucent_mcu madge_teleos promptus 207 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 get Displays the current profile view Displays all the settings speed prefix or suffix of the current profile Example 1 v35profile adtran_isu512 Selects adtran_isu512 as the profile Example 2 v35profile view Output to Example 2 This example assumes adtran_isu512 as the current profile The first column lists the available speeds for that profile The second column lists the suffixes associated with each speed 56 0 64 2x56 112 2x64 128 168 19 2 224 256 280 320 336 384 392 7x64 504 512 etc BW WI Wd Wd dis isis ui W O O SAN A ADAUOABBWWN ON OO User Interface Screen Location 208 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide Sy
148. splays the current setting isdn ip or none Example secondarycallchoice isdn User Interface Screen Location System Info gt Admin Setup gt Video Network gt Call Preferences Secondary Call Type Choice Polycom Inc 2003 125 ViewStation EX ViewStation FX and VS4000 API Guide sendonlypreferredalias sendonlypreferredalias lt yes no get gt 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 yes Enables the option no Disables the option get Displays the current setting yes or no Example sendonlypreferredalias User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Address gt Preferences Preferred Alias E 164 Select this field to access the Preferred Alias screen gt Send Only Preferred Alias serialnum serialnum Description This command displays the serial number of the system Example serialnum Output 00EA79 126 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt Software Hardware gt Software System Serial Number setaccountnumber setaccountnumber lt account number gt Description This command sets the account number that is required for dialing out The account number is saved in the GMS database and i
149. stem Info gt Admin Setup gt Video Network gt Video Network gt Advanced Dialing This screen is only accessible if you have a V 35 RS 449 RS 530 RS 366 network interface connected to your system v35suffix v35suffix lt set get gt lt valid speed gt value v35suffix set lt valid speed gt value v35suffix set lt valid speed gt v35suffix get lt valid speed gt Description This command sets the V 35 RS 449 RS 530 RS 366 dialing suffix It assumes that a profile has already been selected see the command v35profile set lt valid speed gt Sets the V 35 RS 449 RS 530 RS 366 suffix when followed by a value parameter If you want to erase the current setting omit the parameter valid speedValid speeds are 56 64 2x56 112 2x64 128 168 192 224 256 280 320 336 384 392 7x64 504 512 560 576 616 640 672 704 728 768 784 832 840 14x64 952 960 1008 1024 1064 1088 1120 1152 1176 1216 1232 1280 1288 21x64 1400 1408 1456 1472 1512 1536 1568 1600 1624 1664 1680 1728 28x64 1856 1920 all The parameter all lists all the available speeds and their associated dialing prefixes value 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 get lt valid speed gt Displays the current setting for valid speed Note The ViewStation EX system supports speeds up to 768 Kbps O
150. swer mode yes Enables Mute Auto Answer Calls mode The microphone will be muted when the system receives a call while in Auto Answer mode no Disables Mute Auto Answer Calls mode The microphone will not be muted when the system receives a call while in Auto Answer mode get Displays the current setting yes or no Example muteautoanswercalls yes User Interface Screen Location System Info gt User Setup Mute Auto Answer Calls nearloop nearloop lt on off gt Description This command turns the Near End Loop on or off When itis on you can test the encoder decoder on your system This can help you diagnose a problem with an ISDN H 320 video call If you perform a near end loop test during a call the far site sees a loop of itself on Turns the Near End Loop on It provides a complete internal test of the system Polycom Inc 2003 107 ViewStation EX ViewStation FX and VS4000 API Guide off Disables the Near End Loop Example nearloop on User Interface Screen Location System Info gt Diagnostics gt Near End Loop netmeetingip netmeetingip lt set get gt 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 set Sets the NetMeeting IP address when followed by the xxx xxXx xxx xxx parameter If you want to erase t
151. t 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 This allows your system to display your computer desktop on your system s VGA monitor on Enables Visual Concert as the graphics monitor The command graphicsmonitorfvisualconcert on is similar to graphicsmonitor visualconcert off Disables Visual Concert as the graphics monitor get Displays the current setting on or off Example graphicsmonitorvisualconcert on User Interface Screen Location System Info gt Admin Setup gt Video Camera gt Monitors gt Graphics Monitor Visual Concert VGA 82 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide h323name h323name lt set get gt H 323name h323name set H 323name h323name set h323name get Description This command sets the H 323 name set Sets the H 323 name when followed by the H 323name parameter If you want to erase the current setting omit the parameter get Displays the current setting for this option H 323name Character string specifying the H 323 name Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example h323name set My System User Interface Screen Location System Info gt Admin Setup gt LAN H 323 g
152. t Conference on Demand Conference on Demand allows users to bring multiple endpoints together in a videoconference on an unscheduled basis It allows users to place multipoint video calls to remote participants by only using their names and or numbers that correspond to those remote locations always Always use PathNavigator to place a multipoint call Never use the external MCU never Never use PathNavigator to place a multipoint call Use the external MCU instead required This is the default When this option is selected if the multipoint call is within the MCU capabilities it is handled by the MCU otherwise beyond the MCU capabilities it is handled through the PathNavigator MGC get Displays the current setting always never or required Note 1 This option is only accessible if PathNavigator is used Note 2 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 Example usepathnavigator required 160 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt H 323 gt Gatekeeper Dial Multipoint Calls from PathNavigator Polycom Inc 2003 161 ViewStation EX ViewStation FX and VS4000 API Guide validateacctnum validateacctnum lt yes no get gt Description
153. t H 323 gt Setup H 323 name when calling this system Polycom Inc 2003 83 ViewStation EX ViewStation FX and VS4000 API Guide hangup hangup lt phone video gt hangup phone hangup video 1 3 hangup video Description This command hangs up a telephone or video call phone Hangs up the current audio call video Hangs up the current video call if no parameter from the range 1 3 is specified A specified parameter selects which call to hang up 1 3 The optional parameter selects which call to hang up Example 1 hangup phone Example 2 hangup video 2 help help lt all help verbose terse string syntax gt help Description This command displays simple or detailed list of commands when used with the parameters all help string or syntax It can also switch help display mode when used with the parameters verbose or terse Help without parameters displays the list of command names only 84 www polycom com Polycom Inc 2003 ViewStation EX ViewStation FX and VS4000 API Guide all Displays detailed help for all commands help Describes the various types of help described in this section verbose Sets verbose mode shows syntax and help for commands terse Sets terse mode shows only help for commands without syntax string Displays detailed help for commands containing string syntax Displays the help syntax summary Note Use quotation marks around a com
154. t a number from this range to specify a remote site call for which you want to obtain advanced network statistics 18 www polycom com Polycom Inc 2003 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 tap1 66 rap1 0 taj 46mS raj 40mS tvp1 122 rvpl 0 tv3 21mS rvj 60mS dec rsid Polycom_VS4000_5 0 where tar Transmit audio rate rar Receive audio rate tvr Transmit video rate rvr Receive video rate tvru Transmit video rate used rvru Receive video rate used tvfr Transmit video frame rate rvfr Receive video frame rate v e Video FEC errors tapl Transmit audio packet loss H 323 calls only tlsdp Transmit LSD protocol H 320 calls only rapl Receive audio packet loss H 323 calls only rlsdp Receive LSD protocol H 320 calls only taj Transmit audio jitter h 323 calls only tlsdr Transmit LSD rate H 320 calls only raj Receive audio jitter H 323 calls only rlsdp Receive LSD rate H 320 calls only tvpl 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 Transmit video jitter H 323 calls only 19 ViewStation EX ViewStation FX and VS4000 API Guide tmlpr Transmit MLP rate H 320 calls only rvj Receive video jitter H 323 call
155. t phone number information tech support digits Numeric string specifying the tech support phone number Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gmstechsupport set 123 456 7890 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Info 1 Tech Support 78 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide gmsurl O Polycom Inc 2003 gmsurl lt set get gt lt 1 10 gt XXX XXX XXX XXX gmsurl set lt 1 10 gt XXX XXX XXX XXX gmsurl set lt 1 10 gt gmsurl get lt 1 10 gt 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 In some instances you may add GMS URLs manually This information is provided by your network manager set lt 1 10 gt Sets the URL of the GMS server when followed by the XXx xXXX XXX Xxx parameter If you want to erase the current setting omit the parameter get Displays the current URL information for a selected server A server from the range lt 1 10 gt must be specified 1 10 GMS server order number 1 is reserved for the primary GMS server that performs account validation XXX XXX XXxX XxXXIP address of the URL server pwx vs_status asp is automatically appended after the IP
156. t setting prinumberingplan isdn User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI network gt PRI Setup gt Advanced PRI Setup This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system 190 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide prioutsideline prioutsideline lt set get gt 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 set Sets the outside line access PRI number when followed by the parameter outside_line If you want to erase the current setting omit the parameter get Displays the current setting outside_lineNumeric string This number is provided by your network service provider Example prioutsideline set 9 User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt Numbers This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system O Polycom Inc 2003 191 ViewStation EX ViewStation FX and VS4000 API Guide priswitch priswitch lt set get gt lt att5ess att4ess norteldms ni2 net5 ctr4 gt priswitch set lt att5ess att4ess norteldms ni2 net5 ctr4 gt priswitch get Descrip
157. te Name Display gabk batch gabk batch lt 0 59 gt Description This command displays Global Address Book entries in batches 0 59 Range of batches A selected batch number displays Global Address Book entries The size of the batches is determined by the GAB server Example gabk batch 9 gabpassword Polycom Inc 2003 gabpassword lt set get gt password gabpassword set password gabpassword set gabpassword get Description This command sets the Global Address Book GAB password set Sets the GAB password when followed by the parameter password If you want to erase the current setting omit password get Displays the current GAB password 59 ViewStation EX ViewStation FX and VS4000 API Guide password Password used to access the GAB server Valid characters are a through z lower and uppercase _ 3 gooey 0 through 9 Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gabpassword set gabPass User Interface Screen Location System Info gt User Setup gt LAN H 323 gt Global Address gt Server Server Password gabserverip gabserverip lt set get gt XXX XXX XXX XXX gabserverip set XXX XXX XXX XXX gabserverip set gabserverip get Description This command sets the IP address of the Global Address Book GAB server set Sets the GAB server IP address when
158. tion 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 NET5 CTR4 is the default It is the standard ETSI protocol derived from ITU Q 931 If you change the country settings a new set of PRI switch protocols is loaded set Sets the PRI switch A parameter from lt att5ess att4ess norteldms ni2 net5 ctr4 gt is required get Displays the current switch protocol att5ess att4ess norteldms ni2 net5 ctr4 Switch protocols For E1 NET5 CTR4 is the default NET5 CTR4 is the standard ETSI protocol derived from ITU Q 931 For T1 NET5 CTR4 is also provided for certain Asian countries such as Japan Hong Kong and Taiwan Example priswitch set norteldms User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI Network gt PRI Setup Switch Protocol This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system 192 www polycom com 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 cts lt normal inverted get gt Description This command lets you configure the cts serial interface control signal clear to send The default setting for this signal is normal normal Sets the signal to
159. tmeeting or t120 Example dataconferencetype netmeeting User Interface Screen Location System Info gt Admin Setup gt Data Conference Polycom Inc 2003 4 ViewStation EX ViewStation FX and VS4000 API Guide daylightsavings daylightsavings lt yes no get gt Description This command sets the Global Management System daylight savings time yes Enables daylight savings time no Disables daylight savings time get Displays the status of this option yes or no Example daylightsavings yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt Global Management gt Setup Daylight Savings Time defaultgateway defaultgateway lt set get gt xxx xxx XXX XXX defaultgateway set XXX XXX XXX XXX defaultgateway set defaultgateway get Description This command sets the default gateway This setting can only be changed if DHCP is turned off The system has to be restarted for the change to take effect The user is prompted to restart the system set Sets the default gateway when followed by the XXX XXX XXX XXX parameter If you want to erase 42 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide the current setting omit the XXX XXX XXX XXX parameter get Displays the default gateway IP address XXX XXX XXX XXX Default gateway IP address Example defaultgateway set 192 168 1 5 User Interface Screen Location System Info gt
160. u have a Quad BRI network interface connected to your system 179 ViewStation EX ViewStation FX and VS4000 API Guide ISDN PRI Commands The following commands are specific to the ISDN PRI network interface priareacode priareacode lt set get gt area code priareacode set area code priareacode set priareacode get Description This command sets the PRI area code set Sets the PRI area code when followed by the area code parameter If you want to erase the current setting omit area code get Displays the current setting area code Numeric string specifying the area code Example priareacode set 512 User Interface Screen Location System Info gt User Setup gt Video Network gt IMUX gt Numbers This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system 180 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide pricallbycall Polycom Inc 2003 pricallbycall lt set get gt 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 For example specify a value of 6 fora T1 PRI network interface module that is directly connected to an ATT 5ESS switch which is provisioned with Accunet You must consult with the tel
161. un startcall bat screen screen lt addressbook farvideo main nearvideo sysinfo speeddial disableui enableui chaircontrol sleep wake gt Description This command causes a specified screen to be the current screen on the system addressbook Goes to the Address Book screen farvideo Goes to the far site video screen when in a call main Goes to the main user interface screen nearvideo Goes to the near site video screen sysinfo Goes to the System Information screen 124 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide speeddial Goes to the Speed Dial screen disableui Turns off the user interface enableui Turns on the user interface chaircontrol Goes to the main Chair Control screen sleep Causes the system to go into sleep mode wake Wakes up the system from sleep mode Example screen sysinfo secondarycallchoice secondarycallchoice lt isdn ip none get gt 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 Address Book It is automatically reset to none if the setting matches that of the Primary Call Type Choice see the command primarycallchoice on page 117 isdn Selects ISDN as the Secondary Call Type Choice ip Selects IP as the Secondary Call Type Choice none No call type is selected get Di
162. uotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example t120nameip set t120Box User Interface Screen Location System Info gt Admin Setup gt Data Conference second icon O Polycom Inc 2003 147 ViewStation EX ViewStation FX and VS4000 API Guide tcpports tcpports lt set get gt 1024 49150 tcpports set 1024 49150 tcpports set tcpports get Description This command sets the TCP ports for Quality of Service on your system set Sets the TCP ports when followed by a value from the range 1024 49150 If you want to erase the current setting omit the value get Displays the current TCP port setting 1024 49150Range of available TCP ports Example tcpports set 3233 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt Firewall LAN Connection Use Fixed Ports gt TCP Ports techsupport techsupport lt phone num gt Description This command sends your phone number to GMS technical support if your system is managed by GMS Global Management System 148 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide phone numPhone number at which the user wants to be contacted In order to obtain rapid assistance include the area code with your phone number Note Use quotation marks around a compound name or strings containing spaces Ex united states
163. ure DNS servers up to 4 DNS servers can be configured After a change is made the system prompts the user for restart Note This option can only be set when DHCP is off set lt 1 4 gt Sets a DNS server when followed by the parameter XXX XXX XXX XXX If you want to erase the current setting omit the parameter get lt 1 4 gt Displays the current IP address of the specified server 1 4 1 4 Range of selectable servers XXXx xxx xxx xxxServer IP address Examples dns set 1 192 168 1 111 dns get 4 User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt LAN Intranet gt LAN amp Intranet DNS Servers dynamicbandwidth O Polycom Inc 2003 dynamicbandwidth lt yes no get gt Description This command is used to specify use of dynamic bandwidth allocation for Quality of Service The systems dynamic bandwidth function automatically finds the optimum line speed for a call If you experience excessive packet loss while in a call the dynamic bandwidth function decrements the line speed until there is no packet loss This is supported in calls with endpoints that also support dynamic bandwidth yes Enables the option 53 ViewStation EX ViewStation FX and VS4000 API Guide no Disables the option get Displays the current setting on or off Example dynamicbandwidth yes User Interface Screen Location System Info gt Admin Setup gt LAN H 323 gt QOS Dynamic Bandwidth
164. us for next message sent 10 received 0 lost 10 delayed 0 corrupt 0 waiting 100000us for next message sent 20 received 0 lost 20 delayed 0 corrupt 0 154 www polycom com 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 testlan waiting 100000us for next message testlan sent 60 received 0 lost 60 delayed 0 corrupt 0 testlan waiting 100000us for next message testlan sent 70 received 0 lost 70 delayed 0 corrupt 0 testlan waiting 100000us for next message testlan sent 80 received 0 lost 80 delayed 0 corrupt 0 testlan waiting 100000us for next message testlan sent 90 received 0 lost 90 delayed 0 corrupt 0 testlan waiting 100000us for next message testlan sent 100 received 0 lost 100 delayed 0 corrupt 0 testlan ping O Polycom Inc 2003 testlan ping lt ip_addr gt count testlan ping lt ip_addr gt Description This command pings the IP address of a device to check if it can be reached This command is similar to the command ping on page 114 ip_addr IP address of the device count Optional parameter defining the number of times the devic
165. used with a T1 interface This is the only choice for T1 This value actually chooses both a framing format and an encoding method Legacy frame formats such as D4 are not supported In addition older encoding methods such as B7ZS are not supported crc4 hdb3 A method of signal encoding used with an E1 interface This is the default value Data is encoded using HDB3 to ensure proper one density and CRC4 error checking is enabled on both transmit and receive hdb3 A method of signal encoding used with an E1 interface CRC4 error checking is disabled Example prilinesignal set esf b8zs User Interface Screen Location System Info gt Admin Setup gt Video Network gt IMUX gt PRI Network gt PRI Setup Line Signaling This screen is only accessible if you have a PRI network interface connected to your ViewStation FX or VS4000 system 188 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide prinumber prinumber lt set get gt pri number prinumber set pri number prinumber set prinumber get Description This command sets the PRI video number set Sets the PRI video number when followed by the parameter pri number If you want to erase the current setting omit the parameter get Displays the current setting pri number Numeric string This number is provided by your network service provider Example prinumber set 5551212 User Interface Screen Location System Info gt Admin S
166. ut Always On option When this option is enabled the system can operate with two VCRs one for recording and one for play This also allows the use of the VCR audio out for room audio applications where the near site and the far site audio are required with any video input selected Note If you connect the same device to both the VCR input and VCR output you may need to disable this feature to prevent an audio feedback loop yes Enables the option no Disables the option get Displays the current setting yes or no Example vcraudioout yes User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt VCR VCR Audio Out Always On 163 ViewStation EX ViewStation FX and VS4000 API Guide vcrrecordsource vcrrecordsource lt auto near far get gt Description This command sets the VCR record source auto Enables the VCR to automatically record the current speaker in a point to point call near Enables the VCR to record the near site presentation far Enables the VCR to record the far site presentation get Displays the current setting auto near or far Example verrecordsource auto User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt VCR VCR Record Source version version Description This command displays the current system s version information Example version Output to Example version Release 5 0 FX 14 Mar 2003 164 ww
167. w polycom com ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info Software Version vgahorizpos vgahorizpos lt left right get gt Description This command is used to calibrate the VGA input in the horizontal position left Sets the calibration frame to the left right Sets the calibration frame to the right get Displays the current setting left or right Example vgahorizpos right User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt VGA Input Horizontal Position This screen is only visible if a Visual Concert FX unit is connected to your system vgaoffmode Polycom Inc 2003 vgaoffmode lt black nosignal get gt Description This command sets the system s VGA off mode black Causes the screen to turn black when there is no graphics or video nosignal Causes the VGA monitor to behave as if it were not connected 165 ViewStation EX ViewStation FX and VS4000 API Guide get Displays the current setting black or nosignal Example vgaoffmode nosignal User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt Monitors gt Graphics Monitor gt FX VGA gt Setup VGA Output with No Graphics vgaphase vgaphase lt increase decrease get gt Description This command is used to calibrate the VGA input phase increase Increases the phase decrease Decreases the phase
168. wer outlets The socket outlet to which this apparatus is connected must be installed near the equipment and must always be readily accessible e Keep ventilation openings free of any obstructions SAVE THESE INSTRUCTIONS License Restrictions THE SOFTWARE PROGRAMS CONTAINED OR DESCRIBED HEREIN ARE CONFIDENTIAL INFORMATION AND PROPRIETARY PRODUCTS OF POLYCOM OR ITS LICENSORS Buyer shall not sublicense or otherwise distribute any of the Subject Programs except to End Users and or resellers who have entered into a Sublicense Agreement For purposes of this Agreement a Sublicense Agreement shall mean a written license agreement between the Buyer and its purchaser or in the case of any sale by Buyer to a reseller between such reseller and the End User that is either 1 signed by the End User or 2 included with the Documentation in such a manner that the End User reasonably indicates its acceptance of the Sublicense Agreement by turning on and using the Computer Equipment Polycom shall include so called break the seal software licenses with the Documentation and Buyer shall not remove or alter any such Sublicense Agreements or any notifications or warning stickers relating thereto Buyer shall not waive amend or otherwise modify any 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
169. whereas after coding and compression the digitized signal requires a bandwidth of 16 Kbps CCITT now called ITU T which is International Telecommunications Union s Telecommunications Standardization Sector Recommendation entitled Pulse Code Modulation PCM of Voice Frequencies G 711 defines how a 3 1 kHz audio signal is encoded at 64 Kbps using PCM and either mu law US and Japan or A law Europe Same as g711u but uses A law Europe CCITT Recommendation that defines how a 7 5 kHz audio signal is encoded at a data rate of 64 Kbps CCITT Recommendation that defines how a 7 5 kHz audio signal is encoded at a data rate of 64 Kbps Turns the audio mode off Displays the current setting for this option h33laudiomode g728 Polycom Inc 2003 197 ViewStation EX ViewStation FX and VS4000 API Guide User Interface Screen Location System Info gt Admin Setup gt Video Network gt Video Network gt 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 h331iframerate lt 30 15 10 7 5 get gt Description This command sets the H 331 video frame rate for the broadcast transmission Broadcast configuration parameters should be set to accommodate the lowest common denominator of the systems which are receiving the broadcast 30 Sets the frame rate at 30 fps 15 Sets the frame rate at 15 fp
170. wn get Displays the current setting up or down Example vgavertpos down User Interface Screen Location System Info gt Admin Setup gt Video Cameras gt VGA Input Vertical Position This screen is only visible if a Visual Concert FX unit is connected to your system volume volume lt set Jup down get register unregister gt volume set lt 0 24 gt Description This command is used to change the audio volume not sound effects on the system set Sets the volume to a specified level Requires a parameter from 0 24 up Increases the audio volume by 1 down Decreases the audio volume by 1 get Displays the current volume level register Registers the system to give notification when the volume level changes unregister Disables register mode 0 24 Range of volume levels Example volume set 10 168 www polycom com 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 lt callcomplete systemready receivingcall gt 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 This command causes the API shell to wait until a call being placed either connects or fails This command can be used to synchronize a remote controlle
171. xt set gatewayext get Description This command sets the gateway extension number You need to restart the system for changes to take effect set Sets the gateway extension number when followed by the gateway extension parameter If you want to erase the current setting omit gateway extension get Displays the current setting gateway extension Numeric string specifying the gateway extension Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gatewayext set 59715 User Interface Screen Location System Info gt User Setup gt LAN H 323 gt H 323 gt Gateway Gateway Number gt Extension 64 www polycom com ViewStation EX ViewStation FX and VS4000 API Guide gatewaynumber gatewaynumber lt set get gt number gatewaynumber set number gatewaynumber set gatewaynumber get Description This command sets the gateway number set Sets the gateway number when followed by the number parameter If you want to erase the current setting omit number get Displays the current setting number Numeric string specifying the gateway number Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Example gatewaynumber set 5555454 User Interface Screen Location System Info gt User Setup gt LAN H 323 gt H 323 gt Gateway Gateway Number gt Number Polyc
172. ys records 0 through 9 abk range 2 8 Displays Address Book entries 2 through 8 adminpassword Polycom Inc 2003 adminpassword lt set get gt password adminpassword set password adminpassword set adminpassword get Description This command is used to set the administrator password ViewStation EX ViewStation FX and VS4000 API Guide Note This command cannot be accessed through the RS 232 port set Sets the password used for remote management of the system if followed by the password parameter If you want to erase the current setting omit the password parameter The system must have an admin password set before this command works get Displays the current admin password password Valid characters are a through z lower and uppercase _ O through 9 The length is limited to 10 characters Note Use quotation marks around a compound name or strings containing spaces Ex united states or 111 222 333 Examples adminpassword set MyFXpsswd adminpassword set EX 2003 User Interface Screen Location System Info gt Admin Setup gt Security Admin Password advnetstats advnetstats 0 2 advnetstats Description This command is used to get advanced network statistics for each call 0 2 Range of selectable calls in a multipoint call maximum number of concurrent calls 3 where 0 is call 1 1 is call 2 and 2 is call 3 Selec

Download Pdf Manuals

Related Search

Related Contents

Steam Station Plus Article 320170 Nederlands 1 English 7 Français  Samsung SGH-X460 Felhasználói kézikönyv    rendamax r600  Ford 2010 Explorer Automobile User Manual  SH7410 E8000 Emulator HS7410EDD82H User`s Manual  W.MACHINE/WASHER-DRYER 31000831 SE234  （仮称）大磯町リサイクルセンター整備及び運営事業 要求水準書（案  

Copyright © All rights reserved. Failed to retrieve file