doc/api.html : Discourage the use of sf_read/write_raw().

This commit is contained in:
Erik de Castro Lopo 2010-01-05 17:54:25 +11:00
parent 66e72fb912
commit 07611d9755
2 changed files with 11 additions and 0 deletions

View File

@ -1,3 +1,8 @@
2010-01-05 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* doc/api.html
Discourage the use of sf_read/write_raw().
2009-12-28 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* configure.ac

View File

@ -549,6 +549,12 @@ same as the frames parameter).
sf_count_t sf_write_raw (SNDFILE *sndfile, void *ptr, sf_count_t bytes) ;
</PRE>
<P>
<b>Note:</b> Unless you are writing an external decoder/encode that uses
libsndfile to handle the file headers, you should not be using these
functions.
</P>
<P>
The raw read and write functions read raw audio data from the audio file (not to be
confused with reading RAW header-less PCM files). The number of bytes read or written