Integrator’s Reference Manual For The Polycom RealPresence .

Transcription

[Type the document title] 4.1.1 July 2013 3725-63708-002/AIntegrator’s ReferenceManual for the Polycom RealPresence Group SeriesPolycom Document Title1

Integrator’s Reference Manual for the Polycom RealPresence Group SeriesiiPolycom, Inc.

Trademark InformationPOLYCOM and the names and marks associated with Polycom's products are trademarks and/or servicemarks of Polycom, Inc., and are registered and/or common law marks in the United States and various othercountries.All other trademarks are the property of their respective owners.Patent InformationThe accompanying product may be protected by one or more U.S. and foreign patents and/or pending patentapplications held by Polycom, Inc. 2013 Polycom, Inc. All rights reserved.Polycom, Inc.6001 America Center DriveSan Jose CA 95002USANo part of this document may be reproduced or transmitted in any form or by any means, electronic ormechanical, for any purpose, without the express written permission of Polycom, Inc. Under the law,reproducing includes translating into another language or format.As between the parties, Polycom, Inc., retains title to and ownership of all proprietary rights with respect tothe software contained within its products. The software is protected by United States copyright laws andinternational treaty provision. Therefore, you must treat the software like any other copyrighted material (e.g.,a book or sound recording).Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc., is notresponsible for printing or clerical errors. Information in this document is subject to change without notice.iii

Integrator’s Reference Manual for the Polycom RealPresence Group SeriesivPolycom, Inc.

About This GuideThe Integrator’s Reference Manual for Polycom RealPresence Group Seriesis for system integrators who need to configure, customize, manage, andtroubleshoot Polycom RealPresence Group systems. The API commands inthis guide are applicable to the Polycom RealPresence Group 300, PolycomRealPresence Group 500, and Polycom RealPresence Group 700 systems.Polycom, Inc.v

Integrator’s Reference Manual for the Polycom RealPresence Group SeriesviAbout This GuidePolycom, Inc.

ContentsAbout This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v1Room Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Setting Up a Room for Video Conferencing . . . . . . . . . . . . . . . . . . . . . . . . . . 1Room Layout Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Integrating Video . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Connecting Polycom Cameras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Integrating Audio and Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Connecting a Polycom RealPresence Group Microphone Array to aPolycom RealPresence Group System . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Connecting a Computer to a Polycom RealPresence Group System . 162Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Network Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17CAT 5e LAN Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17LAN Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Polycom Touch Control LAN Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Polycom Touch Control Power Adapter . . . . . . . . . . . . . . . . . . . . . . . . . 21Video and Camera Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22HDMI Monitor Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22HDCI Analog Camera Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23HDCI Polycom EagleEye Director Cable . . . . . . . . . . . . . . . . . . . . . . . . 25HDCI Camera Break-Out Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27HDCI Polycom EagleEye 1080 Camera Cable . . . . . . . . . . . . . . . . . . . . 28HDCI Polycom EagleEye View Camera Cable . . . . . . . . . . . . . . . . . . . 29Audio Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30RealPresence Group Microphone Array Cable . . . . . . . . . . . . . . . . . . . 30Custom Cabling for Polycom RealPresence Group Microphone Arrays31Audio Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Polycom EagleEye Director Audio Feedback Phoenix toRCA Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Polycom, Inc.vii

Integrator’s Reference Manual for the Polycom RealPresence Group SeriesSerial Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Polycom RealPresence Group Series Serial cable . . . . . . . . . . . . . . . . . 36Straight-Through Serial Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Null Modem Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393Using the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Using the API with an RS-232 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Configuring the RS-232 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Understanding the RealPresence Group Series RS-232 Interfaces . . . 43Starting an API Session using an RS-232 Interface . . . . . . . . . . . . . . . . 44Using the API with the Maximum Security Profile Enabled . . . . . . . . 45Using the API with a LAN Connection . . . . . . . . . . . . . . . . . . . . . . . . . . 46Using the API Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Additional API Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Technical Support Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . 46Feature Enhancement Request Web Site . . . . . . . . . . . . . . . . . . . . . . . . . 47Video Test Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49About the API Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Availability of Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Command Response Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Commands that Restart the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Additional Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52addrbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53advnetstats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60all register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62all unregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64amxdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66audiotransmitlevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67autoanswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68autoshowcontent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69basicmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70calendardomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71calendarmeetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72calendarpassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76calendarplaytone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77viiiPolycom, Inc.

Contentscalendarregisterwithserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78calendarremindertime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79calendarresource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80calendarserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81calendarshowpvtmeetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82calendarstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83calendaruser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84callinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85callstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86camera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87camerainput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90configdisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91configparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93contentauto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94daylightsavings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95defaultgateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96dhcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97dial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101dynamicbandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102e164ext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103echocanceller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104echoreply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105enablefirewalltraversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106enablekeyboardnoisereduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107enablelivemusicmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108enablepvec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109enablersvp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110enablesnmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114farcontrolnearcamera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115gaddrbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116gatekeeperip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125gendial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126getcallstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127getconfiguredipaddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128h239enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129h323name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130hangup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Polycom, Inc.ix

Integrator’s Reference Manual for the Polycom RealPresence Group Serieshostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132ipaddress . . . . . . . . . . . . . . . . . . . . . . . .

The API commands in this guide are applicable to the Polycom RealPresence Group 300, Polycom RealPresence Group 500, and Polycom RealPresence Group 700 systems.