Go back

Launch TrueConf Client Applications via Command Line Parameters

November 15, 2018
Dimitry

Dimitry

TrueConf client applications for desktops (Windows, macOS, Linux) and TrueConf Room PC-based room software can be launched  using 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

In TrueConf applications for macOS and Linux, if you specify parameters with a “\” character, you need to escape it with a second “\” character, e.g., “/c \\c\\6427906610”.
Function Parameter and Use Case
Login -l [user] -p [password] -e

-l maria -p 4839 -e

Connect to a server by its IP address or domain name -h [server]:[port]

-h 192.168.1.100:12345

-h video.company.com

You can specify several TrueConf Server IP addresses or domain names (FQDNs) separated by commas. The application will connect to the first available one. E.g: -h 192.168.1.100,192.168.1.101.
Forced authorization or connection to the server -lf

This parameter can be used to force a connection to the server specified with the -h parameter, as well as to authorize with the given username and password. If the key -lf is not specified and the user is already authorized on the server, there will be neither reconnection to the required server, nor authorization with a new account.
Specify the domain, which SRV-records will be used to search for an available video conferencing server to connect to -d [domain_name]

-d company.com

If you specify this parameter, the client application will not connect to TrueConf Online service (as it should be by default) at first launch, but will perform SRV record request of the following form: vcs2.tcp.[domain name]. After that it will select one of the available TrueConf servers from the response received from the DNS server.

After the first successful connection, the TrueConf application will save all addresses that are specified in the External addresses list of the server control panel.

This will be helpful to automate connection of the application to the required server at its first start, if you have several external IP addresses corresponding to one video conferencing server or if you use TrueConf Enterprise. You can contact us so that we provide you with an installer with the default domain value already set.

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.
Select the monitor to display the TrueConf Room main screen
-monitor [id]

-monitor 2

For TrueConf Room only

By default the TrueConf Room main screen is launched on the primary monitor of your operating system (e.g. indexed as 1 in Windows). With the -monitor parameter, you can change this setting, i.e. when you connect an additional monitor, you can display the TrueConf Room main screen on it by specifying the -monitor 2 parameter. This will allow you to use different monitors to display the conference window and simultaneously control TrueConf Room via the web-based control panel.

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:
  • To be logged in and call the user, run the following command:
  • To be logged in and join the conference, run the following command:
  • To launch another instance of application and connect to TrueConf Server via IP, run the following command:
  • To launch another instance of the TrueConf Room application, connect to TrueConf Server using its domain name and display the application main screen on an additional monitor, run the following command:

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.

Launch TrueConf Client Applications via Command Line Parameters 1

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.

Launch TrueConf Client Applications via Command Line Parameters 2

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:


Still have questions? Please contact our support team directly via online chat.

Sign up for newsletter