diff options
author | Max Horn | 2007-02-20 16:13:45 +0000 |
---|---|---|
committer | Max Horn | 2007-02-20 16:13:45 +0000 |
commit | 35b191bad982661d0f5b1ab105084ae55dcba606 (patch) | |
tree | d5f7b83b7c8422077de9a13302ac6048cd84f188 /sound/audiocd.h | |
parent | 270efc16e3414e551af484d24bc9ce84e4a2a0f4 (diff) | |
download | scummvm-rg350-35b191bad982661d0f5b1ab105084ae55dcba606.tar.gz scummvm-rg350-35b191bad982661d0f5b1ab105084ae55dcba606.tar.bz2 scummvm-rg350-35b191bad982661d0f5b1ab105084ae55dcba606.zip |
Document AudioCDManager::play
svn-id: r25742
Diffstat (limited to 'sound/audiocd.h')
-rw-r--r-- | sound/audiocd.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/sound/audiocd.h b/sound/audiocd.h index b23942c9f5..5b9c05355c 100644 --- a/sound/audiocd.h +++ b/sound/audiocd.h @@ -51,6 +51,16 @@ public: int numLoops; }; + /** + * Start playback of the specified "CD" track. This method mimics + * the interface of OSystem::playCD (which it in fact may call, if an Audio CD is + * present), but also can play digital audio tracks in various formats. + * + * @param track the track to play. + * @param num_loops how often playback should be repeated (-1 = infinitely often). + * @param start_frame the frame at which playback should start (75 frames = 1 second). + * @param duration the number of frames to play (0: play until end) + */ void play(int track, int numLoops, int startFrame, int duration); void stop(); bool isPlaying() const; |