Integrator C Series API

Using the command line

Getting help

To get help with what commands are available you can write help or ? on the command line.

?
  - User Commands -

  help            xconfiguration  xfeedback       xgetxml         xhistory
  xstatus         xpreferences    xcommand        log

Adding ? after xCommand will show all available xCommands

xcommand ?
  - User Commands -

  Audio           Dial            Message         SystemUnit
  Boot            DTMFSend        Phonebook       TStringSend
  Call            Experimental    Presentation    Video
  CallLog         FarEndControl   Preset
  CamCtrlPip      HttpFeedback    SStringSend
  Camera          Key             Standby

Adding ? after xCommand + <command path> will show all available commands and valuespaces for their parameters under that command path.

xcommand Phonebook ?
xCommand Phonebook Contact Add
    Name(r): <S: 0, 255>
    FolderId: <S: 0, 255>
    ImageURL: <S: 0, 255>
    Title: <S: 0, 255>
    Number: <S: 0, 255>
    Protocol: <H323/SIP>
    CallRate: <0..65534>
    Device: <Mobile/Other/Telephone/Video>
xCommand Phonebook Contact Modify
    ContactId(r): <S: 0, 255>
    Name: <S: 0, 255>
    FolderId: <S: 0, 255>
    ImageURL: <S: 0, 255>
    Title: <S: 0, 255>
...

Writing xConfiguration will list out all available configurations.

xconfiguration
*c xConfiguration Audio Input Microphone 1 Type: Microphone
*c xConfiguration Audio Input Microphone 1 Mode: On
*c xConfiguration Audio Input Microphone 1 Level: 14
*c xConfiguration Audio Input Microphone 1 EchoControl Mode: On
*c xConfiguration Audio Input Microphone 1 EchoControl NoiseReduction: On
*c xConfiguration Audio Input Microphone 1 Equalizer Mode: Off
*c xConfiguration Audio Input Microphone 1 Equalizer ID: 1
...

Adding ?? after xConfiguration (and an optional <configuration path>) will show all available configurations and valuespaces matching the path.

xconfiguration Conference ??

*? xConfiguration Conference [1..1] AutoAnswer Mode: <Off/On>

*? xConfiguration Conference [1..1] AutoAnswer Mute: <Off/On>

*? xConfiguration Conference [1..1] AutoAnswer Delay: <0..50>

*? xConfiguration Conference [1..1] MicUnmuteOnDisconnect Mode: <Off/On>

*? xConfiguration Conference [1..1] DoNotDisturb Mode: <Off/On>

Searching

You can use // to search for elements anywhere in the status or configuration hierarchy to find the elements you are looking for.

Example List out all configurations that start with DVI:

xconfiguration //dvi
  *c xConfiguration Video Input DVI 3 Type: AutoDetect
  *c xConfiguration Video Input DVI 5 Type: AutoDetect
  *c xConfiguration Video Output DVI 2 Resolution: 1366_768_60
  *c xConfiguration Video Output DVI 2 OverscanLevel: None
  *c xConfiguration Video Output DVI 2 MonitorRole: Second
  *c xConfiguration Video Output DVI 4 Resolution: Auto
  *c xConfiguration Video Output DVI 4 OverscanLevel: None
  *c xConfiguration Video Output DVI 4 MonitorRole: Fourth
  ** end

You can combine multiple //'s too.

Example Get the resolution width of all connected sources for both inputs and outputs:

xstatus //vid//res//wid
  *s Video Input Source 1 Resolution Width: 1920
  *s Video Input Source 2 Resolution Width: 0
  *s Video Input Source 3 Resolution Width: 0
  *s Video Input Source 4 Resolution Width: 0
  *s Video Input Source 5 Resolution Width: 0
  *s Video Output HDMI 1 Resolution Width: 1366
  *s Video Output HDMI 3 Resolution Width: 1366
  *s Video Output DVI 2 Resolution Width: 1366
  *s Video Output DVI 4 Resolution Width: 1024
  *s Video Output Legacy 5 Resolution Width: 720
  ** end

WARNING: The search shortcuts are great while inspecting the API, but should not be used within applications. We recommend always using the complete paths, as this will avoid command ambiguity when upgrading to newer firmware releases.

Input values that contain spaces need to be quoted

Any values for configurations and commands containing spaces must be enclosed in quotes. Quotes are not necessary for values without spaces. This is common for all commands and configurations.

Examples:

Correct:

  xcommand dial number: "my number contains spaces"

Correct:

  xcommand dial number: 12345

Incorrect:

  xcommand dial number: my number contains spaces

Case sensitivity

All commands are case-insensitive. All of the following commands will work.

XCOMMAND DIAL NUMBER: foo@bar.org
xcommand dial number: foo@bar.org
xcommand Dial Number: foo@bar.org

Some time saving command line tricks

If your client supports it, there exists some time-saving shortcuts while working towards the codec.

• You can use tab-completion to complete the commands and arguments.
• You can use arrow up and arrow down keys to navigate your command history.
• <CTRL-a>: Jump to the beginning of the line
• <CTRL-e>: Jump to the end of the line
• <CTRL-r>: Incremental command history search.
• <CTRL-w>: Erase the current line.