ref: 4d478ebe2743f3cfb97625ab2b232853822c7ff9
parent: 1bc9773d55db7b602e75059a38f4a77beccbc6f0
author: Erik de Castro Lopo <erikd@mega-nerd.com>
date: Tue Mar 11 10:42:18 EDT 2008
doc/api_simple.html : Try once again to convince people that src_simple cannot be used on small chunks of a larger piece of audio.
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-03-11 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
+
+ * doc/api_simple.html
+ Try once again to convince people that src_simple cannot be used on small
+ chunks of a larger piece of audio.
+
2008-03-08 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* tests/snr_bw_test.c
--- a/doc/api_simple.html
+++ b/doc/api_simple.html
@@ -54,7 +54,22 @@
<DIV CLASS="block">
<H1><B>Simple API</B></H1>
+
<P>
+<B>Important Note:</B>
+The simple API is not designed to work on small chunks of a larger piece of
+audio.
+If you attempt to use it this way you are doing it wrong and will not get the
+results you want.
+For processing audio data in chunks you <b>must</b> use the
+ <a href="api_full.html">full api</a>
+or the
+ <a href="api_callback.html">callback based api</a>.
+</P>
+
+<br/><br/>
+
+<P>
The simple API consists of a single function :
</P>
<PRE>
@@ -128,12 +143,4 @@
</BODY>
</HTML>
-
-<!--
- Do not edit or modify anything in this comment block.
- The arch-tag line is a file identity tag for the GNU Arch
- revision control system.
-
- arch-tag: 935c1734-00b4-42fb-998e-36b9136d405b
--->