Command line parameters

TrueConfAbout 21 min

title: Command line

Command line parameters

Conventional notation for the command line syntax

The table below describes the notation for the command line syntax.

Notation	Description
Text without square, curly, or round brackets	Elements that must be entered exactly as they appear.
\[Text inside square brackets]	Optional argument.
{Text inside curly braces}	Required argument.
...	Unlimited number of parameters in the argument.

Description of the command line style

- is allowed in short parameters
-<single character> style is allowed
An argument is allowed in the same token for short parameters, for example, -lsome
An argument is allowed in the next token for short parameters, for example, -l some
--long_name style is allowed
An argument in the same token is allowed for long parameters, for example, --login=ivanov
An argument in the next token is allowed for long parameters, for example, --login ivanov
It is possible to combine multiple short parameters so that -v -f can be transformed into -vf. All parameters except the last one must not accept any arguments. For example, if -v accepts a parameter, f will be accepted as the parameter, but not the other short parameter
It is possible to use the abbreviated version of long parameters if there is a one-to-one correspondence between the short version and the long parameter. No long name of a parameter can be the prefix of another long parameter name if autocomplete is used

Description of command line parameters

--allowhidcontrol

Enable or disable HID devices functionality. The parameter value will be remembered and used in subsequent launches.

Syntax:

--allowhidcontrol {true|false}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --allowhidcontrol false

--autoclose

Returns TrueConf Room API to its original state after the call.

Syntax:

--autoclose

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --autoclose

--background

Specify the path to the file that will be used for the virtual background.

Syntax:

--background {path_to_file}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --background c:\path\to\file.png

--blur

Enable the background blur feature.

Syntax:

--blur

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --blur

--br

Set the maximum bitrate.

Rules:

The argument must be a positive number

Syntax:

--br {max_bitrate}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --br 28000

--ccl, -x

Specify the encoded command line.

The parameter will be decoded and the resulting string will be used as standard parameters.

Syntax:

--ccl {coded_cl}
-x {coded_cl}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --ccl L2WQ4gd5ml9jb25mL39yZy51YSAvcyAwMWUy

--cid, -c

Call the specified CallID after launching TrueConf Room API.

CallID can be either the user's TrueConf ID or the conference ID (i.e., starting with \c\).

Syntax:

--cid {CallID}
-c {CallID}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --cid \c\test@some.trueconf.com#vcs

--crop

Enable Image cropper in the specified mode when the application starts. Available modes (CropMode):

240p
360p
480p
720p
1080p
2160p

By default, the 720p mode will be used.

Syntax:

--crop {CropMode}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --crop 240p

--domain, -d

Specify the domain that TrueConf Room API will use.

This parameter is used in conjunction with --mh, -h.

Syntax:

--domain {some_domain}
-d {some_domain}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --domain example.com --mh "se1.server.org.ru#as\se1.example.com:4307,12.34.56.78:443,se1.example.net:4307,se2.example.com#as\se2.example.com:4307,se2.example.com:443"

--dsrecord

Use directSoundRecord.

Available only in Windows.

Syntax:

--dsrecord

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --dsrecord

--encrypt, -e

The parameter which indicates if it is necessary to use a hashed password instead of an open password.

Used together with --login, -l and --password, -p.

Syntax:

--encrypt
-e

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --password pass1234 --login ivanov --encrypt

--filepath

Specify the file that contains the key for TrueConf Room API, or the file where the generated HID for activation should be saved. See also the Activation section.

Syntax:

--filepath {path_to_file}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --filepath с:\regoffline2.rrg

--hardware-key

Generate a registration file to obtain a license for TrueConf Room API (used for offline registration). See also the Activation section.

Used together with --filepath and --license-key.

The registration regoffline.rrg file will be moved to the same directory where the license file is stored (the file was specified in the --filepath parameter).

Syntax:

--hardware-key

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --hardware-key --license-key --filepath c:\file_with_key.txt

--httpport

Specify the port for HTTP servers.

Rules:

The argument must be greater than zero and less than 65536

Syntax:

--httpport {port}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --httpport 568

--hwtest

Start the device test.

TrueConf Room API will not start.

