Launch TrueConf Client Applications via Command Line Parameters

Elizaveta Nesova
November 15, 2018
Elizaveta Nesova
Categories: Knowledge Base

TrueConf client applications can be launched via command line parameters. In this case, upon opening the application users automatically can:

  • Log in
  • Connect to the right server
  • Launch applications in the selected mode (full screen or minimized)
  • Call users or join video conferences
  • Launch another instance of application to control the second camera, e.g. to capture the second video source.

Parameter List

Function Parameter and Use Case
Login -l [user] -p [password] -e

-l maria -p 4839 -e

Server connection -h [server]:[port]

-h 192.168.1.100:12345

Launch Applications in Different Modes
Full screen (without interface elements) -f

This parameter is to be used in conjunction with -c parameter when automatically receiving and making video calls. It is also important to use this parameter if  you need to see users’ images without interface elements during video conferences.

Minimized -m
“Instance” mode -t [id]

By using this parameter, you’ll launch the instance of your application with ID specified by the user. Instance settings are saved separately from original settings. Once closed, these settings are saved and automatically brought back when restarted by using the same ID.

Call Users and Join Conferences
Call users -c [user]

-c george

-c [user] @ [server_name]

-c george@company.com

Join conferences on the server via \c\CID -c \с\[CID]

-c \c\6427906610

-c \с\[CID]@ [server_name]

-c \c\6427906610@company.com

Automatically close the application once the call/conference is ended -ac

This parameter can only be used in conjunction with -c parameter.

-c kate -ac

-c \c\5427905512 -ac

Here:     

  • [user] — user login
  • [password] — user password [server] — TrueConf Server IP
  • [server_name] — TrueConf Server FQDN
  • [port] — port reserved for server control panel
  • [id]  — unique ID for the instance of application
  • [CID]Conference ID

Parameters can be combined at random. For example:

  • To connect and log in on TrueConf Server, run the following command:

TrueConf.exe -h 192.168.1.100:12345 -l maria -p 4839 -e

  • To be logged in and call the user, run the following command:

TrueConf.exe  -c george -l maria -p 4839 -e

  • To be logged in and join the conference, run the following command:

TrueConf.exe  -c \c\5427905512 -l maria -p 4839 -e

  • To launch another instance of application and connect to TrueConf Server via IP, run the following command:

TrueConf.exe -t1  -h 192.168.1.100:12345

TrueConf client applications for macOS and Linux (and TrueConf Client for Windows) can be launched via command line parameters only when they’re entered with “/” (e.g. “/c george”).

How to Use Parameters at Launch

Method 1: Run the application via the console

Go to Windows OS consoles, find the folder with TrueConf client application installed and run one of the commands described in the previous section.

Method 2: Embed the parameters in the application shortcut

1. On the desktop or in the taskbar, find the shortcut for TrueConf client application.

2. In the shortcut menu, select the Properties tab.

3. Add launch parameters in the Target field after quotation marks that limit the file name.

4. Click OK or Apply to save the changes.

Method 3: Add parameters to the software application launch

You can embed the parameters in the call to TrueConf client application from your own application to automatically connect users to subscribers or conferences you need.

Below is the use case in Python: