summaryrefslogtreecommitdiff
path: root/modules/vumeter
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-11-29 09:48:26 +0100
committerAlfred E. Heggestad <aeh@db.org>2015-11-29 09:48:26 +0100
commit3e04c639549873f752dc077d8a0e5cf58fa12c7b (patch)
treece203c05017199b19ed63454dbad16a934efaeac /modules/vumeter
parent8497126045f34963b04e79cd900f82049a857f37 (diff)
modules: update documentation header
Diffstat (limited to 'modules/vumeter')
-rw-r--r--modules/vumeter/vumeter.c11
1 files changed, 11 insertions, 0 deletions
diff --git a/modules/vumeter/vumeter.c b/modules/vumeter/vumeter.c
index 827bde2..efefa23 100644
--- a/modules/vumeter/vumeter.c
+++ b/modules/vumeter/vumeter.c
@@ -9,6 +9,17 @@
#include <baresip.h>
+/**
+ * @defgroup vumeter vumeter
+ *
+ * Simple ASCII VU-meter for the audio-signal.
+ *
+ * The Volume unit (VU) meter module takes the audio-signal as input
+ * and prints a simple ASCII-art bar for the recording and playback levels.
+ * It is using the aufilt API to get the audio samples.
+ */
+
+
struct vumeter_enc {
struct aufilt_enc_st af; /* inheritance */
struct tmr tmr;