aboutsummaryrefslogtreecommitdiff
path: root/sound/vorbis.h
diff options
context:
space:
mode:
Diffstat (limited to 'sound/vorbis.h')
-rw-r--r--sound/vorbis.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/sound/vorbis.h b/sound/vorbis.h
index 0e7b715927..ee8943cdde 100644
--- a/sound/vorbis.h
+++ b/sound/vorbis.h
@@ -36,6 +36,12 @@ namespace Common {
DigitalTrackInfo *getVorbisTrack(int track);
+/**
+ * Create a new AudioStream from the Vorbis 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 *makeVorbisStream(Common::File *file, uint32 size);
#endif