# Параметры командной строки

# Условные обозначения синтаксиса командной строки

В таблице ниже описана нотация, используемая для указания синтаксиса командной строки.

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

# Описание стиля командной строки

  • Разрешен - в коротких параметрах
  • Разрешен стиль -<single character>
  • Разрешен аргумент в том же токене для коротких параметров. Например: -lsome
  • Разрешен аргумент в следующем токене для коротких параметров. Например: -l some
  • Разрешен стиль --long_name
  • Разрешен аргумент в том же токене для длинных параметров. Например: --login=ivanov
  • Разрешен аргумент в следующем токене для длинных параметров. Например: --login ivanov
  • Разрешено объединие несколько коротких параметров вместе, чтобы -v -f превратился в -vf. Все параметры, кроме последнего, не должны принимать никаких аргументов. Например, если -v принимает параметр, то в качестве параметра будет приниматься f, а не другой короткий параметр
  • Разрешено сокращенное написание длинных параметров, если они однозначно идентифицируют длинный параметр. Никакое длинное имя параметра не должно быть префиксом другого длинного имени параметра, если действует угадывание

# Описание параметров командной строки

# --twin, -t

Запустить ещё один экземпляр VideoSDK/Room с заданным наименованием.

По умолчанию VideoSDK/Room при старте проверяет наличие запущенного экземпляра VideoSDK/Room и, если находит, отправляет ему параметры, с которыми был запущен, затем завершает работу.

Все экземпляры не влияют на работу друг друга, а настройки хранятся в папке с именем твина, заданного в параметрах.

Правила:

  • Аргумент необязателен

  • Аргумент в следующем токене для параметра не разрешен

  • При отсутствии аргумента подставляется строка twin

  • Максимальная длина имени - 32 символа

  • Разрешенные символы:

    ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-.

  • Неразрешенные символы заменяются на _

Синтаксис:

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

Пример:

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

Задать геометрию главного окна при старте.

Взаимоисключающий с параметрами --monitor, --sz и --pn: будет отработан параметр, который встретится первее.

Правила:

  • Аргумент в качестве значения содержит x-координату, y-координату, ширину и высоту. Разделяющий символ - ,

Синтаксис:

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

Пример:

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

# --min, -m

Запустить VideoSDK/Room со свёрнутым (минимизированым) главным окном.

Синтаксис:

--min
-m

Пример:

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

# --mh, -h

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

Синтаксис:

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

Пример:

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

# --domain, -d

Указать домен, с которым будет работать VideoSDK/Room .

Синтаксис:

--domain {some_domain}
-d {some_domain}

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --domain some.trueconf.ru

# --login, -l

Указать логин для авторизации.

Используется в сочетании с параметром --password, -p.

Если пароль передаётся в незашифрованном виде, необходимо указывать параметр --encrypt, -e.

Синтаксис:

--login {some_login}
-l {some_login}

Пример:

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

# --password, -p

Указать пароль для авторизации.

Используется в сочетании с параметром --login, -l.

Если пароль передаётся в незашифрованном виде, необходимо указывать параметр --encrypt, -e.

Синтаксис:

--password {some_password}
-p {some_password}

Пример:

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

# --encrypt, -e

Параметр, указывающий на то, нужно ли использовать хеш от пароля вместо открытого вида.

Используется совместно с --login, -l и --password, -p.

Синтаксис:

--encrypt
-e

Пример:

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

# --cid, -c

Позвонить после запуска VideoSDK/Room на указанный CallID.

CallID может быть как TrueConf ID пользователя, так и ID конференции (то есть, начинаться с \c\).

Синтаксис:

--cid {CallID}
-c {CallID}

Пример:

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

# --ccl, -x

Указать закодированную командную строку.

Параметр раскодируется и полученная строка используется, как обычные параметры.

Синтаксис:

--ccl {coded_cl}
-x {coded_cl}

Пример:

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

# --url, -u

Указать ссылку для загрузки параметров, с которыми необходимо запустить VideoSDK/Room .

При использовании этого параметра другие параметры игнорируются.

Новая командная строка приходит в ответе на запрос, время ожидания ответа - 2-5 секунд.

При отсутствии ответа запускается VideoSDK/Room без параметров. В новых параметрах игнорируются параметры --ccl, -x и --url, -u.

Синтаксис:

--url {download_URL}
-u {download_URL}

Пример:

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

# --verbose, -v

Разрешить вывод логов в консоль.

Синтаксис:

--verbose
-v

Пример:

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

# --render, -r

Указать типа рендера, который будет использоваться в VideoSDK/Room .

