Перейти к содержимому

Запуск клиентского приложения TrueConf с параметрами командной строки

Автор23.08.2021Дата написанияОколо 9 минВремя чтенияКлиентские приложенияКатегорияAPI / SDKПланирование конференцийТеги

Клиентские приложения TrueConf для десктопных ОС (Windows, macOS, Linux) и программный ВКС-терминал TrueConf Room можно запускать с параметрами командной строки, благодаря чему пользователь может при открытии приложения автоматически:

  • авторизоваться;

  • подключиться к нужному серверу;

  • запустить приложение в выбранном режиме (полноэкранном или минимизированном);

  • позвонить пользователю или подключиться к видеоконференции;

  • запустить еще один независимый экземпляр приложения (например, для захвата второго видеоисточника).

Список параметров

В приложениях TrueConf для macOS и Linux при указании параметров с символом “\” его надо экранировать вторым символом “\”, например “/c \\c\\6427906610”.

ФункцияПараметр и пример его использования

Авторизация

-l [user] -p [password] -e -lf
-l maria -p 4839 -e -lf


-l — указывает логин для авторизации. Используется в сочетании с параметром --password, -p, который в свою очередь указывает пароль для авторизации.


-e — обязательный параметр, указывающий на использование хеша от пароля вместо открытого вида. Используется совместно с --login, -l и --password, -p.

Подключение к серверу по его IP-адресу или доменному имени

-h [server]:[port]
-h 192.168.1.100:12345
-h video.company.com

Указание домена, по SRV-записям которого будет производиться поиск доступного ВКС-сервера для подключения

-d [domain_name]
-d company.com


Данный параметр рекомендуется использовать совместно с -h для корректной работы автологина в случае изменения адреса сервера в списке SRV-записей.


Параметр -d работает следующим образом:

  • все сервера из списка для параметра -h помечаются как сервера из этого домена;
  • с помощью DNS SRV Discovery происходит запрос SRV-записей следующего вида: vcs2.tcp.[domain name]. После чего из полученного ответа от DNS-сервера выбирается один из доступных ВКС-серверов TrueConf. Но если Discovery ничего не находит, то берутся сервера из -h.


    После первого успешного подключения приложение TrueConf сохранит в своих настройках все адреса, которые указаны в списке Внешние адреса панели управления сервером. Конечно, вам для этого понадобится добавить новую SRV-запись в вашем домене.

Форсирование авторизации или подключения к серверу

-lf
-l maria -p 4839 -e -lf


Данный параметр можно использовать для принудительного подключения к указанному с параметром -h серверу, а также для авторизации с указанными логином и паролем. Если ключ -lf не указать и пользователь уже авторизован на сервере, то переподключения к нужному серверу или авторизации с новыми учётными данными не произойдёт.

Запуск приложения в различных режимах

Полноэкранный (без отображения элементов интерфейса)

-f


Использование данного параметра будет уместным совместно с параметром -c при автоматическом совершении видеозвонков, если вам важно видеть только изображения собеседников по конференции без элементов интерфейса.

Свернутый-m

Режим “копии”

-t [id]


Использование данного параметра запустит копию приложения с указанным пользователем идентификатором. Настройки копии приложения сохраняются отдельно от настроек оригинала и не теряются после их закрытия и воспроизводятся автоматически при повторном запуске по тому же идентификатору. Это будет полезно, например, для подключения к другому серверу при использовании совместно с параметрами: -l (логин); -p (пароль); -h (указание к какому серверу подключиться).

Выбор монитора для вывода главного экрана TrueConf Room

-monitor [id]
-monitor 2


Применимо только для TrueConf Room.
По умолчанию главный экран TrueConf Room запускается на мониторе, который используется в ОС в качестве основного, например, в ОС Windows он будет иметь индекс 1. С помощью ключа -monitor это поведение можно изменить, то есть при подключении дополнительного дисплея вы можете вывести на нём главный экран TrueConf Room, указав параметр -monitor 2. Это позволит вам использовать разные дисплеи для отображения окна конференции и одновременного управления программным терминалом, используя веб-панель.

Отключение для TrueConf Room раскладки, получаемой от сервера

--ignore_layouts


Применимо только для TrueConf Room.
Позволяет отключить приём раскладки конференции, заданной ведущим или администратором, и управлять раскладкой с помощью панели управления (например, через планшет).

Вызов пользователя или присоединение к конференции

Звонок пользователю

-c [user]
-c george
-c [user] @ [server_name]
-c george@company.com

Подключение к конференции на сервере по \c\CID

-c \c\[CID]
-c \c\6427906610
-c \c\[CID]@[server_name]#vcs
-c \c\6427906610@company.com#vcs

Автоматическое закрытие приложения после завершения звонка/конференции

-ac


Данный параметр можно использовать только совместно с параметром -с. -c kate -ac -c \c\5427905512 -ac

Дополнительные параметры работы приложения

Изменение типа рендера

-r [render-type] или --render [render-type]
-r opengl или --render opengl


Указать типа рендера, который будет использоваться в приложении. Может быть полезно попробовать указать какое-то значение из списка ниже (перебором), если наблюдаются проблемы с отрисовкой приложения (так называемые “артефакты”). Если ничего не поможет, следует собрать логи и создать обращение в техподдержку Труконф.
Доступны следующие типы рендера:

  • opengl
  • angle
  • soft
  • gl
  • gles
  • opengles
  • directx
  • soft-gl
  • gdi


    Также существует отдельный параметр --offhwenc (используется без -r) для отключения аппаратного кодирования.

