From d0ec859de8b2a0e3740028e4be6670246d8f135a Mon Sep 17 00:00:00 2001 From: Tim Janik Date: Sun, 1 Oct 2023 03:01:47 +0200 Subject: [PATCH] ASE: engine.hh: document engine lifetime Signed-off-by: Tim Janik --- ase/engine.hh | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ase/engine.hh b/ase/engine.hh index 3ba54046..ecc8d136 100644 --- a/ase/engine.hh +++ b/ase/engine.hh @@ -11,6 +11,9 @@ namespace Ase { class AudioEngineThread; /** Main handle for AudioProcessor administration and audio rendering. + * Use make_audio_engine() to create a new engine and start_threads() to run + * its synthesis threads. AudioEngine objects cannot be deleted, because other + * ref-counted objects may hold `AudioEngine&` members until after main(). * Use async_jobs to have the engine execute arbitrary code. * Use const_jobs for synchronous read-only data gathering, this may take quite long. * Use main_rt_jobs (see main.hh) for obstruction free enqueueing of main_loop callbacks.