Skip to content

Commit

Permalink
ASE: engine.hh: document engine lifetime
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Janik <[email protected]>
  • Loading branch information
tim-janik committed Oct 1, 2023
1 parent 4459649 commit d0ec859
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions ase/engine.hh
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d0ec859

Please sign in to comment.