Page 1 Integrator’s Reference Manual for Polycom HDX Systems Version 1.0 December 2006 Edition 3725-23979-001/A Version 1.0...
Page 2 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 Audio Cables ............2-29 Polycom HDX Microphone Array Cable ......2-29 Polycom HDX Microphone Array Cable Adapter .
Page 5 Contents backlightcompensation ..........4-20 basicmode .
Page 6 Integrator’s Reference Manual for Polycom HDX Systems dynamicbandwidth ........... 4-73 e164ext .
Page 7 Contents history ............. . 4-119 homecallquality .
Page 8 Integrator’s Reference Manual for Polycom HDX Systems notify ............. . . 4-165 ntpmode .
Page 9 Contents snmplocation ............4-215 snmpsystemdescription .
Page 10 Integrator’s Reference Manual for Polycom HDX Systems Air Conditioning ..........A-4 Interior Design and Finishes .
Page 11: Room Integration
A-1. Room Layout Examples Use the following diagrams as examples for setting up a conference room with Polycom® HDX systems. Polycom recommends that you contract an experienced contractor to assure all the components operate as a single cohesive system.
Page 12 Integrator’s Reference Manual for Polycom HDX Systems Large Conference Room Document Camera Acoustic Panels Polycom Microphone Polycom HDX system and Eagle Eye camera Flat Panel Flat Panel Monitor 1 Monitor 2 Network Outlets Media Center Power Outlets 1 - 2...
Page 13: Setting Up The Room For People On Content
For the best results, follow these guidelines for setting up People On Content™: • Use the Polycom Eagle Eye camera. • Create a flat, consistent background color using a screen or matte-finish paint in green or blue. Make sure the background does not have shadows or glare.
Page 14: Integrating Video
Integrating Video The following sections describe how to connect cameras to Polycom HDX systems. After you connect a camera to a Polycom HDX system, refer to the Administrator’s Guide for Polycom HDX Systems for information about configuring the camera options in the user interface.
Page 15: Connecting Polycom Cameras
Room Integration Connecting Polycom Cameras You can connect Polycom HDX systems to a Polycom Eagle Eye, 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 16 Integrator’s Reference Manual for Polycom HDX Systems PowerCam as the Main Camera up to 10 ft Away You can connect a PowerCam (part number 2215-50370-001) to a Polycom HDX system as the main camera up to 10 ft away using: •...
Page 17 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 Polycom HDX system as the second camera using: • A—PowerCam Break-Out cable shown on page 2-25 •...
Page 18 Integrator’s Reference Manual for Polycom HDX Systems You can connect a PowerCam (part number 2215-50370-001) to a Polycom HDX system as the third camera using: • A—PowerCam Break-Out cable shown on page 2-25 B—8-pin mini-DIN to DB-9 cable shown on page 2-27 •...
Page 19 Room Integration PowerCam Plus as the Main Camera up to 10’ Away You can connect a PowerCam Plus (part number 2215-50200-001) to a Polycom HDX system as the main camera up to 10 ft away using: • A—PowerCam Plus Primary cable shown on page 2-20 •...
Page 20: 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 Polycom HDX system as the main or second camera: You can connect a Sony or ELMO PTZ camera to a Polycom HDX system using: •...
Page 21: Integrating Audio
Polycom Vortex® mixer integration. InstantDesigner resolves many common issues with connections and configuration settings. To use a Polycom HDX system with audio input from a Vortex mixer, set the Input Type to Line Input and disable Echo Canceller. Connecting a Polycom HDX System to a Vortex Mixer...
Page 22 Integrator’s Reference Manual for Polycom HDX Systems 1 - 12...
Page 23: Cables
Network Cables CAT 5e LAN Cable This cable connects a Polycom HDX system to the LAN. It has orange RJ-45 connectors on both ends. It meets category 5e requirements and is wired according to EIA/TIA-568B. The maximum approved length for this cable is 100 ft (30 m) on an 802 network.
Page 24: Isdn Cable
Integrator’s Reference Manual for Polycom HDX Systems ISDN Cable This cable connects a Polycom HDX system to a BRI or PRI line. It has clear RJ-45 connectors on both ends and is used with all Polycom HDX systems that have ISDN capability. The maximum approved length for this cable is 50 ft (15 m).
Page 25: Analog Telephone (Pots) Cable
Cables Analog Telephone (POTS) Cable This cable connects a Polycom HDX system to an analog telephone line. It has pink RJ-11 connectors on both ends. The maximum approved length for this cable is 100 ft (30 m). Length Part Number RoHS Compliant 12 ft (3.6 m)
Page 26: V.35/Rs-449/Rs-530 Serial Adapter
#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 27: V.35 Nic Cable
V.35/RS-449/RS-530 serial adapter on page to connect to network equipment that has the HD-44 pin interface. It has HD-44 M connectors on both ends and is used with Polycom HDX systems that have a serial network interface card (NIC) installed. Length...
Page 28: V.35 And Rs-366 Serial Cable
2457-10609-001 — 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 29: Rs-449 And Rs-366 Serial Cable
2457-10610-001 — 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 30: Rs-530 With Rs-366 Serial Cable
It is used with the V.35/RS-449/RS-530 serial adapter on page to connect to network equipment that has an RS-530/RS-366 interface. It is HD-68M to “Y” DB-25M and is used with Polycom HDX systems that have a serial network interface card (NIC) installed. Length...
Page 31: Video And Camera Cables
Video and Camera Cables S-Video Cable These cables connect a Polycom HDX system to a monitor or camera. They have yellow 4-pin mini-DIN connectors on both ends and are used with all Polycom HDX systems. The maximum approved length for this cable is 200 ft (60 m).
Page 32: Bnc To S-Video Cable
Integrator’s Reference Manual for Polycom HDX Systems BNC to S-Video Cable This cable connects S-Video devices to a Polycom HDX system. It is 4-pin male mini-DIN to dual BNC. The maximum approved length for this cable is 100 ft (30 m).
Page 33: Bnc To S-Video Adapter
2457-21490-200 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 34: Dvi To Vga Monitor Cable
Integrator’s Reference Manual for Polycom HDX Systems DVI to VGA Monitor Cable This cable connects a Polycom HDX system DVI-I output to a VGA monitor. It can also be used to connect a computer to one of the DVI-I video inputs on a Polycom HDX system.
Page 35: Hdmi Monitor Cable
9 ft 10 in (3 m) 2457-23905-001 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: Bnc Monitor Adapter Cable
Integrator’s Reference Manual for Polycom HDX Systems BNC Monitor Adapter Cable This cable connects the Polycom HDX system DVI-I output to a variety of analog display devices with composite, S-Video, component YPbPr, or RGBHV inputs. It is male DVI-A to five female BNC connectors.
Page 37: Dvi-D Monitor Cable
Cables DVI-D Monitor Cable This cable connects a Polycom HDX system DVI-I output to a DVI-D monitor. It is male DVI-D on both ends. Length Part Number RoHS Compliant 9 ft 10 in (3 m) 2457-23793-001 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 38: Hdci Analog Camera Cable
Integrator’s Reference Manual for Polycom HDX Systems HDCI Analog Camera Cable This cable connects a Polycom HDX system to a Polycom Eagle Eye camera. It has male HDCI connectors on both ends. Length Part Number RoHS Compliant 9 ft 10 in (3 m)
Page 39: Hdci Camera Break-Out Cable
1ft (0.3 m) 2457-23521-001 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: Vcr/Dvd Composite Cable
Integrator’s Reference Manual for Polycom HDX Systems VCR/DVD Composite Cable This cable connects a Polycom HDX system to a VCR or DVD player. It has triple RCA connectors on both ends. The Polycom HDX system requires a female RCA to male BNC adapter for the yellow video RCA connector, and the Audio Adapter Cable on page 2-34.
Page 41: Composite Video Cable
Cables Composite Video Cable This cable connects a Polycom HDX system to a monitor or camera. It has single yellow RCA connectors on both ends. The Polycom HDX system requires a female RCA to male BNC adapter in order to connect to composite input or output.
Page 42: Powercam Plus Primary Cable
Chroma Chroma 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: Hdci Powercam Plus Adapter Cable
1 ft (0.3 m) 2457-23481-001 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: Hdci Visca Adapter Cable
Integrator’s Reference Manual for Polycom HDX Systems HDCI VISCA Adapter Cable This cable connects a Polycom HDX system HDCI video input to SD cameras with VISCA control. It is HDCI to 4-pin mini-DIN and DB-9. Standard S-Video and DB-9 serial cables are required to connect this cable to the camera.
Page 45: Hdci Sony Visca Adapter Cable
Cables HDCI Sony VISCA Adapter Cable This cable connects a Polycom HDX system HDCI video input to a camera using Sony 8-pin mini DIN VISCA and S-Video. It is HDCI to 8-pin mini-DIN and S-Video. Standard S-Video and Sony VISCA cables are required to connect this cable to the camera.
Page 46: Powercam Primary Camera Cable
Integrator’s Reference Manual for Polycom HDX Systems PowerCam Primary Camera Cable This cable connects the Polycom HDX system video input 1 to a Polycom PowerCam camera up to 10 ft away when used with the HDCI PowerCam Plus Adapter cable on page 2-21. It is 8-pin mini-DIN to 4-pin mini-DIN and DB-15.
Page 47: Powercam Break-Out Cable
Female 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 48: Powercam Plus/Visca Control Cable
SHIELD SHIELD 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 49 2457-21259-001 — 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
Integrator’s Reference Manual for Polycom HDX Systems PowerCam/VISCA Control Cable This cable connects a Polycom HDX system to a camera VISCA port (via the HDCI Sony VISCA Adapter Cable on page 2-23), or to the PowerCam Break-Out Cable on page 2-25. It has 8-pin mini-DIN male connectors on both ends.
Page 51: Audio Cables
2457-23215-001 BROWN HEAT-SHRINK TUBING 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: Polycom Hdx Microphone Array Cable Adapter
Polycom HDX Microphone Cable Adapter Polycom HDX Microphone Cables 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 53: Custom Cabling For Polycom Hdx Microphones
Cables Custom Cabling for Polycom HDX Microphones You can create a custom-length cable from the Polycom HDX system to the Polycom HDX microphone. Start with the microphone cable (2457-23216-001), and cut off the P1 end. Using the wiring tables shown, create a custom cable from the microphone to a wall plate or other interfacing device.
Page 54 Integrator’s Reference Manual for Polycom HDX Systems 1. Identify the P1 connector on the Polycom HDX microphone cable according to the location of the brown heat-shrink tubing as shown on page 2-29. Remove the P1 connector and skip to step 4. If you cannot identify the P1 connector, remove either connector from the cable and continue with step 2.
Page 55 RJ-45 panel coupler kit (L-com ECF504-SC5E or equivalent) P2- RJ-45 shielded plug, Tyco 5-569552 or equivalent The Polycom RJ-45 connector pinout is custom. For best performance, follow the wiring tables shown in this document. If standard Ethernet cables are used, signal integrity cannot be guaranteed and degraded performance may occur, especially at longer lengths.
Page 56: Audio Adapter Cable
1 ft (0.3 m) 2457-23492-001 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
Cables Audio Cable This cable connects a Polycom HDX system to an external audio system. It is used with the Audio Adapter cable on page 2-34. It has dual RCA connectors (red/white) on both ends. The maximum approved length for this cable is 100 ft (30 m).
Page 58: Vortex Cable
Integrator’s Reference Manual for Polycom HDX Systems Vortex Cable This cable connects a Polycom HDX system to a Polycom Vortex mixer. It has 4 mini-Phoenix and DB-9 connectors on both ends. Length Part Number RoHS Compliant 6 ft (1.8 m) 2457-21978-200 1829.0 +/- 50...
Page 59: 3.5Mm Screw Cage Connector
3.5mm Screw Cage Connector This 3-pin connector connects audio input and output to the Polycom HDX system. It also connects the IR sensor input on a Polycom HDX system to an external IR receiver, such as Xantech models 780-80, 780-90, 480-00, and 490-90.
Page 60: 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. It is an RJ-11 connector.
Page 61: Serial (Rs-232) Cables
Serial (RS-232) Cables RS-232 Cable This cable connects a Polycom HDX system to a serial device. It is DB-9 connectors on both ends. This connection may require the null modem adapter 1517-21577-001 on page 2-41. The maximum approved length for this cable is 100 ft (30 m).
Page 62 DSR (tied to pin 4, DTR) Not used Most devices which connect to the serial port to control the Polycom HDX system via the API only require pins 2, 3, and 5. For more information and to verify the proper cabling, refer to the documentation for your control system.
Page 63: Null Modem Adapter
Cables Null Modem Adapter This adapter is used when connecting a Polycom HDX system to a serial device that transmits on pin 3 such as Crestron Pro2 processor. It is a male to female DB-9 adapter plug. This connection may require the RS-232 cable, part number 2457-09172-001, on page 2-39.
Page 64 Integrator’s Reference Manual for Polycom HDX Systems 2 - 42...
Page 65: Using The Api
Polycom HDX system. You can use the API by connecting a control system or computer RS-232 serial port to the Polycom HDX system. Or, you can use Telnet over the LAN to use the API. Using the API with an RS-232 Interface...
Page 66: Configuring The Rs-232 Interface
1. Power off the computer and the Polycom HDX system. 2. Use an RS-232 cable to connect the control system or computer RS-232 port to an RS-232 port on the Polycom HDX system as shown in the following illustration. This connection may require the null modem adapter 1517-21577-001 on page 2-41.
Page 67: Using The Api With A Lan Connection
Polycom HDX system via Telnet port 24. 1. On the computer, open a command line interface. 2. Start a Telnet session using the Polycom HDX system IP address and port number — for example, telnet 10.11.12.13 24. You cannot use Telnet to access the system if Security Mode is enabled.
Page 68 Integrator’s Reference Manual for Polycom HDX Systems 3 - 4...
Page 69: System Commands
System Commands This chapter describes the API commands for software version 1.0. For an alphabetical list of all the commands, refer to the table of contents for this document. 4 - 1...
Page 70: About The Api Commands
Integrator’s Reference Manual for Polycom HDX Systems 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 Meaning Multiple valid parameters are enclosed in angle brackets and separated by <param1|param2|param3>...
Page 71 System Commands Executes a previously used command from the history list, starting with a specific number or letter. Syntax ! “string” ! {1..64} Parameter Description Specifies the most recent command from the history list “string” that begins with this string. Specifies the Nth command in the history list, where N {1..64} is 1 through 64.
Page 72: Abk
Integrator’s Reference Manual for Polycom HDX Systems Returns local directory (address book) entries. Syntax abk all abk batch {0..59} abk batch search “pattern” “count” abk batch define “start_no” “stop_no” abk letter {a..z} abk range “start_no” “stop_no“ abk refresh Parameter Description Returns all the records in the local directory.
Page 73 6. Polycom Austin Stereo spd:384 num:1.512.6977918 abk 6. Polycom Austin Stereo spd:384 num:stereo.polycom.com abk 7. Polycom Austin USA spd:384 num:1.512.6977926 abk 8. Polycom Austin USA IP spd:256 num:lobby.austin.polycom.com abk 9. Polycom Australia spd:384 num:61.02.99788088 Note: Entries with multiple addresses (for example, IP address and ISDN number) return each address type on separate lines with the same record number.
Page 74: Addressdisplayedingab
Integrator’s Reference Manual for Polycom HDX Systems addressdisplayedingab Specifies whether to make the system address public or private in the global directory. Syntax addressdisplayedingab get addressdisplayedingab private addressdisplayedingab public Parameter Description Returns the current setting. Specifies not to display the system address in the private global directory.
Page 75: Adminpassword
System Commands adminpassword Sets or gets the remote access password. This command is not supported on the serial port. Syntax adminpassword get adminpassword set [“password”] Parameter Description Returns the current remote access password. Sets the password used for remote management of the system if followed by the password parameter.
Page 76: Advnetstats
Integrator’s Reference Manual for Polycom HDX Systems advnetstats Gets advanced network statistics for a call connection. Syntax advnetstats [{0..n}] Parameter Description Specifies a connection in a multipoint call, where n is {0..n} the maximum number of connections supported by the system.
Page 77: Alertusertone
System Commands alertusertone Sets or gets the tone used for user alerts. Syntax alertusertone <get|1|2|3|4> Parameter Description Returns the current setting. Sets the user alert to the corresponding tone. 1|2|3|4 Feedback Examples alertusertone 1 4 - 9...
Page 78: Allowmixedcalls
System Commands 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 Description Returns the current setting. Enables mixed IP and ISDN calls. Disables mixed IP and ISDN calls.
Page 79: Allowusersetup
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting. Enables the User Settings icon.
Page 80: Answer
System Commands answer Answers incoming video or analog phone calls. Syntax answer <video|phone> Parameter Description Answers incoming video calls when Auto Answer Point video to Point Video or Auto Answer Multipoint Video is set to Answers incoming analog phone calls. phone Feedback Examples •...
Page 81: Areacode
Integrator’s Reference Manual for Polycom HDX Systems 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”...
Page 82: Autoanswer
System Commands autoanswer Sets or gets the Auto Answer Point to Point Video 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 Description Allows any incoming call to be connected automatically. This is the default setting.
Page 83: Backlightcompensation
Integrator’s Reference Manual for Polycom HDX Systems backlightcompensation Sets or gets the Backlight Compensation mode. Syntax backlightcompensation <get|yes|no> Parameter Description Returns the current setting. Enables Backlight Compensation. The camera automatically adjusts for a bright background. Disables the option. Feedback Examples •...
Page 84: Basicmode
System Commands 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. Syntax basicmode <get|on|off>...
Page 85: Bri1Enable, Bri2Enable, Bri3Enable, Bri4Enable
Integrator’s Reference Manual for Polycom HDX Systems 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>...
Page 86: Briallenable
System Commands 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 Description Returns the status of all BRI lines—yes if enabled, no if disabled.
Page 87: Button
Integrator’s Reference Manual for Polycom HDX Systems button Simulates Polycom remote control buttons. Syntax button <#|*|0|1|2|3|4|5|6|7|8|9|.> button <down|left|right|select|up> button <auto|callhangup|far|graphics|near|zoom+|zoom-> button <help|mute|volume+|volume-> button <pickedup|putdown> button <camera|delete|directory|home|keyboard|period|pip|preset> button <info|menu|slides|option> button “valid_button” [“valid_button” ...] Parameter Description Types a period (dot) if the cursor is on a text field.
Page 88 Simulates a low battery alert for the remote control. lowbattery Sends the Menu button signal to legacy systems. menu Deprecated. Polycom recommends using back instead of this button. Sends the Mute button signal to the user interface, mute causing a toggle of mute state.
Page 89 For example, you can use the command instead of button pip See Also For information about the IR signals to use when programming non-Polycom remote control devices for systems, refer to Appendix D, Specifications. 4 - 26...
Page 90: Calldetailreport
System Commands calldetailreport Sets or gets whether to generate a report of all calls made with the system. Syntax calldetailreport <get|yes|no> Parameter Description Returns the current setting. Turns on call detail reporting. Does not generate Call Detail Report. Feedback Examples •...
Page 91: Callencryption (Deprecated)
Integrator’s Reference Manual for Polycom HDX Systems 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 on page 4-82, this encryption command has been deprecated.
Page 92: Callinfo
System Commands 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 Description Returns information about each connection in the call. Returns information about the connection with the callid specified call ID.
Page 93: Callstate
Integrator’s Reference Manual for Polycom HDX Systems callstate Sets or gets the call state notification for call state events. Syntax callstate <get|register|unregister> Parameter Description Returns the current setting. Registers the system to give notification of call register activities. Disables the register mode.
Page 94: Callstats
System Commands callstats Returns call summary information. Syntax callstats Feedback Examples might return something like callstats timeinlastcall 0:02:35 totalnumberofcalls 23 totalnumberofipcalls 23 totaltimeipcalls 2:08:44 percentageipcalls 100% totalnumberofisdncalls 0 totaltimeisdncalls 00:00:00 percentageisdncalls 0% 4 - 31...
Page 95: Camera
Integrator’s Reference Manual for Polycom HDX Systems camera Sets or gets the near-site or far-site camera settings. Syntax camera near {1..6} 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 <getposition|setposition “x” “y” “z”>...
Page 96 System Commands Parameter Description Selects discrete movement mode. The camera will discrete move a small amount in the direction specified and then stop. No stop command is required. Returns the number of the near or far camera source source currently selected. Gets the pan, tilt, and zoom coordinates of the currently getposition selected PTZ camera in the format of pan tilt zoom.
Page 97 Integrator’s Reference Manual for Polycom HDX Systems • camera far 1 • camera near source 2 • (returned by event: camera near move continuous camera near move continuous • (returned by event: camera near move discrete camera near move discrete •...
Page 98: Cameradirection
System Commands cameradirection Sets or gets the camera pan direction. Syntax cameradirection <get|normal|reversed> Parameter Description Returns the current setting. Sets the direction of the camera to normal; the camera normal moves in the same direction as the left/right arrows on the remote control.
Page 99: Camerainput
Integrator’s Reference Manual for Polycom HDX Systems camerainput Sets or gets the format for a video source. Syntax camerainput {1|2|3} <get|s-video|composite|component> Parameter Description Specifies the video source. {1..5} Returns the current setting. Specifies that the video source is connected using s-video S-Video.
Page 100: Chaircontrol
System Commands 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” chaircontrol set_password “string”...
Page 101 Integrator’s Reference Manual for Polycom HDX Systems Parameter Description Sets the name for the specified terminal number. set_term_name “term_no” “term_name” Views the specified terminal. view “term_no” Views the broadcaster. view_broadcaster Feedback Examples • (returned from rel_chair & view 1.2 chaircontrol rel_chair •...
Page 102: Colorbar
System Commands colorbar Turns the video diagnostics color bars on or off. Syntax colorbar <on|off> Parameter Description Turns on the color bar test pattern. Turns off the color bar test pattern. Feedback Examples • colorbar on • colorbar off 4 - 39...
Page 103: Cmdecho
Integrator’s Reference Manual for Polycom HDX Systems cmdecho Turns command echoing on or off. Syntax cmdecho <on|off> Parameter Description Turns on command echoing so that everything you type is echoed on the screen. Turns on command echoing so that nothing you type is echoed on the screen.
Page 104: Configchange (Deprecated)
System Commands configchange (deprecated) Sets or gets the notification state for configuration changes. This command has been deprecated. Syntax configchange <get|register|unregister> Parameter Description Returns the current setting. Registers to receive notifications when configuration register variables have changed. Unregisters to receive notifications when configuration unregister variables have changed.
Page 105: Configdisplay
Integrator’s Reference Manual for Polycom HDX Systems 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|dvi|component> <4:3|16:9> configdisplay monitor2 off Parameter Description Returns the current setting.
Page 106: Configpresentation
System Commands 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 Description Returns the current settings for the active monitors. Specifies settings for Monitor 1.
Page 107 Integrator’s Reference Manual for Polycom HDX Systems 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 Command History Introduced in VSX version 8.5.
Page 108: Confirmdiradd
System Commands 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 Description Returns the current setting. When a call disconnects, the user is prompted to create a local directory entry for the far site if it is not already in the directory.
Page 109: Confirmdirdel
Integrator’s Reference Manual for Polycom HDX Systems confirmdirdel Sets or gets the configuration for requiring users to confirm directory deletions. Syntax confirmdirdel <get|yes|no> Parameter Description Returns the current setting. When deleting an entry from the directory (address book), the user is prompted with “Are you sure you want to delete this entry?”...
Page 110: Contentauto
System Commands 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 Description Returns the current setting. Enables automatic bandwidth adjustment for people and content.
Page 111: Country
Integrator’s Reference Manual for Polycom HDX Systems 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} Parameter Description Returns the current setting.
Page 112: Cts
System Commands 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 Description Returns the current setting. Sets the signal to normal (high voltage is logic 1).
Page 113: Daylightsavings
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting. Enables automatic adjustment for daylight savings time.
Page 114: Dcd
System Commands 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 Description Returns the current setting. Sets the signal to normal (high voltage is logic 1).
Page 115: Dcdfilter
Integrator’s Reference Manual for Polycom HDX Systems 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.
Page 116: Defaultgateway
System Commands defaultgateway Sets or gets the default gateway. Syntax defaultgateway get defaultgateway set “xxx.xxx.xxx.xxx” Parameter Description Returns the default gateway IP address. Sets the default gateway when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit the “xxx.xxx.xxx.xxx” parameter. IP address to use as the default gateway.
Page 117: Dhcp
Integrator’s Reference Manual for Polycom HDX Systems dhcp Sets or gets DHCP options. Syntax dhcp <get|off|client|server> Parameter Description Returns the selected DHCP option. Disables DHCP. Enables DHCP client, setting the system to obtain an client IP address from a server on your network.
Page 118: Dial
System Commands 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 manual “speed” “dialstr1” [“dialstr2”] [h323|h320|ip|isdn|sip] dial phone “dialstring” Parameter Description Dials a directory (address book) entry.
Page 119 Integrator’s Reference Manual for Polycom HDX Systems Feedback Examples • might return 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]...
Page 120: Dialchannels
System Commands 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 Description Returns the current setting. Sets the number of channels to dial.
Page 121: Dialingdisplay
Integrator’s Reference Manual for Polycom HDX Systems dialingdisplay Sets or gets the home screen dialing display. Syntax dialingdisplay <get|dialingentry|displaymarquee|none> Parameter Description Returns the current setting. Displays a field for users to enter numbers manually. dialingentry Displays text in the dialing entry field. Users cannot displaymarquee enter numbers manually when this option is selected.
Page 122: Diffservaudio, Diffservfecc, Diffservvideo
System Commands 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}...
Page 123: Dir
Integrator’s Reference Manual for Polycom HDX Systems Lists flash files. No wild cards are allowed. Syntax dir [“string”] Parameter Description Lists flash files which partially match a string of up to “string” 250 alphanumeric characters. To list all the files, omit “string”.
Page 124: Directory
System Commands directory Sets or gets whether the Directory button appears on the home screen. Syntax directory <get|yes|no> Parameter Description Returns the current setting. Displays the Directory button on the home screen. Removes the Directory button from the home screen. Feedback Examples •...
Page 125: Display (Deprecated)
Integrator’s Reference Manual for Polycom HDX Systems display (deprecated) Displays information about the current call or the system. With the implementation of the command on page 4-29 and callinfo whoami command on page 4-254, this command has been deprecated. Syntax...
Page 126: Displayglobaladdresses
System Commands displayglobaladdresses Sets or gets the display of global addresses in the global directory. Syntax displayglobaladdresses <get|yes|no> Parameter Description Returns the current setting. Enables the display of global addresses. Disables the display of global addresses. Feedback Examples • displayglobaladdresses no •...
Page 127: Displaygraphics
Integrator’s Reference Manual for Polycom HDX Systems displaygraphics Sets or gets the display of graphic icons while in a call. Syntax displaygraphics <get|yes|no> Parameter Description Returns the current setting. Enables the display of graphic icons. Disables the display of graphic icons.
Page 128: Displayipext
System Commands 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 Description Returns the current setting. Enables the display of the IP extension. Enables the display of the IP extension.
Page 129: Displayipisdninfo (Deprecated)
Integrator’s Reference Manual for Polycom HDX Systems displayipisdninfo (deprecated) Sets or gets the display of IP and ISDN information on the home screen. This command has been deprecated. Polycom recommends using the ipisdninfo command on page 4-128. Syntax displayipisdninfo <yes|no|both|ip-only|isdn-only|none|get>...
Page 130: Displayparams
System Commands displayparams Outputs a list of 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> gabpassword <empty>...
Page 131: Dns
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current IP address of the specified server. A server identification number {1..4} is required.
Page 132: Dsr
System Commands 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 Description Returns the current setting. Sets the signal to normal (high voltage is logic 1).
Page 133: Dsranswer
Integrator’s Reference Manual for Polycom HDX Systems 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.
Page 134: Dtr
System Commands 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 Description Returns the current setting. Sets the signal to normal (high voltage is logic 1).
Page 135: Dualmonitor
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting. Enables dual monitor emulation. Disables dual monitor emulation.
Page 136: Dynamicbandwidth
System Commands dynamicbandwidth Sets or gets the use of dynamic bandwidth allocation for Quality of Service. Syntax dynamicbandwidth <get|yes|no> Parameter Description Returns the current setting. Enables the dynamic bandwidth option. Disables the dynamic bandwidth option. Feedback Examples dynamicbandwidth yes Comments The system’s dynamic bandwidth function automatically finds the optimum line speed for a call.
Page 137: E164Ext
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting.
Page 138: Echo
Once legacy command's response ends, echo command gets processed which will result in the delimiter string printed to the API client. This command works with all Polycom HDX systems, and VSX systems running version 8.0 or later. Command History Introduced in VSX version 8.0.
Page 139: Echocanceller
• echocanceller yes 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. Sending is equivalent to sending both...
Page 140: Echocancellerred
System Commands echocancellerred Sets or gets the line in red (right) echo canceller setting. Syntax echocancellerred <get|yes|no> Parameter Description Returns the current setting. Enables the echo canceller option for red line in. Disables the echo canceller option for red line in. Examples •...
Page 141: Echocancellerwhite
Integrator’s Reference Manual for Polycom HDX Systems echocancellerwhite Sets or gets the line in white (left) echo canceller setting. Syntax echocancellerwhite <get|yes|no> Parameter Description Returns the current setting. Enables the echo canceller option for white line in. Disables the echo canceller option for white line in.
Page 142: Enablefirewalltraversal
System Commands 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 Description Returns the current setting. Enables the firewall traversal feature. Disables the firewall traversal feature. Feedback Examples •...
Page 143: Enablersvp
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting.
Page 144: Enablesnmp
System Commands enablesnmp Sets or gets the SNMP configuration. Syntax enablesnmp <get|yes|no> Parameter Description Returns the current setting. Enables the SNMP option. Disables the SNMP option. Feedback Examples • enablesnmp no • enablesnmp yes Comments Changing this setting causes the system to restart. This option is enabled by default.
Page 145: Encryption
Integrator’s Reference Manual for Polycom HDX Systems encryption Sets or gets the AES encryption mode for the system. Syntax encryption <get|yes|no> Parameter Description Returns the current setting. Use encryption when the far site is capable of encryption. Disables encryption. Feedback Examples •...
Page 146: Exit
System Commands exit Ends the API command session. Syntax exit Comments This command ends a Telnet session. For serial sessions, this command effectively starts a new session. 4 - 83...
Page 147: Farcontrolnearcamera
Integrator’s Reference Manual for Polycom HDX Systems farcontrolnearcamera Sets or gets far control of the near camera, which allows far sites to control the camera on your system. Syntax farcontrolnearcamera <get|yes|no> Parameter Description Returns the current setting. Allows the far site to control the near camera if the far site has this capability.
Page 148: Farnametimedisplay
System Commands farnametimedisplay Sets or gets the length of time the far-site name is displayed on the system. Syntax farnametimedisplay off farnametimedisplay <get|on|15|30|60|120> Parameter Description Disables the far site name display. Returns the current setting. Displays the far site name for the duration of the call. Specifies the number of seconds to display the far site 15|30|60|120 name at the beginning of a call.
Page 149: Flash
Integrator’s Reference Manual for Polycom HDX Systems flash Flashes the analog phone call. Syntax flash [“callid”] flash [“callid”] [“duration”] Parameter Description Specifies the callid to flash. callid Specifies the pulse duration in ms. duration Command History Introduced in VSX version 8.5.
Page 150: Gabk
{0..59}. Returns a batch of entries in the range defined by define “start_no” to “stop_no.” Polycom recommends using gabk range instead of this command. Specifies the beginning of the range of entries to return. “start_no”...
Page 151: Gabpassword
Integrator’s Reference Manual for Polycom HDX Systems gabpassword Sets or gets the password to gain access to the Global Directory Server. Syntax gabpassword get gabpassword set [“password”] Parameter Description Returns the current setting. Sets the GDS password to “password”. To erase the current setting, omit “password”.
Page 152: 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 “xxx.xxx.xxx.xxx” character string. Feedback Examples • gabserverip <empty> • gabserverip set gab.polycom.com returns gabserverip gab.polycom.com 4 - 89...
Page 153: Gatekeeperip
Integrator’s Reference Manual for Polycom HDX Systems gatekeeperip Sets or gets the IP address of the gatekeeper. Syntax gatekeeperip get gatekeeperip set [“xxx.xxx.xxx.xxx”] Parameter Description Returns the current setting. Sets the gatekeeper IP address when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit “xxx.xxx.xxx.xxx”.
Page 154: Gatewayareacode
System Commands gatewayareacode Sets or gets the gateway area code. Syntax gatewayareacode get gatewayareacode set [“areacode”] Parameter Description Returns the area code for the gateway. Sets the area code when followed by the “areacode” parameter. To erase the current setting, omit “areacode”.
Page 155: Gatewaycountrycode
Integrator’s Reference Manual for Polycom HDX Systems gatewaycountrycode Sets or gets the gateway country code. Syntax gatewaycountrycode get gatewaycountrycode set [“countrycode”] Parameter Description Returns the current setting. Sets the gateway country code when followed by the “countrycode” parameter. To erase the current setting, omit “countrycode”.
Page 156: Gatewayext
System Commands gatewayext Sets or gets the gateway extension number. Syntax gatewayext get gatewayext set [“extension”] Parameter Description Returns the current setting. Sets the gateway extension number when followed by the “extension” parameter. To reset the default value, omit “extension”. Numeric string specifying the gateway extension.
Page 157: Gatewaynumber
Integrator’s Reference Manual for Polycom HDX Systems gatewaynumber Sets or gets the gateway number. Syntax gatewaynumber get gatewaynumber set [“number”] Parameter Description Returns the current setting. Sets the gateway number when followed by the “number” parameter. To erase the current setting, omit “number”.
Page 158: Gatewaynumbertype
System Commands 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 Description Returns the current setting. Indicates that the gateway number is a direct inward dial number; it has no extension. Indicates that the gateway number includes an number+extension extension.
Page 159: Gendial
Integrator’s Reference Manual for Polycom HDX Systems gendial Generates DTMF dialing tones over a video call. Syntax gendial <{0..9}|#|*> Parameter Description Generates the DTMF tone corresponding to telephone {0..9} buttons 0-9. Generates the DTMF tone corresponding to a telephone # button.
Page 160: Gendialtonepots (Deprecated)
System Commands gendialtonepots (deprecated) Generates DTMF dialing tones over an analog phone line. This command has been deprecated. Polycom recommends using the command on gendial page 4-96. Syntax gendialtonepots <{0..9}|#|*> Parameter Description Generates the DTMF tone corresponding to telephone {0..9} buttons 0-9.
Page 161: Generatetone
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Turns on the test tone.
Page 162: Get Screen
System Commands 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 • screen: near • screen: makeacall • screen: generatetone See Also You can also use the command on page 4-204.
Page 163: Getcallstate (Deprecated)
Integrator’s Reference Manual for Polycom HDX Systems getcallstate (deprecated) Gets the state of the calls in the current conference. This command has been deprecated. Polycom recommends using the command on callinfo page 4-29. Syntax getcallstate Feedback Examples cs: call[33] speed[512] dialstr[216.54.150.82] state[connected]...
Page 164: Gmscity
System Commands gmscity Sets or gets the Global Management System™ city information. Syntax gmscity get gmscity set [“city”] Parameter Description Returns the current setting. Sets the Global Management System city name when followed by the “city” parameter. To erase the current setting, omit “city”.
Page 165: Gmscontactemail
Integrator’s Reference Manual for Polycom HDX Systems gmscontactemail Sets or gets the Global Management System contact E-mail information. Syntax gmscontactemail get gmscontactemail set [“email”] Parameter Description Returns the current contact E-mail address. Sets the Global Management system contact E-mail address when followed by the “email” parameter. To erase the current setting, omit “email”.
Page 166: Gmscontactfax
System Commands gmscontactfax Sets or gets the Global Management System contact fax information Syntax gmscontactfax get gmscontactfax set [“fax number”] Parameter Description Returns the current contact fax information. Sets the Global Management System contact fax information when followed by the “fax number” parameter.
Page 167: Gmscontactnumber
Integrator’s Reference Manual for Polycom HDX Systems gmscontactnumber Sets or gets the Global Management System contact number information. Syntax gmscontactnumber get gmscontactnumber set [“number”] Parameter Description Returns the current contact number. Sets the Global Management System contact number when followed by the “number” parameter. To erase the current setting, omit “number”.
Page 168: Gmscontactperson
System Commands gmscontactperson Sets or gets the Global Management System contact person information. Syntax gmscontactperson get gmscontactperson set [“person”] Parameter Description Returns the current contact person information. Sets the Global Management System contact person name when followed by the “person” parameter. To erase the current setting, omit “person”.
Page 169: Gmscountry
Integrator’s Reference Manual for Polycom HDX Systems gmscountry Sets or gets the Global Management System country information. Syntax gmscountry get gmscountry set [“countryname”] Parameter Description Returns the current country setting. Sets the Global Management System country information when followed by the “countryname”...
Page 170: Gmsstate
System Commands gmsstate Sets or gets the Global Management System state information. Syntax gmsstate get gmsstate set [“state”] Parameter Description Returns the current state information. Sets the Global Management System state information when followed by the “state” parameter. To erase the current setting, omit the “state”...
Page 171: Gmstechsupport
Integrator’s Reference Manual for Polycom HDX Systems gmstechsupport Sets or gets the Global Management System technical support phone number. Syntax gmstechsupport get gmstechsupport set [“tech_support_digits”] Parameter Description Returns the current tech support phone number information. Sets the technical support information when followed by the “tech_support_digits”...
Page 172: Gmsurl
System Commands gmsurl Sets or gets the URL of the Global Management System server that manages your system. This command automatically appends “/pwx/vs_status.asp” Syntax gmsurl get {1..10} gmsurl set {1..10} “xxx.xxx.xxx.xxx” gmsurl get all Parameter Description Returns the current URL information for a selected server.
Page 173: H239Enable
Integrator’s Reference Manual for Polycom HDX Systems h239enable Sets or gets the H.239 People+Content™ setting. Syntax h239enable get h239enable <yes|no> Parameter Description Returns the current setting. Enables H.239 People+Content on the system. Disables H.239 People+Content on the system. Feedback Examples •...
Page 174: H323Name
System Commands h323name Sets or gets the system’s H.323 name. Syntax h323name get h323name set [“H.323name”] Parameter Description Returns the current setting. Sets the H.323 name when followed by the “H.323name” parameter. To erase this setting, omit the “H.323name” parameter. Character string specifying the H.323 name.
Page 175: H331Audiomode
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting.
Page 176: H331Dualstream
System Commands 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 Description Returns the current setting. Turns on dual stream for H.331 calls. Turns off dual stream for H.331 calls.
Page 177: H331Framerate
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting.
Page 178: H331Videoformat
System Commands 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 Description Returns the current setting. Sets the video format to FCIF for H.331 calls. fcif Feedback Examples h331videoformat fcif...
Page 179: H331Videoprotocol
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting.
Page 180: Hangup
System Commands hangup Hangs up the current video or phone call. Syntax hangup phone hangup video [“callid”] Parameter Description Disconnects the current analog phone (audio-only) site. phone Disconnects the current video call. If the “callid” video parameter is omitted, the system disconnects all far sites in the call.
Page 181: Help
Integrator’s Reference Manual for Polycom HDX Systems 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 182: 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 My 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 183: Homecallquality
Integrator’s Reference Manual for Polycom HDX Systems homecallquality Sets or gets whether users are allowed to select the bandwidth for calls from the home screen. Syntax homecallquality <get|yes|no> Parameter Description Returns the current setting. Displays the Call Quality menu on the home screen.
Page 184: Homemultipoint
System Commands 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 Description Returns the current setting. Displays the Multipoint button on the home screen. Removes the Multipoint button from the home screen.
Page 185: Homerecentcalls
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting.
Page 186: Homesystem
System Commands 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 Description Returns the current setting. Displays the System button on the home screen. Removes the System button from the home screen.
Page 187: Homesystemname
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting. Displays the system name on the home screen.
Page 188: Hostname
System Commands hostname Sets or gets the LAN host name, which is assigned to the 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 Description Returns the current setting.
Page 189: Ipaddress
Integrator’s Reference Manual for Polycom HDX Systems ipaddress Sets or gets the LAN IP address of the system. Syntax ipaddress get ipaddress set “xxx.xxx.xxx.xxx” Parameter Description Returns the current setting. Sets the LAN IP address to the “xxx.xxx.xxx.xxx” parameter. This setting can only be changed when DHCP is off.
Page 190: Ipdialspeed
System Commands 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 Description Returns the current setting. The parameter “valid speed” is required. Valid speeds are: 56, 64, 2x56, 112, 2x64, 128, 168, “valid speed”...
Page 191: Ipisdninfo
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting. Displays IP and ISDN information on the home screen.
Page 192: Ipprecaudio, Ipprecfecc, Ipprecvideo
System Commands 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...
Page 193: Ipstat
Integrator’s Reference Manual for Polycom HDX Systems ipstat Returns the LAN host name, DHCP, IP address, DNS servers 1-4, default gateway, and subnet mask. Syntax ipstat Feedback Examples hostname My dhcp client ipaddress 192.168.1.111 dnsserver 192.168.1.2 dnsserver1 192.168.1.3 dnsserver2 192.168.1.4 dnsserver3 0.0.0.0...
Page 194: Isdnareacode
System Commands 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 system. Syntax isdnareacode get isdnareacode set ["area code"] Parameter Description...
Page 195: Isdncountrycode
Integrator’s Reference Manual for Polycom HDX Systems isdncountrycode Sets or gets the ISDN country code associated with the country where the system is used. This command is only applicable if you have an ISDN network interface connected to your system.
Page 196: Isdndialingprefix
System Commands isdndialingprefix Sets or gets the ISDN dialing prefix used to access an outside line if the 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...
Page 197: Isdndialspeed
Integrator’s Reference Manual for Polycom HDX Systems 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”...
Page 198: Isdnnum
System Commands isdnnum Sets or gets the ISDN video number or numbers assigned to the 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 Description Returns the current ISDN number associated with the...
Page 199: Isdnswitch
Integrator’s Reference Manual for Polycom HDX Systems isdnswitch Sets or gets the ISDN switch protocol. This command is only applicable if you have an ISDN network interface connected to your system. Syntax isdnswitch get isdnswitch <pt-to-pt_at&t_5_ess|multipoint_at&t_5_ess|ni-1> isdnswitch <nortel_dms-100|standard_etsi_euro-isdn|ts-031|ntt_ins-64> Parameter Description Returns the current switch protocol.
Page 200: Keypadaudioconf
System Commands 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 Description Returns the current setting. Enables audio confirmation. Disables audio confirmation.
Page 201: Language
Integrator’s Reference Manual for Polycom HDX Systems language Sets or gets the language that will display on the system. Syntax language <set|get> language set <chinese|englishuk|englishus|french|german| hungarian|italian|japanese|korean|norwegian|polish|portuguese| russian|spanish|traditional_chinese> Parameter Description Returns the current language used on the system. Sets the specified language. Requires a language parameter.
Page 202: Lanport
System Commands lanport Sets or gets the LAN port settings of the system. Syntax lanport <get|auto|autohdx|autofdx|10|10hdx|10fdx|100|100hdx|100fdx> Parameter Description Returns the current setting. Sets the LAN speed and duplex mode. auto|autohdx|autofdx| 10|10hdx|10fdx|100|10 auto: Automatically negotiates the LAN speed and 0hdx|100fdx duplex mode. autohdx: Automatically negotiates the LAN speed but specifies half-duplex mode.
Page 203: Linestate
Integrator’s Reference Manual for Polycom HDX Systems linestate Sets or gets API session registration to receive notifications about IP or ISDN line state changes. Syntax linestate get linestate <register|unregister> Parameter Description Returns the current setting. Registers to receive notification when IP or ISDN line register states change.
Page 204: 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. Feedback Examples Key off of “listen:”...
Page 205: Localdatetime
Integrator’s Reference Manual for Polycom HDX Systems localdatetime Sets or gets whether to display the local date and time on the home screen. Syntax localdatetime <get|yes|no> Parameter Description Returns the current setting. Displays the local date and time on the home screen.
Page 206: Marqueedisplaytext
System Commands 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 Description Returns the current marquee display text. Sets the text to display in the dialing entry field followed by the text to use.
Page 207: Maxgabinternationalcallspeed
Integrator’s Reference Manual for Polycom HDX Systems 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 208: Maxgabinternetcallspeed
System Commands 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 Description Returns the current valid speed. Sets the maximum speed for Internet calls when followed by a valid speed value.
Page 209: Maxgabisdncallspeed
Integrator’s Reference Manual for Polycom HDX Systems 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 210: Maxtimeincall
System Commands maxtimeincall Sets or gets the maximum number of minutes allowed for call length. Syntax maxtimeincall get maxtimeincall set [{0..999}] Parameter Description Returns the current setting. Sets the maximum time for calls when followed by a parameter from {0..999}. To erase the current setting, omit the time parameter or set it to 0.
Page 211: Mcupassword
Integrator’s Reference Manual for Polycom HDX Systems mcupassword Enters and sends the MCU password to the MCU. Syntax mcupassword [“password”] Parameter Description Specifies the password to send to the MCU. password 4 - 148...
Page 212: Meetingpassword
System Commands meetingpassword Sets or gets the meeting password. Syntax meetingpassword get meetingpassword set [“password”] Parameter Description Returns the current meeting password. Sets the meeting password if followed by the password parameter. To erase the current setting, omit the password parameter. User-defined password.
Page 213: Monitor1 (Deprecated)
Integrator’s Reference Manual for Polycom HDX Systems monitor1 (deprecated) Sets or gets the aspect ratio for Monitor 1. With the implementation of the command on page 4-42, this command has been deprecated. configdisplay Syntax monitor1 <get|4:3|16:9|vga> Parameter Description Returns the current setting.
Page 214: Monitor1Screensaverouput
System Commands 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 Description Returns the current setting. Sends black video to Monitor 1 when the system goes black to sleep and the screen saver activates.
Page 215: Monitor2 (Deprecated)
Integrator’s Reference Manual for Polycom HDX Systems monitor2 (deprecated) Sets or gets the aspect ratio for Monitor 2. With the implementation of the command on page 4-42, this command has been deprecated. configdisplay Syntax monitor2 off monitor2 <get|4:3|16:9> monitor2 vga...
Page 216: Monitor2Screensaverouput
System Commands 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 Description Sends black video to Monitor 2 when the system goes black to sleep and the screen saver activates. Sends no signal to Monitor 2 when the system goes to no_signal sleep and the screen saver activates.
Page 217: Mpautoanswer
Integrator’s Reference Manual for Polycom HDX Systems mpautoanswer Sets or gets the Auto Answer Multipoint Video mode, which determines how the system will handle an incoming call in a multipoint video conference. Syntax mpautoanswer <get|yes|no|donotdisturb> Parameter Description Returns the current setting.
Page 218: Mpmode
System Commands 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> Parameter Description Returns the current setting.
Page 219: Mtumode
Integrator’s Reference Manual for Polycom HDX Systems mtumode Sets or gets the MTU mode. The commands allow you to mtumode mtusize change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set , then use...
Page 220: Mtusize
System Commands mtusize Sets or gets the MTU size. The commands allow you to mtumode mtusize change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set , then use mtumode specify to specify a value. If is set to , the system automatically mtusize...
Page 221: Mute
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Registers to receive notification when the mute mode register changes. Disables register mode.
Page 222: Muteautoanswer
System Commands 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 system answers automatically. Syntax muteautoanswer <get|yes|no> Parameter Description Returns the current setting.
Page 223: Natconfig
Integrator’s Reference Manual for Polycom HDX Systems natconfig Sets or gets the NAT configuration. Syntax natconfig <get|auto|manual|upnp|off> Parameter Description Returns the current setting. Specifies that the system is behind a NAT; specifies auto that the system will automatically discover the public (WAN) address.
Page 224: Nath323Compatible
System Commands nath323compatible Sets or gets the NAT is H.323 Compatible setting. Syntax nath323compatible <get|yes|no> Parameter Description Returns the current setting. Specifies that NAT is capable of translating H.323 traffic. Specifies that NAT is not capable of translating H.323 traffic. Feedback Examples •...
Page 225: Nearloop
Integrator’s Reference Manual for Polycom HDX Systems nearloop Activates or deactivates the Near End Loop test. Syntax nearloop <on|off> Parameter Description Activates the Near End Loop, a complete internal test of the system. Deactivates the Near End Loop. Feedback Examples •...
Page 226: Netstats
System Commands netstats Returns network statistics for each call. Syntax netstats [{0..n}] Parameter Description Call in a multipoint call, where n is the maximum {0..n} number of calls supported by the system. 0 is the first site connected. If no call is specified, netstats returns information about the near site.
Page 227: Nonotify
If entered again, nonotify callstatus returns error: event/notification not active:callstatus Comments This command works with all Polycom HDX systems, and VSX systems running version 8.0 or later. Command History Introduced in VSX version 8.0. See Also See also the related command on page 4-165.
Page 228: Notify
System Commands 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> notify <getregistrations> Parameter Description Lists the notification types that are currently being notify received, in the following format. registered for <num>...
Page 229 Integrator’s Reference Manual for Polycom HDX Systems Parameter Description 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. notification:vidsourcechange:<near or far>:<camera index>:<camera name>:<people or...
Page 230 Duplicate registrations produce another success response. The notify setting remains in effect, even if you restart the system or update the software with system settings saved. This command works with all Polycom HDX systems, and VSX systems running version 8.0 or later. Command History Introduced in VSX version 8.0.
Page 231: Ntpmode
Integrator’s Reference Manual for Polycom HDX Systems 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>...
Page 232: Ntpserver
System Commands 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 Description Gets the IP address of the NTP server. Sets the IP address of the NTP server when followed by a valid parameter.
Page 233: Numdigitsdid
Integrator’s Reference Manual for Polycom HDX Systems numdigitsdid Sets or gets the number of digits in the DID Gateway number (E.164 dialing). Syntax numdigitsdid <get|{0..24}> Parameter Description Returns the current setting. Specifies the number of digits in DID numbers. {0..24}...
Page 234: Numdigitsext
System Commands numdigitsext Sets or gets the number of digits in the Number+Extension Gateway number (E.164 dialing). Syntax numdigitsext <get|{0..24}> Parameter Description Returns the current setting. The number of digits in the gateway number if {0..24} gatewaynumbertype is set to number+extension. Feedback Examples numdigitsext 10 Comments...
Page 235: Pause
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Number of seconds to pause. {0..65535} Feedback Examples...
Page 236: Phone
System Commands phone Flashes the analog phone line. Syntax phone <clear|flash> Parameter Description Clears phone number from the text box. clear Sends flash hook to a POTS connection. If both of flash these call types exist, use the flash command to specify a call ID.
Page 237: Pip
Integrator’s Reference Manual for Polycom HDX Systems 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|camera|swap|register|unregister|location> pip location <get|0|1|2|3> Parameter Description Returns the current setting.
Page 238: Popupinfo
System Commands popupinfo Registers or unregisters to receive popup text and button choices text. Syntax popupinfo <get|register|unregister> Parameter Description Registers to receive popup information. register Unregisters to receive popup information. unregister Returns the current setting. Feedback Examples Key off of “popupinfo:”...
Page 239: Preset
Integrator’s Reference Manual for Polycom HDX Systems 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.
Page 240: Pricallbycall
System Commands pricallbycall Sets or gets the PRI call-by-call value. This command is only applicable if you have a PRI network interface connected to your system. Syntax pricallbycall get pricallbycall set {0..31} Parameter Description Returns the current setting. Sets PRI call-by-call when followed by a value from {0..31}.
Page 241: Prichannel
Integrator’s Reference Manual for Polycom HDX Systems 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}...
Page 242 System Commands Fractional PRI T1 or E1. Channel selection should be handled by your PRI network administrator. PRI E1 Channel Information. The PRI Status screen (for E1) shows 30 channels. However, E1 trunk lines have 32 timeslots, numbered 0 - 31. Timeslot 0 is used for framing, and timeslot 16 is used for call signaling (the D channel).
Page 243: Pricsu
Integrator’s Reference Manual for Polycom HDX Systems pricsu Sets or gets the PRI CSU mode for a T1 interface. Syntax pricsu <get|internal|external> Parameter Description Returns the current setting. Sets the internal CSU mode. This is the default. internal Sets the external CSU mode. When selected, you must external specify the PRI line buildout.
Page 244: Pridialchannels
System Commands 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 Description Sets the number of PRI channels to be dialed in parallel when followed by a parameter from {1..n}.
Page 245: Priintlprefix
Integrator’s Reference Manual for Polycom HDX Systems priintlprefix Sets or gets the PRI international dialing prefix. Syntax priintlprefix get priintlprefix set ["prefix"] Parameter Description Returns the current setting. Sets the PRI international dialing prefix when followed by the parameter “prefix”. To erase the current setting, omit the parameter.
Page 246: Prilinebuildout
System Commands 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 Description Returns the current setting. Sets the PRI line buildout. It requires an output “attenuation in dB” or an “attenuation in feet”.
Page 247: Prilinesignal
Integrator’s Reference Manual for Polycom HDX Systems prilinesignal Sets or gets the PRI line signal. Syntax prilinesignal get prilinesignal set <esf/b8zs|crc4/hdb3|hdb3> Parameter Description Returns the current PRI line signal setting. Sets the PRI line signal. It requires one of the following parameters: esf/b8zs, crc4/hdb3, hdb3 A method of signal encoding used with a T1 interface.
Page 248: Prinumberingplan
System Commands prinumberingplan Sets or gets the PRI numbering plan. This command is only applicable if you have a PRI network interface connected to your system. Syntax prinumberingplan <get|isdn|unknown> Parameter Description Returns the current setting. With this parameter, the numbering plan is identified to isdn the upstream switch as ISDN, and the number type, which is either national or international, is determined...
Page 249: Prioutsideline
Integrator’s Reference Manual for Polycom HDX Systems prioutsideline Sets or gets the PRI number that is dialed for outside line access. Syntax prioutsideline get prioutsideline set ["outside_line"] Parameter Description Returns the current setting. Sets the outside-line-access PRI number when followed by the parameter “outside_line”. To erase the current setting, omit the parameter.
Page 250: Priswitch
System Commands priswitch Sets or gets the PRI switch. Syntax priswitch get priswitch set <att5ess|att4ess|norteldms|ni2> priswitch set <net5/ctr4|nttins-1500|ts-038> Parameter Description Returns the current switch protocol. Sets the PRI switch. One of the switch protocol parameters is required. Switch protocol values. att5ess|att4ess| norteldms|ni2| For E1, net5/ctr4 is the default.
Page 251: Reboot
Integrator’s Reference Manual for Polycom HDX Systems reboot Restarts the system. Syntax reboot now reboot [yes|no] Parameter Description Reboots the system without prompting you. Reboots the system. Can be abbreviated to y. Does not reboot the system. Can be abbreviated to n.
Page 252: 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" 17/Jun/2004 02:13:23 In 209.163.168.122 17/Jun/2004 02:20:08 In "POLYCOM MGC" 17/Jun/2004 02:21:40 In "POLYCOM MGC" 17/Jun/2004 05:53:04 In "POLYCOM MGC"...
Page 253: Registerall
Integrator’s Reference Manual for Polycom HDX Systems registerall Alias for the all register command. Command History Introduced in VSX version 8.5. See Also This command is an alias for the preferred command on all register page 4-11. To unregister user feedback, use the...
Page 254: Registerthissystem
System Commands 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 Description Returns the current setting. Enables this option (register this system). Disables this option.
Page 255: Remotecontrol
Integrator’s Reference Manual for Polycom HDX Systems remotecontrol Set or gets the setting for intercepting signals from the 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 256 System Commands • 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:”...
Page 257: Remotemonenable
Integrator’s Reference Manual for Polycom HDX Systems remotemonenable Gets the state of remote room and call monitoring. Syntax remotemonenable get Feedback Examples • remotemonenable on • remotemonenable off Command History Introduced in VSX version 8.5. 4 - 194...
Page 258: Repeat
System Commands repeat Repeats a specified command from the history list. Syntax repeat {1..64} Parameter Description Repeats the specified command in the history list. {1..64} Values larger than the number of commands in the history list are not valid. The history list may contain up to 64 commands.
Page 259: Requireacctnumtodial
Integrator’s Reference Manual for Polycom HDX Systems 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.
Page 260: Roomphonenumber
System Commands roomphonenumber Sets or gets the number of the phone that is located in the same room as the system. Syntax roomphonenumber get roomphonenumber set [“number”] Parameter Description Returns the current setting. Sets the room phone number when followed by the “number”...
Page 261: Rs232 Baud
Integrator’s Reference Manual for Polycom HDX Systems rs232 baud Sets or gets the baud rate for the first RS-232 port. For systems with two serial ports, use to set the rate for the second serial port. rs232port1 baud Syntax rs232 baud <get|9600|14400|19200|38400|57600|115200>...
Page 262: Rs232 Mode
System Commands rs232 mode Sets or gets the operational mode of the first RS-232 port. For systems with two serial ports, use to set the mode for the second serial port. rs232port1 mode Syntax rs232 mode <get|passthru|control|debug|camera_ptz|closed_caption| vortex_mixer|cps|interactive_touch_board|polycom_annotation|smartboa rd|pointmaker> rs232port1 mode <get|passthru|control|debug|camera_ptz|closed_caption| vortex_mixer|cps|interactive_touch_board|polycom_annotation|smartboa rd|pointmaker>...
Page 263: Rs232Monitor
Integrator’s Reference Manual for Polycom HDX Systems 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.
Page 264: Rs366Dialing
System Commands 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 Description Returns the current setting. Enables RS-366 dialing. Disables RS-366 dialing. Feedback Examples •...
Page 265 Integrator’s Reference Manual for Polycom HDX Systems 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 system. Syntax rt <get|normal|inverted> Parameter Description Returns the current setting.
Page 266: Rts
System Commands 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 system. Syntax rts <get|normal|inverted> Parameter Description Returns the current setting. Sets the signal to normal (high voltage is logic 1). normal Sets the signal to inverted (low voltage is logic 1).
Page 267: Screen
Integrator’s Reference Manual for Polycom HDX Systems screen Returns the name of the current user interface screen on the 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”...
Page 268: Screencontrol
System Commands screencontrol Disables or enables navigation to specified user interface screens of the system. Syntax screencontrol enable <all|none|“screen_name”> screencontrol disable <all|none|“screen_name”> Parameter Description Enables navigation to the specified user interface enable screen(s). All of the user interface screens. None of the user interface screens. none Name of a specific user interface screen.
Page 269: Serialnum
Integrator’s Reference Manual for Polycom HDX Systems serialnum Returns the serial number of the system. Syntax serialnum Feedback Examples serialnum might return serialnum 0202430240x2aa 4 - 206...
Page 270: Session
System Commands session Names or finds an active API session. Syntax session name “session-name” session find “session-name” Parameter Description Names the current API session. name Finds an active API session for this system. find Unique string that identifies the session. session-name Feedback Examples •...
Page 271: Setaccountnumber
Integrator’s Reference Manual for Polycom HDX Systems setaccountnumber Sets the account number when it is required for dialing out. Syntax setaccountnumber “account number” Parameter Description Number that is needed to validate the account before “account number” dialing out. Feedback Examples...
Page 272: Showpopup
System Commands showpopup Displays a message box in the user interface. Syntax showpopup “text to display” Parameter Description Message to display to users. Enclose the text in “text to display” quotation marks if it contains a space. Feedback Examples showpopup “The conference will resume in three minutes.” returns showpopup The conference will resume in three minutes.
Page 273: Sleep
Integrator’s Reference Manual for Polycom HDX Systems sleep Puts the system in sleep mode and returns sleep. Syntax sleep sleep <register|unregister> Parameter Description Puts the system in sleep mode if not followed by other sleep parameters. Registers for sleep or wake events.
Page 274: Sleeptime
System Commands sleeptime Sets or gets the wait time value before the system goes to sleep and displays the screen saver. Syntax sleeptime <get|0|1|3|15|30|60|120|240|480> Parameter Description Returns the current setting. Sets the number of minutes from last user interaction to 0|1|3|15|30|60|120| entering sleep mode.
Page 275: Snmpadmin
Integrator’s Reference Manual for Polycom HDX Systems snmpadmin Sets or gets the SNMP administrator name. Syntax snmpadmin get snmpadmin set ["admin name"] Parameter Description Returns the current setting. Sets the administrator name when followed by the “admin name” parameter. To erase the current setting, omit “admin name”.
Page 276: Snmpcommunity
System Commands snmpcommunity Sets or gets the SNMP community name. Syntax snmpcommunity get snmpcommunity set ["community name"] Parameter Description Returns the current setting. Sets the SNMP community name when followed by the “community name” parameter. To erase the current setting, omit the parameter. SNMP community name.
Page 277: Snmpconsoleip
Integrator’s Reference Manual for Polycom HDX Systems snmpconsoleip Sets or gets the SNMP console IP address. Syntax snmpconsoleip get snmpconsoleip set ["xxx.xxx.xxx.xxx"] Parameter Description Returns the current setting. Sets the SNMP console IP address when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit the parameter.
Page 278: Snmplocation
System Commands snmplocation Sets or gets the SNMP location name. Syntax snmplocation get snmplocation set ["location name"] Parameter Description Returns the current setting. Sets the SNMP location name when followed by the “location name” parameter. To erase the current setting, omit the parameter. SNMP location name.
Page 279: Snmpsystemdescription
Integrator’s Reference Manual for Polycom HDX Systems snmpsystemdescription Sets or gets the SNMP system description. Syntax snmpsystemdescription get snmpsystemdescription set ["system description"] Parameter Description Returns the current setting. Sets the SNMP system description when followed by the “system description” parameter. To erase the current setting, omit the parameter.
Page 280: Soundeffectsvolume
System Commands 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 Description Returns the current setting along with a test tone from the system at that volume level.
Page 281: Spidnum
Integrator’s Reference Manual for Polycom HDX Systems spidnum Sets or gets the ISDN SPID numbers assigned to the BRI lines used by the system. This command is only applicable if you have a BRI network interface connected to your system.
Page 282 System Commands 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 Description Returns the current setting. Sets the signal to normal (falling edge sends data).
Page 283: Subnetmask
Integrator’s Reference Manual for Polycom HDX Systems subnetmask Sets or gets the subnet mask of the system. Syntax subnetmask get subnetmask set [“xxx.xxx.xxx.xxx”] Parameter Description Returns the current subnet mask. Sets the subnet mask of the system when followed by the ”xxx.xxx.xxx.xxx”...
Page 284: Sysinfo
System Commands sysinfo Sets or gets registration for ISDN, IP, and gatekeeper status notifications. Syntax sysinfo <get|register|unregister> Parameter Description Returns ISDN line status. Registers the shell session to receive ISDN, IP, and register gatekeeper status notifications. Unregisters the shell session for ISDN, IP, and unregister gatekeeper status notifications.
Page 285: Systemname
Integrator’s Reference Manual for Polycom HDX Systems systemname Sets or gets the name of the system. Syntax systemname get systemname set “system name” Parameter Description Returns the current setting. Sets the system name to “system name”. Character string specifying the system name. Enclose “system name”...
Page 286: Tcpports
System Commands tcpports Sets or gets the TCP ports on the system. Syntax tcpports get tcpports set [{1024..49150}] Parameter Description Sets the TCP ports when followed by a value from the range {1024..49150}. To erase the current setting, omit the value. Returns the current TCP port setting.
Page 287: Techsupport
Integrator’s Reference Manual for Polycom HDX Systems techsupport Sends your phone number to Global Management System technical support if your system is managed by the Global Management System. Syntax techsupport <"phone num"> Parameter Description Phone number at which the user of this system will be “phone num”...
Page 288: Teleareacode
System Commands teleareacode Sets or gets the system’s area code. Syntax teleareacode get teleareacode set ["telephone_area_code"] Parameter 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.
Page 289: Telecountrycode
Integrator’s Reference Manual for Polycom HDX Systems telecountrycode Sets or gets the system’s telephone country code. Syntax telecountrycode get telecountrycode set ["telephone_country_code"] Parameter 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.
Page 290: Telenumber
System Commands telenumber Sets or gets the system’s telephone number. Syntax telenumber get telenumber set ["telephone_number"] Parameter 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.
Page 291: Telnetmonitor
Integrator’s Reference Manual for Polycom HDX Systems 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.
Page 292: Timediffgmt
System Commands 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 Description Returns the current setting.
Page 293: Typeofservice
Integrator’s Reference Manual for Polycom HDX Systems typeofservice Sets or gets the type of service for Quality of Service. Syntax typeofservice <get|ipprecedence|diffserv> Parameter Description Returns the current setting. Selects IP precedence service. ipprecedence Selects DiffServ service. diffserv Feedback Examples typeofservice diffserv...
Page 294: Udpports
System Commands udpports Sets or gets the UDP ports on the system. Syntax udpports get udpports set [{1024..49150}] Parameter Description Returns the current UDP port setting. Sets the UDP ports when followed by a value from the range {1024..49150}. To erase the current setting, omit the value.
Page 295: Unregisterall
Integrator’s Reference Manual for Polycom HDX Systems unregisterall Alias for the all unregister command. Syntax unregisterall Command History Introduced in VSX version 8.5. See Also This command is an alias for the preferred command on all unregister page 4-12. To register for user feedback, use the...
Page 296: Usefixedports
System Commands usefixedports Sets or gets the Fixed Ports configuration. Syntax usefixedports <get|yes|no> Parameter Description Returns the current setting. Enables the use of Fixed Ports. Disables the use of Fixed Ports. Feedback Examples • usefixedports no • usefixedports yes 4 - 233...
Page 297: Usegatekeeper
Integrator’s Reference Manual for Polycom HDX Systems usegatekeeper Sets or gets the gatekeeper mode (off, specify, or auto). Syntax usegatekeeper <get|off|specify|auto> Parameter Description Returns the current setting. Note: A gatekeeper is not required to make IP-to-IP LAN calls. In these situations, select the off option.
Page 298: Usepathnavigator
System Commands usepathnavigator Sets or gets the Polycom PathNavigator™ mode, if PathNavigator is used with the system. Syntax usepathnavigator <get|always|never|required> Parameter Description Returns the current setting. Always use PathNavigator to place a multipoint call. always Never use the external MCU.
Page 299: Useroompassword
Integrator’s Reference Manual for Polycom HDX Systems useroompassword Sets or gets the Use Room Password for Remote Access setting. Syntax useroompassword get useroompassword <no|yes> Parameter Description Returns the current setting. Configures the system to use a separate room password and remote access password...
Page 300: V35Broadcastmode
System Commands 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 Description Returns the current setting. Turns on V.35 broadcast. Turns off V.35 broadcast. Feedback Examples •...
Page 301: V35Dialingprotocol
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting.
Page 302: V35Num
System Commands 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 system. Syntax v35num get <1b1|1b2> v35num set <1b1|1b2> ["v35 number"] Parameter Description Returns the current ISDN video number associated with a B channel of a particular line.
Page 303: V35Portsused
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting. Selects one port for one-channel calls. Selects two ports for two-channel calls (2 x 56 kbps or 2 x 64 kbps).
Page 304: V35Prefix
System Commands 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 Description Returns the current setting for “valid speed”. Sets the V.35/RS-449/RS-530 prefix when followed by a “value”...
Page 305: V35Profile
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current profile.
Page 306: V35Suffix
System Commands 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 Description Returns the current setting for valid speed. Sets the dialing suffix when followed by a “value” parameter.
Page 307: Validateacctnum
Integrator’s Reference Manual for Polycom HDX Systems 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 Description Returns the current setting. Enables the Global Management System account number validation option.
Page 308: Vcbutton
System Commands vcbutton Controls a content video source. It can also register or unregister to receive notification of content events. Syntax vcbutton <get|play|stop|register|unregister> vcbutton map <get|{2..5} Parameter Description Returns the current setting (play or stop). Starts sending the content from the computer. play Stops sending the content from the computer.
Page 309: Vcrrecordsource
Integrator’s Reference Manual for Polycom HDX Systems vcrrecordsource Sets or gets the VCR/DVD record source. Syntax vcrrecordsource get vcrrecordsource <near|far|auto|content|content-or-near| content-or-far|content-or-auto|none> Parameter Description Returns the current setting. Sets the VCR to record the near-site video source. near Sets the VCR to record the far-site video source.
Page 310: Version
System Commands version Returns the current system’s version information. Syntax version Feedback Examples version "Release 8.5 12jul2006 06:09" 4 - 247...
Page 311: Volume
Integrator’s Reference Manual for Polycom HDX Systems volume Sets or gets the call audio volume (not sound effects) on the system or registration for volume changes. Syntax volume <register|unregister> volume <get|up|down|set {0..50}> Parameter Description Registers to receive notification when the volume register changes.
Page 312: Vortex
System Commands Vortex Sends commands to a Polycom Vortex mixer. Syntax vortex <0|1> mute <on|off> vortex <0|1> forward “vortex_macro” Parameter Description Specifies the serial port to which the Vortex mixer is connected. Sets the mute state for the Vortex mixer connected to mute the specified serial port.
Page 313: Waitfor
Integrator’s Reference Manual for Polycom HDX Systems 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 314: 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-210. sleep 4 - 251...
Page 315: Wanipaddress
Integrator’s Reference Manual for Polycom HDX Systems wanipaddress Sets or gets the WAN IP address. Syntax wanipaddress get wanipaddress set [“xxx.xxx.xxx.xxx”] Parameter Description Sets the WAN IP address when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit the “xxx.xxx.xxx.xxx” parameter.
Page 316: Webport
System Commands webport Sets or gets the port to use when accessing the system using the web interface. Syntax webport get webport set “port” Parameter Description Returns the current setting. Sets the web access port to “port”. Feedback Examples webport set 80 returns webaccessport 80 restart system for changes to take effect.
Page 317: Whoami
Integrator’s Reference Manual for Polycom HDX Systems whoami Displays the same initial banner information as when the RS-232/Telnet session was started with the system. Syntax whoami Feedback Examples Hi, my name is : mine Here is what I know about myself:...
Page 318: 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 319 Integrator’s Reference Manual for Polycom HDX Systems 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 320: Walls
Room Design and Layout 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 321: Ceiling Tiles
Integrator’s Reference Manual for Polycom HDX Systems 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...
Page 322: Interior Design And Finishes
Room Design and Layout 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 323: Room Lighting
Integrator’s Reference Manual for Polycom HDX Systems 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 324: 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 325: Room Preparation Conclusion
Integrator’s Reference Manual for Polycom HDX Systems 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 326 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 327: Audio Output
Integrator’s Reference Manual for Polycom HDX Systems 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,...
Page 328: Range/Frequency Response
Room Design and Layout 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.
Page 329: Video Projection For Use In Videoconference
Integrator’s Reference Manual for Polycom HDX Systems 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...
Page 330: 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 331 Integrator’s Reference Manual for Polycom HDX Systems A - 14...
Page 332: B Commands That Prompt Restart
Commands that Prompt Restart The following commands return a prompt to restart the Polycom HDXsystem. callpreference h320|h323|both configdisplay monitor1 vga|s_video defaultgateway set dhcp off|client|server dns set enablesnmp hostname set ipaddress set lanport reboot yes subnetmask set webport set winsresolution yes|no...
Page 333 Integrator’s Reference Manual for Polycom HDX Systems B - 2...
Page 334: C Status Messages
Status Messages Status Display The call status can be displayed in a number of ways. The getcallstate command on page 4-100 returns a table listing the status, (deprecated) 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 command on callstate...
Page 335 Integrator’s Reference Manual for Polycom HDX Systems 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]...
Page 336 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 337 Integrator’s Reference Manual for Polycom HDX Systems C - 4...
Page 338: D Specifications
Specifications Inputs/Outputs Audio Specifications Characteristic Value Maximum Input Level 0 dBFS for Audio Input 4 +12 dBV (4.0 V ), 1 dB Maximum Input Level 0 dBFS for Audio Input 3 (VCR/DVD) +12 dBV (4.0 V ), 1 dB Maximum Input Level 0 dBFS for Audio Input 1 (External 20 dBV (100 mV ), 1 dB...
Page 339 Integrator’s Reference Manual for Polycom HDX Systems Characteristic Value Frequency Response Balanced Inputs, Relative to 997 Hz +0.5, 3 dB, 20 Hz to 50 Hz 1 dB, 50 Hz to 20 kHz +0.5, 3 dB, 20 kHz to 22 kHz Total Harmonic Distortion + Noise vs.
Page 340: Dtmf Dialing
Specifications DTMF Dialing The HDX 9000 series systems generate the following tip/ring signal levels: • Low-frequency tone: 10.2 dBV, -8.0 dBm when AC termination of the line is 600 Ohms • High-frequency tone: -8.2 dBV, -6.0 dBm when AC termination of the line is 600 Ohms •...
Page 341: Remote Control
Integrator’s Reference Manual for Polycom HDX Systems Remote Control This section provides information about the IR signals for Polycom HDX systems. This information is provided for reference only. Polycom claims no responsibility or liability for programmed third-party remote control devices. Notes •...
Page 342 Specifications Key Name Key Code Key Code Parity 110111 111000 111001 Even Auto 11001 Call 100101 Call/Hang Up Even Camera 11110 Even Colon 101111 Delete 100010 Even Dial String Even Directory 11010 100001 Even Down Arrow Even 10001 Even Fast Forward 101011 Even Feet Down...
Page 343 Integrator’s Reference Manual for Polycom HDX Systems Key Name Key Code Key Code Parity Power 100111 Even Preset 11111 Record 101110 Even Return Rewind 101100 Right Arrow 1010 Even Slides (Graphics) 10010 Even Snapshot (Snap) 10101 Stop 101010 Up Arrow...
Page 344: Rs-232 Serial Interface
Flow Control Control 9600 (default), 14400, None 19200, 38400, 57600, 115200 Camera PTZ 9600 (default), 14400, None (Sony), 19200, 38400, 57600, Even (Polycom 115200 Eagle Eye) Closed Caption 9600 (default), 14400, None 19200, 38400, 57600, 115200 Vortex Mixer 9600 (default), 14400,...
Page 345: Resolution Vs. Call Quality
Integrator’s Reference Manual for Polycom HDX Systems Resolution vs. Call Quality Resolution Sharpness @ 30FPS 1280 x 720 9CIF 9CIF Motion @ 30FPS Motion @ 30FPS 1280 x 720 1280 x 720 Sharpness @ 30FPS Sharpness @ 30FPS 4CIF 4CIF...
Page 346 Index Symbols session command 4-207 ! command 4-3 using over LAN 3-3 using over RS-232 3-1 area code abk command 4-4 command for BRI 4-18 account number command for gateway 4-91 command for requiring 4-196 command for ISDN 4-131 command for setting 4-208 command for system 4-225 command for validating 4-244 areacode command 4-18...
Page 347 Integrator’s Reference Manual for Polycom HDX Systems chaircontrol command 4-37 city, command for GMS 4-101 cables analog telephone 2-3 cmdecho command 4-40 audio 2-34, 2-35 colorbar command 4-39 BNC monitor 2-14 composite video cable 2-19 BNC to S-Video 2-10 configchange command 4-41...
Page 348 Index dir command 4-60 flash command 4-86 directory frame rate, command for H.331 calls 4-114 command for allowing changes 4-13 fullscreen mode, command for multipoint command for confirming additions 4-45 display 4-155 command for confirming deletions 4-46 directory command 4-61 discussion mode, command for multipoint gabk command 4-87 display 4-155...
Page 349 Integrator’s Reference Manual for Polycom HDX Systems h331dualstream command 4-113 isdndialingprefix command 4-133 h331framerate command 4-114 isdndialspeed command 4-134 h331videoformat command 4-115 isdnnum command 4-135 h331videoprotocol command 4-116 isdnswitch command 4-136 hangup command 4-117 HDCI analog camera cable 2-16 keypadaudioconf command 4-137...
Page 350 Index notifications, line state changes 4-140 preset command 4-176 notify command 4-165 PRI cable 2-2 ntpmode command 4-168 PRI channel information 4-178 ntpserver command 4-169 PRI port assignments 2-2 null modem adapter 2-41 pricallbycall command 4-177 numdigitsdid command 4-170 prichannel command 4-178 numdigitsext command 4-171 pricsu command 4-180 pridialchannels command 4-181...
Page 351 Integrator’s Reference Manual for Polycom HDX Systems teleareacode command 4-225 telecountrycode command 4-226 screen command 4-204 telenumber command 4-227 screen saver setting 4-151, 4-153 Telnet session 3-3 screencontrol command 4-205 telnetmonitor command 4-228 serialnum command 4-206 time in call, command 4-147...
Page 352 Index waitfor command 4-250 wanipaddress command 4-252 webport command 4-253 whoami command 4-254 Index–7...
Page 353 Integrator’s Reference Manual for Polycom HDX Systems Index–8...

Polycom HDX series Reference Manual

1 Room Integration

2 Cables

3 Using the API

4 System Commands

A Room Design and Layout

Quick Links

Related Manuals for Polycom HDX series

Summary of Contents for Polycom HDX series