Manuals / Polycom / Home Audio / Speaker System

Polycom VIEWSTATION EX manual help, hangup <phone|video>, Description, Example, 1..3

Models: VIEWSTATION EX

1 224

Download 224 pages 61.71 Kb

Page 92

Image 92

ViewStation EX, ViewStation FX, and VS4000 API Guide

hangup

hangup <phonevideo>

hangup phone hangup video [{1..3}] hangup video

Description

This command hangs up a telephone or video call.

phone	Hangs up the current audio call.
video	Hangs up the current video call if no parameter from the
	range {1..3} is specified. A specified parameter selects
	which call to hang up.
1..3	The optional parameter selects which call to hang up.

Example 1

hangup phone

Example 2

hangup video 2

help

help <allhelpverboseterse"string"syntax>

help

Description

This command displays simple or detailed list of commands (when used with the parameters all, help, string, or syntax). It can also switch help display mode (when used with the parameters verbose or terse). Help without parameters displays the list of command names only.

84	www.polycom.com

Page 92

Image 92

Polycom VIEWSTATION EX help, hangup <phone|video>, hangup phone hangup video 1..3 hangup video, Description, Example

Contents

ViewStation EX, ViewStation FX, and VS4000 API GuideVS4000 User’s 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 What’s New in Release 5.0? button near commandCommand CommandAccessing the API Interface Using TelnetUsing the RS-232Interface Connecting the Serial CableStarting a Communications Session ViewStation EX and ViewStation FXRS-232Interface Information RS-232User Interface ScreenBaud Rate RS-232ModesPage Flow Control Near-SideModeFar-SideMode Resulting OperationPin Number FunctionRS-232Serial Cable Pinout and Connections VS4000 Pin NumberFunction Polycom, Inc.Using the “listen” or “dial” Command Status DisplayB Channel Status Message Example ExamplePolycom, Inc. Page Syntax Summary ExampleExample ExampleAbout the “get” Subcommand ExampleResponse ExampleSystem Commands <“str”|1..64>Description Exampleabk batch <0..59> Subcommandsabk <batch|all|letter|range> adminpassword adminpassword <set|get> passwordabk all abk letter <a..z> abk range <a..b> Examplesadvnetstats User Interface Screen Locationadvnetstats advnetstatsSample Output Examplesallowabkchanges allowabkchanges <yes|no|get>Enables the Allow Address Book Changes option Disables the Allow Address Book Changes optionallowdialing allowmixedcallsallowdialing yes no get allowmixedcalls <yes|no|get>allowusersetup allowusersetup <yes|no|get>allowremotemon allowremotemon <get>answer audioqualityanswer <phone|video> audioquality <set|get>audioqualityg7221 audioqualityg7221 <set|get>audioqualityg7221 get Exampleautoanswer autoanswer <yes|no|donotdisturb|get>Example User Interface Screen Locationautodiscovernat autoh323dialingautodiscovernat yes no get autoh323dialing <yes|no|get>backlightcompensation backlightcompensation <yes|no|get>Displays the current setting yes or no Examplebutton Descriptionpreset volume+volume deletecallpreference callpreference h320 h323 both getExample Examplecallstate callstate <register|unregister|get>Output to Example Descriptioncamera camera <near|far|register|unregister>camera <near|far> stop Subcommandsnear tracking to_presets near move continuousnear move discrete near <setposition|getposition> <x> <y> <z>far subcommands far tracking to_presetsregister unregister subcommand Camera sourcecamera1ptz camera1ptz <yes|no|get>Example Examplecamera4ptz cameradirectioncamera4ptz <yes|no|get> cameradirection <normal|reversed|get>camerainput camerainput <1|2|3|4> <off|s-video|composite|get>Example User Interface Screen Locationchaircontrol SubcommandsExample ExampleRequests voice activated switching set_password <“ string>Example req_term_name <term_no>colorbar countrycolorbar on off country <set|get> <algeria..zimbabwe>dataconferencetype dataconferencetype <off|netmeeting|t120| get>Examples User Interface Screen Locationdefaultgateway defaultgateway <set|get>defaultgateway get daylightsavingsdhcp dhcp <off|client|server|get>Example User Interface Screen Locationdial dial <addressbook|auto|manual|phone>dial phone <dialstring> User Interface Screen Locationdialchannels dialchannels <parallel|oneatatime|get>Examples Descriptiondiffserv diffserv <set|get><0..63>diffserv set <0..63> diffserv get dir stringdisplay call display whoamidisplay call Output Sampledisplaybolt Ouputdisplaybolt dd Descriptiondisplayglobaladdresses displaygraphicsdisplayglobaladdresses <yes|no|get> displaygraphics <yes|no|get>displayipext displayipisdninfodisplayipext <yes|no|get> Enables the display of the IP extensiondisplayparams displayparamsOutput partial Displays the current setting yes or nodns <set|get> <1..4>xxx.xxx.xxx.xxx dns get <1..4>dynamicbandwidth dynamicbandwidth <yes|no|get>Enables the option Descriptione164ext e164ext <set|get> e.164namee164ext get Disables the optionechocanceller echocanceller <yes|no|get>Response User Interface Screen Locationenablesnapshots enablesnmpenablesnmp <yes|no|get> enablesnmp <yes|no|get>exit farcontrolnearcameraexit farcontrolnearcamera <yes|no|get>farloop farnametimedisplayfarloop <on|off> farnametimedisplay <set|get>gabpassword gabpassword <set|get> passwordgabk batch gabk batch <0..59>gabserverip gabserverip <set|get>gabserverip set xxx.xxx.xxx.xxx gabserverip set gabserverip getgatekeeperip gatekeeperip <set|get>gatekeeperip get User Interface Screen Locationgatewayareacode gatewayareacode <set|get> areacodeSets the area code when followed by the areacode Displays the current setting for this optiongatewaycountrycode gatewaycountrycode <set|get> numberDescription Examplegatewayext gatewayext <set|get> gateway extensiongatewayext set gateway extension gatewayext set gatewayext getgatewaynumber gatewaynumber <set|get> numberDescription Examplegatewaynumbertype gatewaynumbertype <did|number+extension|get>Displays the current setting did or Descriptiongatewayprefix gatewayprefix <set|get><valid speed> valueDescription set <“valid speed”>gatewaysetup gatewaysetupOutput Examplegatewaysuffix gatewaysuffix <set|get><valid speed> valueDescription set <“valid speed”>gendial generatetonegendial 0..9|#| generatetone <on|off>get screen gmscityget screen Output Examplegmscontactemail gmscontactemail <set|get> emailExample User Interface Screen Locationgmscontactfax gmscontactfax set get faxDescription Examplegmscontactnumber gmscontactnumber <set|get> numberDescription Examplegmscontactperson gmscontactperson <set|get> personDescription Examplegmscountry gmscountry getDescription Examplegmsstate gmsstate getDescription Examplegmstechsupport gmstechsupport <set|get> tech support digitsgmstechsupport get Descriptiongmsurl gmsurl get <1..10>Description Examplegraphicsmonitor graphicsmonitor <tv|fxvga|visualconcert|get>command graphicsmonitor fxvga is similar to command graphicsmonitor visualconcert isgraphicsmonitorfxvga graphicsmonitortvgraphicsmonitorfxvga <on|off|get> graphicsmonitortv on off getgraphicsmonitorvisualconcert graphicsmonitorvisualconcert <on|off|get>Disables the TV monitor as the graphics monitor Displays the current setting on or offh323name h323name <set|get> H.323nameh323name get Descriptionhangup helphangup <phone|video> hangup phone hangup video 1..3 hangup videoOutput to Example 1 partial Examplehelp verbosehires Output to Example 2 partialhires <2|3> <yes|no|get> Descriptionhistory historyOutput to Example User Interface Screen Locationhostname hostname <set|get> hostnamehostname set hostname hostname set hostname get Descriptionipaddress ipaddress <set|get>ipaddress set xxx.xxx.xxx.xxx ipaddress set ipaddress getipdialspeed ipdialspeed <set|get><valid speed><on|off>Example User Interface Screen Locationipprecedence ipprecedence <set|get> <0..5>ipprecedence set <0..5> ipprecedence get Displays the current settingipstat ipstatDescription Output to Examplekeypadaudioconf languagekeypadaudioconf <yes|no|get> language getlanport Sets the command. It requires a parameter fromDisplays the current setting Examplelanstat <min|misc|reset|sec|tmin|total> lanstatlanstat min lanstat tmin lanstat tmin 0..60 lanstat totalExample Output to ExampleOutput to Example lanstat minlisten listen <phone|video|sleep>Description Examplemaxgabinternationalcallspeed maxgabinternationalcallspeed getDescription Examplemaxgabinternetcallspeed maxgabinternetcallspeed <set|get> <valid speed>maxgabinternetcallspeed get Descriptionmaxgabisdncallspeed maxgabisdncallspeed <set|get> <valid speed>maxgabisdncallspeed get Descriptionmaxtimeincall maxtimeincall <set|get>Description Examplemcupassword mcupassword passwordmcupassword Descriptionmeetingpassword meetingpassword <set|get> passwordpassword Descriptionmpautoanswer mpautoanswer <yes|no|donotdisturb|get>Description Examplempmode Displays the current setting for this optionUser Interface Screen Location Descriptionmute mute <near|far|register|unregister>mute near <on|off|toggle|get> mute far get mute register mute unregistermuteautoanswercalls nearloopmuteautoanswercalls <yes|no|get> nearloop <on|off>netmeetingip netmeetingip <set|get>netmeetingip get Disables the Near End Loopnetstats netstatsnetstats Descriptionnumdigitsdid numdigitsdid <0..24|get>numdigitsdid <0..24> numdigitsdid get User Interface Screen Locationnumdigitsext numdigitsext <0..24|get>numdigitsext <0..24> numdigitsext get Displays the current settingnumberofmonitors outboundcallroutenumberofmonitors <1..4|get> numberofmonitors <1..4> numberofmonitors getpause pcportpause <0..65535> Exampleping ping <ip_addr> countDisplays the current setting Exampleswitchnumber|didextnumber|extension|get> preferredaliaspip <on|off|auto|get> preferredalias<isdnnumber|fulldidnumber|preset preset <near|far|register|unregister>preset unregister switchnumberprimarycallchoice primarycallchoice <isdn|ip|manual|get>Example Descriptionprimarycamera primarycamera <1|2|3|4|get>Displays the current setting isdn, ip, or manual Displays the current setting 1, 2, 3, orqueuecommands queuecommands <yes|no|get>registerthissystem registerthissystem <yes|no|get>repeat repeat <1..64>Enables this option register this system Disables this optionrequireacctnumtodial requireacctnumtodial <yes|no|get>Enables the option Disables the optionroomphonenumber roomphonenumber <set|get> room phone numberDescription Examplers232 rs232 mode flowcontrol baudSubcommands Descriptionscreen run <scriptfilename>User Interface Screen Location Descriptionsecondarycallchoice secondarycallchoice <isdn|ip|none|get>disableui enableuisendonlypreferredalias serialnumsendonlypreferredalias <yes|no|get> serialnumsetaccountnumber showaddrsingabsetaccountnumber <account number> showaddrsingab <h320|h323|both|get>showpopup showpopup <text to display>Displays the current setting h320, h323, or both Examplesleep slidessleep slides select <pres>snapshot snapshot <0|1|2|3|4|register|unregister>password Examplesnapshotcamera snapshotcamera <1|2|3|4|get>Displays the current setting 1, 2, 3, or Examplesnapshottimeout snapshottimeout <yes|no|get>Description Examplesnmpadmin snmpadmin <set|get> admin namesnmpadmin set admin_name snmpadmin set snmpadmin getsnmpcommunity snmpcommunity <set|get> community nameDescription Examplesnmpconsoleip snmplocationsnmpconsoleip <set|get> snmpconsoleip getsoundeffectsvolume soundeffectsvolume <set|get|test> <0..10>Example User Interface Screen Locationstdout streamstdout <on|off> stream <start|stop>streamannounce streamannounce <yes|no|get>Enables streaming announcement Disables streaming announcementstreamaudioport streamaudioport <set|get> stream audio portstreamaudioport get setting, omit the parameterstreamenable streamenable <yes|no|get>streammulticastip streammulticastip <set|get> ip addressstreamrestoredefaults streamrestoredefaultsDisplays the current setting Examplestreamrouterhops streamrouterhops <set|get> number router hopsstreamrouterhops get Descriptionstreamspeed streamvideoportstreamspeed <192|256|384|512|get> streamvideoport <set|get> video portsubnetmask subnetmask <set|get>subnetmask get Displays the current settingsystembehindnat systembehindnat <yes|no|get>Description Examplesystemname systemname <set|get> system namesystemname set system name systemname get Descriptiont120nameip t120nameip <set|get> name or ipDescription Exampletcpports techsupporttcpports <set|get> tcpports getteleareacode teleareacode <set|get> telephone area codeteleareacode get Exampletelecountrycode telecountrycode <set|get> telephone country codetelecountrycode get Exampletelenumber telenumber <set|get> telephone numbertelenumber set telephone number telenumber set telenumber gettestlan arp testlan dcuinfotestlan arp testlan dcuinfotestlan dns testlan echotestlan dns <name or ip> testlan echo <ip_addr>Example Output to ExampleExample Output to Exampletestlan ping testlan ping <ip_addr>counttestlan ping <ip_addr> Descriptiontextinput timediffgmttextinput <text to input> timediffgmt <-12:00..+00:00..+12:00|get>typeofservice typeofservice <ipprecedence|diffserv|get>udpports udpports <set|get>usefixedports usefixedports <yes|no|get>Enables the use of Used Fixed Ports Disables the use of Used Fixed Portsusegatekeeper usegatekeeper <off|specify|auto|get>Description Exampleusepathnavigator usepathnavigator <always|never|required| get>Description ExampleUser Interface Screen Location Polycom, Inc.validateacctnum vcbuttonvalidateacctnum <yes|no|get> vcbutton <play|stop|get|register|unregister>vcraudioout vcraudioout <yes|no|get>Example Descriptionvcrrecordsource versionvcrrecordsource auto near far get versionvgaoffmode <black|nosignal|get> vgahorizposvgaoffmode vgahorizpos <left|right|get>vgaphase vgaphase <increase|decrease|get>Displays the current setting black or nosignal Increases the phasevgaresolution vgaresolution <800x600|1024x768| 1280x1024|get>vgavertpos vgavertpos <up|down|get>volume volume <set|up|down|get|register| unregister>volume set Displays the current setting up or downwaitfor waitfor <callcomplete|systemready| receivingcall>User Interface Screen Location Descriptionwake wanipaddresswake wanipaddress <set|get>whoami widescreenvideowhoami widescreenvideo <yes|no|get>winsresolution winsresolution <yes|no|get>Enables WINS resolution Disables WINS resolutionwinsserver winsserver <set|get>winsserver get DescriptionISDN BRI Commands isdnareacodeisdnareacode <set|get> area code Sets the ISDN area code when followed by the areaisdncountrycode isdncountrycode <set|get> country codeDescription Exampleisdndialingprefix isdndialingprefix <set|get> isdn prefixDescription Exampleisdndialspeed isdndialspeed <set|get> <valid speed> <on|off>Enables the specified speed valid speed Disables the specified speed valid speedisdnnum DescriptionExample User Interface Screen Locationspidnum DescriptionExample User Interface Screen LocationISDN PRI Commands priareacodepriareacode <set|get> area code Displays the current settingpricallbycall pricallbycall <set|get>Description Exampleprichannel prichannel <set|get> <all|1..<23|30>> <on|off>Description ExampleImportant PRI Channel Information ExampleExample User Interface Screen Locationpricsu pricsu <internal|external|get>Sets the internal CSU mode. This is the default command on pagepridialchannels pridialchannels <set|get> <1..12|15>Description Examplepriintlprefix priintlprefix <set|get> prefixDescription Exampleprilinebuildout prilinebuildout set <0|-7.5|-15|-22.5>prilinebuildout get Displays the current settingprilinesignal prilinesignal <set|get><esf/b8zs|crc4/hdb3| hdb3>Description Exampleprinumber prinumber <set|get> pri numberprinumber set pri number prinumber set prinumber getprinumberingplan prinumberingplan <isdn|unknown|get>Description Exampleprioutsideline prioutsideline <set|get> outside_lineDescription Examplepriswitch priswitch getDescription ExampleV.35/RS-449/RS-530/RS-366Commands cts <normal|inverted|get>dcd <normal|inverted|get> Sets the signal to normal high voltage is logicdcdfilter dcdfilter <on|off|get>Sets the signal to inverted low voltage is logic Displays the current setting normal or inverteddsranswer dsr <normal|inverted|get>dsranswer <on|off|get> Sets the signal to normal high voltage is logicdtr <normal|inverted|on|get> ExampleUser Interface Screen Location Descriptionh331audiomode Descriptiong728 g711uh331framerate h331framerate <30|15|10|7.5|get>Displays the current setting for this option User Interface Screen Locationh331videoprotocol h331videoformath331videoprotocol <h263|h261|get> h331videoformat <fcif|get>rs366dialing rs366dialing on off getExample User Interface Screen Locationrt <normal|inverted|get> rts normal inverted getSets the signal to normal high voltage is logic Sets the signal to inverted low voltage is logicst <normal|inverted|get> Sets the signal to normal falling edge sends dataExample User Interface Screen Locationv35broadcastmode v35debugv35broadcastmode <on|off|get> v35debug <0..3> <on|off>v35dialingprotocol v35numv35dialingprotocol <rs366|get> v35num <set|get> <1b1|1b2> v35 numberv35portsused v35portsused <1|1+2|get>Example User Interface Screen Locationv35prefix v35prefix <set|get> <valid speed> valueExample User Interface Screen Locationv35profile ExampleUser Interface Screen Location DescriptionExample ExampleOutput to Example User Interface Screen Locationv35suffix v35suffix <set|get> <valid speed> valueDescription set valid speedv35suffix set 128 ”#4#2” ExampleUser Interface Screen Location Safety and Legal Notices Important SafeguardsLicense Restrictions Warranty Limitation of Remedies and DamagesUSA and Canadian Regulatory Notices FCC NoticeSafety and Legal Notices Part 68 FCC Rules EEA Regulatory Notices CE MarkDeclaration of Conformity KonformitetserklæringDichiarazione di conformità Verklaring van overeenstemmingDeclaração de Conformidade Declaración de conformidadUnderwriters Laboratories Statement Special Safety InstructionsInstallation Instructions