From ca5bc067a74937804afe05a29b3272221bbab058 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 14 Sep 2023 10:57:56 -0600 Subject: [PATCH] Add docs for audio volume --- docs/docs/configuration/audio_detectors.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/docs/configuration/audio_detectors.md b/docs/docs/configuration/audio_detectors.md index 3e5fafdf8..37b0fc278 100644 --- a/docs/docs/configuration/audio_detectors.md +++ b/docs/docs/configuration/audio_detectors.md @@ -48,6 +48,16 @@ cameras: - detect ``` +### Conciguring 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`, `speech`, `yell`, and `scream` are enabled but these can be customized.