Mercurial > hg > svcore

diff data/fileio/AudioFileReader.h @ 989:c9d456b1fcde

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Comment only
author Chris Cannam
date Fri, 03 Oct 2014 09:29:11 +0100
parents 59e7fe1b1003
children 36f79bc5c3d7
line wrap: on
line diff
--- a/data/fileio/AudioFileReader.h	Wed Oct 01 14:06:28 2014 +0100
+++ b/data/fileio/AudioFileReader.h	Fri Oct 03 09:29:11 2014 +0100
@@ -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