TrueConf VideoSDK Guide

# Room Service

# Conventional names

The table below describes the notation used for the command line syntax in TrueConf Room Manager and TrueConfRoomService.

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
... An unlimited number of parameters in the argument

# Room Service hierarchy

TrueConf Room Service service/daemon
|
|→ TrueConf Room Manager
|
|→ TrueConf Room
|
|→ scripts
  • TrueConfRoomService service/daemon:
    • starts/checks/stops the scripts and programs set in the JSON file;
    • in Linux distros, it can shut down/restart the OS;
    • in Windows, it closes/restarts the selected applications when the system goes to sleep mode: it is similar to --stop and --start commands.
  • Room Manager opens/closes the web manager and displays/saves settings.

Service/daemon interacts with Room Manager:

  • Up (to the service): SCM/POSIX signals;
  • Down (to the manager): ProcessController signals and opening / closing by process by.

The difference in the start of Room Manager/Room and scripts:

  • scripts are automatically ended when the process is terminated and their presence is not checked except before the launch/shutdown;
  • Room Manager/Room is ended similarly according to the schedule: the timeout for shutdown is about a few seconds.

# TrueConfRoomService commands

# --install

In Windows, this command will be used to register the service under the specified path and initialize it.

In Linux, this command will launch the TrueConfRoomService daemon.

Rules:

  • it is not necessary to specify the path to Room Manage as the argument [path_to_RoomManager]. It may be needed only for some unstandard locations of Room Manager.
  • if this command is run without an argument, Room Manager is first searched in the TrueConfRoomService folder; then it is searched in the default installation folder.

Syntax:

--install [path_to_RoomManager]

Example:

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

# --uninstall

In Windows, this command cancels TrueConfRoomService registration under the specified path and deinitializes it.

In Linux, it stops the TrueConfRoomService daemon.

Syntax:

--uninstall

Example:

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

# Room Manager command line keys

# --pin

Authorize in the web interface with the specified PIN.

Rules:

  • The following characters can be used for PIN: abcdefghijklmnopqrstuvwxyz0123456789
  • PIN can be up to 8 characters.

Syntax:

--pin={some_pin}

Example:

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

# --monitor

Select the screen where Room Manager will be displayed.

Rules:

  • The argument must be the screen number

Syntax:

--monitor={monitor_index}

Example:

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

# Room Manager command rules

If a single line includes multiple commands, only the first command is processed while others will be ignored.

Example:

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

--start will be executed

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

--settings will be executed

# Room Manager commands

# --settings

An option in the Room Manager command line. It opens the settings window when Room Manager starts.

Rules:

  • If no instance of Room Manager is running, it starts and displays the settings window.
  • If an instance of Room Manager is already running, the second copy starts and sends a command to the instance that had been opened previously. The command requests opening the settings dialogue window. The first copy opens the dialogue window.

Syntax:

--settings

Example:

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

# --start

The command line option for Room Manager. This command uses TrueConfRoomService service/daemon to launch selected applications and start tracking them if they had been previously terminated with the --stop command.

Rules:

  • TrueConfRoomService daemon/service has to be started.
  • Room Manager starts and sends the command to TrueConfRoomService. The command requests that certain applications should be displayed and tracked. Then, Room Manager is closed.

Syntax:

--start

Example:

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

# --stop

The option for the Room Manager command line. This option ensures that the selected applications are stopped by TrueConfRoomService and no longer tracked.

Rules:

  • TrueConfRoomService daemon/service has to be started.
  • Room Manager starts and sends the command to TrueConfRoomService. The command requests that certain applications should no longer be displayed and tracked. Then, Room Manager is closed.

Syntax:

--stop

Example:

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

# --restart

The command line option for Room manager. This option is needed for stopping or starting the selected application with the help of TrueConfRoomService daemon/service.

Rules:

  • TrueConfRoomService daemon/service has to be started.
  • Room Manager launches and requests TrueConfRoomService to stop and start the selected applications. Then, Room Manager is closed.

Syntax:

--restart

Example:

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