summaryrefslogtreecommitdiffstats
path: root/ingen/EngineBase.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'ingen/EngineBase.hpp')
-rw-r--r--ingen/EngineBase.hpp8
1 files changed, 7 insertions, 1 deletions
diff --git a/ingen/EngineBase.hpp b/ingen/EngineBase.hpp
index 6bcb7170..c9acb512 100644
--- a/ingen/EngineBase.hpp
+++ b/ingen/EngineBase.hpp
@@ -48,8 +48,14 @@ public:
/**
Process audio for @p sample_count frames.
+
+ If the return value is non-zero, events have been processed and are
+ awaiting to be finalised (including responding and announcing any changes
+ to clients) via a call to main_iteration().
+
+ @return The number of events processed.
*/
- virtual void run(uint32_t sample_count) = 0;
+ virtual unsigned run(uint32_t sample_count) = 0;
/**
Indicate that a quit is desired.