Integrator C Series API
This document contains a a top-level view of the mechanisms supported by the codec API. For more detailed information about which commands are available, please refer to the API Guide in the Other resources section of this document.
The API consists four major groups:
These four groups are hierarchically organized, which makes it easier to find related functionality.
Commands instruct the codec to execute actions, like to dial a number, move a camera or query the phone book. All commands start with the prefix
xcommand followed by a command path. Writing
xcommand ? on the command line will list all the top level commands.
xcommand ? - User Commands - Audio Dial Key Standby Boot DTMFSend Message SystemUnit Call Experimental Phonebook TStringSend CallLog FarEndControl Presentation Video CamCtrlPip GPIO Preset Camera HttpFeedback SStringSend OK
To view the complete list of commands and their parameters, write
xcommand ?? on the command line:
xcommand ?? xCommand Audio Microphones Mute xCommand Audio Microphones Unmute xCommand Audio Sound Play Sound(r): <Busy/CallWaiting/Dial/KeyTone/Ringing/ SpecialInfo/TelephoneCall/VideoCall> Loop: <On/Off> xCommand Audio Sound Stop xCommand Audio Vumeter Start ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8> xCommand Audio Vumeter Stop ConnectorType(r): <HDMI/Line/Microphone> ConnectorId(r): <1..8>
Command arguments are key-value pairs. The
(r) behind the argument name indicates that the argument is required for the command.
xcommand dial number: "123"
xcommand is the command prefix. The actual command to be executed is
dial. The example contains one argument
number: "123" where
number is the key and
"123" is its value. The key/value pair is separated with ‘:'
Configurations are settings that are persistent across boots. Like commands, configurations are also structured in a hierarchy.
xconfiguration ?on the command line will list all the top level configurations.
xconfiguration ??will list all configurations and their value spaces.
xconfigurationwill list all configurations and their current values. To only list out parts of the configuration, write xconfiguration followed by one or more parts of the configuration paths.
Example: List all settings under H323 Profile 1
xconfiguration H323 Profile 1 *c xConfiguration H323 Profile 1 H323Alias ID: "email@example.com" *c xConfiguration H323 Profile 1 H323Alias E164: "123" *c xConfiguration H323 Profile 1 PortAllocation: Dynamic *c xConfiguration H323 Profile 1 CallSetup Mode: Gatekeeper *c xConfiguration H323 Profile 1 Gatekeeper Address: "127.0.0.1" *c xConfiguration H323 Profile 1 Gatekeeper Discovery: Manual *c xConfiguration H323 Profile 1 Authentication LoginName: "" *c xConfiguration H323 Profile 1 Authentication Password: "" *c xConfiguration H323 Profile 1 Authentication Mode: Off **end
Example: Set H323 Alias ID
xconfiguration H323 Profile 1 H323Alias ID: "firstname.lastname@example.org" **end
Example: Get H323 Alias ID
xconfiguration H323 Profile 1 H323Alias ID *c xConfiguration H323 Profile 1 H323Alias ID: "email@example.com" **end
Status contains the current state of the codec, such as connected calls, the status of the gatekeeper registration, connected inputs and output sources.
xstatus ?on the command line will list all the top level statuses.
xstatuswill list all statuses and their current values.
- To only list out parts of the statuses write xstatus followed by one or more parts of the status paths.
Example: Show the current H323 Gatekeeper status
xstatus H323 Gatekeeper *s H323 Gatekeeper Status: Registered *s H323 Gatekeeper Address: "192.168.1.101" *s H323 Gatekeeper Port: 1719 *s H323 Gatekeeper Reason: "" ** end
Events are notifications of actions that take place and that do not change the state of the system or change any configurations. This may be notifications such as someone pressed a key on the remote control or that a message box should be displayed on the on screen display. Events are not executable, but is something one needs to subscribe to.
For more details on this, see the Feedback mechanism section of this document.
Integrator C Series API
- Connecting to the API
- Using the command line
- API fundamentals
- Feedback mechanism
- Synchronous API calls
- Experimental sections
- Using HTTP
- Programming the video compositor
- Programming the phone book
- Programming the video switcher
- Using GPIO
- Frequently asked questions
- Other resources
- The link between Calls and Channels
- Do's and don'ts