Page 1 Poly Studio G62 with VideoOS 4.3.0 Integrator Guide SUMMARY This guide provides installers and integrators with instructions on how to install and configure the featured product.
Page 2: Legal Information
Legal information Copyright and license Privacy policy Open source software used in this product © 2024, HP Development Company, HP complies with applicable data privacy This product contains open source L.P. The information contained herein is and protection laws and regulations. HP software.
Page 3: Table Of Contents
Connecting modular room IP devices to Poly Studio G62 ................10 Configure the network switch......................... 10 Connect modular room IP peripherals to the Poly Studio G62 LLN port using a network switch ..12 4 Room Layout Recommendations ........................13 Recommended Room Dimensions ....................... 13 Codec Placement............................
Page 4 Connecting multiple cameras to Poly Studio G62.................. 25 Connecting a Poly Studio E60 to a Poly Studio G62 ................26 Connect a Poly Studio E60 to a Poly Studio G62 using a USB cable ..........26 Connecting Poly Studio E70 to the Poly Studio G62 system..............27 Connect a Poly Studio E70 camera to a Poly Studio G62 system using USB .......
Page 5 Connect a third monitor to your system in Zoom Rooms mode ..............53 9 Pairing Controllers to Poly Studio G62 ......................55 Pair a Poly TC10 or Poly TC8 to your Poly Studio G62 system..............55 Connecting a room scheduler ........................55 10 Content Sharing and Device Mode on Poly Studio G62 ................
Page 6 About the command-line API ........................68 Definitions .............................. 68 Syntax conventions..........................68 Command availability..........................68 Command response syntax ........................69 Commands that restart the system without a prompt ................69 Additional tips............................70 Audio APIs ..............................71 audio3p5inputfaronly..........................71 audiotransmitlevel ..........................71 echocanceller............................
Page 7 camera ..............................107 configparam ............................109 farcontrolnearcamera........................... 110 preset ..............................111 Directory and contacts APIs........................113 addrbook .............................. 113 dial addressbook_entry ........................119 exportdirectory ............................. 119 favorites ............................... 121 gdsdirectory ............................124 gdspassword............................124 gdsserverip ............................125 globaldir ............................... 126 importdirectory .............................
Page 8 echo ..............................164 echoreply ............................. 165 dns ............................... 165 enablefirewalltraversal ......................... 166 advnetstats............................167 dynamicbandwidth ..........................169 e164ext ..............................169 daylightsavings ............................ 170 enablepvec............................171 enablesipka............................172 enablesnmp ............................172 gatekeeperip ............................173 h323authenticateenable........................174 h323authenticatename ........................175 h323authenticatepassword ........................176 h323name ............................
Page 9 wanipaddress............................206 Provisioning APIs ............................207 provisionserveraddress........................207 provisionserverdomain......................... 207 provisionserverenable.......................... 208 provisionserverpassword ........................209 provisionserverupdate.......................... 210 provisionserverstatus ........................... 210 provisionservertype..........................211 provisionserverupdate.......................... 212 provisionserveruser..........................212 Security APIs............................... 214 setpassword............................214 sshenable............................. 214 Security APIs............................... 216 encryption ............................216 System control and remote control APIs..................... 218 button ..............................
Page 10 configpresentation..........................242 configdisplay ............................243 configpresentation..........................244 farnametimedisplay..........................245 monitor1screensaveroutput ......................... 246 monitor2screensaveroutput ......................... 247 15 Getting help ..............................248 HP Inc. addresses............................248 Document information ..........................248...
Page 11: 1 About This Guide
Compatible—Third-party products tested with the designated Poly systems and are interoperable ● with your deployment. However, these products aren’t manufactured or serviced by Poly, so if you experience issues with third-party products, contact the manufacturer for assistance. Not compatible—Third-party products that Poly tests and aren’t interoperable with the designated ●...
Page 12: 2 Getting Started
Poly Studio G62 is designed with simplified mounting and PoE+ class 4 power, so you can place it behind a display, under a table, or in an A/V rack. The Poly Studio G62 system supports Poly audio and video products over IP LLN as well as Poly and third-party products using the USB and 3.5 mm system ports.
Page 13 Connects a secondary monitor. HDMI 1 Connects a primary monitor. LLN port Connects IP peripherals such as a Poly IP microphone or Poly IP camera. This port doesn’t provide power. A PoE switch or PoE injector is required to power IP peripherals connected to the LLN port.
Page 14: Poly Studio G62 Led Behavior
Poly Studio G62 LED behavior Use the LED on the front left corner of the Poly Studio G62 system to get information on the state of your system. Table 2-2 Poly Studio G62 LED Behavior Indicator Status Blinking white Powering on...
Page 15: Powering The System On And Off
Ethernet connection to the corporate network. PoE+ class 4 power injector. Connect the PoE+ LAN port on the Poly Studio G62 system to the Out port on the PoE+ class 4 power injector. Connect the In port on the PoE+ class 4 power injector to a network Ethernet port.
Page 16: Connecting Ip Peripherals To The Poly Studio G62 Lln Port
Connecting IP peripherals to the Poly Studio G62 LLN port Connect Poly IP microphones and Poly IP cameras to your Poly Studio G62 system link-local network (LLN) port. NOTE: For supported peripherals and configurations, see the Poly VideoOS Release Notes .
Page 17: Accessibility Features
Accessibility Features Poly products include a number of features to accommodate users with disabilities. NOTE: Accessibility features for Poly Studio G62 include peripherals required for system functionality included connected cameras, microphones, speakers, and monitors. Users Who Are Deaf or Hard of Hearing Your system includes accessibility features so that users who are deaf or hard of hearing can use the system.
Page 18: Users With Limited Mobility
Poly TC10 or Poly TC8 The Poly TC10 or Poly TC8 enables you to control the system and to perform tasks such as placing calls. Auto-answering You can enable the system to auto-answer calls.
Page 19: 3 Supported Peripherals On The Poly Studio G62 System
If you use a third party peripheral with your Poly Studio G62 system, issues with the device should be directed to the device manufacturer.
Page 20: Connecting Modular Room Ip Devices To Poly Studio G62
Poly. Poly doesn't support other switches or configurations. Using an unsupported switch or configuration may cause audio and content issues. If you're connecting only one IP peripheral to the Poly Studio G62 LLN port, you can use a PoE injector rated for the IP device you're connecting.
Page 21 In the Configuration Management section, select Browse file and click in the blank space. A file web browser opens. Browse to the downloaded files, and select the file labeled Poly-MR-16.cfg and select Upload. Once the progress bar turns green and reaches one hundred percent, select Restore Now.
Page 22: Connect Modular Room Ip Peripherals To The Poly Studio G62 Lln Port Using A Network Switch
Connect the Ethernet patch cable to port 9 on the Netgear ProAV M4250-9G1F-PoE+ (GSM4210PD) switch. Connect the cable to the left RJ-45 port (labeled LLN) on the back of the Poly Studio G62 system. Connect your Poly modular room peripherals to ports 1 through 8 on the switch.
Page 23: 4 Room Layout Recommendations
For detailed conference room setup for offices, and configuration options available on different platforms, visit the HP Hybrid Home & Enterprise Video Conferencing website. Consider the following information before the installation visit for your Poly Studio G62 or Poly G7500 or Studio X Family video conferencing system: Recommended room dimensions ●...
Page 24: Codec Placement
Poly Studio R30 Codec Placement The location of your Poly Studio G62, Poly G7500, or Poly Studio G9 Plus codec depends on several factors, and correct placement ensures a great conferencing experience. Measure your space before installation and plan the codec placement.
Page 25: Camera Placement
Camera types Use the camera that is best suited to your conference room size. Choose from the following options: Connect one or two Poly Studio E60 or Poly Studio E70 cameras to the two Poly Studio G62 USB ● Type-A ports.
Page 26: Large Room Layout Recommendation For Poly Studio E70
Some Poly cameras require that the camera mount upside down when placed below a monitor. Consult the quick start guide for your camera or video bar to ensure you mount it correctly. For cameras that mount upside down, you may need to invert the video input in the camera settings.
Page 27: Large Room Layout Recommendation For Poly Studio E60
Poly Studio E70 in a large conference room In a large room configuration, mount the Poly Studio E70 at the front of the room and center to the table. In a large conference room, connect the Poly Studio E70 to a Poly G7500, Poly Studio G62, or Poly Studio G9 Plus codec.
Page 28: Camera Auto-Framing
Camera Auto-Framing Poly camera framing technology can automatically frame groups of people and follow conversations in meeting rooms. Position the cameras in the room to provide optimal framing performance. Framing options and behavior depend on your connected camera. Consider the following tips for obtaining optimal camera framing performance: Keep the camera FOV free of distractions.
Page 29: Microphone Placement
Microphone pickup range refers to the distance at which a microphone is sensitive to sound. The following tables list the typical and maximum audio pickup ranges for the Poly Studio USB and Poly Studio R30 built-in microphones and common microphone solutions. Typical audio pickup ranges refer to acceptable audio quality under most room conditions without causing the far end difficulty in understanding the speech.
Page 30: Poly Ip Ceiling Microphone Placement
1.5m (4.92 ft) from the microphone = works under all room conditions 3.5m (11.48 ft) from the microphone = maximum distance under typical room conditions Poly IP Ceiling mics should be placed no closer than 3m apart and no further than 7m apart. Example layouts...
Page 31: Lan Ports And Power Outlet Placement
Poly system. Consider the following power outlet and cabling tips: To connect IP LLN peripherals, such as Poly Studio E70 cameras or Poly IP microphones, to a ● Poly Studio G62, you'll need a Netgear A/V Line M4250 GSM4210PD Ethernet switch.
Page 32: 5 System Setup
TC8 to out of box your system. To use a Poly TC10 or Poly TC8 to out of box your system, the Poly TC10 or Poly TC8 and your system should be in an out of box state. If necessary, factory reset your Poly TC10 or Poly TC8 to return it to an out of box state.
Page 33 Select Room Controller and select the right arrow. The Poly Poly TC10 searches for the system in the out of box state and displays the results. Use the system IP address to select your system from the results and select the right arrow.
Page 34: 6 Connecting And Configuring Cameras On Poly Studio G62
Connecting and Configuring Cameras on Poly Studio G62 The following sections describe how to connect cameras to the Poly Studio G62 system. Chapter 6 Connecting and Configuring Cameras on Poly Studio G62...
Page 35: Connecting Cameras To Poly Studio G62
Poly Studio G62 doesn't support connecting USB and IP cameras simultaneously. Connecting multiple IP LLN cameras using the Poly G62 LLN port: In Poly Video and Zoom Rooms mode, you can connect up to three Poly Studio E70 cameras to ●...
Page 36: Connecting A Poly Studio E60 To A Poly Studio G62
Connecting a Poly Studio E60 to a Poly Studio G62 Poly Studio G62 supports connecting Poly Studio E60 cameras as USB or IP LLN cameras. NOTE: Poly Studio G62 doesn't support the Poly Studio E60 remote control. Use the Poly Video mode camera controls, Poly Device Mode camera controls, or the partner application camera controls to adjust the camera position.
Page 37: Connecting Poly Studio E70 To The Poly Studio G62 System
Connecting Poly Studio E70 to the Poly Studio G62 system You can connect a Poly Studio E70 camera to a Poly Studio G62 system as a USB or IP LLN camera. Poly Studio E70 is recommended for medium and large room installations.
Page 38: Connect A Poly Studio E70 Camera To A Poly Studio G62 System Using Usb
Width / Front Exclusion Depth Connect a Poly Studio E70 camera to a Poly Studio G62 system using USB You can connect Poly Studio E70 as a USB camera to the Poly Studio G62 system. NOTE: Hot plugging a USB camera isn't supported. Power off the system before connecting the camera.
Page 39: Connect Multiple Poly Studio E70 Cameras As An Ip Lln Camera To A Poly Studio G62 System
Connect multiple Poly Studio E70 cameras as an IP LLN camera to a Poly Studio G62 system You can connect a Poly Studio E70 camera as an IP LLN camera to the Poly Studio G62 system. NOTE: Only Poly Video and Zoom Rooms support connecting multiple Poly Studio E70 cameras using an IP LLN connection.
Page 40: Connect Poly Eagleeye Iv Usb To The System
3.5 mm TRS input port. You can connect a camera or content source to the HDMI In port on the Poly Studio G62. In the system web interface, you can set the HDMI content source as People to include the HDMI input as an available camera.
Page 41: Connect An Hdmi Camera To The System
You can connect an HDMI camera to your Poly Studio G62. Connect one end of the HDMI cable to the Poly Studio G62 HDMI In port. Connect the other end of the HDMI cable to the HDMI camera or content source.
Page 42: Configure General Camera Settings
Poly VideoOS Release Notes for specific information about the cameras you can use with your system. NOTE: If you connect an unsupported camera, the system still attempts to show video. Poly can’t guarantee that the results are optimal or that the available settings are the same as a supported camera.
Page 43: Configuring Video Input Settings
For example, a people source has pan, tilt, zoom, and near/far camera control settings, while a content source doesn’t. Camera settings aren’t available to users during a meeting. Poly recommends adjusting these settings as part of setting up and configuring the video system in your environment.
Page 44: Configure General Video Input Settings
The system only displays settings that apply to your camera. For example, you don’t see tracking options if your camera doesn’t support tracking. For a list of supported configurations for Poly cameras, see the camera information in Video Integration. In the system web interface, go to Audio/Video > Video Inputs.
Page 45: Configure Hdmi Input Settings
Content screen and selecting an active content stream. Select Save. Configure Camera Tracking Settings Poly camera tracking technology can automatically frame groups of people or the active speaker in medium and large rooms. NOTE: Available camera tracking settings depend on the camera you're using. For a list of available settings, review the topic for connecting your camera in the Video integration section.
Page 46: Poly Directorai Perimeter
Poly Lens Feedback Portal. Your Poly system uses the area visible by the camera to locate and track meeting participants in a conference room. In situations such as a conference room with glass walls, the area visible by the camera may extend beyond the conference room.
Page 47: Configure The Frame Presenter Tracking Area
Configure the Poly DirectorAI frame presenter parameters based on your environment. The Poly Studio E60 camera uses the AI lens, beneath the main telephoto lens, for presenter detection and tracking. When you configure presenter framing, the system presents the AI camera view and not the telephoto lens view.
Page 48: 7 Connecting And Configuring Audio Peripherals On Poly Studio G62
Connecting and Configuring Audio Peripherals on Poly Studio G62 You can connect Poly Studio G62 to multiple types of audio input and output devices. NOTE: Microsoft Teams Rooms Certified Peripherals aren’t compatible with Microsoft Teams Rooms for Android. NOTE: The system supports connecting one USB audio device. Connecting a second audio capable USB device to the system may result in no audio sent to the primary intended audio device.
Page 49: Connecting Audio Devices To Poly Studio G62
Alternatively, you can connect the microphones using a CAT5e, CAT6, or CAT7 direct STP Ethernet cable. The cable can be up to 91 m (300 ft) in length. Connect the PoE injector In port to the Poly Studio G62 LLN port and connect the PoE injector power cable.
Page 50: Connect A Poly Trio C60 To Poly Studio G62
Poly Studio G62 supports connecting Poly Trio C60 speakerphones for use as a microphone and speaker. When connecting a Poly Trio C60, observe the following: You can't use a Poly Trio C60 as an audio device if your system is connected to Wi-Fi as the ● primary network.
Page 51: Connect An Analogue Audio Output Device To The System
Connect the RCA splitter cable to the white and red RCA connections on the sound bar. Connect the 3.5 mm connector to the 3.5 mm output port on the Poly Studio G62 system. Make sure the 3.5 mm connector is fully seated in the connector.
Page 52: Connecting An External Amplifier To The Poly Studio G62 3.5Mm Output
Verify that Transmission Audio Gain (dB) is set to 0dB. Connecting an external amplifier to the Poly Studio G62 3.5mm output Poly supports using the 3.5 mm audio output port with an amplifier, but Poly doesn’t support the configuration and tuning of such devices.
Page 53: Connect A Biamp Usb Audio Dsp Usb To A Poly Studio G62
Connect a cable from the Shure P300 USB Type-B port a Poly Studio G62 Type-A port. In the Poly Studio G62 system web interface, go to Audio / Video > Audio and select the Enable USB audio check box. To use the audio DSP noise cancellation features, set NoiseBlockAI Options to Off.
Page 54: Connect A Qsc Core Series Audio Processor To A Poly Studio G62
Connect the QSC Core Series audio processor Type-B port a Poly Studio G62 Type-A port. In the Poly Studio G62 system web interface, go to Audio / Video > Audio and select the Enable USB audio check box.
Page 55: Configuring Audio Settings
Configuring audio output settings You have different options to play audio on your system to fit your setup. You can connect an external speaker system to the Poly Studio G62 system to provide more volume and comprehensive sound in large rooms.
Page 56: Using Poly Trio Speakers
The system automatically restarts. Choose Speakers When Paired with Poly Trio C60 In or out of a call, you can toggle whether you want to use Poly Trio C60, connected monitor, or video system speakers. In the system web interface, go to Audio/Video > Audio > Audio Output.
Page 57: Configure 3.5 Mm Audio Input
HDMI: Used to share audio (along with content) from a device. Sound from this input plays in the ● room and at far sites. Trio Microphones: Available in Poly Video mode, Device Mode, and Teams Rooms when you pair ● a Trio with the video system.
Page 58: Using Poly Trio Microphones
You can pair up to four Poly Trios C60 with your system in supported provider modes. ● You can’t use a Poly Trio if your system is connected to Wi-Fi as the primary network. ● In Microsoft Teams Rooms mode: ●...
Page 59: Poly Noiseblockai V2
Poly NoiseBlockAI v2 Poly recommends you use Poly NoiseBlockAI v2 in large rooms and rooms with reflective surfaces such as tables and glass walls. Poly NoiseBlockAI v2 incorporates Poly Sound Reflection Reduction. This feature uses advanced AI and machine learning to identify and reduce distracting noises and reverberations for the far end.
Page 60: Configure Polycom Acoustic Fence
For Poly Studio G62 Systems: Once you enable Polycom Acoustic Fence, you must set up additional hardware to use this feature with your Poly Studio G62 system. You need a primary microphone and at least one more microphone to create the fence.
Page 61: 8 Connect Monitors To The Poly Studio G62 System
Connect monitors to the Poly Studio G62 system Connect one or two monitors to the system to display people and content. Poly Studio G62 supports connecting two 4K monitors. However, support for 4K output depends on the supported output resolution of the provider you choose. NOTE: While video output can go to both monitors, audio output will only route to the monitor connected to HDMI 1 when you select TV Speakers as the output.
Page 62: Configure Monitor Settings
4K monitor the system sets the monitor output to 4K. On Poly Studio G7500, Poly Studio X70, and Poly Studio X50 set the second monitor drop-down menu to Off to enable 4K output from the HDMI 1 port. If the second monitor is enabled, even if a monitor isn't connected to the HDMI 2 port, the system sets the HDMI 1 output to 1080p.
Page 63: Disable Cec
In the system web interface, go to Audio/Video > Monitors. Select the Enable Consumer Electronics Control check box. Connect a third monitor to your system in Zoom Rooms mode Poly Studio G62 systems support connecting a third monitor using the Plugable USB to HDMI adapter (UGA-2KHDMI). NOTE: When connecting a third monitor to your system, observe the following: Connecting a third monitor is supported in Zoom Rooms mode only.
Page 64 Figure 8-1 Poly Studio G62 with a Plugable USB to HDMI adapter with a third monitor connected Connect an HDMI cable from the HDMI 1 port on the third monitor to the Plugable USB to HDMI adapter. The monitor is recognized by Zoom Rooms and content displays on the third monitor. Use the Zoom Rooms application to configure monitor layout.
Page 65: 9 Pairing Controllers To Poly Studio G62
At startup, use the out of box setup wizard to pair the Poly TC10 or Poly TC8 to your Poly Studio G62 system. If you're setting up a new system, you can use the Poly TC10 or Poly TC8 to out of box the touch controller and the system at the same time.
Page 66: 10 Content Sharing And Device Mode On Poly Studio G62
Connect an HDMI content source to the HDMI In port. ● Connect a computer Alt DP USB Type-C port to the USB Type-C port on the Poly Studio G62. ● If your computer doesn't support Alt DP, connect your computer to the USB Type-C and the HDMI In port on the Poly Studio G62.
Page 67: Connect An Hdmi Content Source To Your Poly Studio G62
Connect an HDMI content source to your Poly Studio G62 You can connect an HDMI content source, such as a computer, to share content on your Poly Studio G62. Connect the HDMI content source to the HDMI input port on the Poly Studio G62.
Page 68: 11 Cable Requirements For Connecting Peripherals To Poly Studio G62
Use a CAT5e, CAT6, or CAT7 direct Ethernet cable. The cable can be up to 91 m (300 ft) in length. To connect multiple IP LLN devices to the Poly Studio G62 and provide power to the IP devices, use the Netgear ProAV M4250-9G1F-PoE+ (GSM4210PD) switch.
Page 69: Audio Cable Requirements
USB Type-C Alt-DP Mode cable Use the following optional cable to connect a computer Alt DP USB Type-C port to the Studio G62 USB Type-C port. This is the only cable supported for Alt DP connectivity with the Poly Studio G62.
Page 70 When connecting 3.5mm audio to your Poly Studio G62, make sure the 3.5mm connector is fully seated in the Poly Studio G62 3.5mm audio port. Chapter 11 Cable Requirements for Connecting Peripherals to Poly Studio G62...
Page 71: 12 Specifications For Poly Studio G62 And Peripherals
Poly Studio G62 systems are suitable for medium to large-sized conference rooms. Mounting options The Poly Studio G62 ships with magnetic on each corner of the bottom of the system. This allows you to install the Poly Studio G62 inside a rack without additional hardware, or by using the Poly Studio G62 magnetic mounting plate.
Page 72: Poly Studio E70 Specifications
Mounting options You can mount your Poly Studio E60 using one of the following options: Wall mount (above or below the monitor) - Poly Studio E60 Wall Mount Quick Start Guide ● Poly Studio E60 Wall Mount Template Display clamp - Poly Studio E60 Display and Tripod Mount Quick Start Guide ●...
Page 73: Poly Eagleeye Iv Usb Specifications
Poly EagleEye IV USB specifications Poly EagleEye IV USB cameras are suitable for large-sized conference rooms. You can mount your Poly EagleEye IV USB using one of the following options: Wall mount (above or below the monitor) ● Table 12-4...
Page 74 Table 12-4 Poly EagleEye IV USB Characteristics and Cable Lengths (continued) Characteristic Description Power over Ethernet (PoE) connection Supplied network cable length: 4.57 m (15 ft) Power consumption 12VDC at 1.2A External power supply output spec: 12v @ 1.5A power...
Page 75: 13 Working With Poly Studio G62 Command-Line Apis
● Enable SSH access Use SSH on port 22 if you want encrypted access to the Poly Studio G62 system command-line API. In the web interface, go to Security > Access. Select the Enable Legacy API Over SSH check box if it’s cleared.
Page 76: Access The Command-Line Api Over Telnet
Access the command-line API over telnet From a device connected to the same LAN as your Poly Studio G62 system, you can access the command-line API using telnet (port 23 or 24 depending on how you’ve configured the system). Start a telnet session using the system IP address and port number configured for the API Port setting (for example, telnet 10.xxx.xx.xx 24).
Page 77: 14 Command-Line Api Reference For Poly Video Mode
Video Mode The system command-line API is organized by category. The command-line API is supported in Poly Video mode or Poly Device only. While some APIs may work in partner applications, using APIs with a partner application isn't supported. NOTE:...
Page 78: About The Command-Line Api
API command availability depends on the connected equipment, security settings, installed software version, among other factors. If a particular command isn’t supported, the command returns feedback such as, “command is not available in current system configuration”. Chapter 14 Command-line API reference for Poly Video Mode...
Page 79: Command Response Syntax
For more information about provisioned settings, refer to your provisioning service administrator.” Commands that are not listed are not supported by Poly. Commands might change or be removed at any time. Poly discourages integrators from using unpublished commands. Command response syntax When you send a command, the system returns responses using the syntax described in the following sections, where <CR>...
Page 80: Additional Tips
Send registration and notification API commands only once. Registrations are written to flash ● memory and retained when the system restarts. Poly recommends putting registrations in the initialization or startup of Crestron and AMX ● systems. Registrations are recommended over polling since they provide status updates without having to ●...
Page 81: Audio Apis
Audio APIs audio3p5inputfaronly Gets or sets the preference for 3.5mm audio input from the system’s 3.5mm audio port. Syntax audio3p5inputfaronly <get|enable|disable> Table 14-3 Parameter Description Returns the current settings. 3.5 mm audio input is sent only to the far site. enable 3.5 mm audio input is sent to both far and near sites.
Page 82 ● audiotransmitlevel get returns audiotransmitlevel 2 ● audiotransmitlevel up returns audiotransmitlevel 3 ● audiotransmitlevel down returns audiotransmitlevel 2 ● audiotransmitlevel register returns audiotransmitlevel registered ● audiotransmitlevel unregister returns audiotransmitlevel unregistered Limitations None Chapter 14 Command-line API reference for Poly Video Mode...
Page 83: Echocanceller
Comments None echocanceller Gets and sets the configuration of line-input port echo cancellation that prevents users from hearing their voices loop back from the far site. Syntax echocanceller <get|yes|no> Table 14-5 Parameter Description Returns the current setting. Enables the echo canceller option. Disables the echo canceller option.
Page 84: Enableaudioadd
Description Returns the current setting. Enables the Audio Add-In features. This is the default setting. Disables the Audio Add-In feature. Feedback Examples ● enableaudioadd get returns enableaudioadd yes ● enableaudioadd yes returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 85: Enablekeyboardnoisereduction
enableaudioadd yes ● enableaudioadd no returns enableaudioadd no Limitations None Comments None enablekeyboardnoisereduction Gets or sets the keyboard noise reduction feature. Syntax enablekeyboardnoisereduction <get|yes|no> Table 14-8 Parameter Description Returns the current setting. Enables keyboard noise reduction. Disables keyboard noise reduction. Feedback Examples ●...
Page 86: Enablelivemusicmode
● enablelivemusicmode no returns enablelivemusicmode no Limitations None Comments M-Mode was previously known as MusicMode. The feature functions the same way as before despite the name change. Chapter 14 Command-line API reference for Poly Video Mode...
Page 87: Calendar Apis
Calendar APIs calendardiscovery Gets the Microsoft Exchange Server address based on the associated email address or registered SIP server address configured for the system. Syntax calendardiscovery get calendardiscovery emaildomain calendardiscovery sipdomain Table 14-10 Parameter Description Gets the Microsoft Exchange Server address that the system is using to register with the calendaring service.
Page 88: Calendardomain
Specifies the domain for the calendaring service when using “domain” the set command. Feedback examples ● calendardomain get returns calendardomain smithfield ● calendardomain set fairview returns calendardomain fairview Limitations None Comments None Chapter 14 Command-line API reference for Poly Video Mode...
Page 89: Calendarmeetings
calendarmeetings Retrieves scheduled meetings within a provided time or for a meeting ID. Syntax calendarmeetings list “starttime” [“endtime”] calendarmeetings info “meetingid” Table 14-12 Parameter Description Returns the meeting id or ids for meetings that start at or list after the specified start time and end time. The start time of meetings to be retrieved.
Page 90 AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ ndgARgAAAADr9GlhsS jWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAA DI/G8AAAQ 2010-03-30:08:30|2010-03-30:09:00|dialable|public organizer|Russell Bell location|Russell's Meeting Room - IP Video Number: 123456 (if registered to corp GK); 888-123-4567/978-123-4567 with passcode: #760900 subject|Bug Scrub dialingnumber|video| 733397@vsgwstdma01.r13.vsg.local2|sip dialingnumber|video|733397|h323 Chapter 14 Command-line API reference for Poly Video Mode...
Page 91 dialingnumber|audio|48527 meetingpassword|none attendee|Russell Bell attendee|Rebecca Sharp calendarmeetings info end ● calendarmeetings info AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMn4AUcVgARgAAAADr9GlhsSjW ZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAAA3 0 GwAAAQ returns calendarmeetings info start id| AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMn4AUcVgARgAAAADr9GlhsS jWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAA A30GwAAAQ 2010-04-01:10:30|2010-04-01:11:00|nondialable|private organizer| Rebecca Sharp location|Red River conference room subject|Escalations Review attendee|Roslin Adam attendee|Conference.Main attendee|Claudia Nevarez calendarmeetings info end Limitations None Comments...
Page 92: Calendarpassword
Sets the password used by the calendaring service to log in to the Microsoft Exchange Server. Syntax calendarpassword “password” Table 14-13 Parameter Description The password used by the calendaring service to log in to “password” the Microsoft Exchange Server. Chapter 14 Command-line API reference for Poly Video Mode...
Page 93: Calendarplaytone
Feedback examples ● calendarpassword Dsca1end@r returns calendarpassword Dsca1end@r Limitations None Comments The password is case-sensitive and can contain a maximum of 15 characters. Use strong passwords that combine uppercase and lowercase letters, numbers, and symbols. calendarplaytone Gets or sets the reminder alert tone that plays with the meeting reminder when the system is registered with the calendaring service.
Page 94: Calendarprotocol
Sets the connection protocol to TLS. Feedback examples ● calendarprotocol get returns calendarprotocol tls ● calendarprotocol auto returns calendarprotocol auto Limitations None Comments None calendarregisterwithserver Enables or disables the calendaring service. Syntax calendarregisterwithserver get calendarregisterwithserver <yes|no> Chapter 14 Command-line API reference for Poly Video Mode...
Page 95: Calendarremindertime
Table 14-16 Parameter Description Returns the current server registration status. Enables the calendaring service. Disables the calendaring service. Feedback examples ● calendarregisterwithserver get returns calendarregisterwithserver no ● calendarregisterwithserver yes returns calendarregisterwithserver yes ● calendarregisterwithserver no returns calendarregisterwithserver no Limitations None Comments To configure the Microsoft Exchange Server address used by the calendaring service, use the calendarserver command.
Page 96: Calendarresource
Syntax calendarresource get calendarresource “resource” Table 14-18 Parameter Description Returns the resource monitored for calendar events. The resource to monitor for calendaring events. “resource” Feedback examples ● calendarresource get returns calendarresource radam@abcde.com Chapter 14 Command-line API reference for Poly Video Mode...
Page 97: Calendarserver
● calendarresource jmcnulty@abcde.com returns calendarresource jmcnulty@abcde.com Limitations None Comments A resource can be a user or resource account. A resource account is assigned to a meeting room. See also Use the calendarregisterwithserver on page 84 command to enable or disable the calendaring service.
Page 98: Calendarshowpvtmeetings
Enables the display of private meetings. Blocks the display of private meetings. Feedback examples ● calendarshowpvtmeetings get returns calendarshowpvtmeetings no ● calendarshowpvtmeetings yes returns calendarshowpvtmeetings yes ● calendarshowpvtmeetings no returns calendarshowpvtmeetings no Chapter 14 Command-line API reference for Poly Video Mode...
Page 99: Calendarstatus
Limitations None Comments None See also Use the calendarregisterwithserver command to enable or disable the calendaring service. calendarstatus Returns the status of the Microsoft Exchange Server connection. Syntax calendarstatus get Table 14-21 Parameter Description Returns the Microsoft Exchange Server connection status. Feedback Examples ●...
Page 100 Feedback examples ● calendaruser get returns calendaruser jpolycom Limitations None Comments None See also See the calendarserver on page 87 command to configure the Microsoft Exchange Server address used by this service. Chapter 14 Command-line API reference for Poly Video Mode...
Page 101: Calling Apis
Calling APIs callinfo Returns information about the current call. Syntax callinfo all callinfo callid “callid” Table 14-23 Parameter Description Returns information about each connection in the call. Returns information about the connection with the specified callid call ID. Feedback examples ●...
Page 102 NAME:Polycom Demo] ended: call[34] Limitations None Comments To retrieve call state status, Poly recommends using notify callstatus instead of callstate register. If you use callstate register, don’t also use notify callstatus. See also You can also use the notify on page 147...
Page 103: Autoanswer
autoanswer Sets how the system handles incoming point-to-point calls. Syntax autoanswer <get|yes|no|donotdisturb> Table 14-25 Parameter Description Returns the current setting. Incoming calls are connected automatically. This is the default setting. Prompts the user to answer incoming calls. Notifies the user of incoming calls but does not connect. The donotdisturb far side receives a rejected call notification.
Page 104: Dial
For example: “John Doe”. Automatically dials a number. When used with “speed”and auto “dialstr,dialsa video call number dialstr1at speed of type h323. Valid data rate for the network. “speed” Chapter 14 Command-line API reference for Poly Video Mode...
Page 105 Table 14-27 (continued) Parameter Description IP directory number. “dialstr”, “dialstr1”, “dialstr2” Dials a video call number dialstr1at speed of type h323. manual Requires the parameters “speed” and “dialstr1”. Use dialmanual “speed” “dialstr” “type” when you do not want automatic call rollover or when the dial string might not convey the intended transport.
Page 106: Gendial
Parameter Description Generates the DTMF tone corresponding to telephone {0..9} buttons 0-9. Generates the DTMF tone corresponding to a telephone # button. Generates the DTMF tone corresponding to a telephone * button. Chapter 14 Command-line API reference for Poly Video Mode...
Page 107: Gendialset
DTMF tone corresponding to a telephone’s 2 button Limitations None Comments None gendialset Audible dual-tone multi-frequency (DTMF) tones are disabled when making a call on a Poly G7500 system using a connected Poly Group Series device in Poly Video mode. Syntax gendialset <get|inband|outband|both> Table 14-29 Parameter Description Returns the current settings.
Page 108: Generatetone
Limitations None Comments None getcallstate Gets the state of the calls in the current conference. Syntax getcallstate Feedback Examples ● getcallstate returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 109: Hangup
returns cs: call[34] speed[384] dialstr[192.168.1.101] state[connected] cs: call[1] inactive cs: call[2] inactive Limitations None Comments None See Also To register the shell session to receive notifications about call state activities, see the callstate on page 91 command. hangup Hangs up the video call. Syntax hangup video [“callid”] hangup all...
Page 110: Maxtimeincall
1_hour, 2_hours to 12_hours, 24_hours and 48_hours. Feedback Examples ● maxtimeincall set returns maxtimeincall <empty> ● maxtimeincall set 180 returns maxtimeincall 180 Chapter 14 Command-line API reference for Poly Video Mode...
Page 111: Mute
● maxtimeincall get returns maxtimeincall 180 Limitations None Comments When the time has expired in a call, a message asks you if you want to hang up or stay in the call. If you do not answer within one minute, the call automatically disconnects. mute Gets or sets near- or far-site mute settings.
Page 112: Muteautoanswer
Disables Mute Auto Answer Calls mode. The microphone is not muted when the system automatically answers calls. Feedback Examples ● muteautoanswer yes returns muteautoanswer yes ● muteautoanswer no returns muteautoanswer no ● muteautoanswer get returns muteautoanswer no Chapter 14 Command-line API reference for Poly Video Mode...
Page 113: Volume
Limitations None Comments None volume Gets or sets the call audio volume (not sound effects) on the system or registration for volume changes. Changes the call audio volume (not sound effects) on the system. Syntax volume <register|unregister> volume <get|up|down|set {0..50}> volume range Table 14-35 Parameter...
Page 114: Recentcalls
192.168.1.106 30/Sep/2015 05:53:04 In "Mary Polycom" 30/Sep/2015 07:00:19 In Limitations None Comments The number of items returned depends on the value entered for the Maximum Number to Display option in the web interface. Chapter 14 Command-line API reference for Poly Video Mode...
Page 115: Videomute
videomute Gets or sets the transmission of local video to the far site. Syntax videomute near <get|on|off> Table 14-36 Parameter Description Returns the current setting. Specifies local video. near Turns on video mute, so no video is transmitted. Turns off video mute, so video is transmitted normally. Feedback Examples ●...
Page 116 Sets the order in which the specified protocol is attempted 1|2|3|4 when a video call is placed. Feedback Examples ● videocallorder h323 1 returns videocallorder h323 1 ● videocallorder sip 2 returns videocallorder sip 2 Limitations None Comments None Chapter 14 Command-line API reference for Poly Video Mode...
Page 117: Camera Apis
Camera APIs camera Sets or gets the near- or far-site camera settings. Syntax camera near {1..4} camera far {1..4} camera <near|far> move <left|right|up|down|zoom+|zoom-|stop> camera <near|far> source camera <near|far> stop camera near <getposition|setposition “x” “y” “z”> camera near tracking statistics camera near tracking <get|on|off> camerainvert near <get|on|off>...
Page 118 The amount of room and close-up view switches divided by the total call time in the most recent 100 calls lasting more than five minutes. Enables or disables the Poly EagleEye Director II or tracking EagleEye Producer camera tracking feature. on turns the tracking feature on, off turns the tracking feature off, and <get|on|off>...
Page 119: Configparam
camera near getposition 100 99 218 ● camerainvert near get returns camerainvert near off ● camerainvert near on returns camerainvert near on ● camerainvert near off returns camerainvert near off Limitations None Comments The camera commands function only when the system is in a wake state. If necessary, use the wake command prior to using the camera commands.
Page 120: Farcontrolnearcamera
Allows the far site to control the near camera if the far site has this capability. Disables far-site control of the near camera. Feedback Examples ● farcontrolnearcamera yes returns farcontrolnearcamera yes ● farcontrolnearcamera no returns farcontrolnearcamera no ● farcontrolnearcamera get returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 121: Preset
farcontrolnearcamera no Limitations None Comments None preset Sets the presets or goes (moves) to the presets for the near or far camera. Also registers or unregisters the API session to notify when the user sets or goes to presets. Syntax preset <register|unregister>...
Page 122 2 returns preset near set 2 and saves the current location/position of the near-site camera as preset 2 Limitations None Comments Up to 100 preset camera positions can be set. Chapter 14 Command-line API reference for Poly Video Mode...
Page 123: Directory And Contacts Apis
Directory and contacts APIs addrbook Returns local directory (address book) entries. Syntax Commands for local directory addrbook all addrbook batch {0..59} addrbook batch search “pattern” “count” addrbook batch define “start_no” “stop_no” addrbook letter {a..z} addrbook range “start_no” “stop_no” Commands for groups addrbook names <all|video>...
Page 124 If a range_start is specified without a range_end,then the single range_startentry will be returned. If range_endis -1, all entries starting with range_startwill be returned. Chapter 14 Command-line API reference for Poly Video Mode...
Page 125 Table 14-42 (continued) Parameter Description Returns a list local directory names that match the search search criteria. The response is similar to the names command described above: addrbook search {0..n}. name:"sys_name" sys_label:"sys_label" type:<video|multicodec|phone|group> addrbooknames search "search_pattern" <all|video|phone> done Specifies the string pattern for which to search. Wildcard search_pattern characters are not supported.
Page 126 2. “Polycom Demo 3” phone_num:1.512.5121212 (and so on, through the last entry in the batch of 10 directory entries, such as:) addrbook 9. “Polycom Demo 20” h323_spd:384 h323_num:192.168.1.120 h323_ext: addrbook batch 0 done Chapter 14 Command-line API reference for Poly Video Mode...
Page 127 ● addrbook batch define 0 2 returns addrbook 0. “Polycom Demo 1” h323_spd:384 h323_num:192.168.1.101 h323_ext:7878 addrbook 1. “Polycom Demo 2” sip_spd:384 sip_num:polycom@polycom.com addrbook batch define 0 2 done ● addrbook names all size returns addrbook names all size 21 ● addrbook names all size 21 returns addrbook names all size 21...
Page 128 3. name:"TPW" sys_label:"HDX" addrbook group "Monday Staff Mtg" done ● addrbook address "John Doe" returns addrbook address 0. name:"John Doe" sys_label:"" codec:1 h323_spd:384 h323_num:172.25.137.101 h323_ext: addrbook address name:"John Doe" sys_label:"" done Chapter 14 Command-line API reference for Poly Video Mode...
Page 129: Dial Addressbook_Entry
Limitations None Comments This command is deprecated. Poly recommends using localdir instead. dial addressbook_entry Dials a system using a unique identifier retrieved by the globaldir command. Syntax dial addressbook_entry “UID” Table 14-43 Parameter Description Unique identifier associated with a site or group, for example: “UID”...
Page 130 <mulitsitetype2 site_type_2="2" type_2="1000"/> <mulitsiteprefcalltype2 pref_call_type_2="H323"/> <multisiteuniqueid2 unique_id_2="local:29"/> </address> </entrytype> <entrytype type="group" name="testGroup1" filename="testGroup1" uniqueid="local:38"> <address filename="testGroup1 " langid=" " displayname="testGroup1 " name="testGroup1"> <multisitename meeting_name="testGroup1" /> <multisitespeed meeting_speed="auto"/> </address> </entrytype> </addresses> </xml> exportdirectory done Chapter 14 Command-line API reference for Poly Video Mode...
Page 131: Favorites
Limitations None Comments exportdirectory done indicates that all directory data has been exported. Do not use the exportdirectory command 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.
Page 132 If the entry is an ITP system, each codec has a unique value. codec:<1..4> The preferred speed for an H.323 call to this entry. h323_spd H.323 address or alias. h323_num H.323 extension or E.164 number. h323_ext Chapter 14 Command-line API reference for Poly Video Mode...
Page 133 Table 14-44 (continued) Parameter Description The preferred speed for a SIP call to this entry. If no speed is sip_spd associated with the entry, it is the same as h323_spd. SIP address. sip_num XMPP address, also known as the Jabber ID (JID). xmpp_addr Feedback Examples ●...
Page 134: Gdsdirectory
Gets or sets options for the Poly Global Directory Service (GDS). Syntax gdsdirectory <get|on|off|status> Table 14-45 Parameter Description Returns the current setting. Enables GDS registration. Disables GDS registration. Returns the current GDS registration status. status Feedback Examples ● gdsdirectory get...
Page 135: Gdsserverip
Table 14-46 Parameter Description Sets the GDS registration password. The GDS password when using the setcommand. “password” Feedback Examples ● gdspassowrd set “polycomuser 01” returns gdspassword failed ● gdspassword set “polycomuser01” returns gdspassword accepted Limitations None Comments The gdspassword command is supported only when H.323 is enabled. gdsserverip Gets or sets the GDS server IP address.
Page 136: Globaldir
Comments The gdsserverip command is supported only when H.323 is enabled. globaldir Retrieves global directory entries. Poly recommends that you use this command for the Global Directory. This command supports all global directory types, including Poly GDS and LDAP. Syntax globaldir “search_string”...
Page 137 Table 14-48 (continued) Parameter Description Specifies the end of the range of entries to return. “stop_no” Feedback Examples LDAP ● globaldir sd 5 returns globaldir 0. SD-Austin-01@polycom.com: ldap#g#840780b28ef4234f84f64298909aca07:site globaldir 1. SD-Austin-02@ polycom.com: ldap#g#8852f4c7cb6d9b4fab7e53e2730a5219:site globaldir 2. SD-Dallas-01@ polycom.com: ldap#g#83840767145bf04a9ce2b307af6d5688:site globaldir 3. SD-Dallas-02@ polycom.com: ldap#g#158aa86dd780ca4f8731fcfd627e05ad:site globaldir 4.
Page 138 6. Group HDX8006C : ldap#g#4275fd987e12e445bde9bcbb551dc7e8:site globaldir 7. Group HDX9004A : ldap#g#f3030565ec10bf4bbbfd1f77e1bdc483:site globaldir 8. Group HDX9004B : ldap#g#3e0b4c247225014682dbdebc5d6d935b:site globaldir 9. Group Saturn : ldap#g#5cb47f04e402d7478631ad45b5e6b493:site globaldir group range 0 9 done MULTI-TIERED DIRECTORY Chapter 14 Command-line API reference for Poly Video Mode...
Page 139 ● globaldir grouplist returns globaldir 0. Admin Admin:ldap#g#589feda2e097073b52134c7984ca6b44:site globaldir 1. Admin2 Admin2:ldap#g#e6b660a112b25d4cb2067243e73da458:site globaldir 2. G7500:ldap#g#0410894cfa213c418df5bd1226d46491:group globaldir 3. Group Series:ldap#g#011d8db58de14d48838549c5e0ec7465:group globaldir 4. HDX_MISC:ldap#g#2331576d60cf9948a09860946f38a42b:group globaldir 5. Sams 9006:ldap#g#e64ffc28a13917488dec8ac97959c80f:site globaldir 6. Sams Saturn:ldap#g#5cb47f04e402d7478631ad45b5e6b493:site globaldir grouplist done ● globaldir grouplist ldap#g#011d8db58de14d48838549c5e0ec7465 returns globaldir 0. HDX8000:ldap#g#38317b15022dc94f83650937c8aa0a48:group globaldir 1.
Page 140: Importdirectory
. error: command not supported in current configuration importdirectory Imports local directory information in XML format. Syntax importdirectory <import data line 1> <import data line 2> <import data line 3> Chapter 14 Command-line API reference for Poly Video Mode...
Page 141 importcomplete Additional Restrictions None Feedback Examples ● importdirectory returns <?xml version="1.0" encoding="UTF-8" ?> <addresses> <entrytype type="entry" name="dawn" filename="dawn" uniqueid="local:26"> <address filename="dawn" langid="" displayname="dawn" name="dawn"> <h323 address="192.168.1.120" speed="0"/> <sip address="192.168.1.120" speed="0"/> <category category="CONTACTS"/> </address> </entrytype> <entrytype type="entry" name="dawn " filename="dawn " uniqueid="local:28">...
Page 142 </address> </entrytype> </addresses>_name_2="dawn3 "/> <mulitsitetype2 site_type_2="2" type_2="1000"/> <mulitsiteprefcalltype2 pref_call_type_2="H323"/> <multisiteuniqueid2 unique_id_2="local:29"/> </address> </entrytype> <entrytype type="group" name="test1" filename="test1" uniqueid="local:38"> <address filename="test1 " langid=" " displayname="test1 " name="test1"> <multisitename meeting_name="test1" /> <multisitespeed meeting_speed="auto"/> </address> Chapter 14 Command-line API reference for Poly Video Mode...
Page 143: Localdir
</entrytype> </addresses> ● importcomplete returns import succeeded Limitations None Comments A restart of the system is required after successfully importing directory information and occurs automatically after the import is complete. When importing XML-formatted data, the imported data must be in the same format as was obtained from the system through the exportdirectory command or the export directory utility in the web interface.
Page 144 0. SD-Austin-01@polycom.com: local#840780b28ef4234f84f64298909aca07:site localdir 1. SD-Austin-02@polycom.com: local#8852f4c7cb6d9b4fab7e53e2730a5219:site localdir 2. SD-Dallas-01@polycom.com: local#83840767145bf04a9ce2b307af6d5688:site localdir 3. SD-Dallas-02@polycom.com: local#158aa86dd780ca4f8731fcfd627e05ad:site localdir 4. SD-Houston-01@polycom.com: local#e2859e0318bca145ba9b6f641e7f39d2:site localdir 5. SD-Houston-02@polycom.com: local#f82be96eea3bd644a1963dc7fdf45011:site localdir sd 5 done ● localdir entry ldap#g#8852f4c7cb6d9b4fab7e53e2730a5219 returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 145: Importprofile
localdir 0. "SD-Austin-02@polycom.com" sip_spd:Auto sip_num:sip:SEA18-09.106@vtc.austin.com:site localdir 1. "SD-Austin-02@polycom.com”h323_spd:Autoh323_num: h323_ext:12067406489:site localdir entry ldap#g#8852f4c7cb6d9b4fab7e53e2730a5219 done ● localdir grouplist returns localdir 0. Admin Admin:ldap#g#589feda2e097073b52134c7984ca6b44:site localdir 1. Admin2 Admin2:ldap#g#e6b660a112b25d4cb2067243e73da458:site localdir 2. G7500:ldap#g#0410894cfa213c418df5bd1226d46491:group localdir 3. Group Series:ldap#g#011d8db58de14d48838549c5e0ec7465:group localdir 4. HDX_MISC:ldap#g#2331576d60cf9948a09860946f38a42b:grouplocaldir 5. Sams 9006:ldap#g#e64ffc28a13917488dec8ac97959c80f:site localdir 6. Sams Saturn:ldap#g#5cb47f04e402d7478631ad45b5e6b493:site localdir grouplist done Limitations None...
Page 146 (not edited in any form). The system may use the checksum utility to verify of integrity of the data when it is imported. importprofile done indicates that all the profile data has been imported. Chapter 14 Command-line API reference for Poly Video Mode...
Page 147 A restart of the system is required after successfully importing system and user profile information. You must include the importcomplete command as the last entry. Issuing the importcomplete command on its own line indicates that the profile import is complete. If no data is received for 60 seconds during import, the import ends, and an importprofile timed out error response displays.
Page 148: Content Sharing Apis
● content close 987 returns content close successful ● content show 115 returns error: input 115 is not a content source content show failed Chapter 14 Command-line API reference for Poly Video Mode...
Page 149: Contentauto
Limitations You can’t close some content sources, only hide them. For example, HDMI content. Comments If you try to call content show for content already shown or content hide for content already hidden, the system returns “error:not allowed”. contentauto Gets or sets 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.
Page 150: Content List
“Blackboard-1” type:”drawingboard” shown:true content list done ● content list contentcam returns content list start content: name: id:“1234” “HDMI” type:”contentcam” shown:true content list done ● content list 12347 returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 151: Vcbutton
content list start content: name: id:“12347” “My iphone” type:”airplay” shown:false content list done Limitations None Comments The system returns an empty list if the filter doesn’t match a source. vcbutton Controls HDMI content video source. It can also register or unregister the API session to receive notification of HDMI and far end (in a call) content events.
Page 152 (HDMI content is active) returns vcbutton source get 2 ● vcbutton source get succeeded Limitations vcbutton supports only control of HDMI content and notifications related to HDMI and far end content in a call. Comments None Chapter 14 Command-line API reference for Poly Video Mode...
Page 153: General Apis
General APIs apiport Gets or sets the command-line API telnet port. Syntax apiport get apiport <23|24> Table 14-54 Parameter Description Returns the configured command-line API port. Sets the command-line API telnet port to 23. Sets the command-line API telnet port to 24. Default setting. Feedback examples ●...
Page 154 When importing directory data back into the system, use the data in its entirety (not edited in any form). There is information that is used by the system to determine what type data (XML or CSV) is being imported. Chapter 14 Command-line API reference for Poly Video Mode...
Page 155: Exit
When this event occurs, the message “listengoing to sleep” is received. When the system wakes up, the message “listen waking up” is received. Deprecated. Poly recommends using sleep registerinstead of this command. Feedback Examples ● listen sleep...
Page 156: Loglevel
Sets debug level to log all informational, warning, and error error messages. Sets debug level to log all informational, warning, error, and critical critical messages. Feedback Examples ● loglevel get returns loglevel info Chapter 14 Command-line API reference for Poly Video Mode...
Page 157: Notify
Limitations None Comments warning logs the fewest number of messages. Poly recommends leaving this setting at the default value of debug. notify Lists the types of notifications being received or registers to receive status notifications. Syntax notify notify <callstatus|linestatus|mutestatus|screenchanges>...
Page 158 ● notify callstatus returns notify callstatus success acknowledging that the session is registered to receive callstatus notifications If entered again, ● notify callstatus returns info: event/notification already active:callstatus ● notify Chapter 14 Command-line API reference for Poly Video Mode...
Page 159: Nonotify
returns registered for 2 notifications:callstatus:mutestatus ● notify calendarmeetings returns notify calendarmeetings success The following are examples of notifications that may be returned after registering to receive them. ● notification:callstatus:outgoing:34:PolycomG7500 Demo:192.168.1.101:connected:384:0:videocall ● notification:mutestatus:near:near:near:near:muted ● notification:screenchange:systemsetup:systemsetup_a ● notification:vidsourcechange:near:1:Main:people ● notification:linestatus:outgoing:32:0:0:disconnected ● notification:vidsourcechange:near:none:none:content ●...
Page 160: Powerdown
● nonotify calendarmeetings returns nonotify calendarmeetings success Limitations None Comments None See Also See the related notify on page 147 command. powerdown Restarts the system and disconnects the API connection. Chapter 14 Command-line API reference for Poly Video Mode...
Page 161: Providermode
Reports the current provider and lock state or sets the provider. Syntax providermode get providermode set <Zoom | Teams| LogMeIn| BlueJeans | RingCentral| PolyVideo | Poly| camuvc | StarLeaf> Table 14-60 Parameter Description Reports the current provider and the provider lock state.
Page 162: Oobcomplete
If a reboot is required after setting the provider, the command returns ● Rebooting… ● provider set Zoom returns Provider change succeeded. Rebooting… Limitations None Comments None oobcomplete Completes the onscreen setup instructions and restarts the system. Chapter 14 Command-line API reference for Poly Video Mode...
Page 163: Reboot
Syntax oobcomplete Feedback Examples ● oobcomplete returns oobcomplete Limitations None Comments The oobcomplete command is processed only when the system is in setup mode. To execute oobcomplete successfully, the system name must be configured. reboot Restarts the system. Syntax reboot [now] Table 14-61 Parameter Description...
Page 164: Sleep
Mutes the system microphone while the system is in sleep on . mode Unmutes the microphone while the system is in sleep mode. Mutes the system microphone while the system is in sleep mute mode. Chapter 14 Command-line API reference for Poly Video Mode...
Page 165 Table 14-63 (continued) Parameter Description Puts the system in sleep mode if not followed by other sleep parameters. Registers the system for sleep or wake events. register Unregisters the system for sleep or wake events. unregister Feedback Examples ● sleep returns sleep ●...
Page 166: Sleeptime
Gets or sets the AMX Device Discovery beacon. Syntax amxdd get amxdd <on|off> Table 14-65 Parameter Description Returns the current setting. Turns on the AMX Device Discovery beacon. Turns off the AMX Device Discovery beacon. Chapter 14 Command-line API reference for Poly Video Mode...
Page 167: Serialnum
Feedback examples ● amxdd get returns amxdd off ● amxdd on returns amxdd on Limitations None Comments The default setting for this signal is off. serialnum Returns the serial number of the system. Syntax serialnum Feedback Examples ● serialnum returns serialnum 82065205E72E1 Limitations None...
Page 168: Status
Limitations None Comments None status Returns the current status of devices and primary system services. Syntax status Table 14-67 Parameter Description Returns the current status of system settings. status Chapter 14 Command-line API reference for Poly Video Mode...
Page 169: Systemname
Feedback Examples ● status returns inacall offline autoanswerp2p online remotecontrol online microphones online globaldirectory offline ipnetwork online gatekeeper online sipserver online calendar online logthreshold offline provisioning online wifi offline status end Limitations None Comments None systemname Gets or sets the name of the system. Syntax systemname get systemname set “system name”...
Page 170: Uptime
Returns the current setting. Feedback Examples ● uptime get returns 1 Hour, 10 Minutes Limitations None Comments None version Returns the current system’s version information. Syntax version Additional Restrictions None Feedback Examples ● version returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 171: Wake
version 2.0 Limitations None Comments None wake Wakes the system from sleep mode. Syntax wake Additional Restrictions None Feedback Examples ● wake returns wake, and wakes the system from sleep mode Limitations None Comments None See Also To put the system in sleep mode, use the sleep on page 154 command.
Page 172 Local Time is: Wed, 30 Nov 2008 10:41:46 Network Interface: NONE IP Video Number: 192.168.1.101 MP Enabled: AB1C-2D34-5EF6-7890-GHI1 H323 Enabled: True HTTP Enabled: True SNMP Enabled: True Limitations None Comments The response can vary depending on your system configuration. Chapter 14 Command-line API reference for Poly Video Mode...
Page 173: Network Apis
Network APIs defaultgateway Gets or sets the default gateway. Syntax defaultgateway get defaultgateway set “xxx.xxx.xxx.xxx” Table 14-70 Parameter Description Returns the default gateway IP address. Sets the default gateway when followed by the “xxx.xxx.xxx.xxx” parameter. IP address to use as the default gateway. “xxx.xxx.xxx.xxx”...
Page 174: Echo
Syntax echo <string> Table 14-72 Parameter Description Returns a string sent to the system. echo<string> Feedback Examples ● echo “Are you there?” returns Are you there? returns ● ● echo KA returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 175: Echoreply
Limitations None Comments None echoreply Gets or sets the system’s ability to send an Echo Reply message in response to an Echo Request message sent to an IPv4 multicast/anycast address. Syntax echoreply <get|yes|no> Table 14-73 Parameter Description Returns the current setting. Enables the echo reply option.
Page 176: Enablefirewalltraversal
Gets or sets the system’s ability to traverse firewalls. This feature requires a session border controller that supports H.460. Syntax enablefirewalltraversal <get|on|off> Table 14-75 Parameter Description Returns the current setting. Enables the firewall traversal feature. Disables the firewall traversal feature. Chapter 14 Command-line API reference for Poly Video Mode...
Page 177: Advnetstats
Feedback Examples ● enablefirewalltraversal on returns enablefirewalltraversal on ● enablefirewalltraversal off returns enablefirewalltraversal off ● enablefirewalltraversal get returns enablefirewalltraversal off Limitations None Comments None advnetstats Gets advanced network statistics for a call connection. Syntax advnetstats[{0..n}] Table 14-76 Parameter Description Specifies a connection in a call, where nis the maximum {0..n} number of connections supported by the system.
Page 178 = receive content rate used tcfr = transmit content frame rate rcfr = receive content frame rate tcpl = transmit content packet loss rcpl = receive content packet loss Limitations None Comments None Chapter 14 Command-line API reference for Poly Video Mode...
Page 179: Dynamicbandwidth
See also To return network statistics for a call, use the nearloop on page 191 command. dynamicbandwidth Gets or sets the use of dynamic bandwidth allocation for Quality of Service. Syntax dynamicbandwidth <get|yes|no> Table 14-77 Parameter Description Returns the current setting. Enables the dynamic bandwidth option.
Page 180: Daylightsavings
Gets or sets the daylight saving time setting. When you enable this setting, the system clock automatically changes for daylight saving time. Syntax daylightsavings <get|yes|no> Table 14-79 Parameter Description Returns the current setting. Enables automatic adjustment for daylight savings time. Disables automatic adjustment for daylight savings time. Chapter 14 Command-line API reference for Poly Video Mode...
Page 181: Enablepvec
Feedback Examples ● daylightsavings no returns daylightsavings no ● daylightsavings yes returns daylightsavings yes ● daylightsavings get returns daylightsavings get Limitations None Comments None enablepvec Gets or sets the Polycom Video Error Concealment (PVEC) setting on the system. Syntax enablepvec <get|yes|no> Table 14-80 Parameter Description...
Page 182: Enablesipka
Enables SIP keep alive messages. Disables SIP keep alive messages. Feedback Examples ● enablesipka get returns enablesipka off ● enablesipka on returns enablesipka on Limitations None Comments None enablesnmp Gets or enables/disables SNMP. Chapter 14 Command-line API reference for Poly Video Mode...
Page 183: Gatekeeperip
Syntax enablesnmp <get|yes|no> Table 14-82 Parameter Description Returns the current setting. Enables SNMP. Disables SNMP. Feedback Examples ● enablesnmp yes returns enablesnmp yes ● enablesnmp no returns enablesnmp no ● enablesnmp get returns enablesnmp no Limitations None Comments None gatekeeperip Gets or sets the IP address of the H.323 gatekeeper.
Page 184: H323Authenticateenable
Enables or disables H.323 authentication. Syntax h323authenticate enable <get|true|false> Table 14-84 Parameter Description Returns the current setting. Enables H.323 authentication. true Disables H.323 authentication. false Feedback Examples ● h323authenticate enable get returns h323authenticate enable true Chapter 14 Command-line API reference for Poly Video Mode...
Page 185: H323Authenticatename
● h323authenticate enable true returns h323authenticate enable true ● h323authenticate enable false returns h323authenticate enable false Limitations None Comments None h323authenticatename Sets the H.323 name to use to identify the system. Syntax h323authenticate name get h323authenticate name “name” Table 14-85 Parameter Description Returns the current H.323 name.
Page 186: H323Authenticatepassword
“H.323name”parameter.To erase this setting, omit the “H.323name” parameter. Character string specifying the H.323 name. Use quotation “H.323name” marks around strings that contain spaces. For example: “Demo” Feedback Examples ● h323name set My Chapter 14 Command-line API reference for Poly Video Mode...
Page 187: Getconfiguredipaddress
returns h323name my ● h323name set “Demo” returns h323name “Demo” ● h323name get returns h323name “Demo” Limitations None Comments None getconfiguredipaddress Retrieves the currently configured IPv4 address from the system. Syntax getconfiguredipaddress Additional Restrictions None Feedback Examples ● getconfiguredipaddress returns getconfiguredipaddress 1.2.3.4 Limitations None...
Page 188: Hostname
Feedback Examples ● hostname set returns hostname ADMIN ● hostname set “My” returns hostname My ● hostname get returns hostname My Limitations None Chapter 14 Command-line API reference for Poly Video Mode...
Page 189: Ipaddress
Comments ALAN 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. ipaddress Gets or sets the LAN IP address (IPv4) of the system. Syntax ipaddress get ipaddress set “xxx.xxx.xxx.xxx”...
Page 190: Ldapauthenticationtype
Comments After making a change, you are prompted to restart the system. ldapauthenticationtype Gets or sets the authentication type required to authenticate with an LDAP server. Syntax ldapauthenticationtype get ldapauthenticationtype set <anonymous|basic> Chapter 14 Command-line API reference for Poly Video Mode...
Page 191: Ldapbasedn
Returns the current setting. 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 Poly system recognizes the server. Specifies “anonymous”as the authentication type of an anonymous LDAP server.
Page 192: Ldapbinddn
Sets the base DN of an LDAP server. To erase the current setting, omit the “basedn” parameter. NOTE: This parameter does not change the setting on the server. Instead, this parameter changes how the Poly system recognizes the server. Specifies the base DN of an LDAP server. Valid characters “basedn”...
Page 193: Ldapdirectory
“bind dn” parameter. NOTE: This parameter does not change the setting on the server. Instead, this parameter changes how the Poly system recognizes the server. Specifies the bind DN of an LDAP server. Valid characters “binddn”...
Page 194: Ldapntlmdomain
LDAP directory server automatically disables any other global directory server, such as Poly GDS, which is enabled. If the Poly GDS and another directory server are defined on the system, Poly GDS becomes the default directory server after upgrading the system software.
Page 195: Ldappassword
LDAP server. To erase the current setting, omit the “domain” parameter. NOTE: This parameter does not change the setting on the server. Instead, this parameter changes how the Poly system recognizes the server. Specifies the domain in which authentication takes place in “domain”...
Page 196: Ldapserveraddress
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 Poly system recognizes the server. Specifies setting the password for NTLM authentication of an ntlm LDAP server.
Page 197: Ldapserverport
"address" parameter. NOTE: This parameter does not change the setting on the server. Instead, this parameter changes how the Poly system recognizes the server. Specifies the IP address or the DNS name of an LDAP “address”...
Page 198: Ldapsslenabled
“port number” parameter. NOTE: This parameter does not change the setting on the server. Instead, this parameter changes how the Poly system recognizes the server. Specifies the port number of an LDAP server. The default “portnumber”...
Page 199: Ldapusername
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 Poly system recognizes the server. Specifies the user name for NTLM authentication of an LDAP “username”...
Page 200: Natconfig
Requires you to assign the WAN address using the wanipaddresscommand. Disables the option when the system is not behind a NAT. Feedback Examples ● natconfig auto returns natconfig auto ● natconfig manual returns natconfig manual Chapter 14 Command-line API reference for Poly Video Mode...
Page 201: Nearloop
● natconfig off returns natconfig off ● natconfig get returns natconfig off Limitations None Comments None nearloop Activates or deactivates the Near End Loop test. Syntax nearloop <on|off> Table 14-102 Parameter Description Activates the Near End Loop, a complete internal test of the system.
Page 202: Netstats
= receive audio protocol tcp = transmit comm protocol rcp = receive comm protocol tcp = transmit content protocol rcp = receive content protocol tcf = transmit content format rcf = receive content format Limitations None Chapter 14 Command-line API reference for Poly Video Mode...
Page 203: Nath323Compatible
Comments Both pktloss and %pktloss report only numbers related to packet loss on the transmit. These numbers are not affected by packet loss on the Real-time Transport Protocol (RTP) that is received. The number listed for %pktloss is not cumulative and is calculated every five seconds. The number listed for pktloss is calculated every 5 seconds and is cumulative.
Page 204: Ntpsecondaryserver
● ntpmode manual returns ntpmode manual Limitations None Comments None ntpsecondaryserver Sets the NTP server to use for time settings when the primary time server does not respond. Chapter 14 Command-line API reference for Poly Video Mode...
Page 205: Ntpserver
Syntax ntpsecondaryserver get ntpsecondaryserver set <“xxx.xxx.xxx.xxx”|server name”> Table 14-106 Parameter Description Returns the current setting. Sets the IP address of the NTP server using the specified IP address or DNS name. Feedback Examples ● ntpsecondaryserver get returns ntpsecondaryserver 172.26.44.22 ● ntpsecondaryserver set returns ntpsecondaryserver “”...
Page 206: Rs232 Baud
Gets or sets the baud rate for the first RS-232 port. Syntax rs232 baud <get|9600|19200|38400|57600|115200> Table 14-108 Parameter Description Returns the current baud rate setting. Sets the RS-232 port to this baud rate. 9600|19200|38400| 57600|115200 Feedback Examples ● rs232 baud 9600 returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 207: Rs232 Mode
rs232 baud 9600 ● rs232 baud get returns rs232 baud 9600 Limitations None Comments None rs232 mode Gets or sets the operational mode of the system’s serial port. Syntax rs232 mode <get|off|control> Table 14-109 Parameter Description Returns the current mode setting. Sets the operational mode of the RS-232 port to off.
Page 208: Snmpadmin
To erase the current setting, omit “admin name”. SNMP administrator contact name. Character string. Enclose “admin name” the character string in quotation marks if it includes spaces. Example: “John Admin” Chapter 14 Command-line API reference for Poly Video Mode...
Page 209: Snmpcommunity
Feedback Examples ● snmpadmin get returns snmpadmin “John Admin” ● snmpadmin set “John Admin” returns snmpadmin “John Admin” ● snmpadmin set returns error: command needs more parameters to execute successfully Limitations None Comments After making a change, you must restart the system for the setting to take effect. snmpcommunity Gets or sets the SNMP community string.
Page 210: Snmpconsoleip
To erase the current setting, omit the parameter. IP address of the console. “xxx.xxx.xxx.xxx” Feedback Examples ● snmpconsoleip set returns snmpconsoleip <empty> ● snmpconsoleip set 192.168.1.111 returns snmpconsoleip 192.168.1.111 ● snmpconsoleip get returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 211: Snmplocation
snmpconsoleip 192.168.1.111 Limitations None Comments After making a change, you must restart the system for the setting to take effect. snmplocation Gets or sets the location of the SNMP system. Syntax snmplocation get snmplocation ["location name"] Table 14-114 Parameter Description Returns the current setting.
Page 212: Snmpnotification
Enables or disables SNMP notifications for the Poly MIB, which can be downloaded from the SNMP page in the system web interface. Syntax snmpnotification <get|true|false> Table 14-115 Parameter Description Returns the current setting for SNMP notifications. Enables SNMP notifications.
Page 213: Snmptrapversion
Table 14-116 Parameter Description get Returns the current setting. Sets the SNMP system description when followed by the “system description” parameter. To erase the current setting, omit the parameter. SNMP system description. “system description” Feedback Examples ● snmpsystemdescription set returns snmpsystemdescription <empty>...
Page 214: Subnetmask
“xxx.xxx.xxx.xxx”. This parameter is not allowed while in a call. Subnet mask of the system. “xxx.xxx.xxx.xxx” Feedback Examples ● subnetmask set 255.255.255.0 returns subnetmask 255.255.255.0 ● subnetmask get returns subnetmask 255.255.255.0 Chapter 14 Command-line API reference for Poly Video Mode...
Page 215: Usegatekeeper
Limitations None Comments After making a change, you must restart the system for the setting to take effect. usegatekeeper Gets or sets whether the system can use an H.323 gatekeeper. Syntax usegatekeeper <get|off|specify|auto> Table 14-119 Parameter Description Returns the current setting. Select this option if no gatekeeper is required.
Page 216: Wanipaddress
Feedback Examples ● wanipaddress set 192.168.1.101 returns wanipaddress 192.168.1.101 ● wanipaddress get returns wanipaddress 192.168.1.101 Limitations None Comments The NAT Configuration setting must be set to Auto or Manual to set this command. Chapter 14 Command-line API reference for Poly Video Mode...
Page 217: Provisioning Apis
Provisioning APIs provisionserveraddress Gets or sets the IP address for the provisioning server. Syntax provisionserveraddress <get|set> <”Server Address”> Table 14-121 Parameter Description Returns the current setting. Sets the IP address of the provisioning server. Specifies the IP address to use when using the set “Server Address”...
Page 218: Provisionserverenable
Syntax provisionserverenable <get|true|false> Table 14-123 Parameter Description Returns the current setting. Enables the provisioning server. true Disables the provisioning server. false Feedback Examples ● provisionserverenable get returns provisionserverenable false ● provisionserverenable true Chapter 14 Command-line API reference for Poly Video Mode...
Page 219: Provisionserverpassword
returns provisionserverenable true ● provisionserverenable false returns provisionserverenable false Limitations None Comments None provisionserverpassword Sets the password for the provisioning server. Syntax provisionserverpassword set <”password”> Table 14-124 Parameter Description Sets the password for the provisioning server. Specifies the password for the provisioning server when “password”...
Page 220: Provisionserverupdate
Limitations None Comments None provisionserverstatus Gets the current status of the provisioning server. Syntax provisionserverstatus <get> Table 14-125 Parameter Description Returns the current status of the provisioning server. Chapter 14 Command-line API reference for Poly Video Mode...
Page 221: Provisionservertype
Feedback Examples ● provisionserverstatus get returns provisionserverstatus registered ● provisionserverstatus get returns provisionserverstatus unregistered Limitations None Comments None provisionservertype Gets or sets the provisioning server type. Syntax provisionservertype <get|rprm> Table 14-126 Parameter Description Returns the current setting. Sets the provisioning server type to RealPresence Resource Manager.
Page 222: Provisionserverupdate
None provisionserveruser Gets or sets the username assigned to the provisioning server account. Syntax provisionserveruser <get|set> <“Username”> Table 14-127 Parameter Description Returns the current setting. Sets the username for the provisioning server. Chapter 14 Command-line API reference for Poly Video Mode...
Page 223 Table 14-127 (continued) Parameter Description Specifies the username for the provisioning server when “UserName” using the set command. Feedback Examples ● provisionserveruser get returns provisionserveruser “John Smith” ● provisionserveruser set “Harry Thomas” returns provisionserveruser “Harry Thomas” Limitations None Comments None provisionserveruser...
Page 224: Security Apis
Limitations None Comments If the account doesn’t have password, enter a pair of single quotes ('') to denote an empty password. sshenable Enables command-line API access over SSH. Syntax sshenable <true|false> Chapter 14 Command-line API reference for Poly Video Mode...
Page 225 Table 14-129 Parameter Description Enables command-line API access over SSH. true Disables command-line API access over SSH false Feedback Examples ● sshenable true returns sshenable true ● sshenable false returns sshenable false Limitations None Comments None sshenable...
Page 226: Security Apis
Feedback Examples ● encryption yes returns encryption yes ● encryption no returns encryption no ● encryption get returns encryption no ● encryption requiredvideocallsonly returns encryption requiredvideocallsonly ● encryption requiredallcalls Chapter 14 Command-line API reference for Poly Video Mode...
Page 227 returns encryption requiredallcalls Limitations None Comments You cannot execute the encryption command while a call is in progress. Using this command while the system is in a call returns the following message: error:command has illegal parameters encryption...
Page 228: System Control And Remote Control Apis
Homescreen. In a content session, removes all content, ends the session, and returns you to the Home screen. Returns you to the Home screen. home Displays the video system’s System Detail screen. info Chapter 14 Command-line API reference for Poly Video Mode...
Page 229 Sends the Left button signal to the user interface. left In Poly Video mode, displays the quick access menu. menu In Partner Mode, performs the same action as the remote control Menubutton action for the selected conferencing partner application.
Page 230: Allregister
Comments Registers changes to any of the following types of parameters: Current near- or far-site source ● State of privacy ● Current volume level ● Active camera presets ● Chapter 14 Command-line API reference for Poly Video Mode...
Page 231: All Unregister
Call status ● IP connection to codec ● System information ● This command is useful when two control systems are used simultaneously, such as the web and API commands. The system maintains the registration changes through restarts. To register for events not included in this feedback, refer to the specific registration command. This is a one-time registration command that is retained in flash memory.
Page 232 Current near-site or far-site source ● State of privacy ● Current volume level ● Active camera presets ● Status of point-to-point or multipoint calls ● IP connection to codec ● System information ● Chapter 14 Command-line API reference for Poly Video Mode...
Page 233: System Settings Apis
System settings APIs systemsetting 323gatewayenable Gets the current setting or enables H.323 calling through a gateway Syntax systemsetting 323gatewayenable <True|False> systemsetting get 323gatewayenable Table 14-132 Parameter Description Returns the current setting. Enables H.323 gateway calls. True Disables H.323 gateway calls. False Feedback Examples ●...
Page 234: Systemsetting Dialingmethod
● systemsetting bfcptransportprotocol UDP_Only returns systemsetting bfcptransportprotocol UDP_Only Limitations None Comments None systemsetting dialingmethod Gets or sets the preferred method for dialing various call types. Syntax systemsetting dialingmethod <Auto|Manual> systemsetting get dialingmethod Chapter 14 Command-line API reference for Poly Video Mode...
Page 235: Systemsetting Displayiconsincall
Table 14-134 Parameter Description Returns the current setting. Sets the dialing mode to Auto. Calls use the configured Auto dialing order. Sets the dialing mode to Manual. The system prompts the Manual user to select the call type from a list when placing a call. Feedback Examples ●...
Page 236: Systemsetting Iph323Enable
Returns the current setting. Enables H.323 call capability. True Disables H.323 call capability. False Feedback Examples ● systemsetting iph323enable True returns systemsetting iph323enable True ● systemsetting get iph323enable returns systemsetting iph323enable True Limitations None Chapter 14 Command-line API reference for Poly Video Mode...
Page 237: Systemsetting Lineinlevel
Comments None systemsetting lineinlevel Gets the current setting or returns the volume level for 3.5 mm stereo audio input. Syntax systemsetting lineinlevel {0..10} systemsetting get lineinlevel Table 14-137 Parameter Description Returns the current setting. Sets the volume level for input 1. Valid range is 0 to 10. 0..10 Feedback Examples ●...
Page 238: Systemsetting Maxrxbandwidth
[speed] systemsetting get maxrxbandwidth Table 14-139 Parameter Description Returns the current setting. Sets the maximum speed for receiving calls. speed Feedback Examples ● systemsetting maxrxbandwidth 1920 returns systemsetting maxrxbandwidth 1920 Chapter 14 Command-line API reference for Poly Video Mode...
Page 239: Systemsetting Maxtxbandwidth
● systemsetting get maxrxbandwidth returns systemsetting maxrxbandwidth 1920 Limitations None Comments None systemsetting maxtxbandwidth Gets or sets the maximum transmit line speed between 64 kbps and 6144 kbps. Syntax systemsetting maxtxbandwidth [speed] systemsetting get maxtxbandwidth Table 14-140 Parameter Description Returns the current setting. Sets the maximum speed for placing calls.
Page 240: Systemsetting Model
5 Limitations None Comments None systemsetting model Returns the model of the system. Syntax systemsetting get model Table 14-142 Parameter Description Returns the current setting. Feedback Examples ● systemsetting get model returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 241: Systemsetting Sipaccountname
systemsetting model “RealPresence ” Limitations None Comments None systemsetting sipaccountname Gets or sets the SIP user account name. Syntax systemsetting sipaccountname <"sipuser"> systemsetting get sipaccountname Table 14-143 Parameter Description Returns the current setting. Specifies the user account name. “sipuser” Feedback Examples ●...
Page 242: Systemsetting Sipenable
Comments None systemsetting sipenable Enables or disables SIP calling. Syntax systemsetting sipenable <True|False> systemsetting get sipenable Table 14-145 Parameter Description Returns the current setting. Enables SIP calling. True Disables SIP calling. False Chapter 14 Command-line API reference for Poly Video Mode...
Page 243: Systemsetting Sipforcereuse
Feedback Examples ● systemsetting sipenable True returns systemsetting sipenable True ● systemsetting get sipenable returns systemsetting sipenable True Limitations None Comments None systemsetting sipforcereuse Enables or disables the SIP force reuse function, which forces the proxy server to reuse the existing SIP connection for requests in the reverse direction by using the SIP port as the source port.
Page 244: Systemsetting Sippassword
Limitations None Comments None systemsetting sipproxyserver Gets or sets the address of the SIP proxy server. Syntax systemsetting sipproxyserver <address> systemsetting get sipproxyserver Table 14-148 Parameter Description Returns the current setting. Chapter 14 Command-line API reference for Poly Video Mode...
Page 245: Systemsetting Sipregistrarserver
Table 14-148 (continued) Parameter Description Address of the proxy server. Can be an IP address or fully “address” qualified domain name (FQDN). Feedback Examples ● systemsetting sipproxyserver pserver.abc.com returns systemsetting sipproxyserver pserver.abc.com ● systemsetting get sipproxyserver returns systemsetting sipproxyserver pserver.abc.com Limitations None Comments...
Page 246: Systemsetting Siptransportprotocol
Feedback Examples ● systemsetting get siptransportprotocol returns systemsetting siptransportprotocol Auto ● systemsetting siptransportprotocol TLS returns systemsetting siptransportprotocol TLS ● systemsetting siptransportprotocol TCP returns systemsetting siptransportprotocol TCP ● systemsetting siptransportprotocol UDP Chapter 14 Command-line API reference for Poly Video Mode...
Page 247: Systemsetting Sipusername
returns systemsetting siptransportprotocol UDP Limitations None Comments None systemsetting sipusername Gets or sets the system's SIP name. Syntax systemsetting sipusername ["name"] systemsetting get sipusername Table 14-151 Parameter Description Returns the current setting. Specifies the SIP URI for SIP registration. “name” Feedback Examples ●...
Page 248: Systemsetting Telnetenabled
Gets or sets the telnet ports. Syntax systemsetting telnetenabled <True|False> systemsetting get telnetenabled Table 14-153 Parameter Description Returns the current setting. Enables ports 23 and 24. True Disables ports 23 and 24. False Chapter 14 Command-line API reference for Poly Video Mode...
Page 249: Systemsetting Transcodingenabled
Feedback Examples ● systemsetting get telnetenabled returns systemsetting get telnetenabled ● systemsetting telnetenabled True returns systemsetting telnetenabled True ● systemsetting telnetenabled returns error: command needs more parameters to execute successfully Limitations None Comments After making a change, you must restart the system for the setting to take effect. systemsetting transcodingenabled Gets or specifies whether the system allows each far-site system to connect using the best possible call rate and audio/video algorithm.
Page 250: Systemsetting Webenabled
True Limitations None Comments You must restart the system for changes to take effect. systemsetting whitebalancemode Gets or sets the white balance mode for a connected Poly camera. Chapter 14 Command-line API reference for Poly Video Mode...
Page 251 Syntax systemsetting whitebalancemode <Auto|Manual|2300K|2856K|3200K|3450K|3680K|4160K|4230K|4640K|5120K| 5200K|5600K|6504K> systemsetting get whitebalancemode Table 14-156 Parameter Description Returns the current setting. Auto - Automatic white balance. Auto|Manual|3200K|3680K| Manual - Fixed white balance (measured in Kelvin). 4160K|4640K|5120K|5600K 2300K 2856K 3200K 3450K 3680K 4160K 4230K 4640K 5120K 5200K 5600K 6504K...
Page 252: Video Display Apis
Feedback Examples ● configpresentation self-view get returns configpresentation self-view Corner ● configpresentation self-view full-screen returns configpresentation self-view full-screen ● configpresentation content get returns configpresentation content dual ● configpresentation content single returns Chapter 14 Command-line API reference for Poly Video Mode...
Page 253: Configdisplay
configpresentation content single Limitations None Comments None configdisplay Gets or sets the resolution and refresh rate for Monitor 1 or Monitor 2. Syntax configdisplay [<monitor1|monitor2>] get configdisplay monitor1 <auto|50hz1920x1080p|60hz1920x1080p|25hz3840x2160p|30hz3840x2160p| 50hz3840x2160p|60hz3 840x2160p> configdisplay monitor2 <off|auto|50hz1920x1080p|60hz1920x1080p> Table 14-158 Parameter Description Returns the current setting. Specifies Monitor 1.
Page 254: Configpresentation
Precedes the singleor dualparameter. Displays content on one monitor. single Displays content on both monitors. dual Feedback Examples ● configpresentation self-view get returns configpresentation self-view Corner ● configpresentation self-view full-screen returns configpresentation self-view full-screen Chapter 14 Command-line API reference for Poly Video Mode...
Page 255: Farnametimedisplay
● configpresentation content get returns configpresentation content dual ● configpresentation content single returns configpresentation content single Limitations None Comments None farnametimedisplay Enables or disables the name that is displayed on a far site monitor. Syntax farnametimedisplay <get|on|off> Table 14-160 Parameter Description Returns the current setting.
Page 256: Monitor1Screensaveroutput
● monitor1screensaveroutput black returns monitor1screensaveroutput black ● monitor1screensaveroutput no_signal returns monitor1screensaveroutput no_signal ● monitor1screensaveroutput get returns monitor1screensaveroutput no_signal Limitations None Comments Setting Monitor 1 automatically sets Monitor 2 to the same setting. Chapter 14 Command-line API reference for Poly Video Mode...
Page 257: Monitor2Screensaveroutput
See Also See the monitor2screensaveroutput on page 247 command. monitor2screensaveroutput Gets the current setting or sets whether to send black video or "No Signal" to Monitor 2 when its screen saver starts. Syntax monitor2screensaveroutput <get|black|no_signal> Table 14-162 Parameter Description Returns the current setting. Sends black video to Monitor 2 when the system goes to black sleep and the screen saver activates.
Page 258: 15 Getting Help
Getting help Poly is now a part of HP. The joining of Poly and HP paves the way for us to create the hybrid work experiences of the future. Information about Poly products has transitioned from the Poly Support site to the HP Support site.
Page 259 Document part number: P03707-002A Last update: May 2024 Email us at documentation.feedback@hp.com with queries or suggestions related to this document. Document information...

This manual is also suitable for:

Pbj-stg-62n Pbj-stg-62r

Poly Studio G62 Integrator Manual

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Poly Studio G62

Summary of Contents for Poly Studio G62