From d537561ffc60e5bed978bf8ac839f5a7c646f783 Mon Sep 17 00:00:00 2001 From: Johannes Lorenz Date: Mon, 22 Apr 2019 09:27:01 +0200 Subject: [PATCH] Document Effect::checkGate --- include/Effect.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/Effect.h b/include/Effect.h index 3d765fdc0..4dc50e8a4 100644 --- a/include/Effect.h +++ b/include/Effect.h @@ -161,6 +161,13 @@ public: protected: + /** + Effects should call this at the end of audio processing + + If the setting "Keep effects running even without input" is disabled, + after "decay" ms of a signal below "gate", the effect is turned off + and won't be processed again until it receives new audio input + */ void checkGate( double _out_sum ); virtual PluginView * instantiateView( QWidget * );