Summary of the content on the page No. 1
®
ViewStation EX, ViewStation
FX, and VS4000 API Guide
VS4000 User’s Guide
April 2003 Edition
Release 5.0
1725-10656-004
Summary of the content on the page No. 2
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 NT® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Intel®, Pentium®, and Celeron® ar
Summary of the content on the page No. 3
Contents Contents........................................................................................................... i What’s New in Release 5.0?............................................................................ 2 Accessing the API Interface............................................................................. 3 Using Telnet........................................................................................ 3 Using the RS-232 Interface................................
Summary of the content on the page No. 4
ViewStation EX, ViewStation FX, and VS4000 API Guide callstate ............................................................................................... 31 camera ................................................................................................ 32 camera1ptz.......................................................................................... 35 camera4ptz.......................................................................................... 36 cameradirection........
Summary of the content on the page No. 5
ViewStation EX, ViewStation FX, and VS4000 API Guide gatewayprefix...................................................................................... 67 gatewaysetup...................................................................................... 68 gatewaysuffix ...................................................................................... 69 gendial................................................................................................. 70 generatetone..................
Summary of the content on the page No. 6
ViewStation EX, ViewStation FX, and VS4000 API Guide nearloop .............................................................................................. 107 netmeetingip........................................................................................ 108 netstats................................................................................................ 109 numdigitsdid ........................................................................................ 110 numdigitsext ......
Summary of the content on the page No. 7
ViewStation EX, ViewStation FX, and VS4000 API Guide streammulticastip ................................................................................ 140 streamrestoredefaults ......................................................................... 141 streamrouterhops................................................................................ 142 streamspeed ....................................................................................... 143 streamvideoport .......................
Summary of the content on the page No. 8
ViewStation EX, ViewStation FX, and VS4000 API Guide ISDN BRI Commands ...................................................................................... 174 isdnareacode....................................................................................... 174 isdncountrycode .................................................................................. 175 isdndialingprefix................................................................................... 176 isdndialspeed ............
Summary of the content on the page No. 9
ViewStation EX, ViewStation FX, and VS4000 API Guide This document describes the CGI-based ViewStation EX, ViewStation FX, and VS4000 API (Application Programming Interface). This API is a set of commands implemented within the shell. The commands are available for advanced users who want to automate some of the control features of the ViewStation EX, ViewStation FX, and VS4000 systems. This API can be used via a Telnet session or via the RS-232 interface. It is presumed that users are f
Summary of the content on the page No. 10
ViewStation EX, ViewStation FX, and VS4000 API Guide What’s New in Release 5.0? The following table lists the major changes for Release 5.0. Type of Command Change 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 co
Summary of the content on the page No. 11
ViewStation EX, ViewStation FX, and VS4000 API Guide Accessing the API Interface Using Telnet To start a Telnet session from Windows: 1. From your computer desktop, click Start and Run. 2. In the Run window, enter the following information in the Open field: telnet 24 Note Telneting to port 24 keeps the user from seeing all the debug outputs which can be extensive and inconvenient. 3. Click OK. The Telnet window appears, and a welcome message is displayed (Ex: ''Hi, My
Summary of the content on the page No. 12
ViewStation EX, ViewStation FX, and VS4000 API Guide 1. Locate the RS-232 serial cable (DB9-to-DB9 straight through). 2. Connect one end of the cable to the serial port of your PC. 3. Connect the other end to the RS-232 serial port on the back panel of the VS4000 system. ViewStation EX and ViewStation FX Connect your PC to the ViewStation EX or FX system as follows: 1. Locate the RS-232 serial cable (DB9-to-8-pin mini-DIN). 2. Connect the 9-pin DB-9 connector to the serial port of your P
Summary of the content on the page No. 13
ViewStation EX, ViewStation FX, and VS4000 API Guide RS-232 Interface Information The following provides additional information about the ViewStation EX, ViewStation FX, and VS4000 systems’ RS-232 interface. RS-232 User Interface Screen The RS-232 user interface screen is used to set the baud rate and the modes for the serial port on the back of the system. To access the RS-232 screen on your system, select System Info>Admin Setup>Software/Hardware> RS-232. On the RS-232 screen, you can c
Summary of the content on the page No. 14
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
Summary of the content on the page No. 15
ViewStation EX, ViewStation FX, and VS4000 API Guide control the far site system, using the far site’s Command Line Interface. The following table summarizes the port operation based on the RS-232 mode configured by each endpoint. Near-Side Mode 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
Summary of the content on the page No. 16
ViewStation EX, ViewStation FX, and VS4000 API Guide RS-232 Serial Cable Pinout and Connections (ViewStation EX and FX) The RS-232 serial cable has a 9-pin DB-9 connector on one end and an 8-pin mini-DIN connector on the other end. It is used to connect the ViewStation EX or ViewStation FX to a terminal or another communications device. Pin Number 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 R
Summary of the content on the page No. 17
ViewStation EX, ViewStation FX, and VS4000 API Guide RS-232 Serial Cable Pinout and Connections (VS4000) The RS-232 serial cable has a 9-pin DB-9 connector on both ends. It is used to connect the VS4000 to a terminal or another communications device. Pin Number 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
Summary of the content on the page No. 18
ViewStation EX, ViewStation FX, and VS4000 API Guide Status Display The call status can be displayed in a number of ways. The display call status command shows table of current calls. Using the “listen” or “dial” Command To display real-time status on individual B channels (incoming/outgoing calls), either register the terminal session with the listen command or start an outbound call with the dial command. These two commands will cause the system to re-direct the B channel status messag
Summary of the content on the page No. 19
ViewStation EX, ViewStation FX, and VS4000 API Guide cs: call[0] chan[0] dialstr[95551212] state[BONDING] cs: call[0] chan[0] dialstr[95551212] state[COMPLETE] cs: call[0] chan[1] dialstr[95551212] state[RINGING] cs: call[0] chan[1] dialstr[95551212] state[CONNECTED] cs: call[0] chan[2] dialstr[95551212] state[RINGING] cs: call[0] chan[3] dialstr[95551212] state[RINGING] cs: call[0] chan[2] dialstr[95551212] state[CONNECTED] cs: call[0] chan[3] dialstr[95551212] state[CONNECTED] cs: call[0] c
Summary of the content on the page No. 20
ViewStation EX, ViewStation FX, and VS4000 API Guide -> ->listen video ringing // there is an incoming call, auto answer is on ->cs: call[0] chan[0] dialstr[8005551212] state[RINGING] cs: call[0] chan[0] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[0] dialstr[8005551212] state[BONDING] cs: call[0] chan[0] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[1] dialstr[8005551212] state[RINGING] cs: call[0] chan[1] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[2] dialstr[8005
