Skip to main content
Version: 2.4.0 (latest)

Regions of Interest (ROI)

Region of Interest (ROI) is an area marked over the video stream. When people enter this marked area, OMNI Agent will detect their faces and silhouettes, identify them (if their faces are in the database) and track their positions. Recognition and tracking results will be automatically sent to OMNI Platform or a third-party service in the process format.

To create ROI, mark at least 3 points on the video stream. Empty ROI is highlighted in white on the camera preview. When a person gets into ROI, the color changes to turquoise.

How to Add ROI

  1. Click on the gear sign in the camera bar. Then click "+" in the upper right corner of the opened tab.


  1. Fill in the ROI name, select a "Region*" type and mark the region of interest on the camera preview. After filling, click "Save".


  1. Return to the main page of the web interface. Now the marked area is displayed on the camera preview.


ROI Configuration

Also, you can add ROI or change ROI settings in the run_params.json configuration file by editing the following fields of the mutlistream_ROI object:

  • force_track_termination_on_lost_event: If the field is disabled, a person's track continues, even if the person leaves the camera's field of view for some time (For example, if there are obstacles in the camera's field of view).

  • regions: array of objects (regions of interest)

An example of an object in the regions array:

"regions": [
{ // object (ROI)
"name": "_region_name_", // ROI name
"points": [ // coordinates of ROI bounding points
"x": 0,
"y": 0.975 // in relative frame coordinates
"x": 1,
"y": 0.975
"x": 0.5,
"y": 0.5
"uuid": "6acb27c7-c967-46ed-a32f-0085c0454c4c" // ROI uuid. Added automatically if absent.