doc/command.html : Document SFC_RAW_NEEDS_ENDSWAP.

This commit is contained in:
Erik de Castro Lopo 2008-01-20 19:29:54 +11:00
parent b72f03928a
commit 968f2e5dd0
2 changed files with 38 additions and 0 deletions

View File

@ -12,6 +12,9 @@
* tests/command.c
Add test for SFC_RAW_NEEDS_ENDSWAP.
* doc/command.html
Document SFC_RAW_NEEDS_ENDSWAP.
2008-01-09 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* examples/sndfile-cmp.c

View File

@ -190,6 +190,11 @@
<TD>Set the the Variable Bit Rate encoding quality</TD>
</TR>
<TR>
<TD><A HREF="#SFC_RAW_NEEDS_ENDSWAP">SFC_RAW_NEEDS_ENDSWAP</a></td>
<TD>Determine if raw data needs endswapping</TD>
</TR>
<!--
<TR>
<TD><A HREF="#add-dither">add dither</A></TD>
@ -1286,6 +1291,36 @@ The command must be sent before any audio data is written to the file.
<DD>Zero on success, non-zero otherwise.
</DL>
<!-- ========================================================================= -->
<A NAME="SFC_RAW_NEEDS_ENDSWAP"></A>
<H2><BR><B>SFC_RAW_NEEDS_ENDSWAP</B></H2>
<P>
Determine if raw data read using
<a href="api.html#raw">
sf_read_raw</a>
needs to be end swapped on the host CPU.
</P>
<P>
For instance, will return SF_TRUE on when reading WAV containing
SF_FORMAT_PCM_16 data on a big endian machine and SF_FALSE on a little endian
machine.
</P>
<P>
Parameters:
<PRE>
sndfile : A valid SNDFILE* pointer
cmd : SFC_SET_VBR_ENCODING_QUALITY
data : NULL
datasize : 0
</PRE>
<P>
</P>
<DL>
<DT>Return value: </DT>
<DD>SF_TRUE or SF_FALSE
</DL>
<!-- ========================================================================= -->