Mercurial > hg > svcore

diff data/fileio/AudioFileReader.h @ 1007:ba404199345f tonioni

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge from default branch
author Chris Cannam
date Mon, 10 Nov 2014 09:19:49 +0000
parents c9d456b1fcde
children 36f79bc5c3d7
line wrap: on
line diff
--- a/data/fileio/AudioFileReader.h	Tue Sep 09 16:36:21 2014 +0100
+++ b/data/fileio/AudioFileReader.h	Mon Nov 10 09:19:49 2014 +0000
@@ -75,7 +75,9 @@
     /** 
      * Return interleaved samples for count frames from index start.
      * The resulting sample block will contain count *
-     * getChannelCount() samples (or fewer if end of file is reached).
+     * getChannelCount() samples (or fewer if end of file is
+     * reached). The caller does not need to allocate space and any
+     * existing content in the SampleBlock will be erased.
      *
      * The subclass implementations of this function must be
      * thread-safe -- that is, safe to call from multiple threads with