Integrator’s Reference Manual for Polycom® HDX™ Systems 2.
Trademark Information Polycom®, the Polycom “Triangles” logo, and the names and marks associated with Polycom’s products are trademarks and/or service marks of Polycom, Inc., and are registered and/or common-law marks in the United States and various other countries. All other trademarks are the property of their respective owners. Patent Information The accompanying product is protected by one or more U.S. and foreign patents and/or pending patent applications held by Polycom, Inc.
About This Guide The Integrator’s Reference Manual for Polycom HDX Systems is for system integrators who need to configure, customize, manage, and troubleshoot Polycom® HDX systems. The API commands in this guide are only applicable to the Polycom HDX™ 9000 series and Polycom HDX™ 8000 HD systems. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems iv About This Guide Polycom, Inc.
Contents About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii 1 Room Integration Setting Up a Room for Video Conferencing . . . . . . . . . . . . . . . . . . . . . . . . 1–1 Room Layout Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1 Setting Up the Room for Polycom People On Content™ . . . . . . . . . . 1–3 Polycom HDX Installation Precautions . . . . . . . . . . . . . . . . . . . . . . . . . 1–4 Integrating Video . . . . . . . . . .
Integrator’s Reference Manual for Polycom HDX Systems BNC to S-Video Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–16 DVI to VGA Monitor Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–17 HDMI Monitor Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–18 BNC Monitor Adapter Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–19 Polycom HDX Component Monitor Cable . . . . . . . . . . . . .
Contents 3 Using the API Using the API with an RS-232 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1 Configuring the RS-232 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1 Starting an API Session via an RS-232 Interface . . . . . . . . . . . . . . . . . 3–2 Using the API with the Department of Defense (DoD) Security Profile Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrator’s Reference Manual for Polycom HDX Systems audiotransmitlevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–33 autoanswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–35 autoshowcontent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–36 backlightcompensation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents cts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–87 daylightsavings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–88 dcd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–89 dcdfilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrator’s Reference Manual for Polycom HDX Systems gabserverip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–135 gaddrbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–136 gatekeeperip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–139 gatewayareacode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents homesystemname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–177 hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–178 importdirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–180 ipaddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–183 ipdialspeed . . . . . . . . . . . . . .
Integrator’s Reference Manual for Polycom HDX Systems monitor2screensaveroutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–222 mpautoanswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–223 mpmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–224 mtumode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents remotecontrol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–269 remotemonenable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–271 requireacctnumtodial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–272 resetsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–273 roomphonenumber . . . . . . . . . . . . . . . . .
Integrator’s Reference Manual for Polycom HDX Systems udpports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–312 unregisterall (deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–313 usefixedports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–314 usegatekeeper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Light Fixtures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–7 Room Preparation Conclusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–8 Audio Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–8 Audio Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–8 Audio Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrator’s Reference Manual for Polycom HDX Systems xvi Polycom, Inc.
1 Room Integration Setting Up a Room for Video Conferencing For detailed information about setting up a room for video conferencing, refer to Room Design and Layout on page 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.
Integrator’s Reference Manual for Polycom HDX Systems Large Conference Room Document Camera Acoustic Panels Polycom SoundStation® IP 7000 Phone 00 07 PI no ita tS dn uo S Polycom Microphone Polycom HDX system and EagleEye HD camera Flat Panel Monitor 1 Polycom HDX Media Center 1–2 Flat Panel Monitor 2 Network Outlets Power Outlets Polycom, Inc.
Room Integration Classroom Teacher’s Podium Touch Panel Computer Document Camera Monitor 1 Camera 2 Polycom HDX system with EagleEye HD camera and Polycom SoundStructure™ mixer Monitor 2 Monitor for VGA Out Table-Top Microphones Setting Up the Room for Polycom People On Content™ For the best results, follow these guidelines for setting up Polycom People On Content™: Polycom, Inc. • Use the Polycom EagleEye™ HD camera with Polycom HDX 9000 series and Polycom HDX 8000 series systems.
Integrator’s Reference Manual for Polycom HDX Systems • Make sure that the background and the presenter are well lit. For example, use a minimum of two 250 W halogen lights on the background and one on the presenter. • Experiment with different room and lighting arrangements until the best results are achieved.
Room Integration 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.
Integrator’s Reference Manual for Polycom HDX Systems Polycom EagleEye HD Camera as the Second Camera up to 30 ft Away You can connect a Polycom EagleEye HD camera (part number 8200-23600-001 or 8200-23610-001) to a Polycom HDX 9000 Series system as the second camera using: • HDCI Analog Camera Cable on page 2-24 . • Power supply. Use only the approved power supply from Polycom (part number 1465-52621-036). Do not exceed 12 Volts at 3 Amps.
Room Integration Polycom EagleEye HD Camera as the Main or Second Camera up to 100 ft Away To connect a Polycom EagleEye HD camera (part number 8200-23600-001 or 8200-23610-001) to a Polycom HDX 9000 Series system more than 30 ft away: Option 1 • HDCI Analog Camera Cable on page 2-24 . • Power supply. Use only the approved power supply from Polycom (part number 1465-52621-036). Do not exceed 12 Volts at 3 Amps.
Integrator’s Reference Manual for Polycom HDX Systems Option 2 • A—Two HDCI Camera Break-Out Cable on page 2-26 . • B—Coaxial analog video cables • C—DB-9 serial cable • Power supply. Use only the approved power supply from Polycom (part number 1465-52621-036). Do not exceed 12 Volts at 3 Amps. Verify the polarity of the power supply as shown on the Polycom camera next to the power supply input. Polycom recommends this configuration when a custom cable length is required.
Room Integration Polycom EagleEye 1080 or Sony EVI-HD1 PTZ as the Main or Second Camera You can connect a Polycom EagleEye 1080 or Sony EVI-HD1 PTZ camera to a Polycom HDX 9000 Series system as the main or second camera using: Option 1 • HDCI Polycom EagleEye 1080 Camera Cable on page 2-33 (this cable is compatible with the Sony EVI-HD1 PTZ camera) Polycom recommends this configuration when a custom cable length is required. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems Option 2 • A—HDCI Sony adapter cable on page HDCI Sony VISCA Adapter Cable on page 2-35 . • B—VGA cable • C—VISCA cable Polycom recommends this configuration when a custom cable length is required. A B Up to 100 ft C Up to 100 ft 1–10 Polycom, Inc.
Room Integration PowerCam as the Main Camera up to 10 ft Away You can connect a PowerCam (part number 2215-50370-001) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the main camera up to 10 ft away using: Option 1 • HDCI PowerCam Cable on page 2-30 1 1 Option 2 • A—PowerCam Primary Camera Cable on page 2-37 • B— HDCI PowerCam Plus Adapter Cable on page 2-31 A 1 1 Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems PowerCam as the Second Camera The following kits are available, which include the power supply, PowerCam Break-Out cable, 8-pin mini-DIN to DB-9 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 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the second camera using: • A— PowerCam Break-Out Cable on page 2-38 • B— 8-pin mini-DIN to DB-9 on pa
Room Integration • D—BNC to S-Video Cable on page 2-15 • Power Supply (part number 1465-52621-036) A C B D IOIOIO Y C 3 VCR/DVD IOIOIO 3 VCR/DVD If you connect a PTZ camera to a serial port, set RS-232 Mode to Camera PTZ on the Serial Ports screen. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems PowerCam Plus as the Main Camera up to 10 ft Away You can connect a PowerCam Plus (part number 2215-50200-001) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the main camera up to 10 ft away using: • A— PowerCam Plus Primary Cable on page 2-29 • B— HDCI PowerCam Plus Adapter Cable on page 2-31 Automatic camera tracking is not available when using the PowerCam Plus camera with a Polycom HDX system.
Room Integration PowerCam Plus as the Second Camera up to 10 ft Away You can connect a PowerCam Plus (part number 2215-50200-001) to a Polycom HDX 9001, Polycom HDX 9002, or Polycom HDX 9004 system as the second camera up to 10 ft away using: • A— PowerCam Plus Primary Cable on page 2-29 • B— HDCI PowerCam Plus Adapter Cable on page 2-31 • Power Supply (part number 1465-52621-036) Automatic camera tracking is not available when using the PowerCam Plus camera with a Polycom HDX system A B 2 2 Poly
Integrator’s Reference Manual for Polycom HDX Systems Connecting Sony and ELMO Cameras Refer to the release notes for a list of supported Pan/Tilt/Zoom (PTZ) cameras.
Room Integration Sony BRC-H700 PTZ To connect a Sony BRC-H700 PTZ camera to a Polycom HDX 9000 Series system: You can connect a Sony BRC-H700 PTZ camera to a Polycom HDX system using: • A— DVI to VGA Monitor Cable on page 2-17 • B— 8-pin mini-DIN to DB-9 on page 2-40 • C—VGA extension cable To provide XGA output (1024x768), you must install the optional Sony HFBK-XG1 card into the slot on the back of the Sony BRC-H700 PTZ camera.
Integrator’s Reference Manual for Polycom HDX Systems Connecting Vaddio and Canon Cameras Refer to the release notes for a list of supported Pan/Tilt/Zoom (PTZ) cameras.
Room Integration Vaddio 300 PTZ as the Main or Second Camera To connect a Vaddio 300 PTZ camera to a Polycom HDX 9000 Series system as the main or second camera: You can connect a Vaddio 300 PTZ camera to a Polycom HDX system using: • A—HDCI VISCA Adapter Cable on page 2-32 • B—DB-9 serial cable • C—S-Video Cable on page 2-14 Note: For situations that require extraordinary cable lengths, CAT5 extension kits for camera video, power, and control are available from third-party vendors.
Integrator’s Reference Manual for Polycom HDX Systems Integrating Audio and Content Connecting a Computer to a Polycom HDX 9000 Series System You can connect Polycom HDX™ 9000 series systems to a computer. To connect a computer to a Polycom HDX 9001 or Polycom HDX 9002 system: Option 1 Connect a Polycom HDX™ 9001 or Polycom HDX 9002 system to a computer using • A—DVI to VGA Monitor Cable on page 2-17 • B—3.
Room Integration Option 2 To hear audio at both the near site and the far site, use a bypass mixer to connect a computer to the Polycom HDX 9001 or Polycom HDX 9002 system as the following figure shows. 4 Y 1 Y C IOIOIO 1 2 Y C 2 3 Y VCR/DVD 3 VCR/DVD C C 4 100-240VAC 50/60Hz 4A 1 1 3 1 VCR/DVD 3 VCR/DVD IR LAN 1 1 Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems To connect a computer to a Polycom HDX 9004 system: Connect a Polycom HDX 9004 system to a computer using • A—DVI to VGA Monitor Cable on page 2-17 • B—3.5 mm stereo to RCA adapter cable • C- Audio Adapter Cable on page 2-49 (Polycom HDX 9004, Polycom HDX 9002, and Polycom HDX 9001 systems only.
Room Integration To connect a computer to a Polycom HDX 9006 system: Connect a Polycom HDX 9006 system to a computer using: • A—DVI to VGA Monitor Cable on page 2-17 • B—3.5 mm stereo to dual 3-pin Phoenix connectors cable When you connect a computer to video input 4 and audio input 4 on a Polycom HDX 9006 system as follows, audio from input 4 is muted unless video input 4 is selected as a video source. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems Connecting a Vortex® Mixer to a Polycom HDX 9000 Series System Polycom strongly recommends using Polycom InstantDesigner™ to get started with your 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.
Room Integration Connecting a Polycom SoundStructure C-Series Mixer to a Polycom HDX 9000 Series System Connect a Polycom HDX system to the Polycom SoundStructure C-Series mixer using: • Polycom HDX Microphone Host Cable on page 2-41 Y 1 Y C 2 Y C 3 VCR/DVD 4 C 2 2 1 IOIOIO 3 Y C VCR/DVD 4 5 100-240VAC 50/60Hz 4A 1 1 3 4 VCR/DVD 1 3 VCR/DVD IR LAN C-LINK2 IN OBAM OUT IR 12V 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 1 2 3 4 5 6 7 8 9 10 11 12 13 14
Integrator’s Reference Manual for Polycom HDX Systems 1–26 Polycom, Inc.
2 Cables This chapter includes information about cables that can be used with a Polycom HDX system. Please note that drawings and part numbers are provided for reference only. Compliance information is provided for the Restriction of certain Hazardous Substances Directive (RoHS). 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.
Integrator’s Reference Manual for Polycom HDX Systems 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. 2–2 Polycom, Inc.
Cables LAN Cable This cable connects a Polycom HDX system to the LAN. It has orange RJ-45 connectors on both ends and is used with all systems. The maximum approved length for this cable is 100 ft (30 m). Length Part Number RoHS Compliant 12 ft (3.6 m) 2457-08343-001 Yes CONN. RJ-45 ( x2 ) P1 P2 PIN # PIN # 1 1 2 2 3 3 4 4 5 5 6 6 7 7 8 8 PIN 8 PIN 8 P2 P1 12 FEET +/- 3" Drawings and part numbers are provided for reference only.
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). Length Part Number RoHS Compliant 20 ft (6.6 m) 2457-08548-001 Yes Drawings and part numbers are provided for reference only.
Cables PRI Pin Assignments The following illustration and table show the pin assignments for the PRI port on the Polycom HDX system. Pin 8 Pin 1 Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems 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) 2457-20071-001 Yes Drawings and part numbers are provided for reference only.
Cables V.35/RS-449/RS-530 Serial Adapter This adapter is used when connecting a Polycom HDX system to other third-party network equipment. It adapts the 68-pin interface to an industry standard 44-pin interface used by some network interface equipment. It is used with Polycom HDX systems that have a V.35/RS-449/RS-530 serial network interface card (NIC) installed. Length Part Number RoHS Compliant 6 in (15.23 cm) 2457-21264-200 Yes Peripheral Link Notes (direction from V.35 module (DTE)) V.
Integrator’s Reference Manual for Polycom HDX Systems V.35 NIC Cable This cable connects a Polycom HDX system to Ascend network equipment. It is used with the V.35/RS-449/RS-530 serial adapter on page V.35/RS-449/RS-530 Serial Adapter on page 2-7 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 Part Number RoHS Compliant 5 ft (1.
Cables V.35 and RS-366 Serial Cable This cable connects a Polycom HDX system to third-party network equipment. It is used with the V.35/RS-449/RS-530 serial adapter on page V.35/RS-449/RS-530 Serial Adapter on page 2-7 to connect to network equipment that has a V.35/RS-366 interface. It is HD-44 M to “Y” Winchester 34M/RS-366 DB-25M and is used with Polycom HDX systems that have a serial network interface card (NIC) installed. Length Part Number RoHS Compliant 5 ft (1.
Integrator’s Reference Manual for Polycom HDX Systems RS-449 and RS-366 Serial Cable This cable connects a Polycom HDX system to third-party network equipment. It is used with the V.35/RS-449/RS-530 serial adapter on page V.35/RS-449/RS-530 Serial Adapter on page 2-7 to connect to network equipment that has an RS-449/RS-366 interface. It is HD-44 M to “Y” RS-449 DB-37M/RS-366 DB-25M and is used with Polycom HDX systems that have a serial network interface card (NIC) installed.
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. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems RS-530 with RS-366 Serial Cable This cable connects a Polycom HDX system to third-party network equipment. It is used with the V.35/RS-449/RS-530 serial adapter on page V.35/RS-449/RS-530 Serial Adapter on page 2-7 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 Part Number RoHS Compliant 5 ft (1.
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. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems 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). Length Part Number RoHS Compliant 8 ft (2.4 m) 2457-08410-002 Yes 25 ft (7.6 m) 2457-08409-002 Yes 50 ft (15 m) 2457-09204-200 Yes MINI-DIN MALE 4 POS.
Cables 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 male. The maximum approved length for this cable is 100 ft (30 m). Length Part Number RoHS Compliant 6 ft (1.8 m) 2457-21489-200 Yes DIMENSIONS ARE IN MILLIMETERS Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems BNC to S-Video Adapter This adapter may be required when connecting standard S-Video cables to a Polycom HDX system. It is dual BNC male to 4-pin female mini-DIN. Length Part Number RoHS Compliant 1 ft (.3 m) 2457-21490-200 Yes Drawings and part numbers are provided for reference only.
Cables 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-A video inputs on a Polycom HDX system. It is male DVI-A to male HD-15. Length Part Number RoHS Compliant 4 ft 6 in (1.5 m) 2457-25182-001 Yes 9 ft 10 in (3 m) 2457-23792-001 Yes 25 ft (7.6 m) 2457-23792-025 Yes Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems HDMI Monitor Cable This cable connects the Polycom HDX system DVI-I output to an HDMI monitor. It is male DVI-D to male HDMI. Length Part Number RoHS Compliant 9 ft 10 in (3 m) 2457-23905-001 Yes 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.
Cables 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. Length Part Number RoHS Compliant 1 ft (0.3 m) 2457-23533-001 Yes Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems Polycom HDX Component Monitor Cable This cable connects a Polycom HDX system DVI-I output to a monitor with component connections. It is male DVI-A to three RCA. Length Part Number RoHS Compliant 6 ft (1.8 m) 2457-52698-006 Yes 12 ft (3.6 m) 2457-52698-012 Yes Drawings and part numbers are provided for reference only.
Cables HDX Component Video Cable This cable connects a Polycom HDX system to a video playback device with component connections. It is three RCA to three male BNC. Length Part Number RoHS Compliant 25 ft (7.6 m) 2457-52688-025 Yes 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.
Integrator’s Reference Manual for Polycom HDX Systems 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 4 ft 6 in (1.5 m) 2457-25181-001 Yes 9 ft 10 in (3 m) 2457-23793-001 Yes Drawings and part numbers are provided for reference only.
Cables Component A/V Monitor Cable This cable connects a Polycom HDX system DVI-I video output and stereo audio output to a monitor with component video and stereo audio connections. It is male DVI-A and dual male RCA to five RCA. You must use the audio adapter cable on page Audio Adapter Cable on page 2-49 to connect the dual RCA connectors on this component A/V monitor cable to the dual Phoenix connectors on the Polycom HDX system.
Integrator’s Reference Manual for Polycom HDX Systems HDCI Analog Camera Cable This cable connects a Polycom HDX system to a Polycom EagleEye HD camera. This cable can be connected to the EagleEye View camera, but does not support audio. It has male HDCI connectors on both ends.
Cables HDCI Digital Camera Cable This cable connects a Polycom HDX system to a Polycom EagleEye HD camera. It has male HDCI connectors on both ends. Length Part Number RoHS Compliant 9 ft 10 in (3 m) 2457-23181-003 Yes 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.
Integrator’s Reference Manual for Polycom HDX Systems HDCI Camera Break-Out Cable This cable breaks out the HDCI camera cable video and control signals to standard interfaces. This cable can be connected to the EagleEye View camera, but does not support audio.The five BNC connectors can be used to carry composite video, S-Video, or analog component YPbPr video. The DB-9 connector is used to connect to PTZ camera control interfaces. It is male HDCI to five female BNC and one female DB-9.
Cables 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-49 . The maximum approved length for this cable is 50 ft (15 m). Length Part Number RoHS Compliant 8 ft (2.6 m) 2457-08412-001 — Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems 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. The maximum approved length for this cable is 100 ft (30 m). Length Part Number RoHS Compliant 25 ft (7.6 m) 2457-09207-001 — Drawings and part numbers are provided for reference only.
Cables PowerCam Plus Primary Cable This cable connects a Polycom HDX system to a Polycom PowerCam Plus camera using the HDCI PowerCam Plus Adapter Cable on page 2-31 . It has 4-pin mini-DIN and DB-15 connectors on both ends. Length Part Number RoHS Compliant 9 ft 10 in (3 m) 1457-50105-002 Yes 30 ft (9 m) 1457-50105-230 Yes 50 ft (15 m) 1457-50105-250 Yes 100 ft (30 m) 1457-50105-300 Yes 150 ft (45 m) 1457-50105-350 Yes 200mm / 7.87" 200mm / 7.87" P3 P1 P2 P4 40mm / 1.57" 40mm / 1.
Integrator’s Reference Manual for Polycom HDX Systems HDCI PowerCam Cable This cable connects a Polycom HDX system to a Polycom PowerCam camera. It is HDCI to 8-pin mini-DIN. Length Part Number RoHS Compliant 10 ft (3 m) 2457-28168-001 Yes 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.
Cables HDCI PowerCam Plus Adapter Cable This cable adapts a PowerCam Plus cable to HDCI. It is HDCI to 4-pin mini-DIN and DB-15. It can also be used with the PowerCam Primary Camera Cable on page 2-37 to connect PowerCam. Length Part Number RoHS Compliant 1 ft (0.3 m) 2457-23481-001 Yes Drawings and part numbers are provided for reference only.
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 that use a DB-9 serial connector. 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. Length Part Number RoHS Compliant 1 ft (0.3 m) 2457-23486-001 Yes Drawings and part numbers are provided for reference only.
Cables HDCI Polycom EagleEye 1080 Camera Cable This cable connects a Polycom HDX system HDCI video input to a Polycom EagleEye 1080 camera or to a Sony HD camera. The cable is HDCI to 8-pin mini-DIN and HD-15. Length Part Number RoHS Compliant 9 ft 10 in (3 m) 2457-28153-001 Yes 33 ft (10 m) 2457-28154-001 Yes 50 ft (15m) 2457-28154-050 Yes 100 ft (30m) 2457-28154-100 Yes Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems HDCI Polycom EagleEye View Camera Cable This cable connects a Polycom HDX system HDCI video input to a Polycom EagleEye View camera. It has male HDCI connectors on both ends. Length Part Number RoHS Compliant 9 ft 10 in (3 m) 2457-29759-001 Yes 33 ft (10 m) 2457-29759-010 Yes Drawings and part numbers are provided for reference only.
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. The VISCA cable is a straight-through male 8-pin mini-DIN to male 8-pin mini-DIN serial cable. Length Part Number RoHS Compliant 1 ft (0.3 m) 2457-23549-001 Yes Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems HDCI EagleEye 1080 or Sony Adapter Cable This cable connects a Polycom system HDCI video input to the Polycom EagleEye 1080, Sony EVI-HD1 PTZ or Sony BRC-H700 PTZ cameras. It is HDCI to 8-pin mini-DIN and HD-15. The maximum approved length for this cable is 100 ft (30 m). Length Part Number RoHS Compliant 1 ft (0.3 m) 2457-23548-001 Yes Drawings and part numbers are provided for reference only.
Cables 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-31 . It is 8-pin mini-DIN to 4-pin mini-DIN and DB-15. The maximum approved length for this cable is 10 ft (3 m). Length Part Number RoHS Compliant 9 ft 10 in (3 m) 1457-50338-002 Yes 200mm / 7.87" 3 2 4 40mm (1.
Integrator’s Reference Manual for Polycom HDX Systems PowerCam Break-Out Cable This cable connects S-Video and control cables and a power supply to a Polycom PowerCam camera. This combination is required when using the PowerCam as the primary camera more than 10 ft away from the system, or as the secondary camera. It is 8-pin mini-DIN to 3-way breakout block. A separate power supply is required (part number 1465-52621-036). Length Part Number RoHS Compliant 6 ft (1.
Cables PowerCam Plus/VISCA Control Cable 8-pin mini-DIN to DB-15 This cable adapts the 8-pin mini-DIN VISCA control interface to the PowerCam Plus DB-15 control interface. It is used with the PowerCam Break-Out cable and the HDCI PowerCam Plus adapter cable. It is 8-pin mini-DIN to DB-15. Part Number RoHS Compliant 50 ft (15 m) 1457-50527-201 Yes 8 Pin Mini Din Male 7 4 1 P1 6 3 7 8 2 3 4 5 6 9 10 11 12 13 14 15 2 1 P2 8 5 Length 50' ± 3.
Integrator’s Reference Manual for Polycom HDX Systems 8-pin mini-DIN to DB-9 This cable connects Polycom HDX system serial port inputs to a non-Polycom camera using a VISCA 8-pin DIN connector, or to a Polycom PowerCam break-out cable with a PowerCam camera. It is 8-pin mini-DIN to DB-9. RTS/CTS and IR are not supported on this cable. Length Part Number RoHS Compliant 50 ft (15 m) 2457-10029-200 Yes Drawings and part numbers are provided for reference only.
Cables Audio Cables Polycom HDX Microphone Host Cable For more information about supported microphone configurations, refer to the Administrator’s Guide for Polycom HDX Systems. This cable connects a Polycom HDX system to the Polycom SoundStructure C-Series mixer. It is unkeyed male RJ-45 on both ends. Length Part Number RoHS Compliant 18 in (0.5 m) 2457-23574-001 Yes 25 ft (7.
Integrator’s Reference Manual for Polycom HDX Systems When connecting two Polycom HDX microphone host devices, a cross-over cable is required. To build a custom cross-over cable for this purpose, you should use shielded CAT5 or better cable. Each end of the custom cable should have a shielded RJ-45 plug connector that connects to a Polycom HDX microphone host device. The maximum supported cable length is 100 feet.
Cables Polycom HDX Microphone Array Cable For more information about supported microphone configurations, refer to the Administrator’s Guide for Polycom HDX Systems. This cable connects two Polycom HDX microphones together. This cable can also be used with the Polycom HDX Microphone Array Cable Adapter on page 2-44 to connect a Polycom HDX system to a Polycom HDX microphone array or to a SoundStation IP 7000 phone. It has male Walta connectors on both ends.
Integrator’s Reference Manual for Polycom HDX Systems Polycom HDX Microphone Array Cable Adapter For more information about supported microphone cable configurations, refer to the Administrator’s Guide for Polycom HDX Systems. This cable adapts the Polycom HDX Microphone Array Cable on page 2-43 for use with the Polycom HDX 9000 Series system and the SoundStructure C-Series mixer. It is male RJ-45 to female Walta. Length Part Number RoHS Compliant 18 in (0.
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. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems Custom Cabling for Polycom HDX Microphones You can create a custom-length cable from the Polycom HDX 9000 Series 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.
Cables 2 If you are not sure which connector you cut off, use the following tables to perform a continuity check between the connector and the cable colors. If you cut off P1, skip to step 4. If you cut off P2, continue with step 3.
Integrator’s Reference Manual for Polycom HDX Systems keystone jack or, if using a shielded panel coupler, a shielded RJ-45 plug connector. The other end terminates to a shielded RJ-45 plug that connects to the Polycom HDX system.
Cables Audio Adapter Cable This cable adapts the Polycom HDX system Phoenix audio connectors to standard RCA audio cables, such as the Audio Cable on page Audio Cable on page 2-50 . It is dual male Phoenix to dual female RCA connectors (red/white). Length Part Number RoHS Compliant 1 ft (0.3 m) 2457-23492-001 Yes Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems Audio Cable This cable connects a Polycom HDX system to an external audio system. It is used with the Audio Adapter cable on page Audio Cable on page 2-50 . It has dual RCA connectors (red/white) on both ends. The maximum approved length for this cable is 100 ft (30 m). Length Part Number RoHS Compliant 25 ft (7.6 m) 2457-09212-002 Yes 9 ft 10 in (3 m) 2457-09212-010 Yes RED INSULATION (2X) WHITE INSULATION (2X) RED RED WHT WHT 6 IN. ± 0.
Cables Vortex Cable This cable connects a Polycom HDX system to a Polycom Vortex mixer. It has four mini-Phoenix connectors and one DB-9 connector on each end. Length Part Number RoHS Compliant 6 ft (1.8 m) 2457-21978-200 Yes 1829.0 +/- 50 2 1 9-POSITION D-SUBMINIATURE PLUG 3 (203 REF) 1422.0 (203 REF) P6 P2 P7 P3 56.0 P1 6 7 8 9 1 2 3 4 5 J1 P4 9-POSITION D-SUBMINIATURE RECEPTACLE 9 8 7 6 5 4 3 2 1 P8 P5 WRAP LABEL 4 X 305.0 P9 4 X 203.0 3.
Integrator’s Reference Manual for Polycom HDX Systems 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.
Cables 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 has an RJ-11 connector. Length Part Number RoHS Compliant 3.5 in (9 cm) 1457-52415-001 — Drawings and part numbers are provided for reference only.
Integrator’s Reference Manual for Polycom HDX Systems Serial Cables Straight-Through Serial Cable This cable connects a Polycom HDX system to a serial device. It has a DB-9 connector on each end. The maximum approved length for this cable is 100 ft (30 m). Polycom does not recommend using this straight-through serial cable for RS-232 communication from a computer, Crestron system, or AMX device.
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.
Integrator’s Reference Manual for Polycom HDX Systems 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 straight-through serial cable (2457-09172-001) on page Straight-Through Serial Cable on page 2-54 . Do not use this adapter with an AMX device. AMX systems support both RS-232 and RS-422.
3 Using the API The Application Programming Interface (API) is a set of commands for advanced users who want to automate a 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 If you use an RS-232 interface to send API commands, you must connect and configure the control system or computer and the Polycom HDX system for serial communication.
Integrator’s Reference Manual for Polycom HDX Systems The RS-232 port on the Polycom HDX system supports the following modes: • Camera PTZ • Closed Caption • Control • Pass-Thru • Vortex Mixer In Control Mode, a device (for example, a computer) connected to the RS-232 port can control the system using the API. In Pass-Thru Mode, the operational modes of both devices’ RS-232 ports depend on the port configuration of each device.
Using the API Using the API with the Department of Defense (DoD) Security Profile Enabled On a system with the Security Profile set to DoD, you can access the API commands using an RS-232 connection only, and must log in as an Admin or User. The availability of certain API commands and parameters depends on whether you are logged in as Admin or User. For example, if you are logged in to the API session as Admin, you can set and get the ISDN area code using the areacode command.
Integrator’s Reference Manual for Polycom HDX Systems Additional API Resources The following online resources are available for your reference as you use the API. Technical Support Contact Information To contact Polycom Technical Support, go to www.polycom.com/support. This web site provides you with contact information for Polycom technical support. Use this web site when you need help using the API. Feature Enhancement Request Web Site Go to www.polycom.com/support, and navigate to Feature Request.
4 System Commands This chapter describes the API commands for software version 2.6. For an alphabetical list of all the commands, refer to the table of contents for this document. Polycom, Inc.
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 the pipe (“|”) character. Example: allowdialing shows that the allowdialing command must be followed by one of the parameters listed.
System Commands controlled by a provisioning service and cannot be changed”. For more information about provisioned settings, refer to your provisioning service administrator. Deprecated commands are included for backward compatibility only and are not recommended for use with this version. Suitable replacements are noted for each deprecated command. API support is not available for: • Telnet ports 23 and 24 when Security Mode is enabled.
Integrator’s Reference Manual for Polycom HDX Systems may receive multiple API registration responses if you are registered for multiple notifications that are affected by the API command you are currently sending.
System Commands Commands that Restart the System Commands that Restart the System with a Prompt • reboot Commands that Restart the System without a Prompt • reboot yes • reboot now • The Polycom HDX system does not provide flow control. If the connection is lost through restarting the system or other means, you must re-establish the connection. • The API processes one command at a time. • Polycom does not recommend sending multiple commands simultaneously without a pause or delay between them.
Integrator’s Reference Manual for Polycom HDX Systems 4–6 • Polycom recommends putting registrations in the initialization or startup of Crestron and AMX systems. • Registrations are recommended over polling since they will provide status updates without having to query for changes. • Never poll for registrations. • Registrations are specific to the port from which they are registered. If you register for notifications from com port 1, registration will not be sent to com port 2 or Telnet port 24.
System Commands ! Executes a previously used command from the history list, starting with a specific number or letter. Syntax !“string” !{1..64} Parameter Description “string” Specifies the most recent command from the history list that begins with this string. {1..64} Specifies the Nth command in the history list, where N is 1 through 64. Feedback Examples Assume the following command history.
Integrator’s Reference Manual for Polycom HDX Systems • !h returns h323name get h323name testip • history returns 1 gatewaynumber set 123456789 2 hangup video 3 h323name get 4 gatewaynumber set 123456789 5 hangup video 6 h323name get See Also For information about the history list, refer to the history on page 4-172 . 4–8 Polycom, Inc.
System Commands abk (deprecated) Returns local directory (address book) entries. This command has been deprecated. Polycom recommends using the addrbook command on page 4-12 . Syntax abk abk abk abk abk abk abk all batch {0..59} batch search “pattern” “count” batch define “start_no” “stop_no” letter {a..z} range “start_no” “stop_no“ refresh Parameter Description all Returns all the entries in the local directory. batch Returns a batch of 10 local directory entries.
Integrator’s Reference Manual for Polycom HDX Systems Feedback Examples • abk all returns abk 0. Polycom HDX Demo 1 spd:384 num:1.700.5551212 abk 1. Polycom HDX Demo 2 spd:384 num:192.168.1.101 abk 2. Polycom HDX Demo 3 spd:384 num:192.168.1.102 abk 3. Polycom HDX Demo 3 spd:384 num:1.700.5551213 (and so on, until all entries in the local directory are listed, then:) abk all done • abk batch 0 returns abk 0. Polycom HDX Demo abk 1. Polycom HDX Demo abk 2.
System Commands Comments Beginning in software version 2.5, entries with multiple addresses (for example, an H.323 address and an ISDN number) return each address type on separate lines with an incremented record number. With previous software versions, entries with multiple addresses return each address type with the same record number. abk entries are entries stored on the system. gabk entries are entries stored on the GDS.
Integrator’s Reference Manual for Polycom HDX Systems addrbook Returns local directory (address book) entries. Syntax addrbook addrbook addrbook addrbook addrbook addrbook addrbook all batch {0..59} batch search “pattern” “count” batch define “start_no” “stop_no” letter {a..z} range “start_no” “stop_no” refresh Parameter Description all Returns all the entries in the local directory. batch Returns a batch of 10 local directory entries.
System Commands isdn_num:1.700.5551212 isdn_ext: addrbook 1. “Polycom HDX Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 addrbook 2. “Polycom HDX Demo 3” sip_spd:384 sip_num:polycomhdx@polycom.com addrbook 3. “Polycom HDX Demo 3” phone_num:1.512.5121212 (and so on, until all entries in the local directory are listed, then:) addrbook all done • addrbook batch 0 returns addrbook 0. “Polycom HDX Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: addrbook 1.
Integrator’s Reference Manual for Polycom HDX Systems addressdisplayedingab Specifies whether to display the system address in the global directory. Syntax addressdisplayedingab get addressdisplayedingab private addressdisplayedingab public Parameter Description get Returns the current setting. private Specifies not to display the system address in the global directory. public Displays the system address in the global directory.
System Commands advnetstats Gets advanced network statistics for a call connection. Syntax advnetstats [{0..n}] Parameter Description {0..n} Specifies a connection in a multipoint call, where n is the maximum number of connections supported by the system. 0 is call #1, 1 is call #2, 2 is call #3, and so on. Select a number from this range to specify a remote site call for which you want to obtain advanced network statistics. Omit this parameter when retrieving statistics for a point-to-point call.
Integrator’s Reference Manual for Polycom HDX Systems rmlpp=Receive MLP protocol (H.320 calls only) tvj=Transmit video jitter (H.323 calls only) tmlpr=Transmit MLP rate (H.320 calls only) rvj=Receive video jitter (H.323 calls only) rmlpr=Receive MLP rate (H.320 calls only) dc=Encryption information rsid=Remote system id ccaps=Content capability, where possible responses include “9” (H.
System Commands alertusertone Sets or gets the tone used for user alerts. Syntax alertusertone Parameter Description get Returns the current setting. 1|2|3|4 Sets the user alert to the corresponding tone. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems alertvideotone Sets the tone used for incoming video calls. Syntax alertvideotone Parameter Description get Returns the current setting. 1|2|3|4|5|6|7|8|9|10 Sets the incoming video alert to the corresponding tone. Feedback Examples 4–18 • alertvideotone 1 returns alertvideotone 1 • alertvideotone get returns alertvideotone 1 Polycom, Inc.
System Commands all register Registers for most commonly-used user registration events.
Integrator’s Reference Manual for Polycom HDX Systems This is a one time registration command that is retained in flash memory.
System Commands all unregister Simultaneously unregisters all registered user feedback so that the API no longer reports changes to the parameters.
Integrator’s Reference Manual for Polycom HDX Systems allowabkchanges Sets or gets the Allow Directory Changes setting. Syntax allowabkchanges Parameter Description get Returns the current setting. yes Enables the Allow Directory Changes setting. no Disables the Allow Directory Changes setting.
System Commands allowcamerapresetssetup Sets or gets whether users are allowed to change camera presets. Syntax allowcamerapresetssetup Parameter Description get Returns the current setting. yes Allows users to change camera presets. no Prevents users from changing camera presets. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems allowdialing Sets or gets the ability to dial out from the system. Syntax allowdialing Parameter Description get Returns the current setting. yes Allows users to place calls. no Disables dialing so that the system can only receive calls.
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 Parameter Description get Returns the current setting. yes Enables mixed IP and ISDN calls. no Disables mixed IP and ISDN calls. Feedback Examples Polycom, Inc.
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 Parameter Description get Returns the current setting. yes Enables the User Settings icon. no Disables the User Settings icon.
System Commands amxdd Sets or gets the AMX Device Discovery beacon. Syntax amxdd get amxdd Parameter Description get Returns the current setting. on Turns on the AMX Device Discovery beacon. off Turns off the AMX Device Discovery beacon. Feedback Examples • amxdd get returns amxdd off • amxdd on returns amxdd on Comments The default setting for this signal is “off”. Turning on this command sends out the AMX Device Discovery beacon over the LAN interface.
Integrator’s Reference Manual for Polycom HDX Systems answer Answers incoming video or phone calls (analog voice or ISDN voice). Syntax answer Parameter Description video Answers incoming video calls when Auto Answer Point-to-Point Video or Auto Answer Multipoint Video is set to No. phone Answers incoming analog phone or ISDN voice calls.
System Commands areacode Sets or gets the area code for all ISDN lines. This command is only applicable if you have a network interface connected to your system. Syntax areacode get areacode set “areacode” Parameter Description get Returns the area code information. set Sets the ISDN area code when followed by the area code parameter. To erase the current setting, omit “areacode”. “areacode” Area code to use for all lines.
Integrator’s Reference Manual for Polycom HDX Systems audiometer Queries and displays audio levels, once per second. Syntax audiometer 4–30 Parameter Description micleft Measures the audio strength of the signal coming from all microphones assigned to the “left” microphone channel.
System Commands Parameter Description farendright Measures the strength of the signal on the right channels of all far-site audio inputs. farendleft Measures the strength of the signal on the left channels of all far-site audio inputs. off Turns off audiometer output.
Integrator’s Reference Manual for Polycom HDX Systems audiotransmitlevel Sets or gets the audio volume transmitted to the far site, or notification of transmit level changes. Syntax audiotransmitlevel audiotransmitlevel set {-20..30} Parameter Description get Returns the current setting. up Sets the volume 1 decibel higher than the current setting. down Sets the volume 1 decibel lower than the current setting.
System Commands • Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems 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 Parameter Description yes Allows any incoming video call to be connected automatically. This is the default setting. no Prompts the user to answer incoming video calls.
System Commands autoshowcontent Specifies whether to send content automatically when a computer is connected to the system. Syntax autoshowcontent Parameter Description get Returns the current setting. on Sets the system to send content automatically when a computer is connected to the system. off Sets the system to not send content automatically. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems backlightcompensation Sets or gets the Backlight Compensation mode. Syntax backlightcompensation Parameter Description get Returns the current setting. yes Enables Backlight Compensation. The camera automatically adjusts for a bright background. no Disables the option.
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 Parameter Description get Returns the current setting. on Enables basic mode. off Disables basic mode. Feedback Examples Polycom, Inc.
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 bri2enable bri3enable bri4enable Parameter Description get Returns the status of the BRI line—yes if enabled, no if disabled. yes Enables the BRI line.
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 Parameter Description get Returns the status of all BRI lines—yes if enabled, no if disabled. yes Enables all BRI lines. no Disables all BRI lines.
Integrator’s Reference Manual for Polycom HDX Systems button Simulates Polycom remote control buttons. Syntax button button button button button button button button button 4–40 <#|*|0|1|2|3|4|5|6|7|8|9|.> “valid_button” [“valid_button” ...
System Commands Polycom, Inc. Parameter Description keyboard Brings up the on-screen keyboard if the cursor is on a text field. left Sends the left arrow button signal to the user interface. lowbattery Simulates a low battery alert for the remote control. menu Sends the Menu button signal to legacy systems. Deprecated. Polycom recommends using back instead of this button. mmstop Stops the video stream on the RSS-2000™. mmplay Plays the video stream on the RSS-2000.
Integrator’s Reference Manual for Polycom HDX Systems Parameter Description volume+ Sends the volume + button signal to the user interface. zoom- Sends the zoom - button signal to the user interface. zoom+ Sends the zoom +button signal to the user interface.
System Commands Comments Several parameters can be combined in the same command in any order. The button commands are not recommended. When possible, use another API command instead of the button commands, which rely on the current organization of the user interface. Use button pip to send the Display button signal to the user interface. Feedback responses from RSS-2000 parameters are not from the RSS-2000 and are not an indication that you are in control of the RSS-2000.
Integrator’s Reference Manual for Polycom HDX Systems calendardomain Gets and sets the domain used by the calendaring service to log in to the Microsoft® Exchange server. Syntax calendardomain get calendardomain set “domain” Parameter Description get Returns the domain used by the calendaring service. set Sets the domain to be used by the calendaring service. “domain” The domain to be used by the calendaring service.
System Commands calendarmeetings Retrieves scheduled meetings within the given time span or with the given meeting ID. Syntax calendarmeetings list “starttime” [“endtime”] calendarmeetings info “meetingid” Parameter Description list Returns the meeting id or ids for meetings that start at or after the specified start time and end time. “starttime” The start time of meetings to be retrieved.
Integrator’s Reference Manual for Polycom HDX Systems Feedback Examples 4–46 • calendarmeetings list tomorrow returns calendarmeetings list begin meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2 /ndgARgAAAADr9GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAA ACZpKWAADe7hJleQIOS7j2mzRJxkLKAAADI/F8BAAA|2010-03-30:08:30 |2010-03-30:09:00|Discuss Budget meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2 /ndgARgAAAADr9GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAA ACZpKWAADe7hJleQIOS7j2mzRJxkL
System Commands Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems Comments If the meeting’s end time is more than 31 days from the meeting’s start time, the response is shortened to starttime+31days, and meetings that start in that time span are returned.
System Commands The following characters in the meeting subject will not be displayed: • | (vertical bar) • CR (carriage return) • LF (line feed) See Also To enable or disable the calendaring service, use the calendarregisterwithserver command on page 4-53 . To configure the Microsoft Exchange server address used by this service use the calendarserver command on page 4-56 . Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems calendarpassword Sets the password used by the calendaring service to log in to the Microsoft Exchange server. Syntax calendarpassword set “password” Parameter Description “password” The password used by the calendaring service to log in to the Microsoft Exchange server. Feedback Examples calendarpassword Dsca1end@r returns calendarpassword Dsca1end@r Comments The password can be up to 15 characters long and is case-sensitive.
System Commands calendarplaytone Enables or disables the reminder alert tone that plays with the meeting reminder when the Polycom HDX system is registered with the calendaring service. Syntax calendarplaytone get calendarplaytone Parameter Description get Gets the current setting for the alert tone. yes Enables the alert tone. no Disables the alert tone.
Integrator’s Reference Manual for Polycom HDX Systems calendarregisterwithserver Enables or disables the calendaring service. Syntax calendarregisterwithserver get calendarregisterwithserver Parameter Description get Returns the current server registration status. yes Enables the calendaring service. no Disables the calendaring service.
System Commands calendarremindertime Gets and sets the reminder time for meetings in the calendar when the system is registered with the calendaring service. Syntax calendarremindertime Parameter Description get Gets the current reminder time. 1|5|10|15|30|none The number of minutes before a meeting starts that a meeting reminder is given.
Integrator’s Reference Manual for Polycom HDX Systems calendarresource Gets and sets the mailbox account being monitored for calendar events. The mailbox account is called a resource. Syntax calendarresource get calendarresource “resource” Parameter Description get Returns the resource being monitored for calendar events. “resource” The resource to monitor for calendaring events. Feedback Examples • calendarresource get returns calendarresource radam@abcde.com • calendarresource jmcnulty@abcde.
System Commands calendarserver Gets or sets the Microsoft Exchange server used by the calendaring service. Syntax calendarserver get calendarserver "server" Parameter Description get Gets the current Microsoft Exchange server used by the calendaring service. “server” The IP address or DNS name of the Microsoft Exchange server to be used by the calendaring service. Feedback Examples • calendarserver get returns calendarserver 192.168.44.168 • calendarserver 192.168.23.
Integrator’s Reference Manual for Polycom HDX Systems calendarshowpvtmeetings Enables or disables the display of private meetings in the calendar when the system is registered with the calendaring service. Syntax calendarshowpvtmeetings get calendarshowpvtmeetings Parameter Description get Gets the current setting for private meeting display. yes Enables the display of private meetings. no Blocks the display of private meetings.
System Commands calendarstatus Returns the status of the Microsoft Exchange server connection. Syntax calendarstatus get Parameter Description get Returns the Microsoft Exchange server connection status. Feedback Examples • calendarstatus get returns calendarstatus established • calendarstatus get returns calendarstatus unavailable See Also Use the calendarregisterwithserver command on page 4-53 to enable or disable the calendaring service. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems calendaruser Gets or sets the user name the calendaring service uses to log in to the Microsoft Exchange server. Syntax calendaruser get calendaruser “username” Parameter Description get Returns the user name being used by the calendaring service. username The user name the calendaring service uses to log in to the Microsoft Exchange server.
System Commands calldetail Displays all call detail records, a specific call detail record, or the call detail range. Syntax calldetail <“Nth_item”|all> calldetail range Parameter Description “Nth_item” Displays the Nth call detail record. all Displays all call detail records. range Displays the range of records in the call detail report. Feedback Examples Polycom, Inc. • calldetail 1 returns 1,02/Nov/2008,16:34:34,02/Nov/2008,16:34:34,0:00:00,---,Pol ycom HDX Demo,192.168.1.
Integrator’s Reference Manual for Polycom HDX Systems calldetailreport Sets or gets whether to generate a report of all calls made with the system. Syntax calldetailreport Parameter Description get Returns the current setting. yes Turns on call detail reporting. no Turns off call detail reporting.
System Commands 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 encryption command on page 4-123 , this command has been deprecated. Syntax callencryption Parameter Description get Returns the current setting. whenavailable Use encryption when the far site is capable of encryption. disabled Disables call encryption.
Integrator’s Reference Manual for Polycom HDX Systems 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 all Returns information about each connection in the call. callid Returns information about the connection with the specified call ID. Feedback Examples • callinfo all returns callinfo begin callinfo:43:Polycom HDX Demo:192.168.1.
System Commands callstate Sets or gets the call state notification for call state events. Syntax callstate Parameter Description get Returns the current setting. register Registers the system to give notification of call activities. unregister Disables the register mode.
Integrator’s Reference Manual for Polycom HDX Systems See Also You can also use the notify command on page 4-235 and the nonotify command on page 4-234 for notifications. For more information about call status messages, refer to Status Messages command on page B-1 . 4–64 Polycom, Inc.
System Commands callstats Returns call summary information. Syntax callstats Feedback Examples • Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems camera Sets or gets the near-site or far-site camera settings. Syntax camera camera camera camera camera camera camera camera camera camera camera camera camera 4–66 near {1..6} far {1..5} move move source stop near near ppcip for-people {2..5} for-content {2..
System Commands Parameter Description continuous Selects continuous movement mode. The camera will move in direction specified until a camera move stop command is sent. This is the default setting. discrete Selects discrete movement mode. The camera will move a small amount in the direction specified and then stop. No stop command is required. source Returns the number of the near or far camera source currently selected.
Integrator’s Reference Manual for Polycom HDX Systems • camera near move zoom+ causes the near-site camera to zoom in and returns event: camera near move zoom+ • camera register returns camera registered • camera unregister returns camera unregistered Comments If the camera near {1..6} API command is used for an input configured as content, the command becomes a toggle. You must send the command once to send the content source and a second time to stop the content source.
System Commands cameradirection Sets or gets the camera pan direction. Syntax cameradirection Parameter Description get Returns the current setting. normal Sets the direction of the camera to normal; the camera moves in the same direction as the left/right arrows on the remote control. reversed Sets the direction of the camera to reversed; the camera moves in the opposite direction of the left/right arrows on the remote control. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems camerainput Sets or gets the format for a video source. Syntax camerainput <1|2|3> camerainput <4|5> Parameter Description <1..5> Specifies the video source. camerainput 5 is available only on the Polycom HDX 9004. get Returns the current setting. s-video Specifies that the video source is connected using S-Video.
System Commands chaircontrol Sends various chair control commands while the system is in a multipoint call. Syntax chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol chaircontrol Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems Parameter Description stop_view Stops viewing the specified terminal. view “term_no” Views the specified terminal. view_broadcaster Views the broadcaster. Feedback Examples • chaircontrol rel_chair returns chaircontrol rel_chair granted chaircontrol view 1.1 granted • chaircontrol req_vas returns chaircontrol req_vas granted chaircontrol view 1.1 granted • chaircontrol hangup_term 1.4 returns chaircontrol del_term 1.
System Commands cmdecho Turns command echoing on or off. Syntax cmdecho Parameter Description on Turns on command echoing so that everything you type is echoed on the screen. off Turns off command echoing so that nothing you type is echoed on the screen. Feedback Examples • cmdecho on returns cmdecho on • cmdecho off returns cmdecho off Comments This setting defaults to on every time the system powers up.
Integrator’s Reference Manual for Polycom HDX Systems colorbar Turns the video diagnostics color bars on or off. Syntax colorbar Parameter Description on Turns on the color bar test pattern. off Turns off the color bar test pattern. Feedback Examples 4–74 • colorbar on returns colorbar on • colorbar off returns colorbar off Polycom, Inc.
System Commands configchange (deprecated) Sets or gets the notification state for configuration changes. This command has been deprecated. Syntax configchange Parameter Description get Returns the current setting. register Registers to receive notifications when configuration variables have changed. unregister Unregisters to receive notifications when configuration variables have changed. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems configdisplay Sets or gets the video format, aspect ratio and resolution for Monitor 1 or Monitor 2.
System Commands Parameter Description 60hz720p Sets the resolution to 1280x720p, 60 Hz (NTSC systems-only). For DVI and VGA formats with a 16:9 aspect ratio only. 50hz1080i Sets the resolution to 1920x1080i, 50 Hz (DVI-only, PAL systems-only). For DVI and VGA formats with a 16:9 aspect ratio only. 60hz1080i Sets the resolution to 1920x1080i, 60 Hz (DVI-only, NTSC systems-only). For DVI and VGA formats with a 16:9 aspect ratio only.
Integrator’s Reference Manual for Polycom HDX Systems configparam Sets or gets the video quality setting for the specified video input for motion or sharpness. Syntax configparam <“parameter”> get configparam <“parameter”> set <“value”> Parameter Possible Values Description camera_video_quality <1|2|3|4> motion|sharpness Sets or gets the video quality setting for the specified video input for motion or for sharpness (for images without motion).
System Commands configpresentation Sets or gets the content presentation settings for Monitor 1 or Monitor 2. Syntax configpresentation get configpresentation get configpresentation monitor1 configpresentation monitor2 configpresentation monitor1 "value" monitor2 "value" Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems Feedback Examples 4–80 • configpresentation monitor1 get returns configpresentation monitor1:all • configpresentation monitor2 get returns configpresentation monitor2:near-or-far • configpresentation monitor2 far returns error: configpresentation not applied since monitor2 is off when monitor 2 is off Polycom, Inc.
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 Parameter Description get Returns the current setting. yes 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. no The user is not prompted to create a local directory entry after a call disconnects. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems confirmdirdel Sets or gets the configuration for requiring users to confirm directory deletions. Syntax confirmdirdel Parameter Description get Returns the current setting. yes When deleting an entry from the directory (address book), the user is prompted with “Are you sure you want to delete this entry?” no When deleting an entry from the directory (address book), the user is not prompted with a message.
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 Parameter Description get Returns the current setting. on Enables automatic bandwidth adjustment for people and content. off Disables automatic bandwidth adjustment for people and content. The system Quality Preference settings is used instead.
Integrator’s Reference Manual for Polycom HDX Systems contentsplash Enables or disables the splash screen display on content monitors. Syntax contentsplash Parameter Description get Returns the current setting. yes Turns on the content splash screen. no Turns off the content splash screen.
System Commands country Gets the country setting for the system. Syntax country get Parameter Description get Returns the current setting. Feedback Examples • Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems cts 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 Parameter Description get Returns the current setting. normal Sets the signal to normal (high voltage is logic 1). inverted Sets the signal to inverted (low voltage is logic 1). ignore Ignores the signal.
System Commands 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 Parameter Description get Returns the current setting. yes Enables automatic adjustment for daylight savings time. no Disables automatic adjustment for daylight savings time. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems dcd Sets the configuration 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 Parameter Description normal Sets the signal to normal (high voltage is logic 1). inverted Sets the signal to inverted (low voltage is logic 1).
System Commands dcdfilter Sets or gets the filter setting of the DCD serial interface control signal (data carrier detect). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dcdfilter Parameter Description get Returns the current setting. on Enables the DCD filter. off Disables the DCD filter.
Integrator’s Reference Manual for Polycom HDX Systems defaultgateway Sets or gets the default gateway. Syntax defaultgateway get defaultgateway set “xxx.xxx.xxx.xxx” Parameter Description get Returns the default gateway IP address. set Sets the default gateway when followed by the “xxx.xxx.xxx.xxx” parameter. “xxx.xxx.xxx.xxx” IP address to use as the default gateway. Feedback Examples • defaultgateway set 192.168.1.101 returns defaultgateway 192.168.1.
System Commands dhcp Sets or gets DHCP options. Syntax dhcp Parameter Description get Returns the selected DHCP option. off Disables DHCP. client Enables DHCP client, setting the system to obtain an IP address from a server on your network. Feedback Examples • dhcp off returns dhcp off • dhcp client returns dhcp client • dhcp get returns dhcp client Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems dial Dials video or audio calls either manually or from the directory. Syntax dial dial dial dial dial addressbook “addr book name” auto “speed” “dialstr” manual <56|64> “dialstr1” “dialstr2” [h320] manual “speed” “dialstr1” [“dialstr2”] [h323|h320|ip|isdn|sip] phone “dialstring” Parameter Description addressbook Dials a directory (address book) entry. Requires the name of the entry.
System Commands Parameter Description h323|h320|ip|isdn|sip Type of call. Note: The parameters ip and isdn are deprecated. phone Dials an analog phone number. “dialstring” Numeric string specifying the phone number to dial. Enclose the string in quotation marks if it includes spaces.
Integrator’s Reference Manual for Polycom HDX Systems notification:callstatus:outgoing:45: Polycom Austin: 192.168.1.101:connected:384:0:videocall Note: The call ID number (45) is an example of the response. The Call ID number depends upon the call type. Comments When searching for feedback from the dial command, expect to see the set of described strings as many times as there are channels in the call.
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 get Returns the current setting. set Sets the number of channels to dial. n Sets the number of channels to dial. n is 8 for QBRI, 12 for PRI. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems dialingdisplay Sets or gets the Place a Call screen dialing display. Syntax dialingdisplay Parameter Description displaymarquee Displays text in the dialing entry field. Users cannot enter numbers manually when this option is selected. The text displayed is specified by the marqueedisplaytext command. none Removes the dialing entry field from the display.
System Commands diffservaudio, diffservfecc, diffservvideo Sets or gets the DiffServ option and specifies a priority level for audio, far-end camera control (FECC) and other call control channels, and video, respectively. The priority level value for each can be between 0 and 63. Syntax diffservaudio get diffservaudio set {0..63} diffservfecc get diffservfecc set {0..63} diffservvideo get diffservvideo set {0..63} Parameter Description get Returns the current setting. set Sets the command.
Integrator’s Reference Manual for Polycom HDX Systems directory Sets or gets whether the Directory button appears on the Home screen. Syntax directory Parameter Description get Returns the current setting. yes Displays the Directory button on the Home screen. no Removes the Directory button from the Home screen. Feedback Examples 4–98 • directory yes returns directory yes • directory no returns directory no • directory get returns directory no Polycom, Inc.
System Commands display (deprecated) Displays information about the current call or the system. With the implementation of the callinfo command on page 4-63 and whoami command on page 4-346 , this command has been deprecated. Syntax display call display whoami Parameter Description call Displays the following information about the current call: call ID, status, speed, the number to which this system is connected. whoami Returns information about the current system. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems FTP Enabled: True HTTP Enabled: True SNMP Enabled: True 4–100 Polycom, Inc.
System Commands displayglobaladdresses Sets or gets the display of global addresses in the global directory. Syntax displayglobaladdresses Parameter Description get Returns the current setting. yes Enables the display of global addresses. no Disables the display of global addresses. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems displaygraphics Sets or gets the display of graphic icons while in a call. Syntax displaygraphics Parameter Description get Returns the current setting. yes Enables the display of graphic icons. no Disables the display of graphic icons. Feedback Examples 4–102 • displaygraphics yes returns displaygraphics yes • displaygraphics no returns displaygraphics no • displaygraphics get returns displaygraphics no Polycom, Inc.
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 Parameter Description get Returns the current setting. yes Enables the display of the IP extension. no Enables the display of the IP extension.
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-186 . Syntax displayipisdninfo Parameter Description yes Enables the display of both IP and ISDN information. Provides feedback both. no Disables the display of IP and ISDN information. Provides feedback none.
System Commands displayparams Outputs a list of system settings. Syntax displayparams Feedback Examples • Polycom, Inc. displayparams returns systemname Polycom HDX Demo hostname ipaddress 192.168.1.101 version “2.
Integrator’s Reference Manual for Polycom HDX Systems rs232 baud 9600 rs232port1 mode camera_ptz rs232port1 baud 9600 4–106 Polycom, Inc.
System Commands dns 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 get Returns the current IP address of the specified server. A server identification number {1..4} is required. {1..4} Specifies the server identification number. set Sets the IP address of the specified DNS server when followed by the “xxx.xxx.xxx.xxx” parameter. A server identification number {1..4} is required. “xxx.xxx.xxx.
Integrator’s Reference Manual for Polycom HDX Systems dsr Sets or gets the configuration of the DSR serial interface control signal (data set ready). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dsr Parameter Description get Returns the current setting. normal Sets the signal to normal (high voltage is logic 1). inverted Sets the signal to inverted (low voltage is logic 1).
System Commands dsranswer Sets or gets the configuration of the DSR serial interface control signal to indicate an incoming call. This command is only applicable if you have a V.35 network interface connected to your system. Syntax dsranswer Parameter Description get Returns the current setting. on Turns on the option. off Turns off the option. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems dtr Sets or gets the configuration of the DTR serial interface control signal (data terminal ready). This command is only applicable if you have a V.35 network interface connected to your system. Syntax dtr Parameter Description get Returns the current setting. normal Sets the signal to normal (high voltage is logic 1). inverted Sets the signal to inverted (low voltage is logic 1). on Sets constant high voltage.
System Commands dualmonitor Sets or gets whether video is displayed using dual monitor emulation, or split-screen mode, when using one monitor. Syntax dualmonitor Parameter Description get Returns the current setting. yes Enables dual monitor emulation. no Disables dual monitor emulation. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems dynamicbandwidth Sets or gets the use of dynamic bandwidth allocation for Quality of Service. Syntax dynamicbandwidth Parameter Description get Returns the current setting. yes Enables the dynamic bandwidth option. no Disables the dynamic bandwidth option.
System Commands e164ext Sets or gets an H.323 (IP) extension, also known as an E.164 name. Syntax e164ext get e164ext set “e.164name” Parameter Description get Returns the current setting. set Sets the E.164 extension when followed by the “e.164name” parameter. To erase the current setting, omit “e.164name”. “e.164name” A valid E.164 extension (usually a four-digit number).
Integrator’s Reference Manual for Polycom HDX Systems echo Prints “string” back to the API client screen. Syntax echo “string” Parameter Description “string” Text to be printed to the screen. Feedback Examples • echo End of abk range results returns End of abk range results Comments Certain API commands print multiple lines without any delimiter string to notify end of command response. This forces a control panel program to guess when the command's response string is going to end.
System Commands echocanceller Sets or gets the configuration of echo cancellation, which prevents users from hearing their voices loop back from the far site. Syntax echocanceller Parameter Description get Returns the current setting. yes Enables the echo canceller option. no Disables the echo canceller option.
Integrator’s Reference Manual for Polycom HDX Systems enablefirewalltraversal Sets or gets the Enable H.460 Firewall Traversal setting. This feature requires an Edgewater session border controller that supports H.460. Syntax enablefirewalltraversal Parameter Description get Returns the current setting. on Enables the firewall traversal feature. off Disables the firewall traversal feature.
System Commands enablekeyboardnoisereduction Sets or gets the Enable Keyboard Noise Reduction setting. Syntax enablekeyboardnoisereduction Parameter Description get Returns the current setting. yes Enables keyboard noise reduction. no Disables keyboard noise reduction. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems enablelivemusicmode Sets or gets the Enable Live Music Mode setting. Syntax enablelivemusicmode Parameter Description get Returns the current setting. yes Enables live music mode. no Disables live music mode. Feedback Examples 4–118 • enablelivemusicmode yes returns enablelivemusicmode yes • enablelivemusicmode no returns enablelivemusicmode no • enablelivemusicmode get returns enablelivemusicmode no Polycom, Inc.
System Commands enablepvec Sets or gets the PVEC (Polycom Video Error Concealment) setting on the system. Syntax enablepvec Parameter Description get Returns the current setting. yes Enables the PVEC option. no Disables the PVEC option. Feedback Examples • enablepvec yes returns enablepvec yes • enablepvec no returns enablepvec no • enablepvec get returns enablepvec no Comments This option is enabled by default. Polycom, Inc.
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 Parameter Description get Returns the current setting. yes Enables the RSVP option. no Disables the RSVP option.
System Commands enablesnmp Sets or gets the SNMP configuration. Syntax enablesnmp Parameter Description get Returns the current setting. yes Enables the SNMP option. no Disables the SNMP option. Feedback Examples • enablesnmp yes returns enablesnmp yes • enablesnmp no returns enablesnmp no • enablesnmp get returns enablesnmp no Comments After making a change, you must restart the system for the setting to take effect. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems encryption Sets or gets the AES encryption mode for the system. Syntax encryption Parameter Description get Returns the current setting. yes Use encryption when the far site is capable of encryption. Note: This parameter is called “When Available” in the user interface. no Disables encryption. Note: This parameter is called “Off” in the user interface.
System Commands Comments You cannot use this command while a call is in progress. Using this command while the system is in a call returns an “error: command has illegal parameters” message. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems exit Ends the API command session. Syntax exit Feedback Examples • exit returns Connection to host lost. Comments This command ends a Telnet session. For serial sessions, this command effectively starts a new session. 4–124 Polycom, Inc.
System Commands exportdirectory Exports a directory in XML format. Syntax exportdirectory Feedback Example exportdirectory returns exportdirectory started PAGE 228Integrator’s Reference Manual for Polycom HDX Systems exportdirectory done as the last line of returned data indicates that all directory data has been exported. Do not use exportdirectory to interpret the data that is returned. Simply store and use the data as input to the importdirectory command or import directory utility in the web interface.
System Commands farcontrolnearcamera Sets or gets far control of the near camera, which allows far sites to control the camera on your system. Syntax farcontrolnearcamera Parameter Description get Returns the current setting. yes Allows the far site to control the near camera if the far site has this capability. no Disables far control of the near camera. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems farnametimedisplay Sets or gets the length of time the far-site name is displayed on the system. Syntax farnametimedisplay off farnametimedisplay Parameter Description off Disables the far site name display. get Returns the current setting. on Displays the far site name for the duration of the call. 15|30|60|120 Specifies the number of seconds to display the far site name at the beginning of a call.
System Commands flash Flashes the analog phone call. Syntax flash [“callid”] flash [“callid”] [“duration”] Parameter Description callid Specifies the callid to flash. duration Specifies the pulse duration in ms. Feedback Examples • flash 34 5 returns flash 34 5 and flashes callid 34 for 5 ms See Also You can also use the phone command on page 4-247 to flash an analog phone line. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems gabk (deprecated) Returns global directory (address book) entries. This command has been deprecated. Polycom recommends using the gaddrbook command on page 4-136 command on page gaddrbook command on page 4-136 . Syntax gabk gabk gabk gabk gabk gabk gabk all batch {0..59} batch define “start_no” “stop_no” batch search “pattern” “count” letter {a..
System Commands Feedback Example • gabk all returns “Polycom HDX Demo 1” isdnspd:384 isdnnum:1.700.5551212 isdnext: “Polycom HDX Demo 2” isdnspd:2x64 isdnnum:1.700.5552323 isdnext: “Polycom HDX Demo 3” ipspd:384 ipnum:192.168.1.101 ipext:7878 “Polycom HDX Demo 4” isdnspd:384 isdnnum:1.700.5553434 isdnext: (and so on, until all entries in the local directory are listed, then:) gabk all done • gabk batch 0 returns “Polycom HDX Demo 1” isdnspd:384 isdnnum:1.700.
Integrator’s Reference Manual for Polycom HDX Systems “Polycom HDX Demo 3” ipspd:384 ipnum:192.168.1.101 ipext:7878 “Polycom HDX Demo 4” isdnspd:384 isdnnum:1.700.5553434 isdnext: (and so on, to include all entries in the batch that begin with p, then:) gabk letter p done • gabk range 1 returns “Polycom HDX isdnext: “Polycom HDX isdnext: gabk range 1 2 Demo 1” isdnspd:384 isdnnum:1.700.5551212 Demo 2” isdnspd:2x64 isdnnum:1.700.
System Commands gabpassword Sets the password to gain access to the Global Directory Server. Syntax gabpassword [{1..5}] set [“password”] Parameter Description {1..5} References GDS server {1..5}. all Returns all current entries. set Sets the GDS password to “password”. To erase the current setting, omit “password”. “password” Password to access the GDS server. Valid characters are: a through z (lower and uppercase), -, _, @, /, ;, ,, ., \, 0 through 9.
Integrator’s Reference Manual for Polycom HDX Systems gabserverip Sets or gets the IP address of the Global Directory Server. Syntax gabserverip Parameter Description get Returns the current setting. set Sets the GDS server’s IP address when followed by the parameter “xxx.xxx.xxx.xxx”. To erase the current setting, omit the “xxx.xxx.xxx.xxx” parameter. Feedback Examples 4–134 • gabserverip set returns gabserverip • gabserverip set gab.polycom.com returns gabserverip gab.
System Commands gaddrbook Returns global directory (address book) entries. Syntax gaddrbook gaddrbook gaddrbook gaddrbook gaddrbook gaddrbook gaddrbook all batch {0..59} batch define “start_no” “stop_no” batch search “pattern” “count” letter {a..z} range “start_no” “stop_no” refresh Parameter Description all Returns all the entries in the global directory. batch Returns a batch of 20 global directory entries. Requires a batch number, which must be an integer in the range {0..59}.
Integrator’s Reference Manual for Polycom HDX Systems isdn_num:1.700.5551212 isdn_ext: gaddrbook 1. “Polycom HDX Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 gaddrbook 2. “Polycom HDX Demo 3” sip_spd:384 sip_num:polycomhdx@polycom.com gaddrbook 3. “Polycom HDX Demo 3” phone_num:1.512.5121212 (and so on, until all entries in the global directory are listed, then:) gaddrbook all done 4–136 • gaddrbook batch 0 returns gaddrbook 0. “Polycom HDX Demo 1” isdn_spd:384 isdn_num:1.700.
System Commands sip_num:polycomhdx@polycom.com gaddrbook 3. “Polycom HDX Demo 3” phone_num:1.512.5121212 gaddrbook 19. “Polycom HDX Demo 20” h323_spd:384 h323_num:192.168.1.120 h323_ext: gaddrbook letter p done • gaddrbook range 0 2 returns gaddrbook 0. “Polycom HDX Demo 1” isdn_spd:384 isdn_num:1.700.5551212 isdn_ext: gaddrbook 1. “Polycom HDX Demo 2” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 gaddrbook 2. “Polycom HDX Demo 3” sip_spd:384 sip_num:polycomhdx@polycom.
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 get Returns the current setting. set Sets the gatekeeper IP address when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit “xxx.xxx.xxx.xxx”. “xxx.xxx.xxx.xxx” IP address of the gatekeeper. Feedback Examples • gatekeeperip set 192.168.1.205 returns gatekeeperip 192.168.1.
System Commands gatewayareacode Sets or gets the gateway area code. Syntax gatewayareacode get gatewayareacode set [“areacode”] Parameter Description get Returns the area code for the gateway. set Sets the area code when followed by the “areacode” parameter. To erase the current setting, omit “areacode”. “areacode” Numeric string specifying the area code. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems gatewaycountrycode Sets or gets the gateway country code. Syntax gatewaycountrycode get gatewaycountrycode set [“countrycode”] Parameter Description get Returns the current setting. set Sets the gateway country code when followed by the “countrycode” parameter. To erase the current setting, omit “countrycode”. “countrycode” Numeric string specifying the gateway country code.
System Commands gatewayext Sets or gets the gateway extension number. Syntax gatewayext get gatewayext set [“extension”] Parameter Description get Returns the current setting. set Sets the gateway extension number when followed by the “extension” parameter. To reset the default value, omit “extension”. “extension” Numeric string specifying the gateway extension. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems gatewaynumber Sets or gets the gateway number. Syntax gatewaynumber get gatewaynumber set [“number”] Parameter Description get Returns the current setting. set Sets the gateway number when followed by the “number” parameter. To erase the current setting, omit “number”. “number” Numeric string specifying the gateway number.
System Commands gatewaynumbertype Sets or gets the Gateway Number Type, which can be either Direct Inward Dial (DID) or Number+Extension. Syntax gatewaynumbertype Parameter Description get Returns the current setting. did Indicates that the gateway number is a direct inward dial number; it has no extension. number+extension Indicates that the gateway number includes an extension.
Integrator’s Reference Manual for Polycom HDX Systems gatewayprefix Sets or gets the gateway prefixes for the corresponding speeds. Syntax gatewayprefix get “valid speed” gatewayprefix set “valid speed” [“value”] Parameter Description get When followed by the “valid speed” parameter, returns the current value for this speed.
System Commands gatewaysetup Lists all available speeds and values at once. Syntax gatewaysetup Feedback Examples • Polycom, Inc. gatewaysetup returns 56 64 #14 2x56 #222 112 #444 2x64 and so on.
Integrator’s Reference Manual for Polycom HDX Systems gatewaysuffix Sets or gets the gateway suffix. Syntax gatewaysuffix get “valid speed” gatewaysuffix set “valid speed” [“value”] Parameter Description get Returns the current value for this speed.
System Commands gdsdirectory Sets or gets whether the Polycom GDS directory server is enabled. Syntax gdsdirectory Parameter Description get Returns the current setting. yes Enables the Polycom GDS directory server. no Disables the Polycom GDS directory server. This is the default setting. Feedback Examples • gdsdirectory get returns gdsdirectory yes • gdsdirectory no returns gdsdirectory no Comments Each Polycom system supports a single global directory server at any given time.
Integrator’s Reference Manual for Polycom HDX Systems gendial Generates DTMF dialing tones. Syntax gendial <{0..9}|#|*> Parameter Description {0..9} Generates the DTMF tone corresponding to telephone buttons 0-9. # Generates the DTMF tone corresponding to a telephone # button. * Generates the DTMF tone corresponding to a telephone * button. Feedback Examples • 4–148 gendial 2 returns gendial 2 and causes the system to produce the DTMF tone corresponding to a telephone’s 2 button Polycom, Inc.
System Commands gendialtonepots (deprecated) Generates DTMF dialing tones over an analog phone line. This command has been deprecated. Polycom recommends using the gendial command on page 4-149 . Syntax gendialtonepots <{0..9}|#|*> Parameter Description {0..9} Generates the DTMF tone corresponding to telephone buttons 0-9. # Generates the DTMF tone corresponding to a telephone # button. * Generates the DTMF tone corresponding to a telephone * button.
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 Parameter Description on Turns on the test tone. off Turns off the test tone.
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 • get screen returns screen: near • get screen returns screen: makeacall • get screen returns screen: generatetone See Also You can also use the screen command on page 4-281 . Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems getcallstate Gets the state of the calls in the current conference. Syntax getcallstate Feedback Examples • getcallstate returns cs: call[34] speed[384] dialstr[192.168.1.101] state[connected] cs: call[1] inactive cs: call[2] inactive See Also To register the shell session to receive notifications about call state activities, see the callstate command on page 4-64 . 4–152 Polycom, Inc.
System Commands getconfiguredipaddress Retrieves the currently configured IPv4 address from the system. Syntax getconfiguredipaddress Feedback Examples • getconfiguredipaddress returns getconfiguredipaddress 1.2.3.4 Comments getconfiguredipaddress returns the currently configured IPv4 address of the system regardless of the status of the LAN connection. This differs from the ipaddress get command, which returns the current IP address of the system if it has an active LAN connection, else it returns 0.
Integrator’s Reference Manual for Polycom HDX Systems gmscity Sets or gets the Polycom Global Management System™ city information. Syntax gmscity get gmscity set [“city”] Parameter Description get Returns the current setting. set Sets the Global Management System city name when followed by the “city” parameter. To erase the current setting, omit “city”. “city” Character string specifying the city. Enclose the string in quotation marks if it includes spaces.
System Commands gmscontactemail Sets or gets the Global Management System contact email information. Syntax gmscontactemail get gmscontactemail set [“email”] Parameter Description get Returns the current contact email address. set Sets the Global Management system contact email address when followed by the “email” parameter. To erase the current setting, omit “email”. “email” Alphanumeric string specifying the email address. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems gmscontactfax Sets or gets the Global Management System contact fax information. Syntax gmscontactfax get gmscontactfax set [“fax number”] Parameter Description get Returns the current contact fax information. set Sets the Global Management System contact fax information when followed by the “fax number” parameter. To erase the current setting, omit “fax number”. “fax number” Character string specifying the fax number.
System Commands gmscontactnumber Sets or gets the Global Management System contact number information. Syntax gmscontactnumber get gmscontactnumber set [“number”] Parameter Description get Returns the current contact number. set Sets the Global Management System contact number when followed by the “number” parameter. To erase the current setting, omit “number”. “number” Numeric string specifying the contact number. Enclose the string in quotation marks if it includes spaces.
Integrator’s Reference Manual for Polycom HDX Systems gmscontactperson Sets or gets the Global Management System contact person information. Syntax gmscontactperson get gmscontactperson set [“person”] Parameter Description get Returns the current contact person information. set Sets the Global Management System contact person name when followed by the “person” parameter. To erase the current setting, omit “person”. “person” Character string specifying the contact person.
System Commands gmscountry Sets or gets the Global Management System country information. Syntax gmscountry get gmscountry set [“countryname”] Parameter Description get Returns the current country setting. set Sets the Global Management System country information when followed by the “countryname” parameter. To erase the current setting, omit “countryname”. “countryname” Character string specifying the country. Enclose the string in quotation marks if it includes spaces.
Integrator’s Reference Manual for Polycom HDX Systems gmsstate Sets or gets the Global Management System state information. Syntax gmsstate get gmsstate set [“state”] Parameter Description get Returns the current state information. set Sets the Global Management System state information when followed by the “state” parameter. To erase the current setting, omit the “state” parameter. “state” Character string specifying the state information.
System Commands gmstechsupport Sets or gets the Global Management System technical support phone number. Syntax gmstechsupport get gmstechsupport set [“tech_support_digits”] Parameter Description get Returns the current tech support phone number information. set Sets the technical support information when followed by the “tech_support_digits” parameter. To erase the current setting, omit “tech_support_digits”. “tech_support_digits” Numeric string specifying the tech support phone number.
Integrator’s Reference Manual for Polycom HDX Systems gmsurl 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 get all Parameter Description get Returns the current URL information for a selected server. A server must be specified. {1..10} Global Management System server number. The primary Global Management System server that performs account validation is always server 1.
System Commands h239enable Sets or gets the H.239 People+Content setting. Syntax h239enable get h239enable Parameter Description get Returns the current setting. yes Enables H.239 People+Content on the system. no Disables H.239 People+Content on the system. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems h323name Sets or gets the system’s H.323 name. Syntax h323name get h323name set [“H.323name”] Parameter Description get Returns the current setting. set Sets the H.323 name when followed by the “H.323name” parameter. To erase this setting, omit the “H.323name” parameter. “H.323name” Character string specifying the H.323 name. Use quotation marks around strings that contain spaces.
System Commands 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 Parameter Description get Returns the current setting. g729|g728|g711u| g711a|g722-56| g722-48|g7221-16| g7221-24|g7221-32| siren14| siren14stereo Sets the audio protocol to this value for H.331 calls.
Integrator’s Reference Manual for Polycom HDX Systems 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 Parameter Description get Returns the current setting. on Turns on dual stream for H.331 calls. off Turns off dual stream for H.331 calls.
System Commands 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 Parameter Description get Returns the current setting. 30|15|10|7.5 Sets the frame rate to this value for H.331 calls.
Integrator’s Reference Manual for Polycom HDX Systems 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 Parameter Description get Returns the current setting. fcif Sets the video format to FCIF for H.331 calls. Feedback Examples 4–168 • h331videoformat fcif returns h331videoformat fcif • h331videoformat get returns h331videoformat fcif Polycom, Inc.
System Commands 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 Parameter Description get Returns the current setting. h264|h263+|h263|h261 Sets the video protocol to this value for H.331 calls.
Integrator’s Reference Manual for Polycom HDX Systems hangup Hangs up the current video or phone call. Syntax hangup phone hangup video [“callid”] hangup all Parameter Description phone Disconnects the current analog phone (audio-only) site. video Disconnects the current video call. If the “callid” parameter is omitted, the system disconnects all video far sites in the call. all Disconnects all video and audio sites in the call.
System Commands history Lists the last commands used in the current session. Syntax history Feedback Examples • history returns 1 ipaddress set 192.168.1.101 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. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems homecallquality Sets or gets whether users are allowed to select the bandwidth for calls from the Place a Call screen. Syntax homecallquality Parameter Description get Returns the current setting. yes Displays the Call Quality menu on the home Place a Call screen. no Removes the Call Quality menu from the Place a Call screen.
System Commands homemultipoint (deprecated) Sets or gets whether users are allowed to access the multipoint dialing screen via a Multipoint button on the home screen. This command has been deprecated. Syntax homemultipoint Parameter Description get Returns the current setting. yes Displays the Multipoint button on the Home screen. no Removes the Multipoint button from the Home screen.
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 Parameter Description get Returns the current setting. yes Displays the Recent Calls button on the Home screen. no Removes the Recent Calls button from the Home screen.
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 Parameter Description get Returns the current setting. yes Displays the System button on the Home screen. no Removes the System button from the Home screen. Feedback Examples Polycom, Inc.
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 Parameter Description get Returns the current setting. yes Displays the system name on the Home screen. no Removes the system name from the Home screen.
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 get Returns the current setting. set Sets the system’s LAN host name when followed by the “hostname” parameter. If “hostname” is omitted, the system automatically sets it to Admin. “hostname” Character string specifying the LAN host name of the system.
Integrator’s Reference Manual for Polycom HDX Systems Comments A LAN host name is required; it cannot be deleted or left blank. After making a change, you must restart the system for the setting to take effect. 4–178 Polycom, Inc.
System Commands importdirectory Imports a directory in CSV or XML format Syntax importdirectory . . . importcomplete Feedback Examples • importdirectory PAGE 282Integrator’s Reference Manual for Polycom HDX Systems NumberA,ISDN NumberB,ISDN Extension,ISDN Speed,IP Address,IP Extension,IP Speed,Phone Country Code,Phone Area Code,Phone Number,Mobile Country Code,Mobile Area Code,Mobile Number,Email,Category,Meeting Name,Meeting Speed,Site Name 1,Call Type 1,Pref Number 1,Site Type 1,Site Name 2,Call Type 2,Pref Number 2,Site Type 2,Site Name 3,Call Type 3,Pref Number 3,Site Type 3,Site Name 4,Call Type 4,Pref Number 4,Site Type 4,Site Name 5,Call Type 5,Pref Number
System Commands Comments When importing XML-formatted data, the imported data must be in the same format as was obtained from the Polycom HDX system via the exportdirectory command on page 4-126 or the export directory utility in the web interface. Duplicate entries are overwritten; other entries in the imported directory are added into the system's local directory. All of the lines entered into the session after importdirectory is issued are interpreted as directory data.
Integrator’s Reference Manual for Polycom HDX Systems ipaddress Sets or gets the LAN IP address (IPv4) of the system. Syntax ipaddress get ipaddress set “xxx.xxx.xxx.xxx” Parameter Description get Returns the current setting. set Sets the LAN IP address to the “xxx.xxx.xxx.xxx” parameter. This setting can only be changed when DHCP is off. “xxx.xxx.xxx.xxx” IP address of the system. Feedback Examples • ipaddress set 192.168.1.101 returns ipaddress 192.168.1.
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” Parameter Description get Returns the current setting. The parameter “valid speed” is required.
Integrator’s Reference Manual for Polycom HDX Systems Comments The Polycom HDX system does not support separate settings for IP and ISDN dialing speeds.When you change a setting using this command, the settings associated with the isdndialspeed command on page 4-192 also change, and vice versa. 4–184 Polycom, Inc.
System Commands ipisdninfo Sets or gets whether the Home screen displays IP information, ISDN information, both, or neither. Syntax ipisdninfo Table 4-1 Parameter Description get Returns the current setting. both Displays IP and ISDN information on the Home screen. ip-only Displays only IP information on the Home screen. isdn-only Displays only ISDN information on the Home screen. none Does not display any IP or ISDN information on the Home screen.
Integrator’s Reference Manual for Polycom HDX Systems ipprecaudio, ipprecfecc, ipprecvideo Sets or gets the IP Precedence priority level (Type of Service Value) for audio, far-end camera control (FECC) and other call control channels, and video. The value for each can be between 0 and 7. Syntax ipprecaudio get ipprecaudio set {0..7} ipprecfecc get ipprecfecc set {0..7} ipprecvideo get ipprecvideo set {0..7} Parameter Description get Returns the current setting. set Sets the IP precedence.
System Commands ipstat Returns the LAN host name, WINS resolution, DHCP, IP address, DNS servers 1-4, default gateway, WINS server, and subnet mask. Syntax ipstat Feedback Examples • Polycom, Inc. ipstat returns hostname My winsresolution no dhcp client ipaddress 192.168.1.101 dnsserver 192.168.1.102 dnsserver1 192.168.1.103 dnsserver2 192.168.1.104 dnsserver3 0.0.0.0 defaultgateway 192.168.1.105 subnetmask 255.255.255.0 winsserver 192.168.1.
Integrator’s Reference Manual for Polycom HDX Systems 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 get Returns the area code information. set Sets the ISDN area code when followed by the “area code” parameter. To erase the current setting, omit “area code”.
System Commands 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. Syntax isdncountrycode get isdncountrycode set [“country code”] Parameter Description get Returns the country code information. set Sets the ISDN country code when followed by the “country code” parameter. To erase the current setting, omit “country code”.
Integrator’s Reference Manual for Polycom HDX Systems 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 Description get Returns the dialing prefix. set Sets the ISDN prefix when followed by the “isdn prefix” parameter.
System Commands isdndialspeed Sets or gets the valid dialing speed of the ISDN network interface. This command only applies if an ISDN network interface is connected to a system. Syntax isdndialspeed get “valid speed” isdndialspeed set “valid speed” Parameter Description get Returns the current setting. The parameter “valid speed” is required. set Sets the ISDN dialing speed. The parameters “valid speed” and on or off are required.
Integrator’s Reference Manual for Polycom HDX Systems Comments The Polycom HDX system does not support separate settings for ISDN and IP dialing speeds.When you change a setting using this command, the settings associated with the ipdialspeed command on page 4-184 also change, and vice versa. 4–192 Polycom, Inc.
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 get Returns the current ISDN number associated with the specified B channel. set Sets the ISDN number for a B channel line when followed by the “number” parameter.
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 isdnswitch Parameter Description get Returns the current switch protocol.
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 Parameter Description get Returns the current setting. yes Enables audio confirmation. no Disables audio confirmation. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems language Sets or gets the language that will display on the system. Syntax language language set Parameter Description get Returns the current language used on the system. set Sets the specified language. Requires a language parameter.
System Commands lanport Sets or gets the LAN port settings of the system. Syntax lanport Parameter Description get Returns the current setting. auto|autohdx|autofdx| 10hdx|10fdx| 100hdx|100fdx| 1000hdx|1000fdx Sets the LAN speed and duplex mode. auto: Automatically negotiates the LAN speed and duplex mode. autohdx: Automatically negotiates the LAN speed but specifies half-duplex mode.
Integrator’s Reference Manual for Polycom HDX Systems ldapauthenticationtype Sets or gets the authentication type required to authenticate with an LDAP server. Syntax ldapauthenticationtype get ldapauthenticationtype set Parameter Description get Returns the current setting. set Sets the authentication type of an LDAP server. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server.
System Commands ldapbasedn Sets or gets the base distinguished name (DN) of an LDAP server. Syntax ldapbasedn get ldapbasedn set [“base dn”] Parameter Description get Returns the current setting. set Sets the base DN of an LDAP server. To erase the current setting, omit the “base dn” parameter. Notes: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server. “base dn” Specifies the base DN of an LDAP server.
Integrator’s Reference Manual for Polycom HDX Systems ldapbinddn Sets or gets the bind DN for LDAP Simple Authentication. Syntax ldapbinddn get ldapbinddn set [“bind dn”] Parameter Description get Returns the current setting. set Sets the bind DN for LDAP Simple Authentication. To erase the current setting, omit the “bind dn” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server.
System Commands ldapdirectory Sets or gets whether the LDAP directory server is enabled. Syntax ldapdirectory Parameter Description get Returns the current setting. yes Enables the LDAP directory server. no Disables the LDAP directory server. This is the default setting. Feedback Examples • ldapdirectory get returns ldapdirectory yes • ldapdirectory no returns ldapdirectory no Comments Each Polycom system supports a single global directory server at any given time.
Integrator’s Reference Manual for Polycom HDX Systems ldapntlmdomain Sets or gets the domain in which authentication takes place in the Active Directory server. Syntax ldapntlmdomain get ldapntlmdomain set [“domain”] Parameter Description get Returns the current setting. set Sets the domain in which authentication takes place in the Active Directory server. To erase the current setting, omit the “domain” parameter. Note: This parameter does not change the setting on the server.
System Commands ldappassword Sets the password for Simple or NT LAN Manager (NTLM) authentication of an LDAP server. Syntax ldappassword set [“password”] Parameter Description set Sets the password for Simple or NTLM authentication of an LDAP server. To erase the current setting, omit the “password” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server.
Integrator’s Reference Manual for Polycom HDX Systems ldapserveraddress Sets or gets the LDAP server address. Syntax ldapserveraddress get ldapserveraddress set [“address”] Parameter Description get Returns the current setting. set Sets the IP address or the DNS name of an LDAP server. To erase the current setting, omit the “address” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server.
System Commands ldapserverport Sets or gets the port number of an LDAP server. Syntax ldapserverport get ldapserverport set [“port number”] Parameter Description get Returns the current setting. set Sets the port number of an LDAP server. To erase the current setting, omit the “port number” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server.
Integrator’s Reference Manual for Polycom HDX Systems ldapsslenabled Sets or gets the Secure Sockets Layer (SSL)/Transport Layer Security (TLS) encryption state for LDAP operations. Syntax ldapsslenabled get ldapsslenabled set [on|off] Parameter Description get Returns the current setting. set Sets the SSL encryption state for LDAP operations. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server.
System Commands ldapusername Sets or gets the user name for NTLM authentication of an LDAP server. Syntax ldapusername get ldapusername set [“user name”] Parameter Description get Returns the current setting. set Sets the user name for NTLM authentication of an LDAP server. To erase the current setting, omit the “user name” parameter. Note: This parameter does not change the setting on the server. Instead, this parameter changes how the Polycom system recognizes the server.
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 Parameter Description get Returns the current setting. register Registers to receive notification when IP or ISDN line states change. unregister Unregisters to receive notification when IP or ISDN line states change.
System Commands listen Registers the RS-232 session to listen for incoming video calls, phone calls, or system sleep or awake state and, consequently, to give notification when the registered state occurs. Syntax listen Parameter Description video Instructs the session to listen for incoming video calls. When this event occurs, the message “listen video ringing” is received. phone Instructs the session to listen for incoming phone calls.
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 Parameter Description get Returns the current setting. yes Displays the local date and time on the Home screen. no Removes the local date and time from the Home screen.
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 get Returns the current marquee display text. set Sets the text to display in the dialing entry field followed by the text to use. Enclose the string in quotation marks if it includes spaces. “text” Text to display. Enclose the character string in quotation marks if it includes spaces.
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” Parameter Description get Returns the current valid speed.
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 get Returns the current valid speed. set Sets the maximum speed for Internet calls when followed by a valid speed value. “valid speed” Valid speeds are: 128, 256, 384, 512, 768, 1024, and 1472 kbps. Feedback Examples Polycom, Inc.
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” Parameter Description get Returns the current valid speed. set Sets the maximum speed for ISDN calls when followed by a valid speed value.
System Commands maxtimeincall Sets or gets the maximum number of minutes allowed for call length. Syntax maxtimeincall get maxtimeincall set [{0..999}] Parameter Description get Returns the current setting. set 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. The call will then stay up indefinitely. {0..999} Maximum call time in minutes. Must be an integer in the range {0..999}.
Integrator’s Reference Manual for Polycom HDX Systems mcupassword Enters and sends the MCU password to the MCU. Syntax mcupassword [“password”] 4–216 Parameter Description password Specifies the password to send to the MCU. Polycom, Inc.
System Commands meetingpassword Sets the meeting password. Syntax meetingpassword set [“password”] Parameter Description set Sets the meeting password if followed by the password parameter. To erase the current setting, omit the password parameter. “password” User-defined password. Valid characters are: A through Z (lower and uppercase), -, _, @, /, ;, ,, ., \, and 0 through 9. The length is limited to 33 characters. The password cannot include spaces.
Integrator’s Reference Manual for Polycom HDX Systems monitor1 (deprecated) Sets or gets the aspect ratio for Monitor 1. With the implementation of the configdisplay command on page 4-77 , this command has been deprecated. Syntax monitor1 Parameter Description get Returns the current setting. 4:3|16:9 Sets the display aspect ratio to 4:3 (standard) or 16:9 (wide screen). vga Sets the display to VGA and causes the system to restart.
System Commands monitor1screensaveroutput Sets or gets whether to send either black video or "No Signal" to Monitor 1 when the screen saver activates. Syntax monitor1screensaveroutput Parameter Description get Returns the current setting. black Sends black video to Monitor 1 when the system goes to sleep and the screen saver activates. no_signal Sends no signal to Monitor 1 when the system goes to sleep and the screen saver activates.
Integrator’s Reference Manual for Polycom HDX Systems monitor2 (deprecated) Sets or gets the aspect ratio for Monitor 2. With the implementation of the configdisplay command on page 4-77 , this command has been deprecated. Syntax monitor2 off monitor2 monitor2 vga Parameter Description off Disables the second monitor output. get Returns the current setting. 4:3|16:9 Sets the aspect ratio to 4:3 (standard) or 16:9 (wide screen). vga Sets the display to VGA.
System Commands monitor2screensaveroutput Sets or gets whether to send either black video or "No Signal" to Monitor 2 when the screen saver activates. Syntax monitor2screensaveroutput Parameter Description black Sends black video to Monitor 2 when the system goes to sleep and the screen saver activates. no_signal Sends no signal to Monitor 2 when the system goes to sleep and the screen saver activates. get Returns the current setting.
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 Parameter Description get Returns the current setting. yes Connects incoming video calls automatically. The screen will split into a multipoint call progress screen as the incoming call is answered.
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 Parameter Description get Returns the current setting. auto In Auto mode, the system switches between Full Screen Mode and Discussion mode, depending on the interaction between the sites.
Integrator’s Reference Manual for Polycom HDX Systems What you see during a multipoint call can depend on many factors such as the system’s monitor configuration, the number of sites in the call, whether content is shared, and whether dual monitor emulation is used. 4–224 Polycom, Inc.
System Commands mtumode Sets or gets the MTU mode. The mtumode and mtusize commands allow you to change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set mtumode to specify, then use mtusize to specify a value. If mtumode is set to default, the system automatically sets the MTU value to 1260. Syntax mtumode Parameter Description get Returns the current setting.
Integrator’s Reference Manual for Polycom HDX Systems mtusize Sets or gets the MTU size. The mtumode and mtusize commands allow you to change the Maximum Transmission Unit (MTU) size, to adjust for the best interoperability with the host network. Set mtumode to specify, then use mtusize to specify a value. If mtumode is set to default, the system automatically sets the MTU value to 1260. Syntax mtusize Parameter Description get Returns the current setting.
System Commands mute Sets or gets the near or far site mute settings. Syntax mute mute near mute far get Parameter Description register Registers to receive notification when the mute mode changes. unregister Disables register mode. near Sets the command for the near site. Requires on, off, toggle, or get. get Returns the current setting for the near or far site. on Mutes the near site (mute near on). off Unmutes the near site (mute near off).
Integrator’s Reference Manual for Polycom HDX Systems 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 Parameter Description get Returns the current setting. yes Enables Mute Auto Answer Calls mode. The microphone will be muted when the system receives a call while in Auto Answer mode.
System Commands natconfig Sets or gets the NAT configuration. Syntax natconfig Parameter Description get Returns the current setting. auto Specifies that the system is behind a NAT; specifies that the system will automatically discover the public (WAN) address. manual Specifies that the system is behind a NAT. Requires the WAN address to be assigned using the wanipaddress command on page 4-343 . off Disables the option when the system is not behind a NAT.
Integrator’s Reference Manual for Polycom HDX Systems nath323compatible Sets or gets the NAT is H.323 Compatible setting. Syntax nath323compatible Parameter Description get Returns the current setting. yes Specifies that NAT is capable of translating H.323 traffic. no Specifies that NAT is not capable of translating H.323 traffic.
System Commands nearloop Activates or deactivates the Near End Loop test. Syntax nearloop Parameter Description on Activates the Near End Loop, a complete internal test of the system. off Deactivates the Near End Loop. Feedback Examples • nearloop on returns nearloop on • nearloop off returns nearloop off Comments When Near End Loop is on, you can test the encoder/decoder on the system. This test is not available when you are in a call. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems netstats Returns network statistics for each call. Syntax netstats [{0..n}] Parameter Description {0..n} Call in a multipoint call, where n is the maximum 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. Feedback Examples • 4–232 netstats 2 returns call:1 txrate:128 K rxrate:128 K pktloss:0 %pktloss:0.0 % tvp:H.263 rvp:H.263 tvf:CIF rvp:CIF tap:G.
System Commands nonotify Unregisters the API client to receive status notifications. Syntax nonotify nonotify Parameter Description calendarmeetings Stops the system from receiving meeting reminders. callstatus Stops the system from receiving changes in call status, such as a connection or disconnection. captions Stops the system from capturing closed captions as they appear on the screen.
Integrator’s Reference Manual for Polycom HDX Systems notify Lists the notification types that are currently being received, or registers to receive status notifications. Syntax notify notify notify notify calendarmeetings Parameter Description notify Lists the notification types that are currently being received, in the following format: registered for notifications[:notification type>...
System Commands Parameter Description sysstatus Registers the system to receive system status notifications, in the following format: notification:sysstatus::[:...] sysalerts Registers the system to receive system alerts, in the following format: notification:sysalert::[:...
Integrator’s Reference Manual for Polycom HDX Systems • notification:vidsourcechange:near:1:Main:people • notification:linestatus:outgoing:32:0:0:disconnected • notification:vidsourcechange:near:6:ppcip:content • notification:vidsourcechange:near:none:none:content • notification: calendarmeetings: AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgA AAADr9GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAA De7hJleQIOS7j2mzRJxkLKAAADI/G8AAAQ:Product Planning:10 Comments The notify callsta
System Commands 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 Parameter Description get Returns the current time server mode. auto Automatically selects an NTP server from the Internet. off Turns off the use of an NTP server. manual Lets you specify a server using the ntpserver command on page 4-239 .
Integrator’s Reference Manual for Polycom HDX Systems 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 get Gets the IP address of the NTP server. set Sets the IP address of the NTP server when followed by a valid parameter. To erase the current setting, omit the [“xxx.xxx.xxx.xxx”|“server name”] parameter. “xxx.xxx.xxx.
System Commands numberofmonitors (deprecated) Returns the number of display monitors configured. With the implementation of the configdisplay command on page 4-77 , this command has been deprecated.
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 Parameter Description get Returns the current setting. {0..24} Specifies the number of digits in DID numbers.
System Commands numdigitsext Sets or gets the number of digits in the Number+Extension Gateway number (E.164 dialing). Syntax numdigitsext Parameter Description get Returns the current setting. {0..24} The number of digits in the gateway number if gatewaynumbertype command on page 4-144 is set to number+extension.
Integrator’s Reference Manual for Polycom HDX Systems ocsdirectory Enable Polycom HDX systems to retrieve and display the Microsoft Office Communications Server contact list and to disable other global directory services. Syntax ocsdirectory Parameter Description get Returns the current setting. yes Enables the Microsoft Office Communications Server 2007 directory server. no Disables the Microsoft Office Communications Server 2007 directory server. This is the default setting.
System Commands Microsoft Office Communications Server 2007 directory server) are defined on the system, the Polycom GDS directory server becomes the default directory server after upgrading the system software. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems oobcomplete Completes the setup wizard and restarts the Polycom HDX system. Syntax oobcomplete Feedback Examples oobcomplete returns oobcomplete Comments The oobcomplete command is processed only when the Polycom HDX system is in setup wizard mode. To execute oobcomplete successfully, the Polycom HDX system name must be configured. 4–244 Polycom, Inc.
System Commands 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 {0..65535} Number of seconds to pause. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems phone Flashes the analog phone line. Syntax phone Parameter Description clear Clears phone number from the text box. flash Sends flash hook to a POTS connection. See Also Use the flash command on page 4-130 to specify a call ID. 4–246 Polycom, Inc.
System Commands pip Sets or gets the on-screen PIP mode. The PIP feature allows the near site to adjust near-camera views while in a video conference. Syntax pip pip location Parameter Description get Returns the current setting. on Enables PIP mode. The system shows a PIP window that remains in the lower right corner of the screen until the video call is completed. off Disables PIP mode.
Integrator’s Reference Manual for Polycom HDX Systems 4–248 • pip location get returns pip location 1 • pip register returns pip registered Polycom, Inc.
System Commands popupinfo Registers or unregisters the session to receive popup text and button choices text. Syntax popupinfo Parameter Description register Registers to receive popup information. unregister Unregisters to receive popup information. get Returns the current setting.
Integrator’s Reference Manual for Polycom HDX Systems preset Sets the presets or goes (moves) to the presets for the near or far camera source. Also registers or unregisters the API session to give notification when the user sets or goes to presets. Syntax preset preset preset preset register get far <{0..15}> near <{0..99}> Parameter Description register Registers the system to give notification when the user or far site sets or goes to a preset.
System Commands Comments Up to 100 preset camera positions can be set. These camera presets can be distributed across the far camera and up to four near-site cameras. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems 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 get Returns the current setting. set Sets PRI call-by-call when followed by a value from {0..31}. {0..31} Range of call-by-call values.
System Commands 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 prichannel prichannel prichannel get get set set all {1..n} all {1..n} Parameter Description get Returns the current setting. Requires a parameter from . all Selects all PRI channels and returns all channels and settings similar to briallenable. {1..
Integrator’s Reference Manual for Polycom HDX Systems through 7 are inactive, but 8 is active and available, then 8 is the first channel that can be used by the system to place an outgoing call. If an additional channel is needed, the system will use the next available active channel in the range (which could be 9, and so on). Incoming Calls.
System Commands pricsu Sets or gets the PRI CSU mode for a T1 interface. Syntax pricsu Parameter Description get Returns the current setting. internal Sets the internal CSU mode. This is the default. external Sets the external CSU mode. When selected, you must specify the PRI line buildout.
Integrator’s Reference Manual for Polycom HDX Systems 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 pridialchannels set {1..n} Parameter Description set Sets the number of PRI channels to be dialed in parallel when followed by a parameter from {1..n}. To erase the current setting, omit the parameter.
System Commands priintlprefix Sets or gets the PRI international dialing prefix. Syntax priintlprefix get priintlprefix set ["prefix"] Parameter Description get Returns the current setting. set Sets the PRI international dialing prefix when followed by the parameter “prefix”. To erase the current setting, omit the parameter. “prefix” Numeric string.
Integrator’s Reference Manual for Polycom HDX Systems 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 get Returns the current setting. set Sets the PRI line buildout. It requires an output “attenuation in dB” or an “attenuation in feet”. 0|-7.5|-15|-22.5 Output attenuation values in dB. For internal CSUs.
System Commands prilinesignal Sets or gets the PRI line signal. Syntax prilinesignal get prilinesignal set Parameter Description get Returns the current PRI line signal setting. set Sets the PRI line signal. It requires one of the following parameters: esf/b8zs, crc4/hdb3, hdb3 esf/b8zs A method of signal encoding used with a T1 interface. This is the only choice for T1. This value actually chooses both a framing format and an encoding method.
Integrator’s Reference Manual for Polycom HDX Systems primarycallchoice (deprecated) Sets or gets the primary call type for placing calls. With the implementation of the videocallorder command on page 4-335 and the voicecallorder command on page 4-336 , this command has been deprecated. Syntax primarycallchoice Parameter Description get Returns the current primary call type. isdn Sets the primary call type to ISDN. ip Sets the primary call type to IP.
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 Parameter Description get Returns the current setting. isdn With this parameter, the numbering plan is identified to the upstream switch as ISDN, and the number type, which is either national or international, is determined from the dialed phone number.
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 get Returns the current setting. set Sets the outside-line-access PRI number when followed by the parameter “outside_line”. To erase the current setting, omit the parameter. “outside_line” Numeric string. This number is provided by your network service provider.
System Commands priswitch Sets or gets the PRI switch. Syntax priswitch get priswitch set priswitch set Parameter Description get Returns the current switch protocol. set Sets the PRI switch. One of the switch protocol parameters is required. att5ess|att4ess| norteldms|ni2| net5/ctr4| nttins-1500|ts-038 Switch protocol values. For E1, net5/ctr4 is the default. net5/ctr4 is the standard ETSI protocol derived from ITU Q.931.
Integrator’s Reference Manual for Polycom HDX Systems reboot Restarts the system. Syntax reboot [y|now|n] Parameter Description y Reboots the system without prompting you. now Reboots the system without prompting you. n Does not reboot the system.
System Commands recentcalls Returns the list of recent calls. Syntax recentcalls Feedback Examples • Polycom, Inc. recentcalls returns "Polycom HDX Demo" 30/Nov/2008 14:39:56 Out 192.168.1.101 30/Nov/2008 14:40:07 Out 192.168.1.102 30/Nov/2008 14:40:35 Out 192.168.1.103 30/Nov/2008 20:27:33 Out "John Polycom HDX 9004" 30/Nov/2008 02:13:23 In 192.168.1.104 30/Nov/2008 02:20:08 In 192.168.1.105 30/Nov/2008 02:21:40 In 192.168.1.
Integrator’s Reference Manual for Polycom HDX Systems registerall (deprecated) Alias for the all register command.
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 Parameter Description get Returns the current setting. yes Enables this option (register this system). no Disables this option.
Integrator’s Reference Manual for Polycom HDX Systems remotecontrol Set or gets the setting for intercepting signals from the system remote control. Syntax remotecontrol remotecontrol remotecontrol remotecontrol remotecontrol remotecontrol remotecontrol remotecontrol disable disable “valid button” [“valid button”...] dontintercept dontintercept “valid button” [“valid button”...] enable enable “valid button” [“valid button”...
System Commands • remotecontrol disable get returns disabled 1 buttons:pip • remotecontrol intercept get returns 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. • notification:buttonintercept::ir: notification:buttonintercept::ir: notification:buttonintercept:home:ir: Comments Remote control disable commands do not persist across the power cycle.
Integrator’s Reference Manual for Polycom HDX Systems remotemonenable Gets the state of remote room and call monitoring. Syntax remotemonenable Feedback Examples 4–270 • remotemonenable get returns remotemonenable on • remotemonenable get returns remotemonenable off Polycom, Inc.
System Commands requireacctnumtodial Enables or disables the Require Account Number to Dial option. It is used to log calls to a specific account so that they can be tracked and billed to the appropriate departments. Syntax requireacctnumtodial Parameter Description get Returns the current setting. yes Enables the option. no Disables the option.
Integrator’s Reference Manual for Polycom HDX Systems resetsystem Resets the system and, optionally, deletes system settings or local address book entries. Syntax resetsystem [deletesystemsettings] [deletelocaldirectory] Parameter Description deletesystemsettings Resets all configuration settings to default values deletelocaldirectory Deletes all local directory entries from the address book.
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 get Returns the current setting. set Sets the room phone number when followed by the “number” parameter. To erase the current setting, omit the “number” parameter. “number” Phone number for a telephone (not the system) in the room. Use quotation marks around the number if it contains spaces.
Integrator’s Reference Manual for Polycom HDX Systems rs232 baud, rs232port1 baud The rs232 baud command sets or gets the baud rate for the first RS-232 port. For systems with two serial ports, use rs232port1 baud to set the rate for the second serial port. Syntax rs232 baud rs232port1 baud Parameter Description get Returns the current baud rate setting.
System Commands rs232 mode, rs232port1 mode The rs232 mode command sets or gets the operational mode of the first RS-232 port. For systems with two serial ports, use rs232port1 mode to set the mode for the second serial port.
Integrator’s Reference Manual for Polycom HDX Systems • 4–276 rs232port1 mode get returns rs232port1 mode closed_caption Polycom, Inc.
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 Parameter Description get Returns the current setting. on Enables RS-366 dialing. off Disables RS-366 dialing.
Integrator’s Reference Manual for Polycom HDX Systems rt 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 Parameter Description get Returns the current setting. normal Sets the signal to normal (rising edge receives data). inverted Sets the signal to inverted (falling edge receives data).
System Commands rts Sets or gets the RTS serial interface control signal (request to send). This command is only applicable if you have a V.35 network interface connected to your system. Syntax rts Parameter Description get Returns the current setting. normal Sets the signal to normal (high voltage is logic 1). inverted Sets the signal to inverted (low voltage is logic 1).
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” Parameter Description screen Returns the name of the current user interface screen if not followed by other parameters. register Registers for user interface screen changes.
System Commands screencontrol Disables or enables navigation to specified user interface screens of the system. Syntax screencontrol enable screencontrol disable Parameter Description enable Enables navigation to the specified user interface screen(s). all All of the user interface screens. none None of the user interface screens. “screen_name” Name of a specific user interface screen.
Integrator’s Reference Manual for Polycom HDX Systems secondarycallchoice (deprecated) Sets or gets the secondary call type for placing calls. With the implementation of the videocallorder command on page 4-335 and the voicecallorder command on page 4-336 , this command has been deprecated. Syntax secondarycallchoice Parameter Description get Returns the current secondary call type. isdn Sets the secondary call type to ISDN. ip Sets the secondary call type to IP.
System Commands serialnum Returns the serial number of the system. Syntax serialnum Feedback Examples • Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems session Names or finds an active API session. Syntax session name “session-name” session find “session-name” Parameter Description name Names the current API session. find Finds an active API session for this system. session-name Unique string that identifies the session.
System Commands setaccountnumber Sets the account number when it is required for dialing out. Syntax setaccountnumber “account number” Parameter Description “account number” Number that is needed to validate the account before dialing out. To erase the current setting, omit this parameter.
Integrator’s Reference Manual for Polycom HDX Systems setpassword Sets the admin password for the Polycom HDX system local admin account. Syntax setpassword admin room "currentacctpasswd" "newacctpasswd" Parameter Description admin Specifies the Polycom HDX system local admin account. room Changes the room password. “currentacctpasswd” The current account password. “newacctpasswd” The new account password.
System Commands showpopup Displays a message box in the user interface. Syntax showpopup “text to display” Parameter Description “text to display” Message to display to users. Enclose the text in 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.
Integrator’s Reference Manual for Polycom HDX Systems sleep Puts the system in sleep mode within 15 seconds and returns sleep. Syntax sleep sleep Parameter Description sleep Puts the system in sleep mode if not followed by other parameters. register Registers for sleep or wake events. unregister Unregisters from sleep or wake events.
System Commands sleeptext Sets or gets the text to be displayed with the logo for 15 seconds as the system goes into sleep mode. Syntax sleeptext get sleeptext set [“text”] Parameter Description get Returns the current text. set Sets the text to be displayed on the screen saver when followed by the “text” parameter. To erase the current setting, omit “text”. “text” Screen saver text to be displayed when the system is in sleep mode. Enclose the text in quotation marks if it includes spaces.
Integrator’s Reference Manual for Polycom HDX Systems sleeptime Sets or gets the wait time value before the system goes to sleep and displays the screen saver. Syntax sleeptime Parameter Description get Returns the current setting. 0|1|3|15|30|60|120| 240|480 Sets the number of minutes from last user interaction to entering sleep mode. The default value is 3. A value of 0 indicates that the system will never go to sleep.
System Commands snmpadmin Sets or gets the SNMP administrator name. Syntax snmpadmin get snmpadmin set ["admin name"] Parameter Description get Returns the current setting. set Sets the administrator name when followed by the “admin name” parameter. To erase the current setting, omit “admin name”. “admin name” SNMP administrator contact name. Character string. Enclose the character string in quotation marks if it includes spaces.
Integrator’s Reference Manual for Polycom HDX Systems snmpcommunity Sets or gets the SNMP community name. Syntax snmpcommunity get snmpcommunity set ["community name"] Parameter Description get Returns the current setting. set Sets the SNMP community name when followed by the “community name” parameter. To erase the current setting, omit the parameter. “community name” SNMP community name. Character string. Enclose the character string in quotation marks if it includes spaces.
System Commands snmpconsoleip Sets or gets the SNMP console IP address. Syntax snmpconsoleip get snmpconsoleip set ["xxx.xxx.xxx.xxx"] Parameter Description get Returns the current setting. set Sets the SNMP console IP address when followed by the “xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit the parameter. “xxx.xxx.xxx.xxx” IP address of the console. Feedback Examples • snmpconsoleip set returns snmpconsoleip • snmpconsoleip set 192.168.1.
Integrator’s Reference Manual for Polycom HDX Systems snmplocation Sets or gets the SNMP location name. Syntax snmplocation get snmplocation set ["location name"] Parameter Description get Returns the current setting. set Sets the SNMP location name when followed by the “location name” parameter. To erase the current setting, omit the parameter. “location name” SNMP location name. Enclose the location name in quotation marks if it includes spaces.
System Commands snmpsystemdescription Sets or gets the SNMP system description. Syntax snmpsystemdescription get snmpsystemdescription set ["system description"] Parameter Description get Returns the current setting. set Sets the SNMP system description when followed by the “system description” parameter. To erase the current setting, omit the parameter. “system description” SNMP system description.
Integrator’s Reference Manual for Polycom HDX Systems snmptrapversion Sets or gets the SNMP trap version. Syntax snmptrapversion get snmptrapversion set Parameter Description get Returns the current setting. set Sets the SNMP trap protocol that the system uses. v1|v2c SNMP trap version 1 or version 2c.
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 get Returns the current setting along with a test tone from the system at that volume level. set Sets the volume of sound effects. Requires a volume parameter in the range {0..10}. test Tests the volume of sound effects. Feedback Examples Polycom, Inc.
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. Syntax spidnum get spidnum set <1b1|1b2|2b1|2b2|3b1|3b2|4b1|4b2> [“spid number”] Parameter Description get Returns the current SPID number associated with a B channel of a particular line.
System Commands • spidnum set 1b1 returns spidnum 1b1 • spidnum set 1b1 7005551212 returns spidnum 1b1 7005551212 Comments SPIDs generally apply only in the United States and Canada. If you are behind an internal phone system (PBX), SPIDs may not be required. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems st 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 Parameter Description get Returns the current setting. normal Sets the signal to normal (falling edge sends data). inverted Sets the signal to inverted (rising edge sends data).
System Commands subnetmask Sets or gets the subnet mask of the system. Syntax subnetmask get subnetmask set [“xxx.xxx.xxx.xxx”] Parameter Description get Returns the current subnet mask. set Sets the subnet mask of the system when followed by the ”xxx.xxx.xxx.xxx” parameter. To erase the current setting, omit “xxx.xxx.xxx.xxx”. “xxx.xxx.xxx.xxx” Subnet mask of the system. Feedback Examples • subnetmask set 255.255.255.0 returns subnetmask 255.255.255.0 • subnetmask get returns subnetmask 255.
Integrator’s Reference Manual for Polycom HDX Systems sysinfo Sets or gets registration for ISDN, IP, and gatekeeper status notifications. Syntax sysinfo Parameter Description get Returns registration status. register Registers the shell session to receive ISDN, IP, and gatekeeper status notifications. unregister Unregisters the shell session for ISDN, IP, and gatekeeper status notifications.
System Commands systemname Sets or gets the name of the system. Syntax systemname get systemname set “system name” Parameter Description get Returns the current setting. set Sets the system name to “system name”. “system name” Character string specifying the system name. Enclose the string in quotation marks if it includes spaces.
Integrator’s Reference Manual for Polycom HDX Systems tcpports Sets or gets the TCP ports on the system. Syntax tcpports get tcpports set [{1024..49150}] Parameter Description set Sets the TCP ports when followed by a value from the range {1024..49150}. To erase the current setting, omit the value. get Returns the current TCP port setting.
System Commands 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 num” Phone number at which the user of this system will be contacted. To obtain rapid assistance, include the area code with the phone number. Enclose the string in quotation marks if it includes spaces.
Integrator’s Reference Manual for Polycom HDX Systems teleareacode Sets or gets the system’s area code. Syntax teleareacode get teleareacode set ["telephone_area_code"] Parameter Description get Returns the current setting. set Sets the system’s area code when followed by the “telephone_area_code” parameter. To erase the current setting, omit the “telephone_area_code” parameter. “telephone_area_code” System’s area code.
System Commands telenumber Sets or gets the system’s telephone number. Syntax telenumber get telenumber set ["telephone_number"] Parameter Description get Returns the current setting. set Sets the telephone number when followed by the “telephone number” parameter. To erase the current setting, omit the parameter. “telephone_number” System’s telephone number. Enclose the string in quotation marks if it includes spaces. Example: “408 555 2323” Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems telnetechoeol Sets the echo end-of-line (EOL) characters to the default values of either the API echo or the serial port echo. Syntax telnetechoeol Parameter Description get Returns the current setting for the end of line echo characters. crnl Sets the echo EOL characters to .
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 Parameter Description get Returns the current setting. {-12:00..+12:00} Sets the time difference from GMT to this value. +00:00 is GMT time. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems typeofservice Sets or gets the type of service for Quality of Service. Syntax typeofservice Parameter Description get Returns the current setting. ipprecedence Selects IP precedence service. diffserv Selects DiffServ service.
System Commands udpports Sets or gets the UDP ports on the system. Syntax udpports get udpports set [{1024..49150}] Parameter Description get Returns the current UDP port setting. set Sets the UDP ports when followed by a value from the range {1024..49150}. To erase the current setting, omit the value.
Integrator’s Reference Manual for Polycom HDX Systems unregisterall (deprecated) Alias for the all unregister command.
System Commands usefixedports Sets or gets the Fixed Ports configuration. Syntax usefixedports Parameter Description get Returns the current setting. yes Enables the use of Fixed Ports. no Disables the use of Fixed Ports. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems usegatekeeper Sets or gets the gatekeeper mode (off, specify, or auto). Syntax usegatekeeper Parameter Description get Returns the current setting. Note: A gatekeeper is not required to make IP-to-IP LAN calls. In these situations, select the off option. off Select this option if no gatekeeper is required or if you make IP-to-IP LAN calls. specify Specifies a gatekeeper.
System Commands usepathnavigator Sets or gets the Polycom PathNavigator™ mode, Polycom ReadiManager® SE200 mode, or Polycom Converged Management Application™ (CMA™) mode if the PathNavigator, ReadiManager, or Polycom CMA system is used with the Polycom HDX system. Syntax usepathnavigator Parameter Description get Returns the current setting.
Integrator’s Reference Manual for Polycom HDX Systems Comments This option is only accessible if the PathNavigator, ReadiManager, or Polycom CMA system is used. The PathNavigator uses the Polycom MGC™ and can handle video conferences with more participants and higher speeds than a Polycom HDX system’s internal multipoint capability.
System Commands useroompassword Sets or gets the Use Room Password for Remote Access setting. Syntax useroompassword get useroompassword Parameter Description get Returns the current setting. no Configures the system to use a separate room password and remote access password. yes Configures the system to use the same password for room and remote access. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems 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 Parameter Description get Returns the current setting. on Turns on V.35 broadcast. off Turns off V.35 broadcast.
System Commands 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 Parameter Description get Returns the current setting. rs366 Enables RS-366 as the dialing protocol. At this time, RS-366 is the only supported dialing protocol on the system.
Integrator’s Reference Manual for Polycom HDX Systems 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 get Returns the current ISDN video number associated with a B channel of a particular line. Requires <1b1|1b2>. 1b1|1b2 B1 and B2 channels: 1b1 designates line 1, B channel 1 (B1).
System Commands See Also See the isdnnum command on page 4-194 . Polycom, Inc.
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 Parameter Description get Returns the current setting. 1 Selects one port for one-channel calls. 1+2 Selects two ports for two-channel calls (2 x 56 kbps or 2 x 64 kbps).
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 get Returns the current setting for “valid speed”. set Sets the V.35/RS-449/RS-530 prefix when followed by a “value” parameter. To erase the current setting, omit the “value” parameter.
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 Parameter Description get Returns the current profile. adtran|adtran_isu512| ascend|ascend_vsx| ascend_max|avaya_mcu| custom_1|fvc.
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 get Returns the current setting for valid speed. set Sets the dialing suffix when followed by a “value” parameter. To erase the current setting, omit the “value” parameter.
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 Parameter Description get Returns the current setting. yes Enables the Global Management System account number validation option. no Disables the Global Management System account number validation option.
System Commands vcbutton Controls a content video source. It can also register or unregister the API session to receive notification of content events. Syntax vcbutton vcbutton vcbutton vcbutton play {2..5} map source get Parameter Description play Starts sending the content from the specified content video source. If no content video source is specified, starts sending content from the default content video source.
Integrator’s Reference Manual for Polycom HDX Systems • vcbutton play 4 returns vcbutton play 4 vcbutton play succeeded camera near 4 If registered for notifications: 4–328 • vcbutton play 4 returns Control event: vcbutton play Control event: vcbutton source 4 Control event: vcbutton play vcbutton play 4 vcbutton play succeeded camera near 4 • vcbutton play 5 returns vcbutton play failed • vcbutton play returns Control event: vcbutton play vcbutton play succeeded • vcbutton play returns vcbutton
System Commands • vcbutton source get returns vcbutton source get 1 vcbutton source get succeeded • vcbutton source get returns vcbutton source get none vcbutton source get succeeded Polycom recommends registering for notifications. If vcbutton register is used for notifications, the following responses occur.
Integrator’s Reference Manual for Polycom HDX Systems vcraudioout Enables, disables, or gets the VCR Audio Out Always On setting. Syntax vcraudioout Parameter Description get Returns the current setting. yes Enables VCR Audio Out Always On. no Disables VCR Audio Out Always On. Feedback Examples 4–330 • vcraudioout yes returns vcraudioout yes • vcraudioout no returns vcraudioout no • vcraudioout get returns vcraudioout no Polycom, Inc.
System Commands vcrrecordsource Sets or gets the VCR/DVD record source. Syntax vcrrecordsource get vcrrecordsource Parameter Description get Returns the current setting. near Sets the VCR to record the near-site video source. far Sets the VCR to record the far-site video source. auto Sets the VCR to automatically record the current speaker in a point-to-point call.
Integrator’s Reference Manual for Polycom HDX Systems version Returns the current system’s version information. Syntax version Feedback Examples • 4–332 version returns version “release 2.5 - 30Nov2008 11:30” Polycom, Inc.
System Commands vgaqualitypreference Sets or gets the bandwidth split for people and content video. Syntax vgaqualitypreference get vgaqualitypreference Parameter Description get Returns the current setting. content Sets the VGA quality preference to content video. people Sets the VGA quality preference to people video. both Sets the VGA quality preference to both people and content video. Feedback Examples Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems videocallorder Sets the video call order of the specified protocol to the specified slot. Syntax videocallorder <1|2|3|4> Parameter Description isdn Specifies ISDN protocol. h323 Specifies IP protocol. sip Specifies SIP protocol. gateway323 Specifies H.323 gateway calling. 1|2|3|4 Sets the order in which the specified protocol is attempted when a video call is placed.
System Commands voicecallorder Sets the voice call order of the specified protocol to the specified slot. Syntax voicecallorder <1|2> Parameter Description isdn_phone Specifies ISDN phone line. pots Specifies analog phone line. 1|2 Sets the order in which the specified method is attempted when a voice call is placed. Positions 1-2 are relative and are shown as 3-4 in the user interface if video protocols are enabled.
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 volume volume range Parameter Description register Registers to receive notification when the volume changes. unregister Disables register mode. get Returns the current volume level. up Increases the audio volume by 1. down Decreases the audio volume by 1.
System Commands Comments Changes the call audio volume (not sound effects) on the system. Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems vortex Sends commands to a Polycom Vortex mixer. Syntax vortex <0|1> mute vortex <0|1> forward “vortex_macro” Parameter Description 0|1 Specifies the serial port to which the Vortex mixer is connected. mute Sets the mute state for the Vortex mixer connected to the specified serial port. on Mutes the Vortex mixer. off Unmutes the Vortex mixer.
System Commands vortex forward where is 0 if the Vortex is connected to the first serial port or 1 if the Vortex is connected to the second serial port, and is a Vortex-specific command. Whatever value is passed in this parameter will be sent to the Vortex. Polycom, Inc.
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).
System Commands wake Wakes the system from sleep mode. Syntax wake Feedback Examples • wake returns wake and wakes the system from sleep mode See Also To put the system in sleep mode, use the sleep command on page 4-289 . Polycom, Inc.
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 set 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. get Returns the WAN IP address. “xxx.xxx.xxx.xxx” WAN IP address. Feedback Examples • wanipaddress set 192.168.1.101 returns wanipaddress 192.168.1.
System Commands webmonitoring Enables or disables the ability to view video from a Polycom HDX system via the web interface. This command can be used via Telnet port 24 only. Syntax webmonitoring “remoteaccesspasswd” Parameter Description “remoteaccesspasswd” Current remote access password. yes Allows Polycom HDX video to be viewed via the web interface. no Disables Polycom HDX video from being viewed via the web interface.
Integrator’s Reference Manual for Polycom HDX Systems webport Sets or gets the port to use when accessing the system using the web interface. Syntax webport get webport set “port” Parameter Description get Returns the current setting. set Sets the web access port to “port”.
System Commands whoami Displays the same initial banner information as when the RS-232/Telnet session was started with the system. Syntax whoami Feedback Examples • whoami returns Hi, my name is: Polycom HDX Demo Here is what I know about myself: Model: HDX9004 Serial Number: 82065205E72EC1 Software Version: 2.5 Build Information: root on domain.polycom.com Contact Number: Time In Last Call: 0:43:50 Total Time In Calls: 87:17:17 Total Calls: 819 SNTP Time Service: auto insync ntp1.polycom.
Integrator’s Reference Manual for Polycom HDX Systems 4–346 Polycom, Inc.
A 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.
Integrator’s Reference Manual for Polycom HDX Systems means that we must consider sight lines and angles of participant interaction that go beyond traditional presentation environments. As a rule we should allow not less than 30 square feet and generally not more than 45 square feet of floor space per participant in a videoconference space.
Room Design and Layout 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. Walls Conference room walls should be built from slab to slab. That is, there should be no gaps from the concrete of one floor to the concrete of the next floor. Resilient, gypsum board mountings should be used to close any gaps.
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.
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” the images at the far-end from a gray/blue reference image.
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. Typically in architectural design, a site evaluation and analysis are required to certify the noise performance of a given space.
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. Bright standard direct fluorescent lighting has the undesirable side effect of being harsh for the local participants. In addition, the direct down lighting casts significant “drop shadows.
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. These will result in extremely uneven fields of light, or pools, and heavy, unnatural shadows on the faces of the participants.
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. At 8’ distance, a normal speaking voice is approximately 60dBA-SPL. Now the voice energy and the room background noise are about equal.
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, intonation, pitch and level of people speaking from the far-end should sound as much as possible like the sound they would make if they were speaking in the room.
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.
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 projection systems are less expensive and easier to implement, but the conflicting interest between the camera and the projection display makes this form of display a very poor choice.
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.
Integrator’s Reference Manual for Polycom HDX Systems A–14 Polycom, Inc.
B Status Messages Status Display The call status can be displayed in a number of ways. The getcallstate command on page 4-153 returns a table listing the status, speed, and dialed number of current calls. To display real-time status on individual B channels (incoming or outgoing calls), either register the API session with the callstate command on page 4-64, or start an outbound call with the dial command on page 4-93.
Integrator’s Reference Manual for Polycom HDX Systems Feedback Examples • • B–2 dial manual 384 5551212 ISDN returns Dialing manual Dialing 5551212 384 none ISDN cs: call[0] chan[0] dialstr[95551212] cs: call[0] chan[0] dialstr[95551212] cs: call[0] chan[0] dialstr[95551212] cs: call[0] chan[0] dialstr[95551212] cs: call[0] chan[1] dialstr[95551212] cs: call[0] chan[1] dialstr[95551212] cs: call[0] chan[2] dialstr[95551212] cs: call[0] chan[3] dialstr[95551212] cs: call[0] chan[2] dialstr[95551212] cs:
Status Messages • listen video returns listen video registered listen video ringing // there is an incoming call, auto answer is on cs: call[0] chan[0] dialstr[7005551212] state[RINGING] cs: call[0] chan[0] dialstr[7005551212] state[CONNECTED] cs: call[0] chan[0] dialstr[7005551212] state[BONDING] cs: call[0] chan[0] dialstr[7005551212] state[COMPLETE] cs: call[0] chan[1] dialstr[7005551212] state[RINGING] cs: call[0] chan[1] dialstr[7005551212] state[CONNECTED] cs: call[0] chan[2] dialstr[7005551212] sta
Integrator’s Reference Manual for Polycom HDX Systems B–4 Polycom, Inc.
C Polycom HDX 9000 Series Specifications Back Panel Information Refer to the Administrator’s Guide for Polycom HDX Systems at www.polycom.com/videodocumentation for back panel views of Polycom HDX systems and for details about the various connections available on each Polycom HDX back panel connector. Inputs/Outputs Audio Specifications Characteristic Value Maximum Input Level 0 dBFS for Audio Input 4 +12 dBV (4.0 VRMS), ±1 dB Maximum Input Level 0 dBFS for Audio Input 3 (VCR/DVD) +12 dBV (4.
Integrator’s Reference Manual for Polycom HDX Systems Characteristic Value Input Impedance Audio Input 3 (VCR/DVD) Differential 20 k, ±5% Ohms Input Common-Mode Rejection Ratio Balanced Inputs, Common-Mode Amplitude 1 dBFS >60 dB, 20 Hz to 22 kHz Maximum Output Level Balanced Outputs (10 k Load) +12 dBV (4.
Polycom HDX 9000 Series Specifications • The system seizes the line and waits 1.5 seconds. The number is then dialed with a 80 ms tone period followed by a 80 ms silence period for each digit. 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 • Wake up – 2.6 ms on; 2.
Integrator’s Reference Manual for Polycom HDX Systems C–4 Key Name Key Code Key Code Parity 3 110011 33H Even 4 110100 34H Odd 5 110101 35H Even 6 110110 36H Even 7 110111 37H Odd 8 111000 38H Odd 9 111001 39H Even Auto 11001 19H Odd Call 100101 25H Odd Call/Hang Up 11 03H Even Camera 11110 1EH Even Colon 101111 2FH Odd Delete 100010 22H Even Dial String 0 00H Even Directory 11010 1AH Odd Dot 100001 21H Even Down Arrow 110 06H Even Fa
Polycom HDX 9000 Series Specifications Polycom, Inc.
Integrator’s Reference Manual for Polycom HDX Systems RS-232 Serial Interface The RS-232 serial port is implemented by an FPGA-based UART (Universal Asynchronous Receiver/Transmitter) that supports the following values.
Index Symbols ! command 4–7 A A/V professionals 3–4 abk command 4–9 account number command for requiring 4–272 command for setting 4–286 command for validating 4–327 adapters audio 2–49 BNC to S-Video 2–16 HDCI PowerCam Plus 2–31 HDCI Sony 2–36 HDCI Sony VISCA 2–35 HDCI VISCA 2–32 microphone 2–44 null modem 2–56 V.
Integrator’s Reference Manual for Polycom HDX Systems BNC adapter 2–16 BNC to S-Video cable 2–15 BRI cable 2–4 briallenable command 4–40 brienable commands 4–39 broadcaster setting 4–73 broadcasting, V.
Index contact, command for Global Management System 4–156, 4–159 contentauto command 4–84 control flow 4–5 controller code downloads 3–3 conventions, syntax 4–2 country code command for gateway 4–141 command for ISDN 4–190 country command 4–86 country, command for Global Management System 4–160 Crestron systems 2–56, 3–3 cts command 4–87 D date and time, command to display 4–211 daylightsavings command 4–88 dcd command 4–89 dcdfilter command 4–90 defaultgateway command 4–91 delay between commands 4–5 Devic
Integrator’s Reference Manual for Polycom HDX Systems fax, command for Global Management System 4–157 firewall traversal, H.460 traversal 4–117 flash command 4–130 flow control 4–5 frame rate, command for H.
Index ipdialspeed command 4–184 ipisdninfo command 4–186 ipprecaudio command 4–187 ipprecfecc command 4–187 ipprecvideo command 4–187 ipstat command 4–188 IR codes C–3 ISDN cable 2–4 ISDN command for line state changes 4–209 ISDN dialing speed 4–192 ISDN information display on home screen 4–186 isdnareacode command 4–189 isdncountrycode command 4–190 isdndialingprefix command 4–191 isdndialspeed command 4–192 isdnnum command 4–194 isdnswitch command 4–195 K keypadaudioconf command 4–196 Knowledge Base 3–4
Integrator’s Reference Manual for Polycom HDX Systems remote access 4–318 room 4–318 PathNavigator, command for multipoint calls 4–316 pause command 4–246 People+Content, H.
Index RS-366 cable 2–9, 2–10, 2–12 rs366dialing command 4–278 RS-449 cable 2–10 RS-530 cable 2–12 RSVP, command to enable 4–121 rt command 4–279 rts command 4–280 S screen command 4–281 screen saver setting 4–220, 4–222 screencontrol command 4–282 secondarycallchoice command 4–283 sending commands not during call establishment 4–5 serial cable 2–54 serialnum command 4–284 server command for DNS 4–108 command for GDS 4–135 command for NTP 4–239 session command 4–285 setaccountnumber command 4–286 setpasswor
Integrator’s Reference Manual for Polycom HDX Systems v35num command 4–321 v35portsused command 4–323 v35prefix command 4–324 v35profile command 4–325 v35suffix command 4–326 validateacctnum command 4–327 vcbutton command 4–328 VCR audio out, command for controlling 4–331 VCR/DVD composite cable 2–27 vcraudioout command 4–331 vcrrecordsource command 4–332 version command 4–333 VGA cable 2–17 vgaqualitypreference command for video calls 4–334 vgaqualitypreference command 4–334 video call, command to answer
