TANDBERG C90 System Integrator Manual page 44

Codec C90
Contents Introduction Getting Started
Contents Introduction Getting started
xCommand operations
Command type commands are used to instruct the
system to perform a given action.
Return result parameters
The following operations can be performed on
xCommand:
Command Help
• *h is used when returning the result of a
query
Command Write
• *r is used when returning the result of a
command
D14128.03—JULY 2009
Interfaces About the API
Interfaces About the API About the API
xCommand Help
To get help on a setting you can use a help query.
Enter the path followed by ? or help.
•
xCommand dial ?
Returns a set of return values. See the example
to the right.
•
xCommand dial help
As above.
help
write
xCommand Write
When issuing a command, the system will return a
set of return values. The structure is described by
the example to the right.
•
xCommand Dial Number: 12345
Issues the command and gives a response. See
the example to the right.
The response will by default be on the same format
as the standard XACLI Status format. The XML
status format is also supported.
You can read more about XML in the xPreferences
section.
xConfiguration xConfiguration xCommand
xCommand xStatus
Example with xCommand Help
To get help on xCommand, type ? or
xCommand <address expression> ?
xCommand Dial ?
*h xCommand Dial:
Number(r): <S: 0, 255>
Protocol: <H323/SIP>
CallRate: <64..6000>
OnlyAudio: <False/True>
OK
Example with xCommand Write
Dial a number with only the required parameter:
xCommand Dial Number: 558458
OK
*r DialResult (status=OK):
CallId: 2
ConferenceId: 1
*r/end
OK
System Integrator Guide
xStatus Cameras Appendices
Cameras Appendices
help after the command path (address expression):
Contact us
Contact us
44