Command line parameters

# Command line parameters

# Conventional notation for the command line syntax

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

Нотация	Описание
Текст без квадратных, фигурных скобок или круглых скобок	Элементы, которые необходимо вводить так, как они отображаются.
[Текст внутри квадратных скобок]	Необязательный аргумент.
{Текст внутри фигурных скобок}	Обязательный аргумент.
[Текст внутри квадратных скобок]	Обязательный разделитель в аргументе.
...	Неограниченное количество параметров в аргументе.

# 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

# --autoclose

Returns VideoSDK/Room to the initial state after a call.

Syntax:

--autoclose

Example:

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

# --background

Specify the path to the file that will be used for 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 blurring 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

After the start of VideoSDK/Room call to the specified CallID.

CallID can be either the TrueConf ID of a user or a conference ID (it will start with\c\).

Syntax:

--cid {CallID}
-c {CallID}

Example:

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

# --domain, -d

Specify the domain that VideoSDK/Room will work with.

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

File specifying the key for VideoSDK/Room, or a file where the generated HID must be written for activation. 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 that can be used to obtain a license for VideoSDK/Room (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.

VideoSDK/Room will not be started.

As a result, the file with the corresponding information will be created. It will be in the same directory with the execution file.

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_monitor

Select the screens that will be ignored.

Rules:

msgid:

Аргумент представляет собой список игнорируемых мониторов. Разделяющий символ - `,`

Translation:

The argument is a list of ignored monitors. The separator is `,`

The argument may include:
- Screen number
- Screen VID
- Screen PID
- Screen PID and VID combined

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

# --license-key

Specify the license file for VideoSDK/Room. Used in conjunction 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.

If specified, it will redefine the value in the database for the current launch of VideoSDK/Room. The value will not be stored in the database.

The parameter --nolog is mutually exclusive, 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

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --log
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --log=111111111

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

Example:

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

# --mfa

msgid "Parameter for specifying parameters of outgoing audio stream." msgstr "Параметр для указания параметров исходящего аудиопотока."

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 to which VideoSDK/Room can connect.

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 VideoSDK/Room with the main window minimized.

Syntax:

--min
-m

Example:

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

# --monitor

Установить монитор, на котором будет отображен VideoSDK/Room.

The parameter --sz and -s are mutually exclusive. The parameter that appears 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.

If --log parameter is included, the parameter that comes first will be executed, excluding others.

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

Start VideoSDK/Room without the splash screen.

Syntax:

--nosplash

Example:

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

# --no_mdns

Disable automatic detection of VideoSDK/Room instances running in 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.

The parameters --monitor and --sz are mutually exclusive: the parameter that occurs first will be executed.

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 VideoSDK/Room window on an additional monitor, because the coordinate grid is shared for all connected displays. You can find out the starting point of coordinates for the required monitor in one of two ways.

Method 1. Launch the VideoSDK/Room application and execute the command getMonitorsInfo. Remember the coordinate origin for the desired display (parameter geomMonitor), close VideoSDK/Room and launch it again with the --position parameter.

Method 2. Through OS commands.

For Windows: run the following code in PowerShell

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

The response will contain a list of monitors and the starting 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 the monitor with index 2, coordinates start from point 0, -1080. To display the VideoSDK/Room window on it with a vertical shift of 100 pixels, specify the parameter --position 0,-980,1920,980.

For Linux: execute the following command in the terminal

xrandr --listmonitors

The response will contain a list of monitors and the beginning of coordinate counting for each of them separated by a + sign after the sizes. 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 there are 2 displays connected and the first one has coordinates counted from the point 0, 1080. To display the window VideoSDK/Room on it with a vertical shift of 100 pixels, specify the parameter --position 0,1180,1920,980.

# --quit -q

Complete the running instance of VideoSDK/Room.

Syntax:

--quit
-q

Example:

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

# --rectonview

Set the coordinates of the rectangle where VideoSDK/Room will be displayed.

Rules:

The argument represents a list of 5 parameters of a rectangle. Separator symbol - ,
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 renderer that will be used in VideoSDK/Room.

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

Return the application settings to defaults.

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,_minutesInConf

# --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

# --sysrescheck

Enable the system performance test.

Syntax:

--sysrescheck

Example:

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

# --sz, -s

Set the window size.

If the size is larger than the screen resolution, the size will be equal to screen resolution.

Mutually exclusive with the --monitor parameter. If two of them are combined, the one that comes first will be used.

Rules:

The argument includes width and height. Separator — x

Syntax:

--sz {w(x)h}
-s {w(x)h}

Example:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --sz 1980x720

# --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

Run another instance of VideoSDK/Room with the predefined name.

By default when launching VideoSDK/Room checks if another instance of VideoSDK/Room is now being run. If it finds such an instance, its sends the starting parameters to the running instance and terminates its work.

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 link for downloading parameters that should be used for starting VideoSDK/Room.

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, VideoSDK/Room will start without parameters. The following new parameters will be ignored: --ccl, -x and --url, -u.

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

# Command line parameters

# Conventional notation for the command line syntax

# Description of the command line style

# Description of command line parameters

# --autoclose

# --background

# --blur

# --br

# --ccl, -x

# --cid, -c

# --domain, -d

# --dsrecord

# --encrypt, -e

# --filepath

# --hardware-key

# --httpport

# --hwtest

# --ignore_monitor

# --license-key

# --log

# --login, -l

# --loginforce

# --mfa

# --mfv

# --mh, -h

# --min, -m

# --monitor

# --ndi

# --nofsbrdr

# --nolog

# --noptz

# --nosplash

# --no_mdns

# --offhwdec

# --offhwenc

# --password, -p

# --pin

# --position

# --quit -q

# --rectonview

# --render, -r

# --reset-settings

# --settings

# --sysrescheck

# --sz, -s

# --templogin

# --twin, -t

# --url, -u

# --verbose, -v

# --wsport