Manuals / Polycom / Home Audio / Speaker System

Polycom VIEWSTATION EX manual

Models: VIEWSTATION EX

1 224

Download 224 pages 61.71 Kb

Page 14

ViewStation EX, ViewStation FX, and VS4000 API Guide

•Pass-Thru Mode to Pass-Thru Mode: Both endpoints are set to Pass-Thru Mode.

•Pass-Thru Mode to Control Mode: The near site is set to Pass-Thru Mode and the far site is set to Control Mode.

Operational Modes: The following information describes operational modes in more detail.

•Pass-Thru Mode to Pass-Thru Mode—Two stations set to Pass-Thru Mode behave essentially as a null-modem between their respective externally connected devices. These two stations can be two ViewStation EX systems, two ViewStation FX systems, two VS4000 systems, or one ViewStation EX system and one ViewStation FX or VS4000 system.

The RS-232 port is used as a data channel over an H.320 video call. Data received from the RS-232 port on the near-end system is pushed through the call to the far-end endpoint and then transmitted to the endpoint’s RS-232 port. Similarly, data from the far-end endpoint is transmitted back to the near-end system (through the H.320 call) and then transmitted to the near-end RS-232 port.

The data channel speed is dynamically allocated. The maximum data flow rate is based on the bandwidth of the call.

Because data throughput has priority over video throughput, video bandwidth may be restricted to support data requirements. Audio is not compromised.

Pass-Thru Mode is a proprietary feature that is only supported when both endpoints are either ViewStation EX, ViewStation FX, or VS4000 systems.

The RS-232 port only supports data Pass-Thru in H.320 mode (ISDN or V.35/RS-449/RS-530/RS-366/RS-366). Data Pass-Thru in an H.323 (IP) video call or multipoint call is not supported, as alternative file transfer methods such as ftp or Telnet are widely available.

Note In Pass-Thru mode, both local and remote stations need to be set to the same data rate.

•Pass-Thru Mode to Control Mode—If the near site is set to Pass-Thru Mode, but the far site is set to Control Mode, then the device connected to the near site RS-232 port can be used to

6	www.polycom.com

Image 14

Polycom VIEWSTATION EX manual

Contents

