diff options
| author | Max Horn | 2006-03-03 15:36:12 +0000 |
|---|---|---|
| committer | Max Horn | 2006-03-03 15:36:12 +0000 |
| commit | a836a83d84b26fd75fab7637641f77334b5e6827 (patch) | |
| tree | b3a39c480ebd9c2164423737a37473962ec84b00 /sound/mp3.h | |
| parent | a1a6967d76fc3cc8d43b2994d24a2b16a8192277 (diff) | |
| download | scummvm-rg350-a836a83d84b26fd75fab7637641f77334b5e6827.tar.gz scummvm-rg350-a836a83d84b26fd75fab7637641f77334b5e6827.tar.bz2 scummvm-rg350-a836a83d84b26fd75fab7637641f77334b5e6827.zip | |
Explain the (admittedly strange) usage of some of our makeXXXStream factory functions
svn-id: r21040
Diffstat (limited to 'sound/mp3.h')
| -rw-r--r-- | sound/mp3.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/sound/mp3.h b/sound/mp3.h index 3ff5576330..db4f0cec6d 100644 --- a/sound/mp3.h +++ b/sound/mp3.h @@ -36,6 +36,12 @@ namespace Common { DigitalTrackInfo *getMP3Track(int track); +/** + * Create a new AudioStream from the MP3 data in the given + * file. If you only want to play part of that file, then seek + * to the start position in file before passing it to this + * factory function, and specify the appropriate size. + */ AudioStream *makeMP3Stream(Common::File *file, uint32 size); #endif |