The result will be a file named tc_configuration.txt containing the relevant information located at:

on Windows C:\Users\[user_name]\AppData\Local\TrueConf\Room
on Linux /home/[user_name]/.config/trueconf/room/

where [user_name] is the user's login in the OS.

Rules:

The argument is optional
No argument is allowed in the next token for the parameter
If there is no argument, the tc_configuration.txt will be used

Syntax:

--hwtest=[configuration.txt]
--hwtest

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --hwtest
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --hwtest=new_configuration.txt

--ignore_layouts

Ignore any specified conference video layouts received from the server.

The --ignore_layouts parameter is not preserved between application launches and only works for the current session.

--ignore_monitor

Select the screens that will be ignored.

Rules:

The argument is a list of ignored monitors. The delimiter is ,.
The argument may include:
- Screen number
- Screen VID
- Screen PID
- Screen PID and VID combined
- Screen ID

Syntax:

--ignore_monitor {monitor_index(,)pid(,)vid}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --ignore_monitor 1
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --ignore_monitor 1,vid_046d&pid_0867,vid_046d,pid_0823
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --ignore_monitor 1,vid_046d&pid_0867,vid_046d,pid_0823,display\\lgd0457\\4&1e135148&0&uid589652

--license-key

Specify the license file for TrueConf Room API. It is used together with --filepath. See also the Activation section.

Used together with --hardware-key for offline activation.

Syntax:

--license-key

Example:

// Online activation
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --license-key --filepath c:\file_with_key.txt

 // Offline activation - the generation of the registration file. This file must include the serial number required for the program activation. 

 C:\Program Files\TrueConf\Room>TrueConfRoom.exe --hardware-key --license-key --filepath c:\file_with_key.txt

 // Offline activation - the selection of the license file. The selected file must include the license required for the program activation. 

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --license-key --filepath c:\regoffline2.rrg

--log

Enable writing logs to files.

The argument specifies the modules that have to be logged.

When specified, it overrides the value from the database for the current launch of TrueConf Room API. The value is not saved in the database.

Mutually exclusive with the --nolog parameter, the parameter that appears first will be executed.

Rules:

The argument is optional
No argument is allowed in the next token for the parameter
The argument is a number (decimal, binary, or hexadecimal)

Syntax:

--log=[modules]
--log

If the parameter is absent, the feature is disabled. If enabled, each command execution request and its result will be logged. Along with commands, information about any notifications that occur will also be recorded in the logs. Private information will be replaced with a hash.

Syntax:

--logapi

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --logapi

Specify the authorization login.

Used in combination with the parameter --password, -p.

If the password is passed in an unencrypted way, it is necessary to specify the parameter --encrypt, -e.

Syntax:

--login {some_login}
-l {some_login}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --login ivanov --password pass1234 -e

--loginforce

Parameter indicating re-login.

Used together with --login, -l and --password, -p.

Syntax:

--loginforce

--master

Specify the channel ID for messaging in the primary TrueConf Room API in the secondary video stream functionality.

Syntax:

--master {channelName}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --master abcd123

--mfa

Parameter for specifying outgoing audio stream settings.

Rules:

The argument consists of 2 parameters. They are not case-sensitive:
- sr — sampling rate
- enc - Название кодека. Доступны следующие типы:
  - pcm
  - g711a
  - g711mu
  - g722
  - g723
  - g728
  - g729a
  - g722.1/24
  - g722.1/32
  - g722.1c/24
  - g722.1c/32
  - g722.1c/48
  - speex
  - isac
  - opus
  - aac
  - mp3
Every parameter is optional.
The parameters will be separated by |.
The value of a parameter should be separated with : — key:value.
The argument should be written in quotes or it is necessary to escape the separators to make sure that the command is parsed correctly.

Syntax:

--mfa {(")enc(:)enc_name(|)sr(:)samplerate(")}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --mfa enc:g722.1c/24|sr:48000
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --mfa enc:g722.1c/24

--mfv

The parameter for specifying the parameters of the outbound video stream.

Rules:

The argument consists of 3 parameters. They are not case-sensitive:
- res — video resolution. The argument value: width and height. Separator —x
- enc - Название кодека. Доступны следующие типы:
  - h265
  - h264
  - h263p
  - h263
  - h261
  - vp8
  - vp9
  - vp8stereo