Запуск с параметрами из файла

--settings [file-path]
--settings "C:\Program Files\TrueConf\Client\settings.json"


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

Здесь:

  • [user] — логин пользователя;

  • [password] — пароль пользователя

  • [server] — IP сервера TrueConf;

  • [server_name] — FQDN - имя сервера TrueConf;

  • [port] — порт, отведённый под панель управления сервера;

  • [id] — уникальный идентификатор копии приложения;

  • [CID] — ID конференции.

Параметры можно произвольным образом комбинировать. Например:

  • чтобы подключиться и авторизоваться на сервере TrueConf, выполните команду

    TrueConf.exe -h 192.168.1.100:12345 -l maria -p 4839 -e
  • чтобы пройти авторизацию и позвонить пользователю, выполните команду

    TrueConf.exe -c george -l maria -p 4839 -e
  • чтобы пройти авторизацию и подключиться к конференции, выполните команду

    TrueConf.exe -c \c\5427905512 -l maria -p 4839 -e
  • чтобы запустить еще один экземпляр приложения и подключиться к серверу TrueConf по IP, выполните команду

    TrueConf.exe -t 1 -h 192.168.1.100:12345 -lf
  • чтобы запустить еще один экземпляр приложения TrueConf Room, подключиться к серверу TrueConf по его доменному имени и вывести главный экран на дополнительный монитор, выполните команду

    TrueConfRoom.exe -t 1 -h video.company.com -lf -monitor 2

Как использовать параметры при запуске

На Windows

С помощью командной строки

По умолчанию приложение Труконф не прописывается в переменную окружения Path, поэтому для запуска через командную строку всегда надо использовать полный путь к исполняемому файлу C:\\Program Files\\TrueConf\\Client\\TrueConf.exe. Для удобства вы можете добавить папку с приложением в Path c помощью команды выполненной от имени администратора:

setx PATH "%PATH%;C:\\Program Files\\TrueConf\\Client"

После выполнения команды необходимо перезагрузиться. Теперь вы можете запускать приложение через командную строку:

TrueConf.exe -t 2 -h 10.110.2.123 -l danilov -p p@ssword123 -e

С помощью ярлыка приложения

    • Найдите на рабочем столе или в панели задач ярлык клиентского приложения TrueConf.

    • В контекстном меню ярлыка выберите вкладку Свойства.

    • Добавьте параметры запуска в поле Объект после кавычек, ограничивающих имя файла, например `-t 2 -h 10.110.2.123 -l danilov -p p@ssword123 -e`:

  • Нажмите ОК для сохранения изменений.

На Linux

С помощью терминала

Для запуска приложения Труконф с параметрами на ОС семейства Linux можно использовать терминал (консоль). Сначала нужно определиться с необходимыми параметрами, выберем их из таблицы. После этого просто вставьте команду в терминал и нажмите Enter. Для примера была взята команда:

trueconf -t 2 -h 10.110.2.123 -l danilov -p p@ssword123 -e

С помощью скрипта .sh

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

Для удобства рекомендуется делать это в отдельной папке, например tcscripts. Для создания папки выполните команду:

mkdir /home/$USER/tcscripts

Перейдите в директорию и создайте скрипт с помощью команды:

printf '#!/bin/bash\ntrueconf -t 2 -h 10.110.1.123 -l danilov -p p@ssword123 -e' > script.sh

где:

  • printf — команда для работы с текстом;

  • #!/bin/bash — указатель на среду выполнения команды;

  • \n — символ переноса строки;

  • trueconf — команда для запуска приложения Труконф;

  • -t 2 — параметр создания нового экземпляра приложения с идентификатором 2;

  • -h 10.110.1.123 — параметр указывающий ip-адрес сервера к которому нужно подключиться;

  • -l danilov — параметр указывающий логин для авторизации;

  • -p p@ssword123 — параметр указывающий пароль для авторизации;

  • -e — обязательный параметр при использовании с -l и -p;

  • > — оператор перенаправления вывода в указанный файл;

  • script.sh — название файла скрипта.

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

sudo chmod +x script.sh

Скрипт готов к использованию, для его запуска достаточно выполнить его в терминале:

./script.sh

На macOS

С помощью терминала

По умолчанию приложение Труконф недоступно к запуску через терминал. Чтобы не запоминать наизусть путь к исполняемому файлу, добавим алиас (символическую ссылку) в стандартный каталог /usr/local/bin:

sudo ln -s '/Applications/TrueConf Client.app/Contents/MacOS/TrueConf Client' /usr/local/bin/trueconf

Теперь вы можете запускать приложение Труконф с параметрами:

trueconf -t 1 -h 10.110.2.240 -l danilov -p p@ssword123

Такой способ требует всегда держать терминал открытым.

С помощью быстрой команды (Shortcuts)

Наверняка вы сталкивались с приложением Команды, используя экосистему Apple. Если нет, то вот руководство пользователя.

Мы создали для вас базовую команду для запуска копии приложения Труконф, которая добавляется в строку меню:

Через приложение Команды вы можете отредактировать её под себя:

  • добавить новые параметры;

  • захардкодить исполняемую команду, чтобы при запуске шортката сразу открывалось приложение без запроса дополнительных параметров;

  • добавить свою бизнес логику.