[Scummvm-cvs-logs] SF.net SVN: scummvm:[47229] scummvm/trunk/sound/audiostream.h

[lordhoto at users.sourceforge.net]

Revision: 47229
          http://scummvm.svn.sourceforge.net/scummvm/?rev=47229&view=rev
Author:   lordhoto
Date:     2010-01-10 15:42:22 +0000 (Sun, 10 Jan 2010)

Log Message:
-----------
Add some more comments.

Modified Paths:
--------------
    scummvm/trunk/sound/audiostream.h

Modified: scummvm/trunk/sound/audiostream.h
===================================================================
--- scummvm/trunk/sound/audiostream.h	2010-01-10 15:30:31 UTC (rev 47228)
+++ scummvm/trunk/sound/audiostream.h	2010-01-10 15:42:22 UTC (rev 47229)
@@ -295,9 +295,22 @@
 	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 @@
 	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


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.