TANDBERG Codec C Series Api Manual page 17

TANDBERG Codec C60 and Codec C40
Contents Contents Introduction Introduction
xConfiguration operations
Configuration type commands defines system
settings and are either supplied or read by the
user.
Return result parameters
Three operations can be performed on
xConfiguration:
Configuration Help
• Help text for this configuration is returned
Configuration Read
• *c is used when returning the result of a
query
Configuration Write
• No return result parameter for configuration
set (write)
• Writes this value to the setting defined by the
path.
D14642.02—MAY 2010
About the API
About the API About the API xConfiguration
xConfiguration Help
To get help on a system setting you can use
a help query. Enter the path followed by ? or
help.
•
xConfiguration H323 Profile 1
Gatekeeper ?
Returns information about the setting defined
by the path.
•
xConfiguration H323 Profile 1
Gatekeeper help
As above.
read
xConfiguration Read
When reading a value you will use the
configuration read. The level of details is defined
by the path:
•
xConfiguration H323 Profile 1
Gatekeeper Discovery
Returns the current value of the setting
defined by the path.
xConfiguration Write
When defining a system setting you will use the
configuration write. The structure is described
by the example to the right.
•
xConfiguration H323 Profile 1
Gatekeeper Discovery: Auto
Writes this value to the setting defined by the
path.
xConfiguration xCommand xCommand
Example with xConfiguration Help:
To get help on xConfiguration, type
xConfiguration <address expression> ?
xConfiguration H323 Profile 1 Gatekeeper Discovery ?
*h xConfiguration H323 Profile 1 Gatekeeper Discovery: <Manual/Auto>
OK
Example with xConfiguration Read:
To read configurations from the system just type the root command (xConfiguration) followed by the path
(address expression):
xConfiguration <address expression>
xConfiguration H323 Profile 1 Gatekeeper Discovery
*c xConfiguration H323 Profile 1 Gatekeeper Discovery: Manual
OK
Example with xConfiguration Write:
To issue a command type a root command (xConfiguration) followed by a valid path (address expression).
The path must be terminated with a colon before the value is added:
xConfiguration <address expression>: <value>
xConfiguration H323 Profile 1 Gatekeeper Discovery: Auto
** end
17
xStatus xStatus Appendices Appendices
? or help after the configuration path (address expression):
API Guide
Contact us Contact us
www.tandberg.com