mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-08-02 09:02:15 +03:00
64 lines
2.1 KiB
Markdown
64 lines
2.1 KiB
Markdown
---
|
|
id: audio_detectors
|
|
title: Audio Detectors
|
|
---
|
|
|
|
Frigate provides a builtin audio detector which runs on the CPU. Compared to object detection in images, audio detection is a relatively lightweight operation so the only option is to run the detection on a CPU.
|
|
|
|
## Configuration
|
|
|
|
Audio events work by detecting a type of audio and creating an event, the event will end once the type of audio has not been heard for the configured amount of time. Audio events save a snapshot at the beginning of the event as well as recordings throughout the event. The recordings are retained using the configured recording retention.
|
|
|
|
### Enabling Audio Events
|
|
|
|
Audio events can be enabled for all cameras or only for specific cameras.
|
|
|
|
```yaml
|
|
|
|
audio: # <- enable audio events for all camera
|
|
enabled: True
|
|
|
|
cameras:
|
|
front_camera:
|
|
ffmpeg:
|
|
...
|
|
audio:
|
|
enabled: True # <- enable audio events for the front_camera
|
|
```
|
|
|
|
If you are using multiple streams then you must set the `audio` role on the stream that is going to be used for audio detection, this can be any stream but the stream must have audio included.
|
|
|
|
:::note
|
|
|
|
The ffmpeg process for capturing audio will be a separate connection to the camera along with the other roles assigned to the camera, for this reason it is recommended that the go2rtc restream is used for this purpose. See [the restream docs](/configuration/restream.md) for more information.
|
|
|
|
:::
|
|
|
|
```yaml
|
|
cameras:
|
|
front_camera:
|
|
ffmpeg:
|
|
inputs:
|
|
- path: rtsp://.../main_stream
|
|
roles:
|
|
- record
|
|
- path: rtsp://.../sub_stream # <- this stream must have audio enabled
|
|
roles:
|
|
- audio
|
|
- detect
|
|
```
|
|
|
|
### 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.
|
|
|
|
```yaml
|
|
audio:
|
|
enabled: True
|
|
listen:
|
|
- bark
|
|
- scream
|
|
- speech
|
|
- yell
|
|
```
|