Правила:

  • Доступны следующие типы рендера:
    • gl
    • opengl
    • gles,
    • opengles
    • directx
    • angle
    • soft
    • soft-gl
    • gdi

Синтаксис:

--render {type_render}
-r {type_render}

Пример:

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

# --mfv

Параметр для указания параметров исходящего видеопотока.

Правила:

  • Аргументов состоит из 5 параметров. Их регистр не учитывается:
    • res - Разрешение видео. Значение аргумента - ширина и высота. Разделяющий символ - x
    • enc - Название кодека. Доступны следующие типы:
      • h265
      • h264
      • h263p
      • h263
      • h261
      • vp8
      • vp9
      • vp8stereo
    • fr - частота кадров
  • Каждый параметр является опциональным.
  • Параметры между собой необходимо разделять с помощью |.
  • Значение параметра необходимо отделять с помощью : - key:value.
  • Аргумент необходимо писать в кавычках или экранировать разделяющие символы для корректного распознавания команды.

Синтаксис:

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

Пример:

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

Параметр для .

Правила:

  • Аргументов состоит из 2 параметров. Их регистр не учитывается:
    • sr - частота дискретизации
    • 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
  • Каждый параметр является опциональным.
  • Параметры между собой необходимо разделять с помощью |.
  • Значение параметра необходимо отделять с помощью : - key:value.
  • Аргумент необходимо писать в кавычках или экранировать разделяющие символы для корректного распознавания команды.

Синтаксис:

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

Пример:

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

Установить максимальный битрейт.

Правила:

  • Аргумент должен быть положительном числом

Синтаксис:

--br {max_bitrate}

Пример:

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

# --log

Включить логирование в файлы.

В аргументе указываются модули, которые необходимо логировать.

При указании переопределяет значение из БД для текущего запуска VideoSDK/Room . В БД значение не сохраняется.

Взаимоисключающий с параметром --nolog, будет отработан параметр, который встретится первее.

Правила:

  • Аргумент необязателен
  • Аргумент в следующем токене для параметра не разрешен
  • Аргумент является числом (в десятичной, в двоичной или шестнадцатеричной форме)

Синтаксис:

--log=[modules]
--log

Пример:

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

# --nolog

Отключить логирование в файлы.

Взаимоисключающий с параметром --log, будет отработан параметр, который встретится первее.

Синтаксис:

--nolog

Пример:

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

# --hwtest

Запустить тестирование оборудования.

VideoSDK/Room не будет запущен.

В результате будет записан файл с соответствующей информацией, файл будет находиться рядом с исполняемым файлом.

Правила:

  • Аргумент необязателен
  • Аргумент в следующем токене для параметра не разрешен
  • При отсутствии аргумента подставляется строка tc_configuration.txt

Синтаксис:

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

Пример:

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

# --sz, -s

Установить размер окна.

Если указанный размер больше разрешения экрана, размер равен разрешению экрана.

Взаимоисключающий с параметром --monitor, будет отработан параметр, который встретится первее.

Правила:

  • Значение аргумента - ширина и высота. Разделяющий символ - x

Синтаксис:

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

Пример:

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

# --pn

Установить стартовые координаты окна VideoSDK/Room .

Взаимоисключающий с параметром --monitor, будет отработан параметр, который встретится первее.

Правила:

  • Значение аргумента - ширина и высота. Разделяющий символ - ,

Синтаксис:

--pn {x(,)y}

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --pn 20,20

# --offhwenc

Отключить хардварное кодирование.

Синтаксис:

--offhwenc

Пример:

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

# --offhwdec

Отключить хардварное декодирование.

Синтаксис:

--offhwdec

Пример:

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

# --autoclose

Возвращает VideoSDK/Room в исходное состояние после звонка.

Синтаксис:

--autoclose

Пример:

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

# --templogin

Параметр, обозначающий автологин.

Используется совместно с --login, -l и --password, -p.

Синтаксис:

--templogin

Пример:

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

# --loginforce

Параметр, обозначащий перелогин.

Используется совместно с --login, -l и --password, -p.

Синтаксис:

--loginforce

Пример:

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

# --extui

Использовать внешний UI.

Синтаксис:

--extui

Пример:

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

# --pippop

Включить режим картинка в картинке.

Правила:

  • Аргументов состоит из 4 параметров. Их регистр не учитывается:
    • x - число, которое является позицией по x
    • y - число, которое является позицией по y
    • w - число, которое является шириной
    • h - число, которое является высотой
  • Каждый параметр является опциональным.
  • Параметры между собой необходимо разделять с помощью |.
  • Значение параметра необходимо отделять с помощью : - key:value.
  • Аргумент необходимо писать в кавычках или экранировать разделяющие символы для корректного распознавания команды.

