TANDBERG D13639 manual Xpreferences ?

Page 35

TANDBERG MPS API

User Guide

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

…suddenly there is a change in audio protocol:

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

Channels 1 (type=Incoming): Rate: 704

Audio (status=Inactive): /

*s/end

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

Channels 1 (type=Incoming): Rate: 720

Audio (status=Active): Protocol: G728 Rate: 16

*s/end

2.6.2 xpreferences

The special command xpreferences lets the user/control application individually configure the Telnet/RS-232 session in use.

xpreferences ?

usage: xpreferences xpathwrite <on/off>

or: xpreferences detaillevel <1..2>

or: xpreferences xmlconfigfeedback <on/off>

or: xpreferences xmlstatusfeedback <on/off>

or: xpreferences xmlcommandresult <on/off>

OK

xpreferences xpathwrite <on/off>

This command disables/enables the XPath engine when issuing configurations. When the XPath engine is disabled, the user/control application must supply the complete path to the configurations to be set (no “double slashes” allowed). This will improve the performance of the system when issuing many consecutive configurations.

NOTE! It is always recommended to supply the complete path for configurations to be set when issuing commands from an external control application.

33

Image 35
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 Feedback Addressing using XPathTandberg XML Engine Structuring of InformationTandberg MPS API Status Documents r XML DocumentsDocuments Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Formputxml Introduction to Tandberg XML API Service TxasBare-bone Https access GetxmlExercise ExercisesTandberg MPS API XML-based Advanced Command Line Interface Addressing Accessing XacliRoot commands Xstatus call Exposure optionsSupported exposure options Misc Xstatus call 1 remotenumber Status-type root commands Xstatus / xhistoryFormat Xstatus ?Xacli *s IP XMLXdirectory ? Configuration-type root commands xconfiguration/xdirectoryConfiguration help Xconfiguration ?Xconfiguration // ? Xconfiguration ?? Configuration readConfiguration set write Xconfiguration ip/assignment static Xcommand ?? Command-type root commands xcommandCommand help Xcommand ?Xcommand dial nu666 ron c128 s10 Issuing a commandExample 2.12 xcommand Dial ? Xcommand dial number666 restricton callrate128 subaddress10Xcommand dial Xcommand dial 666 10 128 onXcommand dial 666 ron 10 Xgetxml status/ip XML Output xgetxmlXfeedback register status/call/channels/audio/protocol Special CommandsXfeedback Xfeedback ?Xfeedback 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 Transport Default TCP/UDP SIP Mode On/OffSIP Interface Authentication UserName S 0 SIP Interface Authentication Password S 0Tandberg 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 attributesMediaBoard 1..8 Top level attributes User GuideEnd NoneSystemUnit 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 PacketsDropped AudioTotalPackets PacketLossEnd