Click on the Server icon at the top left of the Agent UI and "Edit Devices" under Devices. Choose the device you want to edit and click the Edit icon . Alternatively, click the microphone in the Live View to select it and click the edit icon on the bottom toolbar (or press the shortcut key "E"). On Desktop you can right click the Microphone on the Live View (or anywhere in Agent where there is a live thumbnail like the time line).

This is the main interface for configuring your devices. The top displays your object ID (in this case, 15), device name (Office) and then on the right the main device menu which gives you access to all the areas you can configure (which we call tabs). The * next to some of the settings means that changing this applies straight away (without clicking OK).


This tab gives you access to general and frequently used settings.

  • Name: Give your microphone a descriptive name like "Office" or "Back Yard"
  • Location: Click the button to manage locations. You can add locations like "Main House" and assign a color to them. When devices are assigned to locations they will be color coded in the live view.
  • Groups: This is used in permissions
  • Source Type: Choose how Agent connects to your devices. See Audio Source Types
  • Enabled: Controls if the microphone is switched on or off in Agent.
  • Schedule: Controls if the scheduler is enabled or not. If the scheduler is disabled no scheduled events will be triggered.
  • MQTT Events: This enables/ disables the automatic MQTT events packets that Agent can send to your MQTT server (so you don't need to configure it all manually) - requires an MQTT server to be configured.
  • Display Style: This controls how the microphone renders in the live view - you can choose from Analyzer, which is a spectrum analyser, Level, which shows the overall volume level and Historical which shows a historical volume level graph.
  • Color: Choose a color for the audio bars.
  • Trigger Color: Choose a color for the trigger points (volume level that triggers audio detection).
  • Back Color: Choose a background color for the audio overlay.
  • Device Color: This color is used in the time machine view to link the timeline to the playback view.


Tell Agent what to do when various events occur like Alerts or devices turned off or recordings finished etc. See Actions


Alerts are generated by motion detection and plugins. See Alerts


  • Provider: Which cloud provider to upload to - see - Settings - Cloud to configure cloud providers. More info
  • Path: This is the path that Agent will upload to. For example [MEDIATYPE]/[NAME] will upload video to Video/somefilename.mp4 (the actual filename is set on the recording tab)
  • Upload Recordings: Check this to automatically upload recordings


The sound detector listens for increases in volume. Sound over the lower limit is highlighted in red so you can easily tell what is causing alerts.

  • Enabled: Turn on or off the sound detector.
  • Sensitivity: This controls the amount of sound required to trigger sound detection. You can set minimum and maximum values. The numbers shown under the slider are the percentage of the maximum volume range.
  • Gain: This is a multiplier for the detected volume which lets you make sound detection more sensitive or less.
  • Motion Timeout: How long to keep the microphone in a motion state after sound detection stops (seconds,1 - 60, default is 3).


Agent supports both video and audio plugins. Plugins provide a way for external applications to process video and audio in real time and raise alerts and detection events. You can install plugins via the remote website portal ( in - Plugins. To create your own plugins See Plugins.


Agent can record video on sound detection, alert, manual command or schedule.

  • Mode: Choose from Alert, Detect or None. Alert will only record when sound detection causes an Alert event (see Alerts). Detect will record whenever Agent detects sound. None will record only when manually commanded or via the schedule.
  • Filename: Enter a template filename excluding the file type extension (eg .mp3) - Agent will add the extension depending on which encoder it is using. It's best to leave the default filename here which is {id}_{0:yyyy-MM-dd_HH-mm-ss_fff}. You can also use the tags {itype} (the type ID - 1 = microphone, 2 = camera) and {name} - the device name.
  • Max Record Time: The maximum amount of time to record for. Once this is reached Agent will finish the recording and start a new recording.
  • Min Record Time: The minimum amount of time to record for.
  • Inactivity Timeout: If the recording was triggered by motion or alert this controls how long to continue recording for when motion is no longer detected.
  • Trigger Timeout: If the device is recording from a "Trigger Recording" action, how long to keep recording for. This timer resets with every action call to trigger recording. (v4.3.7.0+)
  • Buffer: How much time in seconds to buffer video from the microphone. This is basically pre-record and the video gets dumped to disk when the recording starts.


Add schedule entries to enable or disable the microphone, start and stop recording and modify many other settings on a weekly calendar.

Tip: If you enable "Apply Schedule at Start" in - Settings - General then Agent will work out what states your devices should be in according to the schedule and apply those settings to them when it starts. Otherwise Agent will start with the devices in the state they were last in.

Click Add to add a new schedule entry:

  • Enabled: Check this to make this schedule entry active. In the Schedule summary active entries have a green tick next to them whereas inactive entries have an X next to them.
  • Time: Select a local time to run the schedule entry
  • Days: Select which days of the week to run the schedule. Selected days are highlighted.
  • Command: Choose a command to run. These are quite self explanatory except for perhaps Alert Action Run. Alert Action Run enables you to schedule alert actions to run at specific times. See Actions.


See Storage Settings

AI Services

Audio Recognition:

See Audio Recognition