VS4000 User’s Guide ViewStation EX, ViewStationFX, and VS4000 API Guide April 2003 Edition Release 1725-10656-004Trademark Information Patent InformationContents callstate gatewayprefix nearloop streammulticastip isdnareacode Polycom, Inc. ViewStation EX, ViewStation FXand VS4000 API Guide Command What’s New in Release 5.0?button near command CommandUsing the RS-232Interface Accessing the API InterfaceUsing Telnet Connecting the Serial CableStarting a Communications Session ViewStation EX and ViewStation FXBaud Rate RS-232Interface InformationRS-232User Interface Screen RS-232ModesPage Far-SideMode Flow ControlNear-SideMode Resulting OperationPin Number FunctionFunction RS-232Serial Cable Pinout and Connections VS4000Pin Number Polycom, Inc.B Channel Status Message Example Using the “listen” or “dial” CommandStatus Display ExamplePolycom, Inc. Page Example Syntax SummaryExample ExampleResponse About the “get” SubcommandExample ExampleDescription System Commands<“str”|1..64> Exampleabk batch <0..59> Subcommandsabk <batch|all|letter|range> abk all abk letter <a..z> abk range <a..b> adminpasswordadminpassword <set|get> password Examplesadvnetstats advnetstatsUser Interface Screen Location advnetstatsSample Output ExamplesEnables the Allow Address Book Changes option allowabkchangesallowabkchanges <yes|no|get> Disables the Allow Address Book Changes optionallowdialing <yes|no|get> allowdialingallowmixedcalls allowmixedcalls <yes|no|get>allowremotemon allowusersetupallowusersetup <yes|no|get> allowremotemon <get>answer <phone|video> answeraudioquality audioquality <set|get>audioqualityg7221 get audioqualityg7221audioqualityg7221 <set|get> ExampleExample autoanswerautoanswer <yes|no|donotdisturb|get> User Interface Screen Locationautodiscovernat <yes|no|get> autodiscovernatautoh323dialing autoh323dialing <yes|no|get>Displays the current setting yes or no backlightcompensationbacklightcompensation <yes|no|get> Examplebutton Descriptionvolume presetvolume+ deleteExample callpreferencecallpreference <h320|h323|both|get> ExampleOutput to Example callstatecallstate <register|unregister|get> Descriptioncamera <near|far> stop cameracamera <near|far|register|unregister> Subcommandsnear move discrete near tracking to_presetsnear move continuous near <setposition|getposition> <x> <y> <z>register unregister subcommand far subcommandsfar tracking to_presets Camera sourceExample camera1ptzcamera1ptz <yes|no|get> Examplecamera4ptz <yes|no|get> camera4ptzcameradirection cameradirection <normal|reversed|get>Example camerainputcamerainput <1|2|3|4> <off|s-video|composite|get> User Interface Screen LocationExample chaircontrolSubcommands ExampleExample Requests voice activated switchingset_password <“ string> req_term_name <term_no>colorbar <on|off> colorbarcountry country <set|get> <algeria..zimbabwe>Examples dataconferencetypedataconferencetype <off|netmeeting|t120| get> User Interface Screen Locationdefaultgateway get defaultgatewaydefaultgateway <set|get> daylightsavingsExample dhcpdhcp <off|client|server|get> User Interface Screen Locationdial phone <dialstring> dialdial <addressbook|auto|manual|phone> User Interface Screen LocationExamples dialchannelsdialchannels <parallel|oneatatime|get> Descriptiondiffserv set <0..63> diffserv get diffservdiffserv <set|get><0..63> dir stringdisplay call display calldisplay whoami Output Sampledisplaybolt dd displayboltOuput Descriptiondisplayglobaladdresses <yes|no|get> displayglobaladdressesdisplaygraphics displaygraphics <yes|no|get>displayipext <yes|no|get> displayipextdisplayipisdninfo Enables the display of the IP extensionOutput partial displayparamsdisplayparams Displays the current setting yes or nodns <set|get> <1..4>xxx.xxx.xxx.xxx dns get <1..4>Enables the option dynamicbandwidthdynamicbandwidth <yes|no|get> Descriptione164ext get e164exte164ext <set|get> e.164name Disables the optionResponse echocancellerechocanceller <yes|no|get> User Interface Screen Locationenablesnmp <yes|no|get> enablesnapshotsenablesnmp enablesnmp <yes|no|get>exit exitfarcontrolnearcamera farcontrolnearcamera <yes|no|get>farloop <on|off> farloopfarnametimedisplay farnametimedisplay <set|get>gabk batch gabpasswordgabpassword <set|get> password gabk batch <0..59>gabserverip set xxx.xxx.xxx.xxx gabserverip set gabserveripgabserverip <set|get> gabserverip getgatekeeperip get gatekeeperipgatekeeperip <set|get> User Interface Screen LocationSets the area code when followed by the areacode gatewayareacodegatewayareacode <set|get> areacode Displays the current setting for this optionDescription gatewaycountrycodegatewaycountrycode <set|get> number Examplegatewayext set gateway extension gatewayext set gatewayextgatewayext <set|get> gateway extension gatewayext getDescription gatewaynumbergatewaynumber <set|get> number ExampleDisplays the current setting did or gatewaynumbertypegatewaynumbertype <did|number+extension|get> DescriptionDescription gatewayprefixgatewayprefix <set|get><valid speed> value set <“valid speed”>Output gatewaysetupgatewaysetup ExampleDescription gatewaysuffixgatewaysuffix <set|get><valid speed> value set <“valid speed”>gendial 0..9|#| gendialgeneratetone generatetone <on|off>get screen get screengmscity Output ExampleExample gmscontactemailgmscontactemail <set|get> email User Interface Screen LocationDescription gmscontactfaxgmscontactfax <set|get> fax ExampleDescription gmscontactnumbergmscontactnumber <set|get> number ExampleDescription gmscontactpersongmscontactperson <set|get> person ExampleDescription gmscountrygmscountry get ExampleDescription gmsstategmsstate get Examplegmstechsupport get gmstechsupportgmstechsupport <set|get> tech support digits DescriptionDescription gmsurlgmsurl get <1..10> Examplecommand graphicsmonitor fxvga is similar to graphicsmonitorgraphicsmonitor <tv|fxvga|visualconcert|get> command graphicsmonitor visualconcert isgraphicsmonitorfxvga <on|off|get> graphicsmonitorfxvgagraphicsmonitortv graphicsmonitortv <on|off|get>Disables the TV monitor as the graphics monitor graphicsmonitorvisualconcertgraphicsmonitorvisualconcert <on|off|get> Displays the current setting on or offh323name get h323nameh323name <set|get> H.323name Descriptionhangup <phone|video> hanguphelp hangup phone hangup video 1..3 hangup videohelp Output to Example 1 partialExample verbosehires <2|3> <yes|no|get> hiresOutput to Example 2 partial DescriptionOutput to Example historyhistory User Interface Screen Locationhostname set hostname hostname set hostname get hostnamehostname <set|get> hostname Descriptionipaddress set xxx.xxx.xxx.xxx ipaddress set ipaddressipaddress <set|get> ipaddress getExample ipdialspeedipdialspeed <set|get><valid speed><on|off> User Interface Screen Locationipprecedence set <0..5> ipprecedence get ipprecedenceipprecedence <set|get> <0..5> Displays the current settingDescription ipstatipstat Output to Examplekeypadaudioconf <yes|no|get> keypadaudioconflanguage language getDisplays the current setting lanportSets the command. It requires a parameter from Examplelanstat min lanstat <min|misc|reset|sec|tmin|total>lanstat lanstat tmin lanstat tmin 0..60 lanstat totalOutput to Example ExampleOutput to Example lanstat minDescription listenlisten <phone|video|sleep> ExampleDescription maxgabinternationalcallspeedmaxgabinternationalcallspeed get Examplemaxgabinternetcallspeed get maxgabinternetcallspeedmaxgabinternetcallspeed <set|get> <valid speed> Descriptionmaxgabisdncallspeed get maxgabisdncallspeedmaxgabisdncallspeed <set|get> <valid speed> DescriptionDescription maxtimeincallmaxtimeincall <set|get> Examplemcupassword mcupasswordmcupassword password Descriptionpassword meetingpasswordmeetingpassword <set|get> password DescriptionDescription mpautoanswermpautoanswer <yes|no|donotdisturb|get> ExampleUser Interface Screen Location mpmodeDisplays the current setting for this option Descriptionmute near <on|off|toggle|get> mute far get mutemute <near|far|register|unregister> mute register mute unregistermuteautoanswercalls <yes|no|get> muteautoanswercallsnearloop nearloop <on|off>netmeetingip get netmeetingipnetmeetingip <set|get> Disables the Near End Loopnetstats netstatsnetstats Descriptionnumdigitsdid <0..24> numdigitsdid get numdigitsdidnumdigitsdid <0..24|get> User Interface Screen Locationnumdigitsext <0..24> numdigitsext get numdigitsextnumdigitsext <0..24|get> Displays the current settingnumberofmonitors <1..4|get> numberofmonitorsoutboundcallroute numberofmonitors <1..4> numberofmonitors getpause <0..65535> pausepcport ExampleDisplays the current setting pingping <ip_addr> count Examplepip <on|off|auto|get> switchnumber|didextnumber|extension|get>preferredalias preferredalias<isdnnumber|fulldidnumber|preset unregister presetpreset <near|far|register|unregister> switchnumberExample primarycallchoiceprimarycallchoice <isdn|ip|manual|get> DescriptionDisplays the current setting isdn, ip, or manual primarycameraprimarycamera <1|2|3|4|get> Displays the current setting 1, 2, 3, orregisterthissystem queuecommandsqueuecommands <yes|no|get> registerthissystem <yes|no|get>Enables this option register this system repeatrepeat <1..64> Disables this optionEnables the option requireacctnumtodialrequireacctnumtodial <yes|no|get> Disables the optionDescription roomphonenumberroomphonenumber <set|get> room phone number ExampleSubcommands rs232rs232<mode|flowcontrol|baud|> DescriptionUser Interface Screen Location screenrun <scriptfilename> Descriptiondisableui secondarycallchoicesecondarycallchoice <isdn|ip|none|get> enableuisendonlypreferredalias <yes|no|get> sendonlypreferredaliasserialnum serialnumsetaccountnumber <account number> setaccountnumbershowaddrsingab showaddrsingab <h320|h323|both|get>Displays the current setting h320, h323, or both showpopupshowpopup <text to display> Examplesleep sleepslides slides select <pres>password snapshotsnapshot <0|1|2|3|4|register|unregister> ExampleDisplays the current setting 1, 2, 3, or snapshotcamerasnapshotcamera <1|2|3|4|get> ExampleDescription snapshottimeoutsnapshottimeout <yes|no|get> Examplesnmpadmin set admin_name snmpadmin set snmpadminsnmpadmin <set|get> admin name snmpadmin getDescription snmpcommunitysnmpcommunity <set|get> community name Examplesnmpconsoleip <set|get> snmpconsoleipsnmplocation snmpconsoleip getExample soundeffectsvolumesoundeffectsvolume <set|get|test> <0..10> User Interface Screen Locationstdout <on|off> stdoutstream stream <start|stop>Enables streaming announcement streamannouncestreamannounce <yes|no|get> Disables streaming announcementstreamaudioport get streamaudioportstreamaudioport <set|get> stream audio port setting, omit the parameterstreammulticastip streamenablestreamenable <yes|no|get> streammulticastip <set|get> ip addressDisplays the current setting streamrestoredefaultsstreamrestoredefaults Examplestreamrouterhops get streamrouterhopsstreamrouterhops <set|get> number router hops Descriptionstreamspeed <192|256|384|512|get> streamspeedstreamvideoport streamvideoport <set|get> video portsubnetmask get subnetmasksubnetmask <set|get> Displays the current settingDescription systembehindnatsystembehindnat <yes|no|get> Examplesystemname set system name systemname get systemnamesystemname <set|get> system name DescriptionDescription t120nameipt120nameip <set|get> name or ip Exampletcpports <set|get> tcpportstechsupport tcpports getteleareacode get teleareacodeteleareacode <set|get> telephone area code Exampletelecountrycode get telecountrycodetelecountrycode <set|get> telephone country code Exampletelenumber set telephone number telenumber set telenumbertelenumber <set|get> telephone number telenumber gettestlan arp testlan arptestlan dcuinfo testlan dcuinfotestlan dns <name or ip> testlan dnstestlan echo testlan echo <ip_addr>Example ExampleOutput to Example Output to Exampletestlan ping <ip_addr> testlan pingtestlan ping <ip_addr>count Descriptiontextinput <text to input> textinputtimediffgmt timediffgmt <-12:00..+00:00..+12:00|get>udpports typeofservicetypeofservice <ipprecedence|diffserv|get> udpports <set|get>Enables the use of Used Fixed Ports usefixedportsusefixedports <yes|no|get> Disables the use of Used Fixed PortsDescription usegatekeeperusegatekeeper <off|specify|auto|get> ExampleDescription usepathnavigatorusepathnavigator <always|never|required| get> ExampleUser Interface Screen Location Polycom, Inc.validateacctnum <yes|no|get> validateacctnumvcbutton vcbutton <play|stop|get|register|unregister>Example vcraudiooutvcraudioout <yes|no|get> Descriptionvcrrecordsource <auto|near|far|get> vcrrecordsourceversion versionvgaoffmode vgaoffmode <black|nosignal|get>vgahorizpos vgahorizpos <left|right|get>Displays the current setting black or nosignal vgaphasevgaphase <increase|decrease|get> Increases the phasevgavertpos vgaresolutionvgaresolution <800x600|1024x768| 1280x1024|get> vgavertpos <up|down|get>volume set <0..24> volumevolume <set|up|down|get|register| unregister> Displays the current setting up or downUser Interface Screen Location waitforwaitfor <callcomplete|systemready| receivingcall> Descriptionwake wakewanipaddress wanipaddress <set|get>whoami whoamiwidescreenvideo widescreenvideo <yes|no|get>Enables WINS resolution winsresolutionwinsresolution <yes|no|get> Disables WINS resolutionwinsserver get winsserverwinsserver <set|get> Descriptionisdnareacode <set|get> area code ISDN BRI Commandsisdnareacode Sets the ISDN area code when followed by the areaDescription isdncountrycodeisdncountrycode <set|get> country code ExampleDescription isdndialingprefixisdndialingprefix <set|get> isdn prefix ExampleEnables the specified speed valid speed isdndialspeedisdndialspeed <set|get> <valid speed> <on|off> Disables the specified speed valid speedExample isdnnumDescription User Interface Screen LocationExample spidnumDescription User Interface Screen Locationpriareacode <set|get> area code ISDN PRI Commandspriareacode Displays the current settingDescription pricallbycallpricallbycall <set|get> ExampleDescription prichannelprichannel <set|get> <all|1..<23|30>> <on|off> ExampleExample Important PRI Channel InformationExample User Interface Screen LocationSets the internal CSU mode. This is the default pricsupricsu <internal|external|get> command on pageDescription pridialchannelspridialchannels <set|get> <1..12|15> ExampleDescription priintlprefixpriintlprefix <set|get> prefix Exampleprilinebuildout get prilinebuildoutprilinebuildout set <0|-7.5|-15|-22.5> Displays the current settingDescription prilinesignalprilinesignal <set|get><esf/b8zs|crc4/hdb3| hdb3> Exampleprinumber set pri number prinumber set prinumberprinumber <set|get> pri number prinumber getDescription prinumberingplanprinumberingplan <isdn|unknown|get> ExampleDescription prioutsidelineprioutsideline <set|get> outside_line ExampleDescription priswitchpriswitch get Exampledcd <normal|inverted|get> V.35/RS-449/RS-530/RS-366Commandscts <normal|inverted|get> Sets the signal to normal high voltage is logicSets the signal to inverted low voltage is logic dcdfilterdcdfilter <on|off|get> Displays the current setting normal or inverteddsranswer <on|off|get> dsranswerdsr <normal|inverted|get> Sets the signal to normal high voltage is logicUser Interface Screen Location dtr <normal|inverted|on|get>Example Descriptiong728 h331audiomodeDescription g711uDisplays the current setting for this option h331framerateh331framerate <30|15|10|7.5|get> User Interface Screen Locationh331videoprotocol <h263|h261|get> h331videoprotocolh331videoformat h331videoformat <fcif|get>Example rs366dialingrs366dialing on off get User Interface Screen LocationSets the signal to normal high voltage is logic rt <normal|inverted|get>rts <normal|inverted|get> Sets the signal to inverted low voltage is logicExample st <normal|inverted|get>Sets the signal to normal falling edge sends data User Interface Screen Locationv35broadcastmode <on|off|get> v35broadcastmodev35debug v35debug <0..3> <on|off>v35dialingprotocol <rs366|get> v35dialingprotocolv35num v35num <set|get> <1b1|1b2> v35 numberExample v35portsusedv35portsused <1|1+2|get> User Interface Screen LocationExample v35prefixv35prefix <set|get> <valid speed> value User Interface Screen LocationUser Interface Screen Location v35profileExample DescriptionOutput to Example ExampleExample User Interface Screen LocationDescription v35suffixv35suffix <set|get> <valid speed> value set <valid speed>v35suffix set 128 ”#4#2” ExampleUser Interface Screen Location Safety and Legal Notices Important SafeguardsLicense Restrictions USA and Canadian Regulatory Notices WarrantyLimitation of Remedies and Damages FCC NoticeSafety and Legal Notices Part 68 FCC Rules Declaration of Conformity EEA Regulatory NoticesCE Mark KonformitetserklæringDeclaração de Conformidade Dichiarazione di conformitàVerklaring van overeenstemming Declaración de conformidadUnderwriters Laboratories Statement Special Safety InstructionsInstallation Instructions