Add documentation to non experimental AutomaticGainControl

RustAudio · Oct 1, 2024 · 2610a27 · 2610a27
1 parent af210a6
commit 2610a27
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/source/agc.rs b/src/source/agc.rs
@@ -59,6 +59,10 @@ pub struct AutomaticGainControl<I> {
 }
 
 #[cfg(not(feature = "experimental"))]
+/// Automatic Gain Control filter for maintaining consistent output levels.
+///
+/// This struct implements an AGC algorithm that dynamically adjusts audio levels
+/// based on both **peak** and **RMS** (Root Mean Square) measurements.
 #[derive(Clone, Debug)]
 pub struct AutomaticGainControl<I> {
     input: I,