Skip to content

Commit

Permalink
Add docs for audio volume config (#7807)
Browse files Browse the repository at this point in the history
* Add docs for audio volume

* fix typo
  • Loading branch information
NickM-27 authored Sep 21, 2023
1 parent fd9196a commit 4a65795
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/docs/configuration/audio_detectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@ cameras:
- detect
```

### Configuring Minimum Volume

The audio detector uses volume levels in the same way that motion in a camera feed is used for object detection. This means that frigate will not run audio detection unless the audio volume is above the configured level in order to reduce resource usage. Audio levels can vary widelely between camera models so it is important to run tests to see what volume levels are. MQTT explorer can be used on the audio topic to see what volume level is being detected.

:::tip

Volume is considered motion for recordings, this means when the `record -> retain -> mode` is set to `motion` any time audio volume is > min_volume that recording segment for that camera will be kept.

:::

### Configuring Audio Events

The included audio model has over [500 different types](https://github.com/blakeblackshear/frigate/blob/dev/audio-labelmap.txt) of audio that can be detected, many of which are not practical. By default `bark`, `fire_alarm`, `scream`, `speech`, and `yell` are enabled but these can be customized.
Expand Down

0 comments on commit 4a65795

Please sign in to comment.