TANDBERG Codec C90 D14128.02 - Manual (Page 43)

D14128.02—NOVEMBER 2008 43
Codec C90 System Integrator Guide
Contents Introduction Getting Started Interfaces About the API xConfiguration xCommand xStatus Cameras Appendices Contact us About the API
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 help
query
Command Write
*r • is used when returning the result of a write
command
Example with xCommand Help
To get help on xCommand, type
? or help after the command path (address expression):
xCommand <address expression> ?
xCommand dial ?
*h xCommand dial:
Number(r): <S: 0, 255>
Protocol: <H323/SIP>
CallRate: <64..6000>
OK
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.
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.
Example with xCommand Write
Dial a number with only the required parameter:
xCommand dial number: 558458
*r Result (status=OK):
CallRef: 1
LogTag: 6
*r/end
OK