TANDBERG D13639 manual Example

Page 5

TANDBERG MPS API

User Guide

Example 1.3

If we now look at the call element for an active call we see that call element contains a large sub-structure:

<Status>

<Call item="1" status="Synced" type="Vtlph" protocol="H323"> <CallRate item="1">768</CallRate>

<RemoteNumber item="1">10.47.15.127</RemoteNumber> <Channels item="1" type="Incoming">

<Audio item="1" status="Active"> <Protocol item="1">G722</Protocol> <Rate item="1">64</Rate>

</Audio>

<Video item="1" status="Active"> <Protocol item="1">H263</Protocol> <Resolution item="1">CIF</Resolution> <Rate item="1">704</Rate>

</Video>

<Video item="2" status="Inactive" /> <Data item="1" status="Inactive" />

</Channels>

<Channels item="2" type="Outgoing"> <Audio item="1" status="Active">

<Protocol item="1">G722</Protocol> <Rate item="1">64</Rate>

</Audio>

<Video item="1" status="Active"> <Protocol item="1">H264</Protocol> <Resolution item="1">SIF</Resolution> <Rate item="1">704</Rate>

</Video>

<Video item="2" status="Inactive" /> <Data item="1" status="Inactive" />

</Channels>

</Call>

</Status>

In this example, the attributes are used to provide valuable information in addition to establishing a dependency to the underlying sub-structure of the element.

Example 1.4

In the above examples, all elements are having an attribute named item. This attribute specifies the instance number of the element. If we expand Example 1.1 to a system having two serial ports, the XML structure could look like this:

<Configuration> <SerialPort item="1">

<BaudRate item="1">9600</BaudRate> <Parity item="1">None</Parity> <DataBits item="1">8</DataBits> <StopBits item="1">1</StopBits> <Mode item="1">Control</Mode>

</SerialPort> <SerialPort item="2">

<BaudRate item="1">19200</BaudRate> <Parity item="1">None</Parity> <DataBits item="1">8</DataBits>

3

Image 5
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 Status Documents r XML DocumentsDocuments 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 Addressing Accessing XacliRoot commands Xstatus call Exposure optionsSupported exposure options Misc Format Status-type root commands Xstatus / xhistoryXstatus ? Xstatus call 1 remotenumberXacli *s IP XMLConfiguration help Configuration-type root commands xconfiguration/xdirectoryXconfiguration ? Xdirectory ?Xconfiguration // ? Xconfiguration ?? Configuration readConfiguration set write 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 Xcommand dial 666 10 128 onXcommand dial 666 ron 10 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 Description Textual description of the cause code DialGroupEntry DialInNumberAdd DialInNumberRemoveParameters Conferencer DialLocalEntry DisconnectCall DisconnectGWCall FeedbackDeregister FeedbackRegister OK Result parameters Error Result parametersParameters Name S 0, 48 The entry’s name FloorToSite FloorToSiteEnd GroupEntryAddGroupEntryDelete LayoutLock LayoutUnLock NetworkId NetworkModule OK Result parameters Windowr CallIDr 1..176 Call Error Result parametersLocalEntryAdd LocalEntryDelete 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