Monitor - norihiro/obs-face-tracker GitHub Wiki

Face Tracker Monitor

Version 0.5.1 adds a source that displays face detection and tracking status. In the monitor source, you can watch the tracking status without affecting program. It will be useful to combine with obs-source-dock.

How to add

To add the source, you have three options described below.

A. Add through obs-websocket

1. Install obs-websocket.
2. Send this command

CreateSource {"sourceName": "Face Tracker Monitor", "sourceKind": "face_tracker_monitor", "sceneName": "Scene"}

B. Editing scene collection file

1. Start OBS Studio and add a source named Face Tracker Monitor (any type is ok.) You don't need to change any settings.
2. Close OBS Studio
3. Find your scene-collection file. For Linux, ~/.config/obs-studio/basic/scenes/Untitled.json is the default location. Description below uses this path. For Windows, %AppData%/obs-studio/basic/scenes/Untitled.json is the default location. For macOS, ~/Library/Application Support/obs-studio/basic/scenes/Untitled.json is the default location. The scene collection name will change if you rename your scene-collection on OBS Studio.
4. Format the scene-collection file.

   python3 -mjson.tool < ~/.config/obs-studio/basic/scenes/Untitled.json > a.json
   

5. Open a.json by your favorite editor.
6. Find Face Tracker Monitor.
7. Change id and versioned_id in the source to face_tracker_monitor. Below is the example (other settigns are omitted.).

   {
     "id": "face_tracker_monitor",
     "name": "Face Tracker Monitor",
     "versioned_id": "face_tracker_monitor",
     "volume": 1.0
   }
   

8. Backup your scene-collection file and put the edited file.

   cp ~/.config/obs-studio/basic/scenes/Untitled.json ~/.config/obs-studio/basic/scenes/Untitled.json-ftmon
   cp a.json ~/.config/obs-studio/basic/scenes/Untitled.json
   

9. Open OBS Studio
10. Just in case something were wrong, revert the backup file.

cp ~/.config/obs-studio/basic/scenes/Untitled.json-ftmon ~/.config/obs-studio/basic/scenes/Untitled.json

11. Open the settings of the source Face Tracker Monitor and change your settings. You have to type source name and filter name exactly same as your source you want to monitor.

C. Compile with ENABLE_MONITOR_USER

Instead of using obs-websocket or editing the file, you can enable menu item by a build option. Add -DENABLE_MONITOR_USER=ON to cmake option.

Future plan

Implementation of dock is in progress. Once the dock is implemented, the monitor source will be available on the dock.