diff options
author | Johannes Schickel | 2010-01-10 15:42:22 +0000 |
---|---|---|
committer | Johannes Schickel | 2010-01-10 15:42:22 +0000 |
commit | bfed78a5dbd1b7f528691f972757549eb5fcc6d4 (patch) | |
tree | 30c6face89ff5b02aecdd3c85449a5f30a0a67d5 /sound/audiostream.h | |
parent | 59471e3f4352396ba2e78c161b006e3d36e11682 (diff) | |
download | scummvm-rg350-bfed78a5dbd1b7f528691f972757549eb5fcc6d4.tar.gz scummvm-rg350-bfed78a5dbd1b7f528691f972757549eb5fcc6d4.tar.bz2 scummvm-rg350-bfed78a5dbd1b7f528691f972757549eb5fcc6d4.zip |
Add some more comments.
svn-id: r47229
Diffstat (limited to 'sound/audiostream.h')
-rw-r--r-- | sound/audiostream.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/sound/audiostream.h b/sound/audiostream.h index 003fef64f7..1788561510 100644 --- a/sound/audiostream.h +++ b/sound/audiostream.h @@ -295,9 +295,22 @@ private: Timestamp _pos, _length; }; +/** + * Creates a audio stream, which plays the given raw data. + * + * @param ptr Data + * @param len Length of the data (in bytes!) + * @param rate The sample rate of the data. + * @param flags Flags combination. + * @see Mixer::RawFlags + * @return The new SeekableAudioStream (or 0 on failure). + */ SeekableAudioStream *makeLinearInputStream(const byte *ptr, uint32 len, int rate, byte flags); /** + * NOTE: + * This API is considered deprecated. + * * Factory function for a raw linear AudioStream, which will simply treat all * data in the buffer described by ptr and len as raw sample data in the * specified format. It will then simply pass this data directly to the mixer, @@ -317,10 +330,27 @@ struct LinearDiskStreamAudioBlock { int32 len; ///< Length of the block (in samples) }; +/** + * Creates a audio stream, which plays from given stream. + * + * @param stream Stream to play from + * @param block Pointer to an LinearDiskStreamAudioBlock array + * @see LinearDiskStreamAudioBlock + * @param numBlocks Number of blocks. + * @param rate The rate + * @param len Length of the data (in bytes!) + * @param flags Flags combination. + * @see Mixer::RawFlags + * @param disposeStream Wheter the "stream" object should be destroyed after playback. + * @return The new SeekableAudioStream (or 0 on failure). + */ SeekableAudioStream *makeLinearDiskStream(Common::SeekableReadStream *stream, LinearDiskStreamAudioBlock *block, int numBlocks, int rate, byte flags, bool disposeStream); /** + * NOTE: + * This API is considered deprecated. + * * Factory function for a Linear Disk Stream. This can stream linear (PCM) * audio from disk. The function takes an pointer to an array of * LinearDiskStreamAudioBlock which defines the start position and length of |