Руководство TrueConf VideoSDK

# Room Service

# Условные обозначения

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

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

# Иерархия Room Service

сервис/демон TrueConfRoomService
|
|→ TrueConf Room Manager
|
|→ TrueConf Room
|
|→ скрипты
  • сервис/демон TrueConfRoomService:
    • запускает/проверяет/останавливает заданные ему в json-файле программы и скрипты;
    • в ОС семейства Linux может завершать работу системы/перезагружать систему;
    • в Windows закрывает/заново открывает заданные приложения при уходе системы в сон аналогично командам --stop и --start.
  • Room Manager открывает/закрывает веб-менеджер и показывает/сохраняет настройки.

Сервис/демон взаимодействует с Room Manager:

  • вверх (к сервису): SCM/Posix сигналы;
  • вниз (к менеджеру): ProcessController сигналы и открытие/закрытие по process id.

Разница в запуске Room Manager/Room и скриптов:

  • скрипты завершаются при остановке процесса, а также не проверяется их наличие, кроме как перед запуском/остановкой;
  • Room Manager/Room завершаются аналогично штатному закрытию, затем происходит ожидание закрытия в несколько секунд.

# Команды TrueConfRoomService

# --install

В Windows: зарегистрировать сервис по данному пути и инициализировать его.

В Linux: запуск демона TrueConfRoomService.

Правила:

  • указание пути к Room Manager в качестве аргумента [path_to_RoomManager] опционально и требуется только для нестандартных расположений Room Manager;
  • при запуске данной команды без аргумента Room Manager ищется сначала в той же папке, что TrueConfRoomService, затем в стандартной папке для установки.

Синтаксис:

--install [path_to_RoomManager]

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomService.exe --install

# --uninstall

В Windows: отменить регистрацию сервиса TrueConfRoomService по данному пути и деинициализировать его.

В Linux: остановка демона TrueConfRoomService.

Синтаксис:

--uninstall

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomService.exe --uninstall

# Ключи командной строки Room Manager

# --pin

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

Правила:

  • Доступны следующие символы для пина: abcdefghijklmnopqrstuvwxyz0123456789
  • Максимальная длина пина 8 символов.

Синтаксис:

--pin={some_pin}

Пример:

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

# --monitor

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

Правила:

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

Синтаксис:

--monitor={monitor_index}

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomManager.exe --monitor=1

# Схема действия команд Room Manager

Если в одной командной строке встречается несколько команд, то обрабатывается первая в списке, а остальные игнорируются.

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomManager.exe --start --settings --stop --restart --stop

выполнится --start

C:\Program Files\TrueConf\Room>TrueConfRoomManager.exe --settings --restart

выполнится --settings

# Команды Room Manager

# --settings

Опция командной строки для Room Manager, обеспечивающая открытие окна настроек при его запуске.

Правила:

  • Если не открыто ни одной копии Room Manager: он запускается и показывает окно настроек.
  • Если уже открыта одна копия Room Manager: вторая копия стартует, передает ранее открытой копии команду об открытии диалога настроек, закрывается. Первая копия показывает диалог настроек.

Синтаксис:

--settings

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomManager.exe --settings

# --start

Опция командной строки для Room Manager, обеспечивающая запуск с помощью сервиса/демона TrueConfRoomService заданных ему приложений и начало слежения за ними, если до этого они были остановлены командой --stop.

Правила:

  • Сервис/демон TrueConfRoomService должен быть запущен.
  • Room Manager стартует и посылает TrueConfRoomService команду начала показа и отслеживания заданных ему приложений, затем закрывается.

Синтаксис:

--start

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomManager.exe --start

# --stop

Опция командной строки для Room Manager, обеспечивающая остановку с помощью сервиса/демона TrueConfRoomService заданных ему приложений и окончание слежения за ними.

Правила:

  • Сервис/демон TrueConfRoomService должен быть запущен.
  • Room Manager стартует и посылает TrueConfRoomService команду окончания показа и отслеживания заданных ему приложений, затем закрывается.

Синтаксис:

--stop

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomManager.exe --stop

# --restart

Опция командной строки для Room Manager, обеспечивающая остановку и старт с помощью сервиса/демона TrueConfRoomService заданных ему приложений.

Правила:

  • Сервис/демон TrueConfRoomService должен быть запущен.
  • Room Manager стартует и посылает TrueConfRoomService команду остановки и старта заданных ему приложений, затем закрывается.

Синтаксис:

--restart

Пример:

C:\Program Files\TrueConf\Room>TrueConfRoomManager.exe --restart