Skip to main content

BriefCam VMS Integration Guide

Mirasys Integration

Last Updated: 4 minute read
LanguageEnglish

Integration Summary

VMS Partner 

Product 

Version 

Last Tested BriefCam Version 

Integration Level 

H.265 Support 

Additional License Required 

Mirasys

Mirasys VMS V9

9.9.2

2025 R1 (including Classic and Next-Gen engine)

Client integration (L3)

Yes

Yes. Request a VMS license from Mirasys with the "BriefCam" feature enabled.

Ports Required

The following ports should be available when installing the plugin.

Default Port # 

Description 

9000

VMS port. The port can be changed in the VMS and in the BriefCam.MirasysIntegration.ini file.

8083

Alerts API port. The port can be changed in the VMS and in the BriefCam.MirasysIntegration.ini

7001 and above

The cameras each come with a port from the range above 7000. These ports can be changed and are reflected in the MirasysCamerasMap.json file.

Installing the Mirasys Plugin and Connecting to the VMS

  • Install BriefCamMirasys9Plugin_<version number>.exe.

  1. After the installation is completed, open the BriefCam Administrator Console.

  2. In the BriefCam Administrator Console, open the Camera Management section.

    Camera Management full screen.png

  3. Click the Add directory button.

  4. From the Video Integration field, select Mirasys Integration

  5. In the Directory Name field, enter a name.

  6. Fill in the Address, User Name, and Password fields.

  7. Click Add.

Mirasys Settings in BriefCam

Mirasys config file.png

The BriefCam.MirasysIntegration.ini file (located by default at C:\Program Files\BriefCam\BriefCam Server\plugins) includes the following settings:

Setting 

Description 

ConnectionTimeoutSec 

General timeout for VMS connection in seconds.

DefaultPort 

Default port of the VMS connection.

AlertsPort 

Default port of the VMS Alarm Triggering API.

TrustAllCertificates 

Sets the default behavior for of SSL certificate trust.

FFmpegPath 

The path to the ffmpeg.exe file. Fetching for both continuous and motion detection recording is made using this file.

MotionDetectionGapSec 

As fetching is one continuous stream, this parameter defines a maximum gap in seconds between two timestamps. If this threshold is reached, a new recording file will be created.

LiveDelayMsec 

This is used when live streams are coming with a delay from the VMS.

LiveStreamWarmupFrameCount 

This is used to set the frames needed for stream warmup.

Rtsp 

To use the RTSP streams set this parameter to true.

RtspUser 

RTSP user setup in the VMS RTSP Server Streaming Settings.

RtspPassword 

Password of the RTSP user.

Setting Up Live Video Streaming

There are two options for live streaming from the VMS:

  1. SDK streams - SDK live streams work out-of-the box and require no set up.

  2. RTSP streams – preferred option for RESPOND rules. RTSP streams needs to be enabled in the in the integration's ini file as described in the section above and in the VMS as described in the section below.

VMS RTSP Settings

  1. Navigate to VMS Server -> Cameras –> RTSP Server Streaming.

  2. Select the Enabled check box for each camera that will use the RTSP streams.

  3. Create a new file and name it MirasysCamerasMap.json. This file will be used to map the cameras to their live stream.

  4. Fill in the list of cameras and their RTSP streams.

Each camera is its own object in the list of cameras, and it has two properties: the name of the camera and the live stream URL.

Mirasys streaming settings.png

The live stream URL is copied from the VMS RTSP page.

Mirasys camera map.png
Configuration of Alerts

To configure alerts you need to manually create a trigger and configure an alarm for every camera.

In System Manager go to VMS Servers -> Alarm Triggers, enable alarm triggering API and create a generic alarm trigger for every camera with the same name as the camera's name.

Mirasys alarm triggers.png

Go to VMS Servers -> Alarms and configure alarm for every trigger. Select thecorresponding trigger and configure actions. Enable alarm visibility for profile(s).

Mirasys alarm configuration.png
View Alerts in Spotter application

To see alerts in the client application go to View -> Alarms and click Show.

Mirasys Spotter 1.png

You will see the Alarms tab on the right side of the client application.

Mirasys Spotter 2.png

Mirasys Embedded Client Installation

The following section describes the installation and configuration that need to be performed to allow the BriefCam web client application to become embedded in the Mirasys Spotter application.

After installing the Mirasys plugin on the BriefCam Server, you are ready to install the Mirasys Embedded Client.

  1. On the same computer where the Mirasys Spotter application is installed, run the Embedded Integration Plugin Installation by right-clicking the BriefCamMirasys9EmbeddedPlugin_<Version_number>.exe file and selecting Run as administrator.

    Note that if you are using the latest Windows Update and a Windows Defender alert appears, click the More info link and click Run anyway.

    Windows protected your PC4.png

  2. After successful installation of the plugin, the plugin location can be verified in the pluginConfig.xml file. This file is located at: C:\Users\<Current user>\AppData\Roaming\DVMS\DVR Application.

    Mirasys DVR app.png

Logs for the Mirasys Embedded Client are located at: C:\Users\<Current user>\AppData\Roaming\DVMS\DVR Application\Logs\SpotterLog.txt.

Setup Embedded Client web address

The BriefCam address needs to be setup for the Embedded Client to work.

  1. In the Spotter, open: File -> Settings.

    Mirasys video synopsis.png

  2. In the Plugins tab, select BriefCam Synopsis and modify the Client address to point to BriefCam.

  3. After the setup is successful, when you open the Mirasys Spotter application, the login page of BriefCam will be shown.

    Mirasys BriefCam embedded.png