TANDBERG D13639 manual Exposure options, Supported exposure options, Xstatus call

Page 21

TANDBERG MPS API

User Guide

2.1.4 Exposure options

By adding an exposure option after the address (XPath or SimplePath) expression, the system can be instructed to return only parts of the information within an element structure.

<root command> <address expression> <exposure option>

Supported exposure options:

“-“ hides all value elements

“--" hides all sub-elements

Example 2.2

Request for Call 1 element with no exposure option

xstatus call 1

*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing):

CallRate: 768

RemoteNumber: "10.47.15.127"

Mute: Off

Microphone: Off

Duration: 10

Channels 1 (type=Incoming): Rate: 768

Restrict: Off

Encryption (status=Off): / Audio (status=Active):

Protocol: G722

Rate: 64

Video 1 (status=Active): Protocol: H263 Resolution: CIF Rate: 704

Video 2 (status=Inactive): /

Data (status=Inactive): /

Channels 2 (type=Outgoing): Rate: 768

Restrict: Off

Encryption (status=Off): / Audio (status=Active):

Protocol: G722

Rate: 64

Video 1 (status=Active): Protocol: H263+ Resolution: ICIF Rate: 704

Video 2 (status=Inactive): /

Data (status=Inactive): /

*s/end

Request for Call 1 element with exposure option “-“:

xstatus call 1 -

*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing):

Channels 1 (type=Incoming): Encryption (status=Off): /

19

Image 21
Contents User Guide Tandberg MPS APITable of Contents Disclaimer Tandberg APIExample Introduction to XMLExample Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Tandberg XML Engine Addressing using XPathStructuring of Information FeedbackTandberg MPS API XML Documents DocumentsStatus Documents r Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Bare-bone Https access Introduction to Tandberg XML API Service TxasGetxml FormputxmlExercise ExercisesTandberg MPS API XML-based Advanced Command Line Interface Accessing Xacli Root commandsAddressing Exposure options Supported exposure optionsXstatus call Misc Format Status-type root commands Xstatus / xhistoryXstatus ? Xstatus call 1 remotenumberXacli *s IP XMLConfiguration help Configuration-type root commands xconfiguration/xdirectoryXconfiguration ? Xdirectory ?Configuration read Configuration set writeXconfiguration // ? Xconfiguration ?? Xconfiguration ip/assignment static Command help Command-type root commands xcommandXcommand ? Xcommand ??Example 2.12 xcommand Dial ? Issuing a commandXcommand dial number666 restricton callrate128 subaddress10 Xcommand dial nu666 ron c128 s10Xcommand dial 666 10 128 on Xcommand dial 666 ron 10Xcommand dial Xgetxml status/ip XML Output xgetxmlXfeedback Special CommandsXfeedback ? Xfeedback register status/call/channels/audio/protocolXfeedback register status/call@status=Disconnected Xcom dial Xfeedback register status/call Xcom dialXfeedback register status/call@status=Synced Xcom dial Xcom discXpreferences ? XpreferencesXpreferences detaillevel Xstat call 1 channels 1 audio Xstat call 1 channels 1 audioBaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API Http Mode On/Off H323Gatekeeper 1..2 Authentication Password S 0Tandberg MPS API MCU LoS Polarity Positive/Negative LoS RetrySerialInterfaceCard Session RTPSIP Interface Authentication UserName S 0 SIP Mode On/OffSIP Interface Authentication Password S 0 SIP Interface Transport Default TCP/UDPTandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry Parameters Conferencer OK Result parameters CallMuteVideo ConferenceDisconnect ConferenceModifyConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial DialGroupEntry DialInNumberAdd DialInNumberRemove Parameters ConferencerDescription Textual description of the cause code DialLocalEntry DisconnectCall DisconnectGWCall FeedbackDeregister FeedbackRegister OK Result parameters Error Result parametersParameters Name S 0, 48 The entry’s name FloorToSite FloorToSiteEnd GroupEntryAddGroupEntryDelete LayoutLock LayoutUnLock Windowr CallIDr 1..176 Call Error Result parameters LocalEntryAdd LocalEntryDeleteNetworkId NetworkModule OK Result parameters Command used to add option key ProtectNumberRemove VideoTextSet API Status Examples Status.xml xstatusTandberg MPS API Examples Tandberg MPS API Mcuid Feedback Top level attributes Ethernet Top level attributesEnd User GuideNone MediaBoard 1..8 Top level attributesSystemUnit Top level attributes None Summary Top level attributes Status on/off Summary SerialInterfaceCard ISDNInterfaceCardTandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end Conference Top level attributes History.xml xhistoryEvent.xml xevent TotalPackets AudioPacketLoss PacketsDroppedEnd