- fr — frame rate
Every parameter is optional.
The parameters will be separated by |.
The value of a parameter should be separated with : — key:value.
The argument should be written in quotes or it is necessary to escape the separators to make sure that the command is parsed correctly.

Syntax:

--mfv {(")res(:)width(x)height(|)enc(:)enc_name(|)fr(:)framerate(")}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --mfv res:1980x1080|enc:h264|fr:30
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --mfv enc:h264|fr:15

--mh, -h

Specify the list of servers that TrueConf Room API will work with.

Syntax:

--mh {server_name1(,)server_name2(,)...}
-h {server_name1(,)server_name2(,)...}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe -h some.trueconf.com,127.0.0.1

--min, -m

Launch TrueConf Room API with the main window minimized. If this option is used when starting a secondary TrueConf Room API in the additional video stream feature, its window will remain permanently hidden.

Syntax:

--min
-m

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --min

--monitor

Set the monitor to display TrueConf Room API.

If a monitor UUID was provided, TrueConf Room API will be bound to that monitor, ignoring the value saved from the previous session.

This is mutually exclusive with the --position parameter; the parameter encountered first will be executed.

Rules:

The argument must be the screen number or UUID

Syntax:

--monitor {monitor_index_or_device_instance_path}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --monitor 1
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --monitor DISPLAY\AUO24ED\4&1b4e36bd&8&UID265988

--ndi

Enable NDI protocol for receiving and sending.

Syntax:

--ndi

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --ndi

--nofsbrdr

Disable a one-pixel-wide window frame.

Available only in Windows.

Syntax:

--nofsbrdr

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --nofsbrdr

--nolog

Disable writing logs to files.

Mutually exclusive with the parameter --log, the parameter encountered first will be executed.

Syntax:

--nolog

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --nolog

--noptz

Disable the ability to control a PTZ camera.

Syntax:

--noptz

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --noptz

--nosplash

Launch TrueConf Room API without a splash screen.

Syntax:

--nosplash

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --nosplash

--no_mdns

Disable the automatic detection mechanism for running instances of TrueConf Room API on the local network.

Syntax:

--no_mdns

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --no_mdns

--offhwdec

Disable hardware decoding.

Syntax:

--offhwdec

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --offhwdec

--offhwenc

Disable hardware encoding.

Syntax:

--offhwenc

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --offhwenc

--password, -p

Specify the authorization password.

Used in combination with the parameter --login, -l.

If the password is passed in an unencrypted way, it is necessary to specify the parameter --encrypt, -e.

Syntax:

--password {some_password}
-p {some_password}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --password pass1234 --login ivanov -e

--pin

Authorize in the web interface with the specified PIN.

Syntax:

--pin {some_pin}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --pin d5f6g8

--position

Set the size and position of the main window at startup.

Mutually exclusive with the --monitor parameter. The parameter that appears first will be processed.

Rules:

The argument contains x-coordinate, y-coordinate, width, and height. Separator — ,

Syntax:

--position {x,y,w,h}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --position 100,100,600,600

You can display the TrueConf Room API window on an additional monitor since the coordinate grid is shared across all connected displays. You can determine the starting point of coordinates for the desired monitor in one of two ways.

Method 1. Launch the TrueConf Room API application and execute the getMonitorsInfo command. Note the starting coordinate for the desired display (parameter geomMonitor), close TrueConf Room API, and relaunch it with the --position parameter.

Method 2. Using OS commands.

For Windows: execute the code in PowerShell

Add-Type -AssemblyName System.Windows.Forms
>> [System.Windows.Forms.Screen]::AllScreens

The response will include a list of monitors and the starting point of coordinates for each of them in the Bounds parameter. For example, the output:

BitsPerPixel : 32
Bounds       : {X=0,Y=0,Width=1920,Height=1080}
DeviceName   : \\.\DISPLAY1
Primary      : True
WorkingArea  : {X=0,Y=0,Width=1920,Height=1040}

