Page 1 product pic here Integrator’s Reference Manual for the VSX Series Version 8.5 May 2006 Edition 3725-21905-004/A VSX Version 8.5...
Page 2: Trademark Information
As between the parties, Polycom, Inc. retains title to, and ownership of, all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision.
Page 3: Table Of Contents
Connecting Polycom Cameras ........
Page 4 Integrator’s Reference Manual for the VSX Series Audio Cables ............2-23 Serial (RS-232) Cables .
Page 5 Contents allowusersetup ............4-20 answer .
Page 6 Integrator’s Reference Manual for the VSX Series displayglobaladdresses ..........4-73 displaygraphics .
Page 7 Contents gmscountry ............4-119 gmsstate .
Page 8 Integrator’s Reference Manual for the VSX Series monitor1 (deprecated) ..........4-165 monitor1screensaverouput .
Page 9 Contents registerthissystem ........... . 4-215 remotecontrol .
Page 10 Integrator’s Reference Manual for the VSX Series techsupport ............4-262 teleareacode .
Page 11 Interior Design and Finishes ..........A-5 Furniture .
Page 12 B Channel Status Message Example ........E-1 F IR Codes for Non-Polycom Remotes ....F-1...
Page 13: Room Integration
Room Layout Examples Use the following diagrams as examples for setting up a conference room with VSX™ systems. Polycom® recommends that you contract an experienced contractor to assure all the components operate as a single cohesive system. Small Conference Room...
Page 14 Integrator’s Reference Manual for the VSX Series Large Conference Room Acoustic Panels 1 - 2 SoundStation VTX 1000 Document Camera VSX Component System and PowerCam Plus Flat Panel Flat Panel Monitor 1 Monitor 2 Network Outlets Media Center Power Outlets...
Page 15 Classroom Teacher’s Podium Touch Panel Computer Document Camera Monitor 1 VSX Component System with Monitor for PowerCam Plus VGA Out and Vortex Table-Top Microphones Room Integration Monitor 2 on Media Cart Camera 2 1 - 3...
Page 16: Integrating Video
You can connect the VSX 8000 and VSX 7000e systems to either a PowerCam™ or PowerCam Plus camera from Polycom, or to other supported cameras. You must use a PowerCam Plus as the main camera, not as a secondary camera.
Page 17 In addition to their integrated main camera, VSX 7000 and VSX 7000s systems provide an S-Video input for a second camera. You can use the RS-232 serial port on the VSX 7000 or VSX 7000s system for camera control. Refer to the release notes for a list of supported PTZ cameras.
Page 18 Integrator’s Reference Manual for the VSX Series You can connect a PowerCam (part number 2215-50370-001) to a VSX 7000e as the main camera up to 10 ft away using: • PowerCam as the Main Camera More Than 10 ft Away The following extension kits are available, which include the power supply, PowerCam Break-Out cable, PowerCam/VISCA Control cable, and S-Video cable:...
Page 19 You can connect a PowerCam (part number 2215-50370-001) to a VSX 8000 as the main camera for distances more than 10 ft away using: • PowerCam Break-Out cable shown on page PowerCam/VISCA Control cable shown on page • • S-Video cable on page •...
Page 20 Integrator’s Reference Manual for the VSX Series You can connect a PowerCam (part number 2215-50370-001) to a VSX 7000e as the main camera for distances more than 10 ft away using: • • • • 1 - 8 PowerCam Break-Out cable shown on page PowerCam/VISCA Control cable shown on page S-Video cable on page Power Supply (part number 1465-52621-036)
Page 21 PowerCam as the Secondary Camera The following kits are available, which include the power supply, PowerCam Break-Out cable, PowerCam/VISCA Control cable, and S-Video cable: • 7230-22231-001 (50 ft) • 7230-22232-001 (100 ft) You can connect a PowerCam (part number 2215-50370-001) to a VSX 8000 as the secondary camera using: •...
Page 22 Integrator’s Reference Manual for the VSX Series You can connect a PowerCam (part number 2215-50370-001) to a VSX 7000e as the secondary camera using: • • • • 1 - 10 PowerCam Break-Out cable shown on page PowerCam/VISCA Control cable shown on page S-Video cable on page Power Supply (part number 1465-52621-036) IOIOIO...
Page 23 You can connect a PowerCam (part number 2215-50370-001) to a VSX 7000 as the secondary camera using: • PowerCam Break-Out cable shown on page PowerCam/VISCA Control cable shown on page • • S-Video cable on page • Power Supply (part number 1465-52621-036) 0101 2-17 2-21...
Page 24 Integrator’s Reference Manual for the VSX Series You can connect a PowerCam (part number 2215-50370-001) to a VSX 7000s as the secondary camera using: • • • • 1 - 12 PowerCam Break-Out cable shown on page PowerCam/VISCA Control cable shown on page S-Video cable on page Power Supply (part number 1465-52621-036) 0101...
Page 25 PowerCam Plus as the Main Camera up to 10’ Away You can connect a PowerCam Plus (part number 2215-50200-001) to a VSX 8000 as the main camera up to 10 ft away using: • PowerCam Plus Primary cable shown on page •...
Page 26 Integrator’s Reference Manual for the VSX Series PowerCam Plus as the Main Camera More Than 10’ Away You can connect a PowerCam Plus (part number 2215-50200-001) to a VSX 8000 as the main camera for distances more than 10 ft away using: •...
Page 27: Connecting Other Video Cameras
Connecting Other Video Cameras Refer to the release notes for a list of supported Pan/Tilt/Zoom (PTZ) cameras. To connect a PTZ camera to a VSX 8000 system as the main camera: You can connect a PTZ camera to a VSX 8000 using: •...
Page 28 Integrator’s Reference Manual for the VSX Series To connect a PTZ camera to a VSX 8000 system as the secondary camera: You can connect a PTZ camera to a VSX 8000 as the secondary camera using: • • To connect a PTZ camera to a VSX 7000e system as the secondary camera: You can connect a PTZ camera to a VSX 7000e as the secondary camera using: •...
Page 29 To connect a PTZ camera to a VSX 7000s system as the secondary camera: You can connect a PTZ camera to a VSX 7000s as the secondary camera using: PowerCam/VISCA Control cable shown on page • S-Video cable on page •...
Page 30: Integrating Audio
SoundStation VTX 1000® conference phone, refer to the Vortex application notes available at www.polycom.com/voicedocumentation. Polycom strongly recommends using Polycom InstantDesigner™ to get started with your Polycom Vortex mixer integration. InstantDesigner resolves many common issues with connections and configuration settings.
Page 31: Connecting A Vsx 7000E To A Vortex Mixer And Soundstation Vtx 1000
Connecting a VSX 7000e to a Vortex Mixer and SoundStation VTX 1000 Connect the VSX 7000e to the Vortex mixer using: • • • Vortex cables shown on page 2-28 Serial cable shown on page 2-34 VSX to VTX cable shown on page IOIOIO VCR/DVD IOIOIO...
Page 32: Together
VSX system matches that of the Vortex. appropriate AEC reference signal if the VSX system will be used in Mono mode (Standard AEC Operation). If using Polycom InstantDesigner to create the configuration settings for the Vortex, the reference will be set...
Page 33: Cables
Orange RJ-45 connectors on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 34: Isdn Cable
Clear RJ-45 connectors on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 35: Analog Telephone (Pots) Cable
Pink RJ-11 connectors on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 36: V.35/Rs-449/Rs-530 Adapter
68-pin to 44-pin Peripheral Link V.35 HD-68 Pinout Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 37: V.35 Cable
Description HD-44 M connectors on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 38: V.35 And Rs-366 Serial Cable
HD-44 M to “Y” Winchester 34M/RS-366 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 39: Rs-449 And Rs-366 Serial Cable
HD-44 M to “Y” RS-449 DB-37M/RS-366 DB-25M Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 40: Rs-530 With Rs-366 Serial Cable
#For RS530, connect pins 1 and 3 of 68 pin connector to ground ** Gnd pins are 2,4, 35-60 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom.
Page 41: Video And Camera Cables
S-Video adapter on page 2-11) Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 42: Bnc To S-Video Cable
Description 4-pin male mini-DIN to dual BNC Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 43: Bnc To S-Video Adapter
Dual BNC to 4-pin female mini-DIN Dimensions are in millimeters Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 44: Vcr/Dvd Composite Cable
Triple RCA connectors on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 45: Vga Cable
HD-15 high-density subminiature connectors on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 46: Composite Video Cable
Single yellow RCA connector on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 47: Powercam Plus Primary Cable
PowerCam Plus Primary Cable This cable connects a VSX 7000e or VSX 8000 to a Polycom PowerCam Plus camera. Description Used With 4-pin mini-DIN and VSX 7000e DB-15 on both ends VSX 8000 (requires S-Video to BNC adapter on page 2-11) 200mm / 7.87"...
Page 48: Powercam Primary Camera Cable
Integrator’s Reference Manual for the VSX Series PowerCam Primary Camera Cable This cable connects a VSX 7000e or VSX 8000 to a Polycom PowerCam camera up to 10 ft away. Description 8-pin mini-DIN to 4-pin mini-DIN and DB-15 200mm / 7.87"...
Page 49: Powercam Break-Out Cable
Mini Din Female Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 50: Powercam/Visca Control Cable (Vsx 7000E Or Vsx 8000)
Integrator’s Reference Manual for the VSX Series PowerCam/VISCA Control Cable (VSX 7000e or VSX 8000) This cable connects a VSX 7000e or VSX 8000 to Non-Polycom camera using a VISCA 8-pin DIN connector, or to a Polycom PowerCam break-out cable with a PowerCam camera.
Page 51 Cables 8-pin mini-DIN to DB-9 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 52: Rs-232 Adapter
This adapter is included with the VSX 7000e and VSX 8000 and is used to convert the primary camera control input port (DB-15) to a DB-9 for use in connecting the control port of non-Polycom cameras to the system as the main camera. This does not carry any IR signals to the system.
Page 53: Powercam/Visca Control Cable (Vsx 7000 Or Vsx 7000S)
Description 8-pin mini-DIN on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 54: S-Video To Rca Adapter
Description Yellow RCA to 4-pin mini-DIN Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 55: Audio Cables
Audio Cables Conference Link Cable These cables connect a VSX system to a Polycom microphone or a Polycom Visual Concert™ VSX. Description Used With Brown RJ-11, offset tab All VSX Systems connectors on both ends except VSX 3000 Main conference link (with ferrite bead) Use this cable to connect a microphone or Visual Concert VSX directly to the system.
Page 56 Integrator’s Reference Manual for the VSX Series Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 57: Audio Cable
RED INSULATION (2X) Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 58: Vortex Cable (Vsx 8000)
Signal - (return) Shield/darin wire/ground Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 59: Balanced Audio Connector
Description 3-pin Phoenix connector Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 60: Vortex Cable (Vsx 6000, Vsx 6000A, Vsx 7000, Vsx 7000S, Or Vsx 7000E)
Description Mini-Phoenix to RCA Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 61: Vsx To Vtx Cable
Black offset RJ-9 to RJ-45 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 62: Visual Concert To Vtx Cable
Black offset RJ-9 to RJ-45 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 63: Subwoofer Volume Attenuator
Subwoofer Volume Attenuator This attenuator plugs into the Volume Control RJ-11 port on the subwoofer that comes with the Polycom stereo speaker kit. The attenuator is required for proper operation of the acoustic echo cancellation. Description RJ-11 connector Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom.
Page 64: Serial (Rs-232) Cables
VSX 7000 VSX 7000s Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 65 The 8-pin mini-DIN female connector on the VSX system has the following connections. Signal Not used Tx (output) Rx (input) DSR (input) DTR (output) RTS (output) CTS (input) Shield Cables 2 - 33...
Page 66: Cable (Vsx 7000E Or Vsx 8000)
Description DB-9 connectors on both ends Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 67 The DB-9 male connector on the VSX system has the following connections. Signal Not used DTR (tied to pin 6, DSR) DSR (tied to pin 4, DTR) RTS (tied to pin 8, CTS) CTS (tied to pin 7, RTS) Not used Most devices which connect to the serial port to control the VSX system via the API only require pins 2, 3, and 5.
Page 68: Null Modem Cable
Description 8-pin mini-DIN to DB-9 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 69: Null Modem Adapter
PIN 8 PIN 9 Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 70: Content Sharing Cables
Integrator’s Reference Manual for the VSX Series Content Sharing Cables Visual Concert VSX Cable This cable connects a Polycom Visual Concert VSX to a computer. Description RJ-45, HD-15, and stereo jack connectors on both ends 2 - 38 Used With...
Page 71: Imageshare Ii To Computer Cable
Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 72: Ir Connector
Integrator’s Reference Manual for the VSX Series Drawings and part numbers are provided for reference only. Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings, other than cables provided by Polycom. Contact your Polycom distributor or Polycom Custom/Vertical Products to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for your application.
Page 73: Using The Api
Using the API The VSX Series Application Programming Interface (API) is a set of commands for advanced users who want to automate a VSX system. You can use the API by connecting a control system or computer RS-232 serial port to the VSX system.
Page 74: Configuring The Rs-232 Interface
Integrator’s Reference Manual for the VSX Series Configuring the RS-232 Interface If you use the API with a serial connection, make sure that the RS-232 interfaces of the VSX system and your computer are configured appropriately. To access the RS-232 settings on your system, select System > Admin Settings >...
Page 75: Starting An Api Session Via An Rs-232 Interface
Starting an API Session via an RS-232 Interface After you have verified that the VSX system and your computer are both configured appropriately, set up both devices as follows: 1. Power off the computer and the VSX system. 2. Use an RS-232 cable to connect the control system or computer RS-232 3.
Page 76: Using The Api With A Lan Connection
Integrator’s Reference Manual for the VSX Series Using the API with a LAN Connection If you have a computer connected to the LAN, you can send API commands to the VSX system via Telnet port 24. 1. On the computer, open a command line interface. 2.
Page 77: System Commands
System Commands This chapter describes the API commands for software version 8.5. For an alphabetical list of all the commands, refer to the Table of Contents for this document. For a list of all the commands by category, refer to Appendix B, Categorical List of API Commands.
Page 78: About The Api Commands
Integrator’s Reference Manual for the VSX Series About the API Commands Syntax Conventions The following conventions are used for the API command descriptions in this chapter. All of the commands are case sensitive. Convention <param1|param2|param3> [param] [“param”] {a..z} “x” Although the API command parser may accept the minimum number of characters in a command which makes it unique, you should always use the full command string.
Page 79 Executes a previously used command from the history list, starting with a specific number or letter. Syntax ! “string” ! {1..64} Parameter “string” {1..64} Feedback Examples ->gatewaynumber set 123456789 gatewaynumber 123456789 ->hangup video hanging up video call ->history Each of the following and prints its output from the history list, as follows.
Page 80: Abk
Specifies the number of entries to list that match the pattern. Returns a batch of entries in the range defined by “start_no” to “stop_no.” Deprecated. Polycom recommends using abk range instead of this command. Specifies the beginning of the range of entries to return.
Page 81 Feedback Examples • abk range 0 3 might return abk 0. Ascot spd:384 num:1.512.xxxxxxx abk 1. Austn spd:2x64 num:1.512.xxxxxxx abk 2. Japan spd:384 num:81.03.xxxxxxxx abk 3. John spd:Auto num: 1.512.xxxxxxx • abk letter a might return abk 0. Ascot spd:384 num 1.512.xxxxxxx abk 1.
Page 82: Addressdisplayedingab
Integrator’s Reference Manual for the VSX Series addressdisplayedingab Specifies whether to make the system address public or private in the global directory. Syntax addressdisplayedingab get addressdisplayedingab private addressdisplayedingab public Parameter private public Feedback Examples addressdisplayedingab private addressdisplayedingab public Comments User interface screen location: System > Admin Settings > Global Services > Directory Servers: Display Name in Global Directory Command History Introduced in version 8.5.
Page 83: Adminpassword
adminpassword Sets or gets the remot the serial port. Syntax adminpassword get adminpassword set [“password”] Parameter “password” Feedback Examples • • • Comments User interface screen location: System > Admin Settings > General Settings > Security: Remote Access cess password. This command is not supported on e ac Description Returns the current remote access password.
Page 84: Advnetstats
Integrator’s Reference Manual for the VSX Series advnetstats Gets advanced network statistics for a call connection. Syntax advnetstats [{0..n}] Parameter {0..n} Feedback Examples advnetstats 1 returns call:1 tar:24k rar:24k tvr:64.3k rvr:104k tvru:63.8k rvru:114.6k tvfr:15.0 rvfr:15.0 vfe --- tapl:66 rapl:0 taj:46mS raj:40mS tvpl:122 rvpl:0 tvj:21mS rvj:60mS dc:--- rsid:Polycom_4.2 Returned parameters are: tar=Transmit audio rate...
Page 85 System Commands rsid=Remote system id Comments User interface screen location: System > Diagnostics > Call Statistics 4 - 9...
Page 86: Alertusertone
Integrator’s Reference Manual for the VSX Series alertusertone Sets or gets the tone used for user alerts. Syntax alertusertone <get|1|2|3|4> Parameter 1|2|3|4 Feedback Examples alertusertone 1 Comments User interface screen location: System > Admin Settings > Audio: User Alert Tones 4 - 10 Description Returns the current setting.
Page 87: Alertvideotone
alertvideotone Sets the tone used for incoming video calls. Syntax alertvideotone <get|1|2|3|4|5|6|7|8|9|10> Parameter 1|2|3|4|5|6|7|8|9|10 Feedback Examples alertusertone 8 Comments User interface screen location: System > Admin Settings > Audio: Incoming Video Call Description Returns the current setting. Sets the incoming video alert to the corresponding tone.
Page 88: All Register
Integrator’s Reference Manual for the VSX Series all register Registers for most commonly-used user registration events. Syntax all register Feedback Examples all register might return callstate registered camera registered linestate registered mute registered pip registered popupinfo registered preset registered screen registered vcbutton registered volume registered sleep registered...
Page 89 System Commands See Also command on page 4-214 is an alias for this command. registerall To unregister user feedback, use the command on page 4-14 all unregister or the command on page 4-271. unregisterall 4 - 13...
Page 90: All Unregister
Integrator’s Reference Manual for the VSX Series all unregister Simultaneously unregisters all registered user feedback so that the API no longer reports changes to the parameters. Syntax all unregister Feedback Examples all unregister might return callstate unregistered camera unregistered linestate unregistered mute unregistered pip unregistered popupinfo unregistered...
Page 91: Allowabkchanges
allowabkchanges Sets or gets the Allow Directory Changes setting. Syntax allowabkchanges <get|yes|no> Parameter Feedback Examples • • Comments If this option is enabled, the user has access to the New, Edit, and Delete icons on the Directory screen. User interface screen location: System > Admin Settings > General Settings >...
Page 92: Allowcamerapresetssetup
Integrator’s Reference Manual for the VSX Series allowcamerapresetssetup Sets or gets whether users are allowed to change camera presets. Syntax allowcamerapresetssetup <get|yes|no> Parameter Feedback Examples • • 4 - 16 Description Returns the current setting. Allows users to change camera presets. Prevents users from changing camera presets.
Page 93: Allowdialing
allowdialing Sets or gets the ability to dial out from the system. Syntax allowdialing <get|yes|no> Parameter Feedback Examples • • Comments allowdialing no screen. User interface screen location: System > Admin Settings > General Settings > Home Screen Settings: Dialing Display See Also The ability to place calls is also controlled by the on page 4-67 and...
Page 94: Allowmixedcalls
Integrator’s Reference Manual for the VSX Series allowmixedcalls Sets or gets the ability to place and receive mixed protocol multipoint calls (IP and ISDN). It allows the administrator to disable this ability for security reasons. Syntax allowmixedcalls <get|yes|no> Parameter Feedback Examples •...
Page 95: Allowstreaming
allowstreaming Adds or removes Streaming on the Utilities screen, which allows users to start streaming calls. Syntax allowstreaming <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > Streaming: Allow Streaming Description Returns the current setting.
Page 96: Allowusersetup
Integrator’s Reference Manual for the VSX Series allowusersetup Adds or removes the User Settings icon on the System screen, which allows users to access the User Settings screen. Syntax allowusersetup <get|yes|no> Parameter Feedback Examples • • Comments This command is useful to prevent users from changing the user settings. User interface screen location: System >...
Page 97: Answer
answer Answers incoming video or analog phone calls. Syntax answer <video|phone> Parameter video phone Feedback Examples • • Description Answers incoming video calls when Auto Answer Point to Point or Auto Answer Multipoint is set to Answers incoming analog phone calls when Auto Answer Point to Point or Auto Answer Multipoint is set to No.
Page 98: Areacode
Integrator’s Reference Manual for the VSX Series areacode Sets or gets the area code for all ISDN BRI lines. This command is only applicable if you have a BRI network interface connected to your system. Syntax areacode get areacode set “areacode” Parameter “areacode”...
Page 99: Audiometer
audiometer Queries and displays levels and peak of audio inputs, 10 times per second. Syntax audiometer <micpod|farin|linein|lineinred|lineinwhite|balancedin|visualconcert| vcr|aux|off> Parameter micpod farin linein lineinred lineinwhite balancedin visualconcert Feedback Examples audiometer farin might return audiometer farin level:-20 peak:-20 audiometer farin level:-19 peak:-19 audiometer farin level:-2 peak:-2 audiometer farin level:-4 peak:-4 audiometer farin level:-6 peak:-6...
Page 100: Audiotransmitlevel
Integrator’s Reference Manual for the VSX Series audiotransmitlevel Sets or gets the audio volume transmitted to the far site, or notification of transmit level changes. This command is used when a control system needs to increase the audio gain level of DTMF tones being sent to a gateway. Syntax audiotransmitlevel <get|up|down|register|unregister>...
Page 101: Autoanswer
autoanswer Sets or gets the Auto Answer Point to Point mode, which determines how the system will handle an incoming call in a point-to-point video conference. Syntax autoanswer <get|yes|no|donotdisturb> Parameter donotdisturb Feedback Examples • • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 102: Autoshowcontent
Integrator’s Reference Manual for the VSX Series autoshowcontent Specifies whether to send content automatically when the computer is connected to the Visual Concert VSX or ImageShare II. Syntax autoshowcontent <get|on|off|nearfar|nearonly> Parameter nearfar nearonly Feedback Examples ->autoshowcontent get autoshowcontent off ->autoshowcontent nearfar autoshowcontent on Comments User interface screen location: System >...
Page 103: Backlightcompensation
backlightcompensation Sets or gets the Backlight Compensation mode. Syntax backlightcompensation <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Cameras: Backlight Compensation Description Returns the current setting. Enables Backlight Compensation. The camera automatically adjusts for a bright background. Disables the option.
Page 104: Basicmode
Integrator’s Reference Manual for the VSX Series basicmode Sets or gets the Basic Mode configuration, a limited operating mode that uses H.261 for video and G.711 for audio. Basic mode provides administrators with a workaround for interoperability issues that cannot be solved using other methods.
Page 105: Bri1Enable, Bri2Enable, Bri3Enable, Bri4Enable
bri1enable, bri2enable, bri3enable, bri4enable Sets or gets the configuration of the specified ISDN BRI line. This command is only applicable if you have a BRI network interface connected to your system. Syntax bri1enable <get|yes|no> bri2enable <get|yes|no> bri3enable <get|yes|no> bri4enable <get|yes|no> Parameter Feedback Examples •...
Page 106: Briallenable
Integrator’s Reference Manual for the VSX Series briallenable Sets or gets the configuration of all ISDN BRI lines. This command is only applicable if you have a BRI network interface connected to your system. Syntax briallenable <get|yes|no> Parameter Feedback Examples •...
Page 107: Button
Sends the Help button signal to the user interface. Sends the Home button signal to the user interface. Sends the Info button signal to legacy systems. Deprecated. Polycom recommends using help instead of this button. Brings up the on-screen keyboard if the cursor is on a text field.
Page 108 Description Sends the left arrow button signal to the user interface. Sends the Menu button signal to legacy systems. Deprecated. Polycom recommends using back instead of this button. Sends the Mute button signal to the user interface, causing a toggle of mute state.
Page 109 For example, you can use the instead of button pip See Also For information about the IR signals to use when programming non-Polycom remote control devices for VSX systems, refer to Appendix Non-Polycom Remotes. System Commands...
Page 110: Calldetail
Parameter Nth_item Feedback Examples calldetail 1 might return 1,02/Jun/2004,16:34:34,02/Jun/2004,16:34:34,0:00:00,---,”Polycom Chicago Ohare IP”,xxx.xx.xxx.xxx,---, h323,384Kbps,Polycom/VSX 7000/7.0, Out,2,1,---,---,---,terminal, xxx.xx.xxx.xx:1720,Siren14,Siren14, H.263,CIF,CIF,Normal call clearing has occurred.”,16,---,0.00,0.00,0.00,0.00,16.00,16,00,29,29,4.00,6.00,19 Comments User interface screen location: Recent Calls button This button is only available if enabled on the Home Screen Settings screen.
Page 111: Calldetailreport
calldetailreport Sets or gets whether to generate a report of all calls made with the system. Syntax calldetailreport <get|yes|no> Parameter Feedback Examples • • Comments calldetail no User interface screen location: System > Admin Settings > General Settings > System Settings > Call Settings (page 2): Call Detail Report Description Returns the current setting.
Page 112: Callencryption (Deprecated)
Integrator’s Reference Manual for the VSX Series callencryption (deprecated) Sets or gets the call encryption mode. You cannot use this command while a call is in progress. With the implementation of the command has been deprecated. Syntax callencryption <get|whenavailable|disabled> Parameter whenavailable disabled Feedback Examples...
Page 113: Callinfo
callinfo Returns information about the current call. If you are in a multipoint call, this command returns one line for each site in the call. Syntax callinfo all callinfo callid “callid” Parameter callid Feedback Examples • • • • Command History Introduced in version 8.0.
Page 114: Callpreference
Integrator’s Reference Manual for the VSX Series callpreference Sets or gets the supported call types (ISDN, IP, or both). Syntax callpreference <get|h320|h323|both> Parameter h320 h323 both Feedback Examples callpreference both returns callpreference both callpreference yes callpreference yes restart system for changes to take effect. restart now? <y,n> Comments After making a change, you are prompted to restart the system.
Page 115: Callstate
[COMPLETE] active: call[0] speed[128] cleared: call[0] line[0] bchan[0] cause[16] dialstr[IP:192.168.1.103] ended: call[0] See Also Polycom recommends using the nonotify callstate unregister For more information about call status messages, refer to Appendix Messages. Description Returns the current setting.
Page 116: Callstats
Integrator’s Reference Manual for the VSX Series callstats Returns call summary information. Syntax callstats Feedback Examples callstats timeinlastcall 0:02:35 totalnumberofcalls 23 totalnumberofipcalls 23 totaltimeipcalls 2:08:44 percentageipcalls 100% totalnumberofisdncalls 0 totaltimeisdncalls 00:00:00 percentageisdncalls 0% Comments User interface screen location: System > Diagnostics > Call Statistics (page 5) 4 - 40 might return something like...
Page 117: Camera
camera Sets or gets the near-site or far-site camera settings. Syntax camera near {1..4} camera far {1..5} camera <near|far> move <left|right|up|down|zoom+|zoom-|stop> camera <near|far> move <continuous|discrete> camera <near|far> source camera <near|far> stop camera <near|far> tracking <get|on|off|to_presets> camera near <getposition|setposition “x” “y” “z”> camera <register|unregister>...
Page 118 Integrator’s Reference Manual for the VSX Series Parameter tracking to_presets getposition setposition “x” “y” “z” register unregister Feedback Examples • • • • • • • • 4 - 42 Description Sets the tracking mode. Returns the current near or far camera tracking mode when followed by the get parameter.
Page 119 • event: camera near move continuous continuous • event: camera near move discrete discrete camera near position x y z • • camera near setposition x y z • camera near tracking off • camera near tracking to_presets System Commands (returned by camera near move (returned by...
Page 120: Cameradirection
Integrator’s Reference Manual for the VSX Series cameradirection Sets or gets the camera pan direction. Syntax cameradirection <get|normal|reversed> Parameter normal reversed Feedback Examples • • Comments User interface screen location: System > Admin Settings > Cameras: Camera Direction 4 - 44 Description Returns the current setting.
Page 121: Camerainput
camerainput Sets or gets the format for a video source. Syntax camerainput {1..3} <get|s-video|composite> Parameter {1..3} s-video composite Feedback Examples • • Comments User interface screen location: System > Admin Settings > Cameras (page 2): Source Command History Introduced in version 8.5. Description Specifies the video source.
Page 122: Chaircontrol
Integrator’s Reference Manual for the VSX Series chaircontrol Sends various chair control commands while the system is in a multipoint call. Syntax chaircontrol end_conf chaircontrol hangup_term “term_no” chaircontrol list chaircontrol rel_chair chaircontrol <register|unregister> chaircontrol req_chair chaircontrol req_floor chaircontrol req_term_name “term_no” chaircontrol req_vas chaircontrol set_broadcaster “term_no”...
Page 123 Feedback Examples • rel_chair & view 1.2 (returned from • req_floor & view 1.1 (returned from • req_vas & view 1.1 (returned from • view “term_no” (returned from • view_broadcaster (returned from • view “term_no” (returned from • chaircontrol del_term 1.3 cleared: call[xx] dialstring[<IP|ISDN Number>...
Page 124: Colorbar
Integrator’s Reference Manual for the VSX Series colorbar Turns the video diagnostics color bars on or off. Syntax colorbar <on|off> Parameter Feedback Examples • • Comments User interface screen location: System > Diagnostics > Video 4 - 48 Description Turns on the color bar test pattern. Turns off the color bar test pattern.
Page 125: Colorscheme
colorscheme Sets or gets the interface color scheme of the VSX system. Syntax colorscheme <get|1|2|3|4|5> Parameter 1|2|3|4|5 Feedback Examples colorscheme 4 returns colorscheme 4 and the system switches to the Midnight Gray color scheme Comments User interface screen location: System > Admin Settings > General Settings >...
Page 126: Configchange
Integrator’s Reference Manual for the VSX Series configchange Sets or gets the notification state for configuration changes. Syntax configchange <get|register|unregister> Parameter register unregister Feedback Examples Key off of • • 4 - 50 Description Returns the current setting. Registers to receive notifications when configuration variables have changed.
Page 127: Configdisplay
configdisplay Sets or gets the video format and aspect ratio for Monitor 1 or Monitor 2. Syntax configdisplay get configdisplay <monitor1|monitor2> get configdisplay <monitor1|monitor2> <s_video|composite|vga> <4:3|16:9> configdisplay monitor2 off Parameter monitor1 monitor2 s_video composite 16:9 Feedback Examples • • • •...
Page 128: Configpresentation
Integrator’s Reference Manual for the VSX Series configpresentation Sets or gets the content presentation settings for Monitor 1 or Monitor 2. Syntax configpresentation get configpresentation <monitor1|monitor2> get configpresentation monitor1 <near|far|content|near-or-far| content-or-near|content-or-far|all|none> configpresentation monitor2 <near|far|content|near-or-far| content-or-near|content-or-far|all|none> configpresentation monitor1 "value" monitor2 "value" Parameter monitor1 monitor2...
Page 129 Feedback Examples • configpresentation monitor1 get might return configpresentation monitor1:all configpresentation monitor2 get • might return configpresentation monitor2:near-or-far • error: configpresentation not applied since monitor2 is off Comments User interface screen location: System > Admin Settings > Monitors > Monitors (page 2) Command History Introduced in version 8.5.
Page 130: Confirmdiradd
Integrator’s Reference Manual for the VSX Series confirmdiradd Sets or gets the configuration for prompting users to add directory entries for the far sites when a call disconnects. Syntax confirmdiradd <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 131: Confirmdirdel
confirmdirdel Sets or gets the configuration for requiring users to confirm directory deletions. Syntax confirmdirdel <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings > System Settings > Directory: Confirm Directory Deletions Description Returns the current setting.
Page 132: Contentauto
Integrator’s Reference Manual for the VSX Series contentauto Sets or gets the automatic bandwidth adjustment for people and content in point-to-point H.323 calls. Automatic adjustment maintains equal image quality in the two streams. Syntax contentauto <get|on|off> Parameter Feedback Examples • •...
Page 133: Country
country Sets or gets the country setting for the system. This allows you to specify country-specific calling parameters for your location. Syntax country get country set {afghanistan...zimbabwe} country list Parameter {algeria...zimbabwe} list Feedback Examples • • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 134: Cts
Integrator’s Reference Manual for the VSX Series Sets or gets the CTS serial interface control signal (clear to send) configuration. This command is only applicable if you have a V.35 network interface connected to your system. Syntax cts <get|normal|inverted|ignore> Parameter normal inverted ignore...
Page 135: Daylightsavings
daylightsavings Sets or gets the daylight savings time setting. When you enable this setting, the system clock automatically changes for daylight saving time. Syntax daylightsavings <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 136: Dcd
Integrator’s Reference Manual for the VSX Series Sets or gets the configure for the DCD serial interface control signal (data carrier detect). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dcd <get|normal|inverted> Parameter normal inverted...
Page 137: Dcdfilter
dcdfilter Sets or gets the filter setting of the DCD serial interface control signal (data carrier detect). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dcdfilter <get|on|off> Parameter Feedback Examples • •...
Page 138: Defaultgateway
Integrator’s Reference Manual for the VSX Series defaultgateway Sets or gets the default gateway. Syntax defaultgateway get defaultgateway set “xxx.xxx.xxx.xxx” Parameter “xxx.xxx.xxx.xxx” Feedback Examples defaultgateway set 192.168.1.5 returns defaultgateway 192.168.1.5 restart system for changes to take effect. restart now? <y,n> Comments This setting can only be changed if DHCP is turned off.
Page 139: Dhcp
dhcp Sets or gets DHCP options. Syntax dhcp <get|off|client|server> Parameter client server Feedback Examples dhcp client restart system for changes to take effect. restart now? <y,n> Comments After making a change, you are prompted to restart the system. If the user or administrator has chosen not to allow the DHCP server option, it will not be available.
Page 140: Dial
Integrator’s Reference Manual for the VSX Series dial Dials video or audio calls either manually or from the directory. Syntax dial addressbook “addr book name” dial auto “speed” “dialstr” dial manual <56|64> “dialstr1” “dialstr2” [h320] dial “speed” “dialstr1” [“dialstr2”] [h323|h320|ip|isdn|sip] dial phone “dialstring”...
Page 141 Feedback Examples • dial manual 2x64 5551212 5551213 h320 dialing manual cs: call[xx] chan[0] dialstr[5551212] state[ALLOCATED] cs: call[xx] chan[0] dialstr[5551212] state[RINGING] cs: call[xx] chan[0] dialstr[5551212] state[CONNECTED] cs: call[xx] chan[0] dialstr[5551212] state[CONNECTED] cs: call[xx] chan[0] dialstr[5551212] state[COMPLETE] cs: call[xx] chan[0] dialstr[5551212] state[COMPLETE] active: call[xx] speed[xxx] dial addressbook "Monday meeting"...
Page 142: Dialchannels
Integrator’s Reference Manual for the VSX Series dialchannels Sets or gets whether to dial ISDN channels in parallel. This command is only applicable if you have an ISDN network interface connected to your system. Syntax dialchannels get dialchannels set n Parameter Feedback Examples dialchannels 8...
Page 143: Dialingdisplay
dialingdisplay Sets or gets the home screen dialing display. Syntax dialingdisplay <get|dialingentry|displaymarquee|none> Parameter dialingentry displaymarquee none Feedback Examples • • • Comments User interface screen location: System > Admin Settings > General Settings > Home Screen Settings: Dialing Display See Also The text displayed is specified by the page 4-157.
Page 144: Dialingentryfield
Integrator’s Reference Manual for the VSX Series dialingentryfield Sets or gets the configuration of the dialing entry field on the Place a Call screen. Syntax dialingentryfield <get|yes|no> Parameter Feedback Examples dialingentryfield yes Command History Introduced in version 8.5 4 - 68 Description Returns the current setting.
Page 145: Diffservaudio, Diffservfecc, Diffservvideo
diffservaudio, diffservfecc, diffservvideo Sets or gets the DiffServ option and specifies a priority level for audio, far-end camera control (FECC), and video, respectively. The priority level value for each can be between 0 and 63. Syntax diffservaudio get diffservaudio set {0..63} diffservfecc get diffservfecc set {0..63} diffservvideo get...
Page 146: Dir
Integrator’s Reference Manual for the VSX Series Lists flash files. No wild cards are allowed. Syntax dir [“string”] Parameter “string” Feedback Examples • • • 4 - 70 Description Lists flash files which partially match a string of up to 250 alphanumeric characters.
Page 147: Directory
directory Sets or gets whether the Directory button appears on the home screen. Syntax directory <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings > Home Screen Settings: Directory Description Returns the current setting. Displays the Directory button on the home screen.
Page 148: Display (Deprecated)
------- ------------------ CM_CALLINFO_CONNECTED display whoami returns information similar to Hi, my name is: Jw_System Serial Number: xxxxx Brand: Polycom Software Version: Release 7.0 VSX - 31Sept2004 Model: VSX7000 Network Interface: PRI_E1 MP Enabled: Yes Encryption Enabled: Yes H.264 Enabled: Yes H.323 Enabled: Yes...
Page 149: Displayglobaladdresses
displayglobaladdresses Sets or gets the display of global addresses in the global directory. Syntax displayglobaladdresses <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > Directory Servers: Display Global Addresses Description Returns the current setting.
Page 150: Displaygraphics
Integrator’s Reference Manual for the VSX Series displaygraphics Sets or gets the display of graphic icons while in a call. Syntax displaygraphics <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Monitors > Monitors: Display Icons in a Call 4 - 74 Description...
Page 151: Displayipext
displayipext Sets or gets the display of the IP extension field. This extension is needed when placing a call through a gateway. Syntax displayipext <get|yes|no> Parameter Feedback Examples • • Comments When this option is selected, the extension field is visible on the Place a Call screen.
Page 152: Displayipisdninfo
Integrator’s Reference Manual for the VSX Series displayipisdninfo Sets or gets the display of IP and ISDN information on the home screen. Syntax displayipisdninfo <yes|no|both|ip-only|isdn-only|none|get> Parameter both ip-only isdn-only none Feedback Examples • • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 153: Displayparams
System Commands displayparams Outputs the list of all the system settings. Syntax displayparams Feedback Examples systemname Jw hostname Jw ipaddress 192.168.1.104 wanipaddress 192.168.1.111 version 8.5 - 31Jul2006 14:12 serialnum xxxxx allowremotemonitoring no daylightsavings yes requireacctnumtodial no validateacctnum no timediffgmt -12:00 gabserverip <empty>...
Page 154: Dns
Integrator’s Reference Manual for the VSX Series Sets or gets the configuration for up to four DNS servers. Syntax dns get {1..4} dns set {1..4} “xxx.xxx.xxx.xxx” Parameter {1..4} “xxx.xxx.xxx.xxx” Feedback Examples dns set 1 192.168.1.111 returns dns 1 192.168.1.111 restart system for changes to take effect. restart now? <y,n> Comments After making a change, you are prompted to restart the system.
Page 155: Dsr
Sets or gets the configuration of the DSR serial interface control signal (data set ready). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dsr <get|normal|inverted> Parameter normal inverted Feedback Examples • •...
Page 156: Dsranswer
Integrator’s Reference Manual for the VSX Series dsranswer Sets or gets the configuration of the DSR serial interface control signal to indicate an incoming call. This command is only applicable if you have a V.35 network interface connected to your system. Syntax dsranswer <get|on|off>...
Page 157: Dtr
Sets or gets the configuration of the DTR serial interface control signal (data terminal ready). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dtr <get|normal|inverted|on> Parameter normal inverted Feedback Examples • •...
Page 158: Dualmonitor
Integrator’s Reference Manual for the VSX Series dualmonitor Sets or gets whether video is displayed using dual monitor emulation, or split-screen mode, when using one monitor. Syntax dualmonitor <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Monitors > Monitors: Dual Monitor Emulation 4 - 82 Description...
Page 159: Dynamicbandwidth
dynamicbandwidth Sets or gets the use of dynamic bandwidth allocation for Quality of Service. Syntax dynamicbandwidth <get|yes|no> Parameter Feedback Examples dynamicbandwidth yes Comments The VSX system’s 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 end points that also support dynamic bandwidth.
Page 160: E164Ext
Integrator’s Reference Manual for the VSX Series e164ext Sets or gets an H.323 (IP) extension, also known as an E.164 name, needed for inbound calls going through a gateway. Syntax e164ext get e164ext set “e.164name” Parameter “e.164name” Feedback Examples e164ext set returns e164ext <empty>...
Page 161: Echo
echo Prints Syntax echo “string” Parameter “string” Feedback Examples echo End of abk range results prints End of abk range results to the API client. Comments Certain API commands print multiple lines without any delimiter string to notify end of command response. This forces a control panel program to guess when the command's response string is going to end.
Page 162: Echocanceller
• • Comments This option is enabled by default. Polycom strongly recommends that you do not turn off echo cancellation except when using an external microphone system with its own built-in echo cancellation. User interface screen location: System > Admin Settings > Audio (page 2):...
Page 163: Echocancellerred
echocancellerred Sets or gets the line in red (right) echo canceller setting. Syntax echocancellerred <get|yes|no> Parameter Examples • • Comments User interface screen location: System > Admin Settings > Audio (page 2): Echo Canceller Description Returns the current setting. Enables the echo canceller option for red line in. Disables the echo canceller option for red line in.
Page 164: Echocancellerwhite
Integrator’s Reference Manual for the VSX Series echocancellerwhite Sets or gets the line in white (left) echo canceller setting. Syntax echocancellerwhite <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Audio (page 2): Echo Canceller 4 - 88 Description...
Page 165: Enablefirewalltraversal
enablefirewalltraversal Sets or gets the Enable NAT/Firewall Traversal setting. This feature requires an Edgewater session border controller that supports H.460. Syntax enablefirewalltraversal <get|on|off> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > Firewall (page 2): Enable NAT/Firewall Traversal Command History Introduced in version 8.5.
Page 166: Enablersvp
Integrator’s Reference Manual for the VSX Series enablersvp Sets or gets the RSVP (Resource Reservation Setup Protocol) setting on the system, which requests that routers reserve bandwidth along an IP connection path. Syntax enablersvp <get|yes|no> Parameter Feedback Examples • • Comments This option is enabled by default.
Page 167: Enablesnmp
enablesnmp Sets or gets the SNMP configuration. Syntax enablesnmp <get|yes|no> Parameter Feedback Examples • • Comments This option is enabled by default. User interface screen location: System > Admin Settings > Global Services > SNMP: Enable SNMP Description Returns the current setting. Enables the SNMP option.
Page 168: Encryption
Integrator’s Reference Manual for the VSX Series encryption Sets or gets the AES encryption mode for the system. Syntax encryption <get|yes|no> Parameter Feedback Examples • • Comments You cannot use this command while a call is in progress. The encryption options are only visible on the user interface if an encryption key has been entered.
Page 169: Exit
System Commands exit Ends the API command session. Syntax exit 4 - 93...
Page 170: Farcontrolnearcamera
Integrator’s Reference Manual for the VSX Series farcontrolnearcamera Sets or gets far control of the near camera, which allows far sites to control the camera on your VSX system. Syntax farcontrolnearcamera <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Cameras: Far Control of Near Camera 4 - 94 Description...
Page 171: Farnametimedisplay
farnametimedisplay Sets or gets the length of time the far-site name is displayed on the VSX system. Syntax farnametimedisplay off farnametimedisplay <get|on|15|30|60|120> Parameter 15|30|60|120 Feedback Examples • • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 172: Flash
Integrator’s Reference Manual for the VSX Series flash Flashes the analog phone call, either an analog phone or a SoundStation VTX 1000. Syntax flash [“callid”] flash [“callid”] [“duration”] Parameter callid duration Command History Introduced in version 8.5. 4 - 96 Description Specifies the callid to flash.
Page 173: Gabk
{0..59}. Returns a batch of entries in the range defined by “start_no” to “stop_no.” Polycom recommends using gabk range instead of this command. Specifies the beginning of the range of entries to return.
Page 174: Gabpassword
Integrator’s Reference Manual for the VSX Series gabpassword Sets or gets the password to gain access to the Global Directory Server. Syntax gabpassword get gabpassword set [“password”] Parameter “password” Feedback Examples • • This command might not return the current password in correct case-sensitive format.
Page 175: Gabserverip
Sets the GDS server’s IP address when followed by the parameter “xxx.xxx.xxx.xxx”. To erase the current setting, omit “xxx.xxx.xxx.xxx”. IP address of the GDS server. Can be a numeric or character string. gabserverip <empty> gabserverip set gab.polycom.com returns gabserverip gab.polycom.com System Commands 4 - 99...
Page 176: Gatekeeperip
Integrator’s Reference Manual for the VSX Series gatekeeperip Sets or gets the IP address of the gatekeeper. Syntax gatekeeperip get gatekeeperip set “xxx.xxx.xxx.xxx” Parameter “xxx.xxx.xxx.xxx” Feedback Examples gatekeeperip set 192.168.1.1 returns gatekeeperip 192.168.1.1 Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 2): Gatekeeper IP Address The Use Gatekeeper option on the same page must be set to Auto or Specify for the Gatekeeper IP Address to be available.
Page 177: Gatewayareacode
gatewayareacode Sets or gets the gateway area code. Syntax gatewayareacode get gatewayareacode set “areacode” Parameter “areacode” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 4): Area Code Description Returns the area code for the gateway.
Page 178: Gatewaycountrycode
Integrator’s Reference Manual for the VSX Series gatewaycountrycode Sets or gets the gateway country code. Syntax gatewaycountrycode get gatewaycountrycode set [“countrycode”] Parameter “countrycode” Feedback Examples gatewaycountrycode set 1 returns gatewaycountrycode 1 Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 4): Country Code 4 - 102 Description...
Page 179: Gatewayext
gatewayext Sets or gets the gateway extension number. Syntax gatewayext get gatewayext set [“extension”] Parameter “extension” Feedback Examples gatewayext set 59715 returns gatewayext 59715 Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 4): H.323 Extension (E.164) Description Returns the current setting.
Page 180: Gatewaynumber
Integrator’s Reference Manual for the VSX Series gatewaynumber Sets or gets the gateway number. Syntax gatewaynumber get gatewaynumber set [“number”] Parameter “number” Feedback Examples gatewaynumber set 5551212 returns gatewaynumber 5551212 Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 4): Number 4 - 104 Description...
Page 181: Gatewaynumbertype
gatewaynumbertype Sets or gets the Gateway Number Type, which can be either Direct Inward Dial (DID) or Number+Extension. Syntax gatewaynumbertype <get|did|number+extension> Parameter number+extension Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 4): Gateway Number Type Description Returns the current setting.
Page 182: Gatewayprefix
Integrator’s Reference Manual for the VSX Series gatewayprefix Sets or gets the gateway prefixes for the corresponding speeds. Syntax gatewayprefix get “valid speed” gatewayprefix set “valid speed” [“value”] Parameter “valid speed” “value” Feedback Examples • • Comments Some gateways require a number to be prepended (prefix) to the gateway number.
Page 183: Gatewaysetup
gatewaysetup Lists all available speeds and values at once. Syntax gatewaysetup Feedback Examples 2x56 2x64 and so on. Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 4): Prefix and Suffix <empty> <empty>...
Page 184: Gatewaysuffix
Integrator’s Reference Manual for the VSX Series gatewaysuffix Sets or gets the gateway suffix. Syntax gatewaysuffix get “valid speed” gatewaysuffix set “valid speed” [“value”] Parameter “valid speed” “value” Feedback Examples • • Comments Some gateways require a number to be appended (suffix) to the gateway number.
Page 185: Gendial
Feedback Examples gendial 2 returns gendial 2 and the system produces the DTMF tone corresponding to a telephone’s 2 button. Comments User interface screen location: On the near or far video screen, press # on the remote control to access a keypad for generating tones.
Page 186: Gendialtonepots
Parameter {0..9} Feedback Examples gendialtonepots 2 returns gendialtonepots 2 and the system produces the DTMF tone corresponding to a telephone’s 2 button. See Also To generate DTMF tones over video, use the 4 - 110 Description Generates the DTMF tone corresponding to telephone buttons 0-9.
Page 187: Generatetone
generatetone Turns the test tone on or off. The tone is used to check the monitor audio cable connections or to monitor the volume level. Syntax generatetone <on|off> Parameter Feedback Examples generatetone on returns generatetone on and the VSX system produces a test tone. Comments User interface screen location: System >...
Page 188: Get Screen
Integrator’s Reference Manual for the VSX Series get screen Returns the name of the current screen so that the control panel programmer knows which screen the user interface is currently displaying. Syntax get screen Feedback Examples • • • See Also You can also use the 4 - 112 screen: near...
Page 189: Getcallstate
System Commands getcallstate Gets the state of the calls in the current conference. Syntax getcallstate Feedback Examples cs: call[33] speed[512] dialstr[216.54.150.82] state[connected] cs: call[1] inactive cs: call[2] inactive Comments User interface screen location: System > Diagnostics > Call Statistics See Also To register the shell session to receive notifications about call state activities, see the command on page 4-39.
Page 190: Gmscity
Integrator’s Reference Manual for the VSX Series gmscity Sets or gets the Global Management System™ city information. Syntax gmscity get gmscity set [“city”] Parameter “city” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: City 4 - 114 Description...
Page 191: Gmscontactemail
gmscontactemail Sets or gets the Global Management System contact E-mail information. Syntax gmscontactemail get gmscontactemail set [“email”] Parameter “email” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: Contact Email Description Returns the current contact E-mail address.
Page 192: Gmscontactfax
Integrator’s Reference Manual for the VSX Series gmscontactfax Sets or gets the Global Management System contact fax information Syntax gmscontactfax get gmscontactfax set [“fax number”] Parameter “fax number” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: Contact Fax 4 - 116 Description...
Page 193: Gmscontactnumber
gmscontactnumber Sets or gets the Global Management System contact number information. Syntax gmscontactnumber get gmscontactnumber set [“number”] Parameter “number” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: Contact Number Description Returns the current contact number.
Page 194: Gmscontactperson
Integrator’s Reference Manual for the VSX Series gmscontactperson Sets or gets the Global Management System contact person information. Syntax gmscontactperson get gmscontactperson set [“person”] Parameter “person” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: Contact Person 4 - 118 Description...
Page 195: Gmscountry
gmscountry Sets or gets the Global Management System country information. Syntax gmscountry get gmscountry set [“countryname”] Parameter “countryname” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: Country Description Returns the current country setting. Sets the Global Management System country information when followed by the “countryname”...
Page 196: Gmsstate
Integrator’s Reference Manual for the VSX Series gmsstate Sets or gets the Global Management System state information. Syntax gmsstate get gmsstate set [“state”] Parameter “state” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: State/Province 4 - 120 Description...
Page 197: Gmstechsupport
gmstechsupport Sets or gets the Global Management System technical support phone number. Syntax gmstechsupport get gmstechsupport set [“tech_support_digits”] Parameter “tech_support_digits” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > My Information: Tech Support Description Returns the current tech support phone number information.
Page 198: Gmsurl
Integrator’s Reference Manual for the VSX Series gmsurl Gets the URL of the Global Management System server that manages your system. This command automatically appends Syntax gmsurl get {1..10} gmsurl get all Parameter {1..10} Feedback Examples gmsurl 1 192.168.1.123/pwx/nx_status.asp Comments When you are registered with the Global Management System, this information is automatically configured.
Page 199: Graphicsmonitor
graphicsmonitor Sets or gets the graphics monitor configuration for one of these choices: monitor1, monitor2, or a Visual Concert VSX monitor. Syntax graphicsmonitor <get|1|2|vcnx> Parameter vcnx Feedback Examples • • • Comments When you use this command to set the graphics monitor, you automatically turn off the other two choices.
Page 200: H239Enable
Integrator’s Reference Manual for the VSX Series h239enable Sets or gets the H.239 People+Content™ setting. Syntax h239enable get h239enable <yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > Call Preference: Enable H.239 Command History Introduced in version 8.5.
Page 201: H323Name
h323name Sets or gets the system’s H.323 name. Syntax h323name get h323name set [“H.323name”] Parameter “H.323name” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings: H.323 Name Description Returns the current setting. Sets the H.323 name when followed by the “H.323name”...
Page 202: H331Audiomode
Integrator’s Reference Manual for the VSX Series h331audiomode Set or gets the audio protocol sent during H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331audiomode <get|g729|g728|g711u|g711a|g722-56|g722-48|g7221-16|g7221-24| g7221-32|siren14|siren14stereo|off> Parameter g729|g728|g711u| g711a|g722-56| g722-48|g7221-16| g7221-24|g7221-32|...
Page 203: H331Dualstream
h331dualstream Set or gets the dual stream setting used for H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331dualstream <get|on|off> Parameter Feedback Examples • • Comments This value cannot be changed during a call. User interface screen location: System >...
Page 204: H331Framerate
Integrator’s Reference Manual for the VSX Series h331framerate Sets or gets the frame rate sent during H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331framerate <get|30|15|10|7.5> Parameter 30|15|10|7.5 Feedback Examples •...
Page 205: H331Videoformat
h331videoformat Sets or gets the video format for H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331videoformat <get|fcif> Parameter fcif Feedback Examples h331videoformat fcif Comments User interface screen location: System > Admin Settings > Network > V.35/RS-449/RS-530 (page 5): Video Format Command History Introduced in version 7.5.
Page 206: H331Videoprotocol
Integrator’s Reference Manual for the VSX Series h331videoprotocol Sets or gets the H.331 video protocol sent during H.331 calls. This command is only applicable if you have a V.35 network interface connected to your system. Syntax h331videoprotocol <get|h264|h263+|h263|h261> Parameter h264|h263+|h263|h261 Feedback Examples •...
Page 207: Hangup
hangup Hangs up the current video or phone call. Syntax hangup phone hangup video [“callid”] Parameter phone video Feedback Examples hangup video 2 returns hanging up video call cleared: call[xx] dialstring[comm port: dialstr] NAME:system name] ended: call[xx] and disconnects the specified site, leaving other sites connected Description Disconnects the current analog phone (audio-only) site.
Page 208: Help
Integrator’s Reference Manual for the VSX Series help Returns a simple or detailed list of commands when used with the parameters all, help, string, or syntax. Also switches help display mode when used with the parameters verbose or terse. This command without parameters returns the list of command names only.
Page 209: History
System Commands history Lists the last commands used in the current session. Syntax history Feedback Examples 1 ipaddress set 192.168.1.105 2 hostname set MyVSX 3 lanport 100fdx 4 callstate register 5 lanport get 6 history Comments If more than 64 commands have been issued, only the last 64 are displayed, with the most recent always at the bottom.
Page 210: Homecallquality
Integrator’s Reference Manual for the VSX Series homecallquality Sets or gets whether users are allowed to select the bandwidth for calls from the home screen. Syntax homecallquality <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 211: Homemultipoint
homemultipoint Sets or gets whether users are allowed to access the multipoint dialing screen via a Multipoint button on the home screen. Syntax homemultipoint <get|yes|no> Parameter Feedback Examples • • Comments This option is only available if multipoint calling is enabled. User interface screen location: System >...
Page 212: Homerecentcalls
Integrator’s Reference Manual for the VSX Series homerecentcalls Sets or gets whether users are allowed to access a list of recent calls made with the system by displaying the Recent Calls button on the home screen. Syntax homerecentcalls <get|yes|no> Parameter Feedback Examples •...
Page 213: Homesystem
homesystem Sets or gets whether users are allowed to access the system screen by displaying the System button on the home screen. Syntax homesystem <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 214: Homesystemname
Integrator’s Reference Manual for the VSX Series homesystemname Sets or gets whether to display the name of the system on the home screen, above the PIP window. Syntax homesystemname <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 215: Hostname
hostname Sets or gets the LAN host name, which is assigned to the VSX system for TCP/IP configuration and can be used in place of an IP address when dialing IP calls. Syntax hostname get hostname set [“hostname”] Parameter “hostname” Feedback Examples •...
Page 216: Ipaddress
Integrator’s Reference Manual for the VSX Series ipaddress Sets or gets the LAN IP address of the VSX system. Syntax ipaddress get ipaddress set “xxx.xxx.xxx.xxx” Parameter “xxx.xxx.xxx.xxx” Feedback Examples ipaddress 192.168.1.111 restart system for changes to take effect. restart now? <y,n> Comments Use this command when you need to allocate a static IP address to your system.
Page 217: Ipdialspeed
ipdialspeed Sets or gets the valid IP dialing speed, and enables or disables the specified speed. Syntax ipdialspeed get “valid speed” ipdialspeed set “valid speed” <on|off> Parameter “valid speed” Feedback Examples ipdialspeed get 168 returns ipdialspeed 168 off (if the specified speed is disabled) ipdialspeed 168 on (if the specified speed is enabled) Comments User interface screen location: System >...
Page 218: Ipisdninfo
Integrator’s Reference Manual for the VSX Series ipisdninfo Sets or gets whether the home screen displays IP information, ISDN information, both, or neither. Syntax ipisdninfo <get|both|ip-only|isdn-only|none> Parameter both ip-only isdn-only none Feedback Examples • • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 219: Ipprecaudio, Ipprecfecc, Ipprecvideo
ipprecaudio, ipprecfecc, ipprecvideo Sets or gets the IP Precedence priority level (Type of Service Value) for audio, far-end camera control (FECC), and video. The value for each can be between 0 and 7. Syntax ipprecaudio get ipprecaudio set {0..7} ipprecfecc get ipprecfecc set {0..7} ipprecvideo get ipprecvideo set {0..7}...
Page 220: Ipstat
Integrator’s Reference Manual for the VSX Series ipstat Returns the LAN host name, WINS resolution, DHCP, IP address, DNS servers 1-4, default gateway, subnet mask, and WINS server. Syntax ipstat Feedback Examples hostname MyVSX winsresolution no dhcp client ipaddress 192.168.1.111 dnsserver 192.168.1.2 dnsserver1 192.168.1.3 dnsserver2 192.168.1.4...
Page 221: Isdnareacode
isdnareacode Sets or gets the ISDN area code or STD code associated with the area where the system is used. This command is only applicable if you have an ISDN network interface connected to your Syntax isdnareacode get isdnareacode set ["area code"] Parameter “area code”...
Page 222: Isdncountrycode
Integrator’s Reference Manual for the VSX Series isdncountrycode Sets or gets the ISDN country code associated with the country where the VSX system is used. This command is only applicable if you have an ISDN network interface connected to your system. Syntax isdncountrycode get isdncountrycode set [“country code”]...
Page 223: Isdndialingprefix
isdndialingprefix Sets or gets the ISDN dialing prefix used to access an outside line if the VSX system is behind a PBX. This command is only applicable if you have an ISDN network interface connected to your system. Syntax isdndialingprefix get isdndialingprefix set [“isdn prefix”] Parameter “isdn prefix”...
Page 224: Isdndialspeed
Integrator’s Reference Manual for the VSX Series isdndialspeed Sets or gets the valid dialing speed of the ISDN network interface. This command is only applicable if you have an ISDN network interface connected to your system. Syntax isdndialspeed get “valid speed” isdndialspeed set “valid speed”...
Page 225: Isdnnum
isdnnum Sets or gets the ISDN video number or numbers assigned to the VSX system. This command is only applicable if you have an ISDN network interface connected to your system. Syntax isdnnum get <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> isdnnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> [“number”] Parameter 1b1|1b2|2b1|2b2|3b1| 3b2|4b1|4b2 “number”...
Page 226: Isdnswitch
Comments If more than one switch protocol is supported, you must find out from your telephone service provider which protocol to select. If you change the country settings, a new set of ISDN switch protocols is loaded. User interface screen location: System > Admin Settings > Network > ISDN:...
Page 227: Keypadaudioconf
keypadaudioconf Sets or gets the keypad audio confirmation. When this option is enabled, an audio response is echoed when a numeric key is pressed on the remote control. Syntax keypadaudioconf <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 228: Language
Integrator’s Reference Manual for the VSX Series language Sets or gets the language that will display on the VSX system. Syntax language <set|get> language set <chinese|englishuk|englishus|french|german| hungarian|italian|japanese|korean|norwegian|polish|portuguese| russian|spanish|traditional_chinese> Parameter Feedback Examples language set german returns language german Comments User interface screen location: System > Admin Settings > General Settings >...
Page 229: Lanport
lanport Sets or gets the LAN port settings of the VSX system. Syntax lanport <get|auto|autohdx|autofdx|10|10hdx|10fdx|100|100hdx|100fdx> Parameter auto|autohdx|autofdx| 10|10hdx|10fdx|100|10 0hdx|100fdx Feedback Examples lanport auto restart system for changes to take effect. restart now? <y,n> Comments After making a change, you are prompted to restart the system. User interface screen location: System >...
Page 230: Linestate
Integrator’s Reference Manual for the VSX Series linestate Sets or gets API session registration to receive notifications about IP or ISDN line state changes. Syntax linestate get linestate <register|unregister> Parameter register unregister Feedback Examples Key off of “linestate:” • • Comments IP line state changes are only received in a serial API session.
Page 231: Listen
When this event occurs, the message “listen going to sleep” is received. When the system wakes up, the message “listen waking up” is received. Deprecated. Polycom recommends using sleep register instead of this command. “listen:” System Commands...
Page 232: Localdatetime
Integrator’s Reference Manual for the VSX Series localdatetime Sets or gets whether to display the local date and time on the home screen. Syntax localdatetime <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings >...
Page 233: Marqueedisplaytext
marqueedisplaytext Sets or gets the text to display in the dialing entry field on the Place a Call screen. Syntax marqueedisplaytext get marqueedisplaytext set “text” Parameter “text” Feedback Examples • • Comments This option is only available when the dialingdisplay is set to display a marquee.
Page 234: Maxgabinternationalcallspeed
Integrator’s Reference Manual for the VSX Series maxgabinternationalcallspeed Sets or gets the maximum speed for international ISDN calls made from the global directory. This command is only applicable if you have an ISDN network interface connected to your system. Syntax maxgabinternationalcallspeed get maxgabinternationalcallspeed set “valid speed”...
Page 235: Maxgabinternetcallspeed
maxgabinternetcallspeed Sets or gets the maximum speed for Internet (IP/H.323) calls made from the global directory. Syntax maxgabinternetcallspeed get maxgabinternetcallspeed set “valid speed” Parameter “valid speed” Feedback Examples maxgabinternetcallspeed set 384 returns maxgabinternetcallspeed 384 Comments User interface screen location: System > Admin Settings > Network > Call Preference (page 3): IP Calls Description Returns the current valid speed.
Page 236: Maxgabisdncallspeed
Integrator’s Reference Manual for the VSX Series maxgabisdncallspeed Sets or gets the maximum speed for ISDN (H.320) calls made from the global directory. This command is only applicable if you have an ISDN network interface connected to your system. Syntax maxgabisdncallspeed get maxgabisdncallspeed set “valid speed”...
Page 237: Maxtimeincall
maxtimeincall Sets or gets the maximum number of minutes allowed for call length. Syntax maxtimeincall get maxtimeincall set [{0..999}] Parameter {0..999} Feedback Examples • • Comments When the time has expired in a call, a message asks you if you want to hang up or stay in the call.
Page 238: Mcupassword
Integrator’s Reference Manual for the VSX Series mcupassword Enters and sends the MCU password to the MCU. Syntax mcupassword [“password”] Parameter password 4 - 162 Description Specifies the password to send to the MCU.
Page 239: Meetingpassword
meetingpassword Sets or gets the meeting password. Syntax meetingpassword get meetingpassword set [“password”] Parameter “password” Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings > Security: Meeting Description Returns the current meeting password. Sets the meeting password if followed by the password parameter.
Page 240: Midrangespeaker
<get|on|off> Parameter Feedback Examples • • Comments This option is only available when Polycom StereoSurround™ is disabled. User interface screen location: System > Admin Settings > Audio (page 3): Midrange Speaker 4 - 164 Description Returns the current setting.
Page 241: Monitor1 (Deprecated)
monitor1 (deprecated) Sets or gets the aspect ratio for Monitor 1. With the implementation of the configdisplay Syntax monitor1 <get|4:3|16:9|vga> Parameter 4:3|16:9 Feedback Examples monitor1 4:3 monitor1 16:9 Comments User interface screen location: System > Admin Settings > Monitors > Monitors: Monitor Command History Deprecated in version 8.5.
Page 242: Monitor1Screensaverouput
Integrator’s Reference Manual for the VSX Series monitor1screensaverouput Sets or gets whether to send either black video or "No Signal" to Monitor 1 when the screen saver activates. Syntax monitor1screensaveroutput <get|black|no_signal> Parameter black no_signal Feedback Examples The command monitor1screensaverouput black returns monitor1screensaverouput black The command...
Page 243: Monitor2 (Deprecated)
monitor2 (deprecated) Sets or gets the aspect ratio for Monitor 2. With the implementation of the configdisplay Syntax monitor2 off monitor2 <get|4:3|16:9> monitor2 vga Parameter 4:3|16:9 Feedback Examples • • Comments User interface screen location: System > Admin Settings > Monitors > Monitors: Monitor 2 Command History Deprecated in version 8.5.
Page 244: Monitor2Screensaverouput
Integrator’s Reference Manual for the VSX Series monitor2screensaverouput Sets or gets whether to send either black video or "No Signal" to Monitor 2 when the screen saver activates. Syntax monitor2screensaveroutput <get|black|no_signal> Parameter black no_signal Feedback Examples The command monitor2screensaverouput black returns monitor2screensaverouput black The command...
Page 245: Mpautoanswer
mpautoanswer Sets or gets the Auto Answer Multipoint mode, which determines how the system will handle an incoming call in a multipoint video conference. Syntax mpautoanswer <get|yes|no|donotdisturb> Parameter donotdisturb Feedback Examples • • • Comments mpautoanswer notifications to answer inbound calls. User interface screen location: System >...
Page 246: Mpmode
Integrator’s Reference Manual for the VSX Series mpmode Sets or gets the multipoint conference viewing 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. Syntax mpmode <get|auto|discussion|presentation|fullscreen>...
Page 247: Mtumode
mtumode Sets or gets the MTU mode. The change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set mtusize sets the MTU value to 1260. Syntax mtumode <get|default|specify> Parameter default specify Feedback Examples Success examples: ->mtumode default mtumode default...
Page 248: Mtusize
Integrator’s Reference Manual for the VSX Series mtusize Sets or gets the MTU size. The change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set mtusize sets the MTU value to 1260. Syntax mtusize <get|660|780|900|1020|1140|1260|1500>...
Page 249: Mute
mute Sets or gets the near or far site mute settings. Syntax mute <register|unregister> mute near <get|on|off|toggle> mute far get Parameter register unregister near toggle Feedback Examples • • • • mute far on registered to receive mute states) Comments In register mode, the system sends notification to the API session when the far or near site is muted or unmuted.
Page 250: Muteautoanswer
Integrator’s Reference Manual for the VSX Series muteautoanswer Sets or gets the Mute Auto Answer Calls mode. When this setting is selected, the microphone is muted to prevent the far site from hearing the near site when the VSX system answers automatically. Syntax muteautoanswer <get|yes|no>...
Page 251: Natconfig
natconfig Sets or gets the NAT configuration. Syntax natconfig <get|auto|manual|upnp|off> Parameter auto manual upnp Feedback Examples • • • Comments User interface screen location: System > Admin Settings > Network > IP > Firewall: NAT Configuration Description Returns the current setting. Specifies that the system is behind a NAT;...
Page 252: Nath323Compatible
Integrator’s Reference Manual for the VSX Series nath323compatible Sets or gets the NAT is H.323 Compatible setting. Syntax nath323compatible <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > Firewall: NAT is H.323 Compatible Command History Introduced in version 8.5.
Page 253: Nearloop
nearloop Activates or deactivates the Near End Loop test. Syntax nearloop <on|off> Parameter Feedback Examples • • Comments When Near End Loop is on, you can test the encoder/decoder on the VSX system. This can help you diagnose a problem with a video call. If you perform a near end loop test during a call, the far site sees a loop of itself.
Page 254: Netstats
Integrator’s Reference Manual for the VSX Series netstats Returns network statistics for each call. Syntax netstats [{0..n}] Parameter {0..n} Feedback Examples netstats 2 might return call:1 txrate:128k rxrate:128k pktloss:0 %pktloss:0.00% tvp:H.263 rvp:H.263 tvf:CIF rvp:CIF tap:G.722.1 rap:G.722.1 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...
Page 255: Nonotify
nonotify Unregisters the API client to receive status notifications. Syntax nonotify <callstatus|captions|linestatus|mutestatus|screenchanges> nonotify <sysstatus|sysalerts|vidsourcechanges> Parameter callstatus captions linestatus mutestatus screenchanges sysstatus sysalerts vidsourcechanges Feedback Examples nonotify callstatus returns nonotify callstatus success acknowledging that the session is no longer registered to receive callstatus notifications.
Page 256: Notify
Integrator’s Reference Manual for the VSX Series notify Lists the notification types that are currently being received, or registers to receive status notifications. Syntax notify notify <callstatus|captions|linestatus|mutestatus|screenchanges> notify <sysstatus|sysalerts|vidsourcechanges> Parameter notify callstatus captions linestatus mutestatus screenchanges 4 - 180 Description Lists the notification types that are currently being received, in the following format.
Page 257 Parameter Description Registers the system to receive system status sysstatus notifications, in the following format. notification:sysstatus:<sys parameter name>:<value1>[:<value2>...] Registers the system to receive system alerts, in the sysalerts following format. notification:sysalert:<alert name>:<value1>[:<value2>...] Registers the system to receive notification of camera vidsourcechanges source changes, in the following format.
Page 258 Integrator’s Reference Manual for the VSX Series • • • • Key off of • • • • • Comments status notifications. The API client receives call status notifications as a call progresses. Registration for status notifications is session-specific. For example, registering for alerts in a Telnet session does not return alerts in a simultaneous RS-232 session with the same system.
Page 259: Ntpmode
ntpmode Sets or gets the mode of the system’s Network Time Protocol (NTP) server. NTP server time is used to ensure synchronized time data in the local Call Detail Report. Syntax ntpmode <get|auto|off|manual> Parameter auto manual Feedback Examples • • •...
Page 260: Ntpserver
Integrator’s Reference Manual for the VSX Series ntpserver Sets or gets an Network Time Protocol (NTP) server, using the IP address or the DNS name of the server. Syntax ntpserver get ntpserver set [“xxx.xxx.xxx.xxx”|“server name”] Parameter “xxx.xxx.xxx.xxx” “server name” Feedback Examples •...
Page 261: Numberofmonitors (Deprecated)
numberofmonitors (deprecated) Returns the display number of monitors configured. With the implementation of the deprecated. Syntax numberofmonitors get Feedback Examples • • Comments User interface screen location: System > Admin Settings > Monitors > Monitors Command History Deprecated in the 8.5 version. See Also The recommended command for accessing display configuration is the configdisplay...
Page 262: Numberofrouterhops
Integrator’s Reference Manual for the VSX Series numberofrouterhops Sets or gets the maximum number of router hops for streaming. Syntax numberofrouterhops get numberofrouterhops set {1..127} Parameter set {1..127} Feedback Examples The command numberofrouterhops 121 returns numberofrouterhops 121 The command numberofrouterhops get might return numberofrouterhops 121 Comments...
Page 263: Numdigitsdid
numdigitsdid Sets or gets the number of digits in the DID Gateway number (E.164 dialing). Syntax numdigitsdid <get|{0..24}> Parameter {0..24} Feedback Examples numdigitsdid 7 Comments The number of digits in the DID is that portion of the full DID that the Gateway will be given from the ISDN service provider as the Called Party Line Identifier.
Page 264: Numdigitsext
Integrator’s Reference Manual for the VSX Series numdigitsext Sets or gets the number of digits in the Number+Extension Gateway number (E.164 dialing). Syntax numdigitsext <get|{0..24}> Parameter {0..24} Feedback Examples numdigitsext 10 Comments The number of digits in that number is that portion of the full Number+Extension number that the Gateway will be given from the ISDN service provider as the Called Party Line Identifier.
Page 265: Outboundcallroute
outboundcallroute Sets or gets the default outbound calling route. Syntax outboundcallroute <get|gateway|isdn> Parameter gateway isdn Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 2): Outbound Call Route Description Returns the current setting.
Page 266: Pause
Integrator’s Reference Manual for the VSX Series pause Pauses the command interpreter before executing the next command. Pauses are useful when commands are retrieved from a script file. Syntax pause {0..65535} Parameter {0..65535} Feedback Examples pause 3 pausing for 3 seconds pauses 3 seconds before the next command.
Page 267: Phone
phone Flashes the analog phone line. Syntax phone flash Parameter flash See Also Use the Description Sends flash hook to a POTS or VTX 1000 conference phone connection. If both of these call types exist, use the flash command to specify a call ID. command on page 4-96 to specify a call ID.
Page 268: Ping
Integrator’s Reference Manual for the VSX Series ping Pings the IP address of a device, to check if it can be reached. Syntax ping “xxx.xxx.xxx.xxx” [“count”] Parameter “xxx.xxx.xxx.xxx” “count” Feedback Examples testlan ping “ip_addr”: passed = x; failed = y where x = number of passed attempts and y= number of failed attempts Comments User interface screen location: System >...
Page 269: Pip
Sets or gets the on-screen PIP mode. The PIP feature allows the near site to adjust near-camera views while in a video conference. Syntax pip <get|on|off|auto|camera|swap|register|unregister|location> pip location <get|0|1|2|3> Parameter auto camera swap register unregister location Feedback Examples • • •...
Page 270 Integrator’s Reference Manual for the VSX Series • • • Comments User interface screen location: System > Admin Settings > Monitors > Monitors: PIP System > User Settings (page 2): PIP The Allow Access to User Settings option under System > Admin Settings > General Settings >...
Page 271: Popupinfo
popupinfo Registers or unregisters to receive popup text and button choices text. Syntax popupinfo <get|register|unregister> Parameter register unregister Feedback Examples Key off of • • • • Description Registers to receive popup information. Unregisters to receive popup information. Returns the current setting. “popupinfo:”...
Page 272: Preset
Integrator’s Reference Manual for the VSX Series preset Sets or gets the presets or goes (moves) to the presets for the near or far camera source. Also registers or unregisters the API session to give notification when the user sets or goes to presets. Syntax preset <register|unregister>...
Page 273: Priareacode
priareacode Sets or gets the PRI area code. This command is only applicable if you have a PRI network interface connected to your system. Syntax priareacode get priareacode set ["area code"] Parameter “area code” Feedback Examples priareacode set 512 returns priareacode 512 Comments User interface screen location: System >...
Page 274: Pricallbycall
Call-by-call is a number from 0 to 31, which is optionally sent to an upstream telephone company switch, if required. For example, specify a value of 6 for a T1 PRI network interface module that is directly connected to an ATT 5ESS switch, which is provisioned with Accunet.
Page 275: Prichannel
prichannel Sets or gets the PRI channels that will be active for the PRI line. This command is only applicable if you have a PRI network interface connected to your system. Syntax prichannel get all prichannel get {1..n} prichannel set all prichannel set {1..n} <on|off>...
Page 276 Integrator’s Reference Manual for the VSX Series Incoming Calls. For incoming calls, the VSX system may use the highest numbered channel in the range and, if needed, proceed to the next channel number in descending order, depending on the type of third-party equipment attached to the system.
Page 277: Pricsu
pricsu Sets or gets the PRI CSU mode for a T1 interface. Syntax pricsu <get|internal|external> Parameter internal external Feedback Examples • • Comments By default, the T1 PRI network interface module is set for internal CSU mode. User interface screen location: System > Admin Settings > Network > ISDN (page 2): External CSU This screen is only accessible if you have a PRI network interface connected to your system.
Page 278: Pridialchannels
Integrator’s Reference Manual for the VSX Series pridialchannels Sets or gets the number of PRI channels to dial in parallel. This command is only applicable if you have a PRI network interface connected to your system. Syntax pridialchannels get prichannels set {1..n} Parameter {1..n} Feedback Examples...
Page 279: Priintlprefix
priintlprefix Sets or gets the PRI international dialing prefix. Syntax priintlprefix get priintlprefix set ["prefix"] Parameter “prefix” Feedback Examples priintlprefix set 011 returns priintlprefix 011 Comments The international prefix defaults to 011 for North America and 00 for European countries. The default depends on the country. User interface screen location: System >...
Page 280: Prilinebuildout
Integrator’s Reference Manual for the VSX Series prilinebuildout Sets or gets the PRI line buildout for a T1 interface. Syntax prilinebuildout get prilinebuildout set <0|-7.5|-15|-22.5> prilinebuildout set <0-133|134-266|267-399|400-533|534-665> Parameter 0|-7.5|-15|-22.5 0-133|134-266| 267-399|400-533| 534-665 Feedback Examples prilinebuildout set -7.5 returns prilinebuildout -7.5 Comments If you are using an internal CSU, enter the output attenuation in dB.
Page 281: Prilinesignal
prilinesignal Sets or gets the PRI line signal. Syntax prilinesignal get prilinesignal set <esf/b8zs|crc4/hdb3|hdb3> Parameter esf/b8zs crc4/hdb3 hdb3 Feedback Examples prilinesignal set esf/b8zs returns prilinesignal esf/b8zs Comments User interface screen location: System > Admin Settings > Network > ISDN (page 2): Line Signaling This screen is only accessible if you have a PRI network interface connected to your system.
Page 282: Primarycallchoice
Integrator’s Reference Manual for the VSX Series primarycallchoice Sets or gets the primary call type for placing calls. Syntax primarycallchoice <get|isdn|ip|sip|manual> Parameter isdn manual Feedback Examples primarycalltype ip Comments User interface screen location: System > Admin Settings > Network > Call Preference (page 2) Command History Introduced in version 8.5.
Page 283: Primarycamera
primarycamera Sets or gets the primary camera that is used when the VSX system powers on. Syntax primarycamera <get|1|2|3> Parameter 1|2|3 Feedback Examples primarycamera 1 Comments You cannot disconnect the main camera, but you do not have to set it as the primary camera.
Page 284: Prinumber
Integrator’s Reference Manual for the VSX Series prinumber Sets or gets the PRI video number. Syntax prinumber get prinumber set ["number"] Parameter “number” Feedback Examples prinumber set 5551212 returns prinumber 5551212 Comments User interface screen location: System > Admin Settings > Network > ISDN: PRI Video Number This screen is only accessible if you have a PRI network interface connected to your system.
Page 285: Prinumberingplan
The unknown parameter is preferred and should work with all properly configured PBXs and with most telephone company switches. A notable exception in North America is an ATT 5ESS switch, which is provisioned with Accunet, or an ATT 4ESS switch.
Page 286: Prioutsideline
Integrator’s Reference Manual for the VSX Series prioutsideline Sets or gets the PRI number that is dialed for outside line access. Syntax prioutsideline get prioutsideline set ["outside_line"] Parameter “outside_line” Feedback Examples prioutsideline set 9 returns prioutsideline 9 Comments This number is needed if your system is on a PBX. User interface screen location: System >...
Page 287: Priswitch
Comments 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.
Page 288: Reboot
Integrator’s Reference Manual for the VSX Series reboot Restarts the system. Syntax reboot [yes|no] Parameter Feedback Examples • • Comments User interface screen location: System > Diagnostics > Reset System: Reset System 4 - 212 Description Reboots the system. Can be abbreviated to y. Does not reboot the system.
Page 289: Recentcalls
Feedback Examples "Austin Oasis" 16/Jun/2004 14:39:56 Out Sooners 16/Jun/2004 14:40:07 Out A 16/Jun/2004 14:40:35 Out 4136419 16/Jun/2004 20:27:33 Out 4136419 16/Jun/2004 20:28:37 Out "POLYCOM MGC" 209.163.168.122 17/Jun/2004 02:20:08 In "POLYCOM MGC" "POLYCOM MGC" "POLYCOM MGC" Comments User interface screen location: System > Admin Settings > Network > Recent...
Page 290: Registerall
Integrator’s Reference Manual for the VSX Series registerall Alias for the all register command. Command History Introduced in version 8.5. See Also This command is an alias for the preferred page 4-12. To unregister user feedback, use the or the 4 - 214 all unregister command on page 4-271.
Page 291: Registerthissystem
registerthissystem Sets or gets the system’s IP address to be registered and displayed in the global directory when the system is powered on. Syntax registerthissystem <get|yes|no> Parameter Feedback Examples • • Comments If you do not enable this option, the system has access to the GDS, but the IP address does not appear in the global directory.
Page 292: Remotecontrol
Integrator’s Reference Manual for the VSX Series remotecontrol Set or gets the setting for intercepting signals from the VSX system remote control. Syntax remotecontrol disable <get|all|none> remotecontrol disable “valid button” [“valid button”...] remotecontrol dontintercept <all|none> remotecontrol dontintercept “valid button” [“valid button”...] remotecontrol enable <all|none>...
Page 293 • remotecontrol intercept get returns something like intercepting 0 buttons remotecontrol intercept all • returns remotecontrol intercept all success The following is an example of a notification that may be returned after sending the intercept command. Key off of “notification:” notification:buttonintercept::ir: notification:buttonintercept::ir: notification:buttonintercept:home:ir...
Page 294: Remotemonenable
Integrator’s Reference Manual for the VSX Series remotemonenable Gets the state of remote room and call monitoring. Syntax remotemonenable get Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Setting > Security (page 2): Allow Video Display on Web Command History Introduced in version 8.5.
Page 295: Repeat
repeat Repeats a specified command from the history list. Syntax repeat {1..64} Parameter {1..64} Description Repeats the specified command in the history list. Values larger than the number of commands in the history list are not valid. The history list may contain up to 64 commands.
Page 296: Requireacctnumtodial
Integrator’s Reference Manual for the VSX Series requireacctnumtodial 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. Syntax requireacctnumtodial <get|yes|no>...
Page 297: Roomphonenumber
Sets the room phone number when followed by the “number” parameter. To erase the current setting, omit the “number” parameter. Phone number for a telephone (not the VSX system) in the room. Use quotation marks around the number if it contains spaces. For example: “512 555 1212”...
Page 298: Rs232 Baud
Integrator’s Reference Manual for the VSX Series rs232 baud Sets or gets the baud rate for the first RS-232 port. For systems with two serial ports, use Syntax rs232 baud <get|9600|14400|19200|38400|57600|115200> rs232port1 baud <get|9600|14400|19200|38400|57600|115200> Parameter 9600|14400|19200| 38400|57600|115200 rs232port1 Feedback Examples •...
Page 299: Rs232 Mode
rs232 mode Sets or gets the operational mode of the first RS-232 port. For systems with two serial ports, use Syntax rs232 mode <get|passthru|control|debug|sony_ptz|closed_caption| vortex_mixer|cps|interactive_touch_board|polycom_annotation|smartboa rd|pointmaker> rs232port1 mode <get|passthru|control|debug|sony_ptz|closed_caption| vortex_mixer|cps|interactive_touch_board|polycom_annotation|smartboa rd|pointmaker> Parameter passthru contol debug sony_ptz closed_caption vortex_mixer cps|interactive_touc h_board|polycom_anno tation|smartboard| pointmaker rs232port1...
Page 300: Rs232Monitor
Integrator’s Reference Manual for the VSX Series rs232monitor Sets or gets the state of RS-232 serial port monitoring. When RS-232 monitoring is enabled, you can view all communication in and out of the serial port as output to Telnet port 23. Syntax rs232monitor get rs232monitor <on|off>...
Page 301: Rs366Dialing
rs366dialing Sets or gets RS-366 dialing. This command is only applicable if you have a V.35 network interface connected to your system. Syntax rs366dialing <get|on|off> Parameter Feedback Examples • • Comments Enable this option if you want to call from the system through the DCE connection to the far-site video conferencing system.
Page 302 Integrator’s Reference Manual for the VSX Series Sets or gets the RT serial interface control signal (receive timing: clock). This command is only applicable if you have a V.35 network interface connected to your Syntax rt <get|normal|inverted> Parameter normal inverted Feedback Examples •...
Page 303: Rts
Sets or gets the RTS serial interface control signal (request to send). This command is only applicable if you have a V.35 network interface connected to your Syntax rts <get|normal|inverted> Parameter normal inverted Feedback Examples • • Comments The default setting is User interface screen location: System >...
Page 304: Run
Integrator’s Reference Manual for the VSX Series Loads a file from the flash file system and then executes the API commands contained in it. Syntax run “scriptfilename” Parameter “scriptfilename” Command Examples run startcall.bat Comments Each command needs to be placed on a single line with a <CR><LF> as a terminator.
Page 305: Screen
screen Returns the name of the current user interface screen on the VSX system, registers or unregisters for screen changes, or goes to a specific user interface screen. Syntax screen screen register get screen [register|unregister] screen “screen_name” Parameter screen register unregister “screen_name”...
Page 306: Screencontrol
Integrator’s Reference Manual for the VSX Series screencontrol Disables or enables navigation to specified user interface screens of the VSX system. Syntax screencontrol enable <all|none|“screen_name”> screencontrol disable <all|none|“screen_name”> Parameter enable none “screen_name” disable Feedback Examples • • • This command returns a failure for unknown screen names, for example error: screencontrol screen “main”...
Page 307: Secondarycallchoice
secondarycallchoice Sets or gets the secondary call type for placing calls. Syntax secondarycallchoice <get|isdn|ip|sip|none> Parameter isdn none Feedback Examples • Command History Introduced in version 8.5. See Also You can set the primary call type using the page 4-206. Description Returns the current secondary call type.
Page 308: Serialnum
Integrator’s Reference Manual for the VSX Series serialnum Returns the serial number of the VSX system. Syntax serialnum Feedback Examples serialnum might return serialnum 0202430240x2aa Comments User interface screen location: System > System Information: Serial Number 4 - 232...
Page 309: Setaccountnumber
setaccountnumber Sets the account number when it is required for dialing out. Syntax setaccountnumber “account number” Parameter “account number” Feedback Examples setaccountnumber 1234 Comments The account number is saved in the Global Management System database and is generally assigned by the Global Management System administrator. The option Required Account to Dial must be enabled for this command to work.
Page 310: Showpopup
Integrator’s Reference Manual for the VSX Series showpopup Displays a message box in the user interface. Syntax showpopup “text to display” Parameter “text to display” Feedback Examples showpopup “The conference will resume in three minutes.” returns showpopup The conference will resume in three minutes. and the popup is displayed in the user interface.
Page 311: Sleep
sleep Puts the VSX system in sleep mode and returns sleep. Syntax sleep sleep <register|unregister> Parameter sleep register unregister See Also To wake the system from sleep mode, use the Description Puts the system in sleep mode if not followed by other parameters.
Page 312: Sleeptext
Integrator’s Reference Manual for the VSX Series sleeptext Sets or gets the text to be displayed with the logo for 15 seconds as the system goes into sleep mode. Syntax sleeptext get sleeptext set [“text”] Parameter “text” Feedback Examples • •...
Page 313: Sleeptime
sleeptime Sets or gets the wait time value before the VSX system goes to sleep and displays the screen saver. Syntax sleeptime <get|0|1|3|15|30|60|120|240|480> Parameter 0|1|3|15|30|60|120| 240|480 Feedback Examples sleeptime 1 Comments User interface screen location: System > Admin Settings > General Settings >...
Page 314: Snapshottimeout
Integrator’s Reference Manual for the VSX Series snapshottimeout Sets or gets the Snapshot Timeout setting. Syntax snapshottimeout <get|yes|no> Parameter Feedback Examples • • Comments By default, all slides and snapshots are displayed for a period of four minutes. When the display times out after four minutes, the VSX system automatically returns to live video.
Page 315: Snmpadmin
snmpadmin Sets or gets the SNMP administrator name. Syntax snmpadmin get snmpadmin set ["admin name"] Parameter “admin name” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > SNMP: Contact Name Description Returns the current setting. Sets the administrator name when followed by the “admin name”...
Page 316: Snmpcommunity
Integrator’s Reference Manual for the VSX Series snmpcommunity Sets or gets the SNMP community name. Syntax snmpcommunity get snmpcommunity set ["community name"] Parameter “community name” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > SNMP: Community 4 - 240 Description...
Page 317: Snmpconsoleip
snmpconsoleip Sets or gets the SNMP console IP address. Syntax snmpconsoleip get snmpconsoleip set ["xxx.xxx.xxx.xxx"] Parameter “xxx.xxx.xxx.xxx” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > SNMP: Console IP Address Description Returns the current setting. Sets the SNMP console IP address when followed by the “xxx.xxx.xxx.xxx”...
Page 318: Snmplocation
Integrator’s Reference Manual for the VSX Series snmplocation Sets or gets the SNMP location name. Syntax snmplocation get snmplocation set ["location name"] Parameter “location name” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > SNMP: Location Name 4 - 242 Description...
Page 319: Snmpsystemdescription
snmpsystemdescription Sets or gets the SNMP system description. Syntax snmpsystemdescription get snmpsystemdescription set ["system description"] Parameter “system description” Feedback Examples • • Comments User interface screen location: System > Admin Settings > Global Services > SNMP: System Description Description Returns the current setting. Sets the SNMP system description when followed by the “system description”...
Page 320: Soundeffectsvolume
Integrator’s Reference Manual for the VSX Series soundeffectsvolume Sets, gets, or tests the volume level of the ring tone and user alert tone on the system. Syntax soundeffectsvolume get soundeffectsvolume set {0..10} soundeffectsvolume test Parameter test Feedback Examples • • Comments User interface screen location: System >...
Page 321: Spidnum
spidnum Sets or gets the ISDN SPID numbers assigned to the BRI lines used by the VSX system. This command is only applicable if you have a BRI network interface connected to your system. Syntax spidnum get <all|1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> spidnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> [“spid number”] Parameter 1b1|1b2|2b1|2b2|3b1| 3b2|4b1|4b2...
Page 322 Integrator’s Reference Manual for the VSX Series Sets or gets the st serial interface control signal (send timing: clock) setting. This command is only applicable if you have a V.35 network interface connected to your system. Syntax st <get|normal|inverted> Parameter normal inverted Feedback Examples...
Page 323: Stream
stream Starts or stops streaming from your system. Syntax stream start [“addr”] [“ttl”] [“vidPort”] [“audPort”] [“vidCmpr”] [“audCmpr”] [“bitrate”] stream stop Parameter start “addr” “ttl” “vidPort” “audPort” “vidCmpr” “audCmpr” “bitrate” stop Feedback Examples • • Comments User interface screen location: System > Utilities > Streaming: Start Streaming This option is only visible in the user interface if streaming is enabled.
Page 324: Streamannounce
Integrator’s Reference Manual for the VSX Series streamannounce Sets or gets the streaming announcement setting. Syntax streamannounce <get|yes|no> Parameter Feedback Examples • • Comments When this option is enabled, the names of users logged on to your system are displayed on screen. User interface screen location: System >...
Page 325: Streamaudioport
streamaudioport Sets or gets the stream audio port setting. Syntax streamaudioport get streamaudioport set ["stream audio port"] Parameter “stream audio port” Feedback Examples • • Comments By default, the audio port is a fixed port. This may be changed if a user needs to go through the firewall.
Page 326: Streamenable
Integrator’s Reference Manual for the VSX Series streamenable Sets or gets whether streaming is allowed on the system. Syntax streamenable <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > Streaming: Allow Streaming 4 - 250 Description...
Page 327: Streammulticastip
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. User interface screen location: System > Admin Settings > Network > IP >...
Page 328: Streamrestoredefaults
Integrator’s Reference Manual for the VSX Series streamrestoredefaults Restores the stream Speed, IP Multicast Address, Number of Router Hops, Audio Port, and Video Port defaults and prints out the values. Syntax streamrestoredefaults Feedback Examples streamrestoredefaults returns information similar to streamspeed 192 streammulticastip 231.0.231.01 streamrouterhops 1 streamaudioport 16384...
Page 329: Streamrouterhops
streamrouterhops Sets or gets the number of routers you want the streaming video to pass through. This allows you to control who can see your streaming video. Syntax streamrouterhops get streamrouterhops set {1..127} Parameter {1..127} Feedback Examples streamrouterhops set 1 returns streamrouterhops 1 Comments...
Page 330: Streamspeed
Integrator’s Reference Manual for the VSX Series streamspeed Sets or gets the speed of the video stream. Syntax streamspeed <get|192|256|384|512> Parameter 192|256|384|512 Feedback Examples • • • • Comments User interface screen location: System > Admin Settings > Network > IP > Streaming: Speed 4 - 254 Description...
Page 331: Streamvideoport
streamvideoport Sets or gets the stream video port. Syntax streamvideoport get streamvideoport set ["video port"] Parameter “video port” Feedback Examples streamvideoport set 16386 returns streamvideoport 16386 Comments By default, the video port is a fixed port. This command lets you change stream video port to go through a firewall.
Page 332: Subnetmask
Integrator’s Reference Manual for the VSX Series subnetmask Sets or gets the subnet mask of the VSX system. Syntax subnetmask get subnetmask set [“xxx.xxx.xxx.xxx”] Parameter “xxx.xxx.xxx.xxx” Feedback Examples subnetmask 10.11.12.13 restart system for changes to take effect. restart now? <y,n> Comments After making a change, you are prompted to restart the system.
Page 333: Subwoofer
subwoofer Sets or gets whether to use the system’s subwoofer. This command is only valid for VSX 7000 and VSX 7000s systems. Syntax subwoofer <get|on|off> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Audio (page 3): Subwoofer Speaker Description Returns the current setting.
Page 334: Subwooferoffset
Integrator’s Reference Manual for the VSX Series subwooferoffset Sets or gets the volume level for the subwoofer without changing the master audio volume. This command is only valid for VSX 7000 and VSX 7000s systems. Syntax subwooferoffset <get|+3|+2|+1|0|-1|-2|-3> Parameter +3|+2|+1|0|-1|-2|-3 Feedback Examples subwooferoffset +2 Comments...
Page 335: Sysinfo
sysinfo Sets or gets registration for ISDN, IP, and gatekeeper status notifications. Syntax sysinfo <get|register|unregister> Parameter register unregister Feedback Examples sysinfo get might return linestate: isdnline[1] down linestate: isdnline[2] down linestate: isdnline[3] up linestate: isdnline[4] up linestate: isdnline[1] up linestate: isdnline[3] down linestate: isdnline[4] down linestate: isdnline[2] up Description...
Page 336: Systemname
Integrator’s Reference Manual for the VSX Series systemname Sets or gets the name of the VSX system. Syntax systemname get systemname set “system name” Parameter “system name” Feedback Examples • • Comments The first character must be a numeric (a digit) or alphabetic (a letter) character including foreign language characters.
Page 337: Tcpports
tcpports Sets or gets the TCP ports on the VSX system. Syntax tcpports get tcpports set [{1024..49150}] Parameter Feedback Examples tcpports 3233 Comments The Fixed Ports option on the same page must be selected for the TCP Ports option to be available. User interface screen location: System >...
Page 338: Techsupport
1 512 555 1212 Comments The Support icon is visible only when the system is registered with the Polycom Global Management System. User interface screen location: On the remote control press the button and select Support...
Page 339: Teleareacode
User interface screen location: System > Admin Settings > Network > Telephony Description Returns the current setting. Sets the telephone number when followed by the “telephone_area_code” parameter. To erase the current setting, omit the parameter. System’s area code. System Commands...
Page 340: Telecountrycode
> Location: Country Code 4 - 264 Description Returns the country code information. Sets the telephone country code when followed by the “telephone_country_code” parameter. To erase the current setting, omit the parameter. Numeric value. This code is the same as the ISDN...
Page 341: Telenumber
User interface screen location: System > Admin Settings > Network > Telephony: Room Telephone Number Description Returns the current setting. Sets the telephone number when followed by the “telephone number” parameter. To erase the current setting, omit the parameter. System’s telephone number. Enclose the string in quotation marks if it includes spaces.
Page 342: Telnetmonitor
Integrator’s Reference Manual for the VSX Series telnetmonitor Sets or gets the state of Telnet session monitoring. When Telnet monitoring is enabled, you can view all communication to and from the Telnet port 24 session as output to Telnet port 23. Syntax telnetmonitor get telnetmonitor <on|off>...
Page 343: Timediffgmt
timediffgmt Sets or gets the time difference from where the system is installed and Greenwich Mean Time (GMT). This allows the Global Management System to view the local time of the managed system. Syntax timediffgmt <get|{-12:00..+12:00}> Parameter {-12:00..+12:00} Feedback Examples timediffgmt -06:00 Comments User interface screen location: System >...
Page 344: Traceroute
IP address entered. Syntax traceroute host [hops] Parameter host hops Feedback Examples ->traceroute polycom.com hostname polycom.com (207.171.166.102) testlan traceroute complete. 29 hops. Comments User interface screen location: System > Diagnostics > Network > Trace Route 4 - 268 Description Specifies host name or an IP address.
Page 345: Typeofservice
typeofservice Sets or gets the type of service for Quality of Service. Syntax typeofservice <get|ipprecedence|diffserv> Parameter ipprecedence diffserv Feedback Examples typeofservice diffserv Comments User interface screen location: System > Admin Settings > Network > IP > Quality of Service See Also See the See the page 4-69.
Page 346: Udpports
Integrator’s Reference Manual for the VSX Series udpports Sets or gets the UDP ports on the VSX system. Syntax udpports get udpports set [{1024..49150}] Parameter Feedback Examples udpports set 3230 returns udpports 3230 Comments The Fixed Ports option on the same page must be selected for the UDP Ports option to be available.
Page 347: Unregisterall
System Commands unregisterall Alias for the all unregister command. Syntax unregisterall Command History Introduced in version 8.5. See Also This command is an alias for the preferred command on all unregister page 4-14. To register for user feedback, use the command on page 4-12 or all register command on page 4-214.
Page 348: Usefixedports
Integrator’s Reference Manual for the VSX Series usefixedports Sets or gets the Fixed Ports configuration. Syntax usefixedports <get|yes|no> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > IP > Firewall: Fixed Ports 4 - 272 Description Returns the current setting.
Page 349: Usegatekeeper
usegatekeeper Sets or gets the gatekeeper mode (off, specify, or auto). Syntax usegatekeeper <get|off|specify|auto> Parameter specify auto Feedback Examples usegatekeeper auto Comments User interface screen location: System > Admin Settings > Network > IP > H.323 Settings (page 2): Use Gatekeeper See Also See the Description...
Page 350: Usepathnavigator
Integrator’s Reference Manual for the VSX Series usepathnavigator Sets or gets the Polycom PathNavigator™ mode, if PathNavigator is used with the system. Syntax usepathnavigator <get|always|never|required> Parameter always never required Feedback Examples • • • Comments This option is only accessible if PathNavigator is used.
Page 351: Useroompassword
useroompassword Sets or gets the Use Room Password for Remote Access setting. Syntax useroompassword get useroompassword <no|yes> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > General Settings > Security: Use Room Password for Remote Access Command History Introduced in version 8.5.
Page 352: V35Broadcastmode
Integrator’s Reference Manual for the VSX Series v35broadcastmode Sets or gets the V.35 broadcast mode. This command is only applicable if you have a V.35 network interface connected to your system. Syntax v35broadcastmode <get|on|off> Parameter Feedback Examples • • Command History Introduced in version 8.5.
Page 353: V35Dialingprotocol
v35dialingprotocol Sets or gets the V.35 dialing protocol. This command is only applicable if you have a V.35 network interface connected to your system. Syntax v35dialingprotocol <get|rs366> Parameter rs366 Feedback Examples v35dialingprotocol rs-366 Comments Selecting a dialing protocol is not needed if you are using your DCE to dial the call or if you have a dedicated connection to the far site.
Page 354: V35Num
Integrator’s Reference Manual for the VSX Series v35num Sets or gets the ISDN video numbers assigned to the system. This command is only applicable if you have a V.35 network interface connected to your Syntax v35num get <1b1|1b2> v35num set <1b1|1b2> ["v35 number"] Parameter 1b1|1b2 “v35 number”...
Page 355: V35Portsused
v35portsused Sets or gets the number of ports to use on the V.35/RS-449/RS-530 network interface module. Syntax v35portsused <get|1|1+2> Parameter Feedback Examples • • Comments User interface screen location: System > Admin Settings > Network > V.35/RS-449/RS-530: V.35 Ports Used Description Returns the current setting.
Page 356: V35Prefix
Integrator’s Reference Manual for the VSX Series v35prefix Sets or gets the V.35 dialing prefix. It assumes that a profile has already been selected. Syntax v35prefix get “valid speed” v35prefix set “valid speed” [“value”] Parameter “valid speed” “value” Feedback Examples •...
Page 357: V35Profile
v35profile Sets or gets a V.35 profile associated with dialing through a DCE. It can also display all the settings (speed, prefix or suffix) of the current profile. Syntax v35profile <get|adtran|adtran_isu512|ascend|ascend_vsx|ascend_max|avaya_mcu| custom_1|fvc.com|initia|lucent_mcu|madge_teleos> Parameter adtran|adtran_isu512| ascend|ascend_vsx| ascend_max|avaya_mcu| custom_1|fvc.com| initia|lucent_mcu| madge_teleos Feedback Examples •...
Page 358: V35Suffix
Integrator’s Reference Manual for the VSX Series v35suffix Sets or gets the V.35 dialing suffix. It assumes that a profile has already been selected. Syntax v35suffix get “valid speed” v35suffix set “valid speed” [“value”] Parameter “valid speed” “value” Feedback Examples •...
Page 359: Validateacctnum
validateacctnum Sets or gets the validation for the Global Management System account number that is used when dialing out. Syntax validateacctnum <get|yes|no> Parameter Feedback Examples • • Comments When the call connects, the VSX system verifies that the account exists with the Global Management System server.
Page 360: Vcbutton
Integrator’s Reference Manual for the VSX Series vcbutton Simulates the Visual Concert VSX play and stop buttons. It can also register or unregister to receive notification of Visual Concert VSX events. Syntax vcbutton <get|play|stop|register|unregister> Parameter play stop register unregister Feedback Examples •...
Page 361: Vcrrecordsource
vcrrecordsource Sets or gets the VCR record source. Syntax vcrrecordsource get vcrrecordsource <near|far|auto|content|content-or-near| content-or-far|content-or-auto|none> Parameter near auto content content-or-near content-or-far content-or-auto none Feedback Examples • • • Comments If Monitor 2 is enabled, VCR Record Source is automatically set to the Monitor 1 image and cannot be configured.
Page 362: Vcstream
Integrator’s Reference Manual for the VSX Series vcstream Gets the current state of the Visual Concert VSX stream, or registers or unregisters for notification of state changes in the stream. Syntax vcstream <state|register|unregister> Parameter state register unregister Feedback Examples • •...
Page 363: Version
System Commands version Returns the current VSX system’s version information. Syntax version Feedback Examples version "Release 8.5 12jul2006 06:09" Comments User interface screen location: System > System Information: System Software 4 - 287...
Page 364: Videocallorder
Integrator’s Reference Manual for the VSX Series videocallorder Sets the video call order of the specified protocol to the specified slot. Syntax videocallorder <isdn|h323|sip> <1|2|3> Parameter isdn h323 1|2|3 Feedback Examples videocallorder h323 1 Comments User interface screen location: System > Admin Settings > Network > Call Preference (page 2): Dialing Order Command History Introduced in version 8.5.
Page 365: Voicecallorder
voicecallorder Sets the voice call order of the specified protocol to the specified slot. Syntax voicecallorder <pots|voice|vtx> <1|2|3> Parameter pots voice 1|2|3 Feedback Examples voicecallorder pots 2 Comments User interface screen location: System > Admin Settings > Network > Call Preference (page 2): Dialing Order Command History Introduced in version 8.5.
Page 366: Volume
Integrator’s Reference Manual for the VSX Series volume Sets or gets the call audio volume (not sound effects) on the VSX system or registration for volume changes. Syntax volume <register|unregister> volume <get|up|down|set {0..50}> Parameter register unregister down Feedback Examples • •...
Page 367: Vortex
Vortex Sends commands to a Polycom Vortex mixer. Syntax vortex <0|1> mute <on|off> vortex <0|1> forward “vortex_macro” Parameter mute forward “vortex_macro” Feedback Examples The response from the Vortex is displayed in the following form: vortex <portnum> forward <vortexcmd>:<vortexresponse> • •...
Page 368: Waitfor
Integrator’s Reference Manual for the VSX Series waitfor This command is used within script files or control panel programs to wait for a specific event before executing the next statement. It causes the API session to wait until a call being placed either connects or fails, or until system is ready to place a call (such as after a reboot waiting for the ISDN lines to come up).
Page 369: Wake
System Commands wake Wakes the system from sleep mode. Syntax wake Feedback Examples wake See Also To put the system in sleep mode, use the command on page 4-235. sleep 4 - 293...
Page 370: Wanipaddress
Integrator’s Reference Manual for the VSX Series wanipaddress Sets or gets the WAN IP address. Syntax wanipaddress get wanipaddress set [“xxx.xxx.xxx.xxx”] Parameter “xxx.xxx.xxx.xxx” Feedback Examples wanipaddress set 192.168.1.122 returns wanipaddress 192.168.1.122 Comments The NAT Configuration option on the same page must be set to Auto, Manual, or UPnP for this option to be available.
Page 371: Webport
webport Sets or gets the port to use when accessing the system using VSX Web. Syntax webport get webport set “port” Parameter Feedback Examples webport set 80 returns webaccessport 80 restart system for changes to take effect. Comments If you change this from the default (port 80), you will need to include the port number with the IP address when you use VSX Web to access the system.
Page 372: Whoami
Main Processor: BSP15 v0.0 ~ Core/Mem Clks 405/135 Time In Last Call: 0:00:00 Total Time In Calls: 58:17:10 Total Calls: 81 SNTP Time Service: auto insync ntp1.polycom.com Local Time is: Tue, 20 Jul 2004 17:16:41 -0500 Network Interface: ISDN_QUAD_BRI IP Video Number: 216.54.150.47 ISDN Video Number: 1.
Page 373: Winsresolution
winsresolution Sets or gets WINS resolution. Syntax winsresolution <get|yes|no> Parameter Feedback Examples winsresolution yes restart system for changes to take effect. restart now? <y,n> Comments After making a change, you are prompted to restart the system. User interface screen location: System > Admin Settings > LAN Properties (page 2): WINS Resolution Description Returns the current setting.
Page 374: Winsserver
Integrator’s Reference Manual for the VSX Series winsserver Sets or gets the WINS server. Syntax winsserver get winsserver set ["xxx.xxx.xxx.xxx"] Parameter “xxx.xxx.xxx.xxx” Feedback Examples winsserver set xxx.xxx.xxx.xxx returns winsserver xxx.xxx.xxx.xxx restart system for changes to take effect. Comments This option is only available if IP Address is set to Enter IP address manually on the LAN Properties screen.
Page 375: Xmladvnetstats
Gets advanced network statistics in xml for each call. Syntax xmladvnetstats [{0..n}] Parameter {0..n} Feedback Examples xmladvnetstats might return <ADVANCED><CONFERENCE id="0"/><CONNECTION id="1"><FARSITENAME>A</FARSITENAME><FARSITENUMBER>216.54.150.82</FAR SITENUMBER><FARSITESYSTEM>Polycom/V500/Release 7.0 - 11Jun2004 04:28</FARSITESYSTEM><CALLTYPE>h323</CALLTYPE><TRANSMIT><AUDIORATE>4 8 K</AUDIORATE><VIDEORATE>464 K</VIDEORATE><VIDEORATEUSED>199 K</VIDEORATEUSED><VIDEOFRAMERATE>30.2</VIDEOFRAMERATE><VIDEOPACKETLO SS>0</VIDEOPACKETLOSS><VIDEOJITTER>3 mS</VIDEOJITTER><AUDIOPACKETLOSS>0</AUDIOPACKETLOSS><AUDIOJITTER>0 mS</AUDIOJITTER><LSDPROTOCOL>---</LSDPROTOCOL><LSDRATE>---</LSDRATE> <MLPPROTOCOL>---</MLPPROTOCOL><MLPRATE>---</MLPRATE></TRANSMIT><RECE IVE><AUDIORATE>48 K</AUDIORATE><VIDEORATE>464 K</VIDEORATE><VIDEORATEUSED>114 K</VIDEORATEUSED><VIDEOFRAMERATE>29.8</VIDEOFRAMERATE><VIDEOPACKETLO SS>0</VIDEOPACKETLOSS><VIDEOJITTER>5...
Page 376: Xmlnetstats
Integrator’s Reference Manual for the VSX Series xmlnetstats Gets network statistics in xml for each call. Syntax xmlnetstats [{0..n}] Parameter {0..n} Feedback Examples xmlnetstats might return <NETWORK><CONFERENCE id="0"/><CONNECTION id="1"><FARSITENAME>A</FARSITENAME><FARSITENUMBER>216.54.150.82</FAR SITENUMBER><FARSITESYSTEM>Polycom/V500/Release 7.0 - 11Jun2004 04:28</FARSITESYSTEM><CALLTYPE>h323</CALLTYPE><TRANSMIT><CALLSPEED>5 K</CALLSPEED><B2CALLSPEED>---</B2CALLSPEED><TOTPACKETLOSS>0</TOTPACK ETLOSS><PERCENTPACKETLOSS>0.0 %</PERCENTPACKETLOSS><VIDEOPROTOCOL>H.264</VIDEOPROTOCOL><VIDEOANNEX>- --</VIDEOANNEX><VIDEOFORMAT>SIF</VIDEOFORMAT><AUDIOPROTOCOL>Siren14< /AUDIOPROTOCOL></TRANSMIT><RECEIVE><CALLSPEED>512 K</CALLSPEED><B2CALLSPEED>---</B2CALLSPEED><TOTPACKETLOSS>0</TOTPACK ETLOSS><PERCENTPACKETLOSS>0.0 %</PERCENTPACKETLOSS><VIDEOPROTOCOL>H.264</VIDEOPROTOCOL><VIDEOANNEX >---</VIDEOANNEX><VIDEOFORMAT>SIF</VIDEOFORMAT><AUDIOPROTOCOL>Siren1 4</AUDIOPROTOCOL>...
Page 377: A Room Design And Layout
Room Design and Layout Reprinted from the Basics of Audio and Visual Systems Design: Revised Edition, Chapter 12, “Videoconferencing” written by Scott Sharer, CTS, and Jim Smith, CVE, CTS, copyright 2003, with permission of InfoComm International® www.infocomm.org For clarity of discussion, we have divided this section into the following sub-sections: •...
Page 378 Integrator’s Reference Manual for the VSX Series It is here that we have our first conflict. In videoconferencing we have to consider not only the issues related to local viewing and hearing but also the issues of being seen and heard by people at the far-end of the connection. This means that we must consider sight lines and angles of participant interaction that go beyond traditional presentation environments.
Page 379: Walls
with people at the far-end of any connection. In short, we must always ask ourselves, “What does this look like and sound like to the people at the farend?” In order to guarantee that the final conference environment will have a solid foundation, we begin with the construction of the walls, floors and ceilings for videoconference spaces.
Page 380: Ceiling Tiles
Integrator’s Reference Manual for the VSX Series Ceiling Tiles These should be high-quality acoustic tiles, ideally 1”- thick compressed densecore fiberglass. An added benefit of this kind of ceiling tile is that it works well with the indirect lighting as specified elsewhere in this section. To reduce any extraneous noise from leaving or entering the room via the ceiling space, the ceiling tiles can be blanketed completely from the plenum side, with a minimum of 6”- thick unfaced dense fiberglass batting or mineral rock wool,...
Page 381: Interior Design And Finishes
Interior Design and Finishes Wall colors within the field of view of the camera have a significant impact on the far-end perception of the room video quality. Certain colors are better suited to video rooms than others. The electronics and software of the videoconferencing system “builds”...
Page 382: Room Lighting
Integrator’s Reference Manual for the VSX Series ambient noise level). A room built to the description found elsewhere in this section will usually fall between NC-30 and NC-35. The actual NC value is not critical; what is important is that the room be built with the intent and care required to achieve the low noise rating.
Page 383: Light Fixtures
Room Design and Layout only 2’ or 3’ from nearest in-focus to furthest in-focus. With bright light (70fc or more) the range of in-focus objects can more than double. Participants at the far-end will see more people in sharp focus, and the codec will have an easier time encoding the image.
Page 384: Room Preparation Conclusion
Integrator’s Reference Manual for the VSX Series It is important to remember that the use of traditional meeting room downcans—even those that have color-corrected light sources—for any lighting in the field of view that may include human faces is to be avoided at all costs.
Page 385 Room Design and Layout As an example, we will work with a room having an ambient noise level of approximately 60dBA-SPL. A person speaking in a normal voice is 72dBA-SPL at about 2’ distance. At 4’ the loudness drops to approximately 66dBA-SPL. This already is farther than the critical distance criteria allow, given the ambient noise level.
Page 386: Audio Output
Integrator’s Reference Manual for the VSX Series Audio Output For conference communication we do not really care about producing the thundering roar of jet aircraft engines, or other sounds reproduced on TV or in the movies. We are interested in reproducing the human voice. The tone, intonation, pitch and level of people speaking from the far-end should sound as much as possible like the sound they would make if they were speaking in the room.
Page 387: Range/Frequency Response
delays)—will be recognized by the echo canceller as “new audio information,” and it will send those distortions to the far-end, perhaps wreaking havoc on the system audio quality. In short, speaker power should be matched to overall audio subsystem power. The speakers should provide adequate coverage and be able to present approximately 80 to 85dBA-SPL (continuous) at the local site with the system operating at nominal power utilization, and have a peak reserve of 15 to 20dB before distortion.
Page 388: Video Projection For Use In Videoconference
Integrator’s Reference Manual for the VSX Series Video Projection for Use in Videoconference Many installations make use of video projection devices. The most important thing to remember in the planning of video projection for a videoconference space is that front projection is vastly inferior to rear projection. Front projection systems are less expensive and easier to implement, but the conflicting interest between the camera and the projection display makes this form of display a very poor choice.
Page 389: Room Control Elements
Room Design and Layout wish to “show” or “view” must be translated to video, most often with some sort of camera mechanism. Document cameras, 35mm slide-to-video units, video scanners and scan conversion devices all are designed to take one format of source material and convert it to a standard video signal that can be digitized, shipped to the far-end(s), and converted back to composite video for display.
Page 390 Integrator’s Reference Manual for the VSX Series A - 14...
Page 391: B Categorical List Of Api Commands
Categorical List of API Commands The commands are categorized into these sections: • • • • • • • • • • • • • • API Utility Commands Audio Commands Call Commands Cameras, Content, and Monitors Commands Diagnostics and Statistics Commands Global Services Commands Home Screen Setting Commands Local Directory Commands...
Page 392: Api Utility Commands
Integrator’s Reference Manual for the VSX Series API Utility Commands • button on page 4-31 • dir on page 4-70 • displayparams on page • echo on page 4-85 • exit on page 4-93 • get screen on page • help on page 4-132 •...
Page 393: Call Commands
Call Commands • allowmixedcalls on page • answer on page • autoanswer on page • basicmode on page • calldetailreport on page • callpreference on page • chaircontrol on page • contentauto on page • dial on page 4-64 • dialchannels on page •...
Page 394: Diagnostics And Statistics Commands
Integrator’s Reference Manual for the VSX Series Diagnostics and Statistics Commands • advnetstats on page • audiometer on page • calldetail on page • callinfo on page • callstate on page • colorbar on page • generatetone on page • getcallstate on page •...
Page 395 Local Directory Commands • abk on page • allowabkchanges on page • confirmdiradd on page Network Commands IP Commands • callpreference on page • defaultgateway on page • dhcp on page 4-63 • diffservaudio, diffservfecc, diffservvideo on page 4-69 • displayipext on page •...
Page 396 Integrator’s Reference Manual for the VSX Series ISDN Commands The following commands are only applicable if you have an ISDN network interface connected to your system • bri1enable, bri2enable, bri3enable, bri4enable on page 4-29 • briallenable on page • callpreference on page •...
Page 397 Notification Commands • all register on page • all unregister on page • button on page 4-31 • callstate on page • configchange on page • linestate on page • listen on page 4-155 Security and Permissions Commands • adminpassword on page •...
Page 398 Integrator’s Reference Manual for the VSX Series Systems Settings Commands • colorscheme on page • country on page • daylightsavings on page • dialingdisplay on page • displayipext on page • displayparams on page • farnametimedisplay on page • keypadaudioconf on page •...
Page 399: C Commands That Prompt Restart
Commands that Prompt Restart The following commands return a prompt to restart the VSX system. callpreference h320|h323|both configdisplay monitor1 vga|s_video defaultgateway set dhcp off|client|server dns set hostname set ipaddress set lanport reboot yes subnetmask set webport set winsresolution yes|no winsserver set The restart prompt is restart system for changes to take effect.
Page 400 Integrator’s Reference Manual for the VSX Series C - 2...
Page 401: Commands Introduced In Version 8.5
API Changes in This Version The following changes have been made to the API for version 8.5 of the VSX system software. Commands Introduced in Version 8.5 • • • • • • • • • • • • • •...
Page 402: Commands Deprecated In Version 8.5
Integrator’s Reference Manual for the VSX Series • • • • • • • Commands Deprecated in Version 8.5 • callencryption on page • display on page • monitor1 on page D - 2 secondarycallchoice command on page telnetmonitor command on page unregisterall command on page useroompassword...
Page 403: E Status Messages
Status Messages Status Display The call status can be displayed in a number of ways. The command on page 4-113 returns a table listing the status, speed, and dialed number of current calls. To display real-time status on individual B channels (incoming or outgoing calls), either register the API session with the page 4-39, or start an outbound call with the These two commands will cause the system to re-direct the B channel status...
Page 404 Integrator’s Reference Manual for the VSX Series Example: ->dial man 384 5551212 ISDN Dialing manual Dialing 5551212 384 none ISDN cs: call[0] chan[0] dialstr[95551212] state[RINGING] cs: call[0] chan[0] dialstr[95551212] state[CONNECTED] 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]...
Page 405 Status Messages -> listen video listen video registered -> ->listen video ringing // there is an incoming call, auto answer is on ->cs: call[0] chan[0] dialstr[8005551212] state[RINGING] cs: call[0] chan[0] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[0] dialstr[8005551212] state[BONDING] cs: call[0] chan[0] dialstr[8005551212] state[COMPLETE] cs: call[0] chan[1] dialstr[8005551212] state[RINGING] cs: call[0] chan[1] dialstr[8005551212] state[CONNECTED] cs: call[0] chan[2] dialstr[8005551212] state[RINGING]...
Page 406 Integrator’s Reference Manual for the VSX Series E - 4...
Page 407 IR Codes for Non-Polycom Remotes This appendix provides information about the IR signals for VSX systems. This information is provided for reference only. Polycom claims no responsibility or liability for programmed third-party remote control devices. Notes • • • •...
Page 408 Integrator’s Reference Manual for the VSX Series Button/Signal Auto Call Call/Hang Up Colon Delete Dial String Directory Down Arrow Feet Down Feet Up Hang Up Home Info (Help) Keyboard Left Arrow Low Battery Menu (Back) Mute Near Option F - 2 Binary Code Hex Code 110100...
Page 409 Right Arrow 001010 Slides (Graphics) 010010 Snapshot (Snap) 010101 Up Arrow 000101 Volume Down 111100 Volume Up 111011 Zoom In 001101 Zoom Out 001110 IR Codes for Non-Polycom Remotes Hex Code Parity Even Even Even Even Even F - 3...
Page 410 Integrator’s Reference Manual for the VSX Series F - 4...
Page 411 Index Symbols ! command 4-3 abk command 4-4 account number command for requiring 4-220 command for setting 4-233 command for validating 4-283 adapters null modem 2-37 RS-232 2-20 S-Video to BNC 2-11 S-Video to RCA 2-22 V.35/RS-449/RS-530 2-4 addressdisplayedingab command 4-6 adminpassword command 4-7 advnetstats command 4-8 alertusertone command 4-10...
Page 412 Integrator’s Reference Manual for the VSX Series cables analog telephone 2-3 audio 2-25 BRI 2-2 composite video 2-14 conference link 2-23 ImageShare II 2-39 ISDN 2-2 LAN 2-1 null modem 2-36 plenum-rated CAT5 adapters 1-5 POTS 2-3 PowerCam break-out 2-17...
Page 413 dialchannels command 4-66 dialing command for allowing 4-16, 4-17 command for RS-366 4-225 dialing order command for primary choice 4-206 command for secondary choice 4-231 command for video calls 4-288 command for voice calls 4-289 dialing prefix command for PRI international 4-203 command for V.35 4-280 dialing speed command for IP 4-141...
Page 414 Integrator’s Reference Manual for the VSX Series gendialtonepots command 4-110 generatetone command 4-111 get screen command 4-112 getcallstate command 4-113 global directory displaying address in 4-6 maximum call speed 4-158, 4-159, 4-160 returning entries 4-97 global services commands B-4 command for email 4-115 command for support number 4-121 gmscity command 4-114 gmscontactemail command 4-115...
Page 415 localdatetime command 4-156 marqueedisplaytext command 4-157 maxgabinternationalcallspeed command 4-158 maxgabinternetcallspeed command 4-159 maxgabisdncallspeed command 4-160 maxtimeincall command 4-161 mcupassword command 4-162 meetingpassword command 4-163 microphone cable 2-23, 2-24 midrangespeaker command 4-164 monitor command for graphics 4-123 command for split-screen 4-82 content presentation 4-52 monitor commands B-3 monitor1 command 4-165...
Page 416 Integrator’s Reference Manual for the VSX Series PowerCam Plus connecting as main camera 1-13–1-14 primary cable 2-15 presentation mode, command for multipoint display 4-170 preset command 4-196 PRI cable 2-2 PRI channel information 4-199 PRI port assignments 2-2 priareacode command 4-197 pricallbycall command 4-198 prichannel command 4-199 pricsu command 4-201...
Page 417 snmpsystemdescription command 4-243 Sony cameras, connecting 1-17 soundeffectsvolume command 4-244 SoundStation VTX 1000 cable 2-29, 2-30 configuration with VSX system 1-20 connecting 1-18 speaker test, command for 4-111 speed, command for video stream 4-254 spidnum command 4-245 st command 4-246 statistics command for advanced network 4-8 command for advanced network in XML 4-299...
Page 418 Integrator’s Reference Manual for the VSX Series video protocol, command for H.331 calls 4-130 videocallorder command 4-288 VISCA cable 2-18 Visual Concert cable 2-23, 2-24, 2-30, 2-38 command for controlling 4-284 command for stream 4-286 voicecallorder command 4-289 volume command for subwoofer 4-258 volume command 4-290 Vortex cable 2-26, 2-28...

This manual is also suitable for:

Vsx 6000 Vsx7000 Vsx 7000e Vsx 8000 Vsx 7000 Vsx 6000a ... Show all

Polycom VSX3000 Integrator's Reference Manual

1 Room Integration

2 Cables

3 Using the API

4 System Commands

Quick Links

Related Manuals for Polycom VSX3000

Summary of Contents for Polycom VSX3000