Синтаксис:

--pippop {(")x(:)pos_x(|)pos_y(:)y(|)w(:)width(|)h(:)height}

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --pippop x:12|y:21|W:1980|h:1080

# --nofsbrdr

Выключить рамку окна шириной в один пиксель.

Доступно только в Windows.

Синтаксис:

--nofsbrdr

Пример:

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

# --noptz

Отключить возможность управлять поворотом, наклоном и зумом ptz-камер.

Синтаксис:

--noptz

Пример:

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

# --reset-settings

Сбросить настройки продукта.

Правила:

  • В качестве аргумента передаётся список настроек
  • Разделяющий символ - ,

Синтаксис:

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

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoom.exe --reset-settings _language,_minutesInConf

# --sysrescheck

Включить проверку системных ресурсов.

Синтаксис:

--sysrescheck

Пример:

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

# --dsrecord

Использовать directSoundRecord.

Доступно только в Windows.

Синтаксис:

--dsrecord

Пример:

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

# --wsport

Указать порт для web-сокетов.

Правила:

  • Аргумент должен быть больше нуля и меньше 65536

Синтаксис:

--wsport {port}

Пример:

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

# --httpport

Указать порт для http-серверов.

Правила:

  • Аргумент должен быть больше нуля и меньше 65536

Синтаксис:

--httpport {port}

Пример:

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

# --pin

Aвторизоваться в web-интерфейсе по указанному пину.

Синтаксис:

--pin {some_pin}

Пример:

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

# --settings

Применяет новые настройки из файла json, указанного в аргументе.

Синтаксис:

--settings {path_to_json}

Пример:

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

# --filepath

Указание файла, в котором содержится ключ для VideoSDK/Room , либо файл, куда необходимо записать сгенерированный HID для активации.

Синтаксис:

--filepath {path_to_file}

Пример:

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

# --hardware-key

Сгенерировать регистрационный файл, по которому можно будет получить лицензию на VideoSDK/Room (используется для оффлайн регистрации).

Используется совместно с --filepath и --license-key.

Регистрационный файл regoffline.rrg будет помещен в тот же каталог, где находится файл с лицензией, указанный в параметре --filepath.

Синтаксис:

--hardware-key

Пример:

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

# --license-key

Указать файл лицензии для VideoSDK/Room . Используется совместно с --filepath.

Для оффлайн активации используется совместно с --hardware-key.

Синтаксис:

--license-key

Пример:

// Онлайн активация
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --license-key --filepath c:\file_with_key.txt

// Офлайн активация - генерация файла для регистрации. В заданном файле должен находиться серийный номер для активизации программы.
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --hardware-key --license-key --filepath c:\file_with_key.txt

// Офлайн активация - задание файла с лицензией. В заданном файле должна находиться лицензия для активизации программы.
C:\Program Files\TrueConf\Room>TrueConfRoom.exe --license-key --filepath c:\regoffline2.rrg

# --no_mdns

Отключить механизм автоматического обнаружения запущенных экземпляров VideoSDK/Room в локальной сети.

Синтаксис:

--no_mdns

Пример:

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

# --ndi

Включить протокол NDI на прием и отправку.

Синтаксис:

--ndi

Пример:

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

# --nosplash

Запустить VideoSDK/Room без сплаш-окна.

Синтаксис:

--nosplash

Пример:

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

# --monitor

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

Взаимоисключающий с параметром --sz, -s или pn, будет отработан параметр, который встретится первее.

Правила:

  • Аргумент должен быть номером монитора или UUID монитора

Синтаксис:

--monitor {monitor_index_or_device_instance_path}

Пример:

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

Установить игнорируемые мониторы.

Правила:

  • Аргумент предстовляет собой список игнорируемых мониторов. Разделяющий символ - ,
  • В аргументе может быть:
    • Номер монитора
    • VID монитора
    • PID монитора
    • Совмещенный PID и VID монитора

Синтаксис:

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

Пример:

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

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

Правила:

  • Аргумент предстовляет собой список 5 параметров прямоугольника. Разделяющий символ - ,
  • В аргументе должны быть:
    • Число, которое является позицией по x
    • Число, которое является позицией по y
    • Число, которое является высотой
    • Число, которое является шириной
    • Число, которое задаёт прозрачность, в пределах от 0 до 255

Синтаксис:

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

Пример:

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