Polycom HDX series Reference Manual page 4

Integrator's Reference Manual for Polycom HDX Systems
3 Using the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
4 System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
iv
HDCI Sony VISCA Adapter Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
PowerCam Primary Camera Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
PowerCam Break-Out Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
PowerCam Plus/VISCA Control Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26
PowerCam/VISCA Control Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28
Audio Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
Polycom HDX Microphone Array Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
Polycom HDX Microphone Array Cable Adapter . . . . . . . . . . . . . . . . . . . . . . 2-30
Custom Cabling for Polycom HDX Microphones . . . . . . . . . . . . . . . . . . . . . . 2-31
Audio Adapter Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34
Audio Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
Vortex Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
3.5mm Screw Cage Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
Subwoofer Volume Attenuator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Serial (RS-232) Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39
RS-232 Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39
Null Modem Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41
Using the API with an RS-232 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configuring the RS-232 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Starting an API Session via an RS-232 Interface . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Using the API with a LAN Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Using the API Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
About the API Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Availability of Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
abk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
addressdisplayedingab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
adminpassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
advnetstats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
alertusertone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
alertvideotone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
all register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
all unregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
allowabkchanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
allowcamerapresetssetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
allowmixedcalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
allowusersetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
areacode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
autoanswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19