- Command line parameters
- Conventional notation for the command line syntax
- Description of the command line style
- Description of command line parameters
- --twin, -t
- --position
- --min, -m
- --mh, -h
- --domain, -d
- --login, -l
- --password, -p
- --encrypt, -e
- --cid, -c
- --ccl, -x
- --url, -u
- --verbose, -v
- --render, -r
- --mfv
- --mfa
- --br
- --log
- --nolog
- --hwtest
- --sz, -s
- --pn
- --offhwenc
- --offhwdec
- --autoclose
- --templogin
- --loginforce
- --extui
- --pippop
- --nofsbrdr
- --noptz
- --reset-settings
- --sysrescheck
- --dsrecord
- --wsport
- --httpport
- --pin
- --settings
- --filepath
- --hardware-key
- --license-key
- --no_mdns
- --ndi
- --nosplash
- --monitor
- --ignore_monitor
- --rectonview
# 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 | The elements that should be entered in the way in which they are displayed. |
[Text within square brackets] | An optional argument |
{Text within curly brackets} | A required argument |
(Text within round brackets) | A required separator in the argument |
... | An 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
# --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 usedMaximum 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
# --position
Set the geometric parameters for the main window when the application is started.
It is mutually exclusive with the parameters --monitor
, --sz
and --pn
: the parameter that comes first will be used.
Rules:
- The argument contains x-coordinate, y-coordinate, width, and height. Separator —
,
Syntax:
--geometry {x,y,w,h}
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --geometry 100,100,600,600
# --min, -m
Start VideoSDK/Room with the minimized main window.
Syntax:
--min
-m
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --min
# --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
# --domain, -d
Specify the domain VideoSDK/Room can interact with.
Syntax:
--domain {some_domain}
-d {some_domain}
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --domain some.trueconf.ru
# --login, -l
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
# --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
# --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
# --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
# --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
# --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
# --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
# --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
# --mfa
The parameter for specifying the parameters of the outbound video stream.
Rules:
- The argument consists of 2 parameters. They are not case-sensitive:
sr
— sampling rateenc
- Название кодека. Доступны следующие типы: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
# --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
# --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.
Mutually exclusive with the --nolog
parameter. If two of them are combined, the one that comes first will be used.
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
# --nolog
Disable writing logs to files.
Mutually exclusive with the --log
parameter. If two of them are combined, the one that comes first will be used.
Syntax:
--nolog
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --nolog
# --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
# --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
# --pn
Set the starting coordinates for the VideoSDK/Room window.
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 —
,
Syntax:
--pn {x(,)y}
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --pn 20,20
# --offhwenc
Disable hardware encoding.
Syntax:
--offhwenc
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --offhwenc
# --offhwdec
Disable hardware decoding.
Syntax:
--offhwdec
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --offhwdec
# --autoclose
Returns VideoSDK/Room to the initial state after a call.
Syntax:
--autoclose
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --autoclose
# --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
# --loginforce
The parameter that refers to the relogin.
Used together with --login
, -l
and --password
, -p
.
Syntax:
--loginforce
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --loginforce
# --extui
Use an external UI.
Syntax:
--extui
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --extui
# --pippop
Enable picture-in-picture
mode.
Rules:
- The argument includes 4 parameters. They are not case-sensitive:
x
— the number that specifies the X-axis positiony
— the number that specifies the Y-axis positionw
— widthh
— height
- 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:
--pippop {(")x(:)pos_x(|)pos_y(:)y(|)w(:)width(|)h(:)height}
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --pippop x:12|y:21|W:1980|h:1080
# --nofsbrdr
Disable a one-pixel-wide window frame.
Available only in Windows
.
Syntax:
--nofsbrdr
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --nofsbrdr
# --noptz
Disable the ability to control a PTZ camera.
Syntax:
--noptz
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --noptz
# --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
# --sysrescheck
Enable the system performance test.
Syntax:
--sysrescheck
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --sysrescheck
# --dsrecord
Use directSoundRecord.
Available only in Windows
.
Syntax:
--dsrecord
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --dsrecord
# --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
# --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
# --pin
Authorize in the web interface with the specified PIN.
Syntax:
--pin {some_pin}
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --pin d5f6g8
# --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
# --filepath
Specify the file where the
VideoSDK/Room
key is stored or the file where the HID
generated for activation should be written.
Syntax:
--filepath {path_to_file}
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --filepath с:\regoffline2.rrg
# --hardware-key
Generate the registration key needed for receiving the VideoSDK/Room license (used for offline registration).
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
# --license-key
Specify the
VideoSDK/Room
license file. Used together with --filepath
.
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
# --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
# --ndi
Enable NDI protocol for receiving and sending.
Syntax:
--ndi
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --ndi
# --nosplash
Start VideoSDK/Room without the splash screen.
Syntax:
--nosplash
Example:
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --nosplash
# --monitor
Установить монитор, на котором будет отображен VideoSDK/Room .
Mutually exclusive with the parameter --sz
, -s
or pn
(the parameter that comes first will be used).
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
# --ignore_monitor
Select the screens that will be ignored.
Rules:
- The argument represents the list of ignored screens. Separator —
,
- 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
# --rectonview
Set the coordinates of the rectangle where VideoSDK/Room will be displayed.
Rules:
- The argument is the list of five parameters for the rectangle. Separator —
,
- 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