AudioPlayer documentation

pschatzmann · Nov 5, 2024 · aacd78d · aacd78d
1 parent 740b2a6
commit aacd78d
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/AudioTools/CoreAudio/AudioPlayer.h b/src/AudioTools/CoreAudio/AudioPlayer.h
@@ -240,13 +240,13 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
 
   virtual AudioInfo audioInfo() override { return info; }
 
-  /// starts / resumes the playing after calling stop()
+  /// starts / resumes the playing after calling stop(): same as setActive(true)
   virtual void play() {
     TRACED();
     setActive(true);
   }
 
-  /// halts the playing
+  /// halts the playing: same as setActive(false)
   virtual void stop() {
     TRACED();
     setActive(false);