Note that readframes() returns data in linear format, even if the original

is encoded in u-LAW format.  Based on suggestion from Anthony Baxter
<anthony_baxter@users.sourceforge.net>.

This closes bug #122273.

1 files changed, 3 insertions, 1 deletions

diff --git a/Doc/lib/libsunau.tex b/Doc/lib/libsunau.tex
index e0db04d..58aa460 100644
--- a/Doc/lib/libsunau.tex
+++ b/Doc/lib/libsunau.tex
@@ -127,7 +127,9 @@ equivalent to output of the \method{get*()} methods.
 \end{methoddesc}
 
 \begin{methoddesc}[AU_read]{readframes}{n}
-Reads and returns at most \var{n} frames of audio, as a string of bytes.
+Reads and returns at most \var{n} frames of audio, as a string of
+bytes.  The data will be returned in linear format.  If the original
+data is in u-LAW format, it will be converted.
 \end{methoddesc}
 
 \begin{methoddesc}[AU_read]{rewind}{}