TANDBERG D13639 manual Command-type root commands xcommand, Command help, Xcommand ??

Page 28

TANDBERG MPS API

User Guide

2.4The Command-type root commands - xcommand

To get an overview of the supported commands within a command-type root command, type ? or help after the command-type root command.

<command-type root command> ?

Example 2.10

 

 

xcommand ?

 

 

- User Commands -

DuoVideoStart

MessageBoxDisplay

Boot

CallAccept

DuoVideoStop

PIPHide

CallMute

FECCFocus

PIPShow

CameraBrightness

FECCMove

PresetActivate

CameraFocus

FECCPresetActivate

PresetStore

CameraHalt

FECCPresetStore

ScreensaverActivate

CameraMove

FECCRequestStill

ScreensaverDeactivate

CameraPosition

FECCSelectSource

ScreensaverReset

CameraTrackingStart

FeedbackDeregister

SiteDisconnect

CameraTrackingStop

FeedbackRegister

SiteView

CameraWhiteBalance

FloorRelease

SiteViewEnd

ChairRelease

FloorRequest

SPIDAutoConfigure

ChairTake

FloorToSite

StillImageSend

ConferenceDisconnect

FloorToSiteEnd

StreamingStart

DefaultValuesSet

GroupEntryAdd

StreamingStop

Dial

GroupEntryDelete

TextDelete

DialGlobalEntry

LocalEntryAdd

TextDisplay

DialGroupEntry

LocalEntryDelete

VirtualMonitorReset

DialLocalEntry

MessageBoxDelete

VirtualMonitorSet

DisconnectCall

 

 

OK

 

 

 

 

 

To list usage for all commands with parameters, type a double question mark after the command-type root command.

<command root command> ??

Example 2.11

xcommand ??

2.4.1 Command help

To get help on a specific command, type the command-type root command – then a command name followed by ? or help:

<command-type root command> <command name> ?

26

Page 27 Page 29
Image 28
Page 27 Page 29
Contents Tandberg MPS API User GuideTable of Contents Tandberg API DisclaimerIntroduction to XML ExampleExample Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Addressing using XPath Tandberg XML EngineStructuring of Information FeedbackTandberg MPS API Documents XML DocumentsStatus Documents r Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Introduction to Tandberg XML API Service Txas Bare-bone Https accessGetxml FormputxmlExercises ExerciseTandberg MPS API XML-based Advanced Command Line Interface Root commands Accessing XacliAddressing Supported exposure options Exposure optionsXstatus call Misc Status-type root commands Xstatus / xhistory FormatXstatus ? Xstatus call 1 remotenumberXML Xacli *s IPConfiguration-type root commands xconfiguration/xdirectory Configuration helpXconfiguration ? Xdirectory ?Configuration set write Configuration readXconfiguration // ? Xconfiguration ?? Xconfiguration ip/assignment static Command-type root commands xcommand Command helpXcommand ? Xcommand ??Issuing a command Example 2.12 xcommand Dial ?Xcommand dial number666 restricton callrate128 subaddress10 Xcommand dial nu666 ron c128 s10Xcommand dial 666 ron 10 Xcommand dial 666 10 128 onXcommand dial XML Output xgetxml Xgetxml status/ipSpecial Commands XfeedbackXfeedback ? Xfeedback register status/call/channels/audio/protocolXfeedback register status/call Xcom dial Xfeedback register status/call@status=Disconnected Xcom dialXcom disc Xfeedback register status/call@status=Synced Xcom dialXpreferences Xpreferences ?Xstat call 1 channels 1 audio Xpreferences detaillevel Xstat call 1 channels 1 audioBaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API H323Gatekeeper 1..2 Authentication Password S 0 Http Mode On/OffTandberg MPS API LoS Polarity Positive/Negative LoS Retry MCURTP SerialInterfaceCard SessionSIP Mode On/Off SIP Interface Authentication UserName S 0SIP Interface Authentication Password S 0 SIP Interface Transport Default TCP/UDPTandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry CallMuteVideo ConferenceDisconnect ConferenceModify Parameters Conferencer OK Result parametersConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial Parameters Conferencer DialGroupEntry DialInNumberAdd DialInNumberRemoveDescription Textual description of the cause code DialLocalEntry DisconnectCall DisconnectGWCall OK Result parameters Error Result parameters FeedbackDeregister FeedbackRegisterFloorToSite FloorToSiteEnd GroupEntryAdd Parameters Name S 0, 48 The entry’s nameGroupEntryDelete LayoutLock LayoutUnLock LocalEntryAdd LocalEntryDelete Windowr CallIDr 1..176 Call Error Result parametersNetworkId NetworkModule OK Result parameters Command used to add option key ProtectNumberRemove VideoTextSet API Status Status.xml xstatus ExamplesTandberg MPS API Examples Tandberg MPS API Mcuid Ethernet Top level attributes Feedback Top level attributesUser Guide EndNone MediaBoard 1..8 Top level attributesSystemUnit Top level attributes None Summary SerialInterfaceCard ISDNInterfaceCard Top level attributes Status on/off SummaryTandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end History.xml xhistory Conference Top level attributesEvent.xml xevent Audio TotalPacketsPacketLoss PacketsDroppedEnd
Top Page Image Contents