Configure Video Recorder

The FindFace core internal architecture allows for embedding Video Recorder, an additional functionality that records, stores, and plays back video data from cameras.

If Video Recorder is installed during FindFace Multi automated deployment from the installer, then its tools are already available in FindFace Multi web interface. If you skipped this step during installation, first deploy Video Recorder, then enable and configure it by following this instruction.

In this section:

Enable Video Recorder

To enable Video Recorder, do the following:

  1. Enable the findface-video-worker service to transfer video chunks to the findface-video-storage service.

    Important

    This setting makes the Video Recorder functionality available over HTTP API. It’s also obligatory if you want to harness Video Recorder as part of the FindFace Multi web interface.

    Do the following:

    1. Open the /opt/findface-multi/configs/findface-video-worker/findface-video-worker.yaml configuration to enable findface-video-worker service that will supply Video Recorder with the video.

      sudo vi /opt/findface-multi/configs/findface-video-worker/findface-video-worker.yaml
      
    2. Set enabled: true in the recorder section.

      recorder:
        enabled: true
        ...
      
    3. Restart findface-multi-findface-video-worker-1 container.

      sudo docker restart findface-multi-findface-video-worker-1
      
  2. Configure Video Recorder to work as part of FindFace Multi web interface.

    Note

    Omit the following steps if you do not need the Video Recorder tools to appear in the FindFace Multi web interface.

    Do the following:

    1. Open the /opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml configuration file.

      sudo vi /opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml
      
    2. Set enabled: true in the vms section.

      vms:
        enabled: true
      
    3. Restart all FindFace Multi containers.

      cd /opt/findface-multi/
      
      sudo docker-compose restart
      

    In the /opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml configuration file, you may configure the vms and the video_player parameters.

    The list of vms parameters available for configuration is as follows:

    Parameter

    Description

    vmsenabled

    If true, adds the Record video checkbox to the camera settings and enables event viewing in the video player timeline.

    The list of video_player parameters available for configuration is as follows:

    Parameter

    Description

    overlayobjects

    Defines whether to display bbox and attributes with their values for the objects faces, bodies, cars. Set true or false to enable/disable bbox and attributes display for the relevant objects.

    overlaygdpr

    Set true to enable blurring all unmatched objects displayed in the video player. To fully comply with the personal data protection laws, follow this guide.

    timelinemin_zoom

    Defines the largest possible scale on the video player timeline, seconds per pixel.

    timelinemax_zoom

    Defines the smallest possible scale on the timeline, seconds per pixel.

    timelineobjectseventsfacesenabled

    Set true to enable marking face events on the timeline.

    timelineobjectseventsfaceslimit

    The maximum number of face events simultaneously marked on the timeline. If there are more face events than that, you will be asked to zoom in.

    timelineobjectseventsfacesmatchedColor

    Color of the matched face events.

    timelineobjectseventsfacesunmatchedColor

    Color of the unmatched face events.

    timelineobjectseventsbodiesenabled

    Set true to enable marking body events on the timeline.

    timelineobjectseventsbodieslimit

    The maximum number of body events simultaneously marked on the timeline. If there are more body events than that, you will be asked to zoom in.

    timelineobjectseventsbodiesmatchedColor

    Color of the matched body events.

    timelineobjectseventsbodiesunmatchedColor

    Color of the unmatched body events.

    timelineobjectseventscarsenabled

    Set true to enable marking vehicle events on the timeline.

    timelineobjectseventscarslimit

    The maximum number of vehicle events simultaneously marked on the timeline. If there are more vehicle events than that, you will be asked to zoom in.

    timelineobjectseventscarsmatchedColor

    Color of the matched vehicle events.

    timelineobjectseventscarsunmatchedColor

    Color of the unmatched vehicle events.

    timelineobjectsepisodeshumansenabled

    Set true to enable marking human episodes on the timeline.

    timelineobjectsepisodeshumanslimit

    The maximum number of humans episodes simultaneously marked on the timeline. If there are more face episodes than that, you will be asked to zoom in.

    timelineobjectsepisodeshumansmatchedColor

    Color of the matched human episodes.

    timelineobjectsepisodeshumansunmatchedColor

    Color of the unmatched human episodes.

    timelineobjectsepisodescarsenabled

    Set true to enable marking vehicle episodes on the timeline.

    timelineobjectsepisodescarslimit

    The maximum number of vehicle episodes simultaneously marked on the timeline. If there are more vehicle episodes than that, you will be asked to zoom in.

    timelineobjectsepisodescarsmatchedColor

    Color of the matched vehicle episodes.

    timelineobjectsepisodescarsunmatchedColor

    Color of the unmatched vehicle episodes.

    video_player:
      overlay:
        objects:
          faces:
            bbox: true
            info: true
          bodies:
            bbox: true
            info: true
          cars:
            bbox: true
            info: true
        gdpr: false
      timeline:
        min_zoom: 0.2
        max_zoom: 200
        objects:
          events:
            faces:
              enabled: true
              limit: 500
              matchedColor: rgba(6,193,103,0.8)
              unmatchedColor: rgba(232,92,74,0.8)
            bodies:
              enabled: false
              limit: 500
              matchedColor: rgba(6,193,103,0.8)
              unmatchedColor: rgba(232,92,74,0.8)
            cars:
              enabled: false
              limit: 500
              matchedColor: rgba(6,193,103,0.8)
              unmatchedColor: rgba(232,92,74,0.8)
          episodes:
            humans:
              enabled: false
              limit: 500
              matchedColor: rgba(6,193,103,0.8)
              unmatchedColor: rgba(232,92,74,0.8)
            cars:
              enabled: false
              limit: 500
              matchedColor: rgba(6,193,103,0.8)
              unmatchedColor: rgba(232,92,74,0.8)
    vms:
      enabled: true
    

Nuances of Disabling Video Recorder

If Video Recorder is running and recording video on selected cameras, and you need to disable it, be sure to disable video recording on the cameras first, before proceeding with the /opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml and /opt/findface-multi/configs/findface-video-worker/findface-video-worker.yaml configuration files.