BitsPerPixel : 32
Bounds       : {X=0,Y=0,Width=1920,Height=1080}
DeviceName   : \\.\DISPLAY2
Primary      : True
WorkingArea  : {X=0,Y=-1080,Width=1920,Height=1040}

This means that for a monitor with index 2, the coordinate count starts from the point 0, -1080. To display the TrueConf Room API window on it with a vertical shift of 100 pixels, specify the parameter --position 0,-980,1920,980.

For Linux: execute the command in the terminal

xrandr --listmonitors

The response will contain a list of monitors and the starting coordinates for each, indicated by a + sign following the dimensions. For example, output:

Monitors: 2
 0: +*eDP 1920/344x1080/194+0+1080  eDP
 1: +HDMI-A-0 1920/477x1080/268+0+0  HDMI-A-0

This means that 2 displays are connected, and the coordinates for the first display start from the point 0, 1080. To display the TrueConf Room API window with a vertical shift of 100 pixels, specify the parameter --position 0,1180,1920,980.

--quit -q

Terminate the running instance of TrueConf Room API.

Syntax:

--quit
-q

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --quit

--rectonview

Set the coordinates of the rectangle where TrueConf Room API will be displayed.

Rules:

The argument is a list of 5 rectangle parameters, separated by a comma ,.
The argument must include:
- The number that represents the x-axis position
- The number that represents the y-axis position
- Height
- Width
- Transparency: ranges from 0 to 255

Syntax:

--rectonview {x,y,width,height,alpha}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --rectonview 120,60,100,500,155

--render, -r

Specify the type of rendering to be used in TrueConf Room API.

Rules:

The following types of renderer are available:
- gl
- opengl
- gles,
- opengles
- directx
- angle
- soft
- soft-gl
- gdi

Syntax:

--render {type_render}
-r {type_render}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --render gdi

--reset-settings

Reset product settings. The list of possible names is exactly the same as in the getSettings method. In addition to these values, webauth is also available, which refers to resetting the authentication data for the management page (i.e., resetting the items set by setAuthParams for auth).

Rules:

The list of settings is passed as an argument
Separator — ,

Syntax:

--reset-settings {some_setting1(,)some_setting2(,)...}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --reset-settings language,webauth

--settings

Applies the new settings from the json file specified in the argument.

Syntax:

--settings {path_to_json}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --settings c:\settings.json

--slave

Specify the channel identifier for messaging in the secondary TrueConf Room API in the additional video stream functionality. It must be the same as the one provided in the --master key.

Syntax:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --slave abcd123

--sysrescheck

Enable the system performance test.

Syntax:

--sysrescheck

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --sysrescheck

--templogin

The parameter that refers to the autologin.

Used together with --login, -l and --password, -p.

Syntax:

--templogin

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --templogin

--twin, -t

Launch another instance of TrueConf Room API with the specified name.

By default, TrueConf Room API checks for a running instance of TrueConf Room API on startup. If it finds one, it sends the parameters with which it was launched to that instance and then exits.

All instances do not affect each other; their settings are stored in the folder with the twin name specified in the parameters.

Rules:

The argument is optional
No argument is allowed in the next token for the parameter
If an argument is not included, the twin string is used
Maximum name length — 32 characters
Valid characters:
ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-.
Invalid characters are replaced with _

Syntax:

--twin=[twin_name]
-t [twin_name]

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --twin=user1
C:\Program Files\TrueConf\Room>TrueConfRoom.exe -t user2
C:\Program Files\TrueConf\Room>TrueConfRoom.exe -t

--url, -u

Specify the URL to download the parameters needed to launch TrueConf Room API.

If this parameter is used, other parameters will be ignored.

The new command line prompt is displayed in response to the query; the response timeout — 2-5 seconds.

If there is no response, TrueConf Room API is launched without parameters. In the new parameters, the options --ccl, -x, --url, and -u are ignored.

Syntax:

--url {download_URL}
-u {download_URL}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe -u https://some.server.com/cnf/0c014232

--verbose, -v

Allow printing logs in the console.

Syntax:

--verbose
-v

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe -v

--wsport

Specify the port for WebSockets.

Rules:

The argument must be greater than zero and less than 65536

Syntax:

--wsport {port}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --wsport 568

See also:

Additional video stream functionality