Document SFC_GET/SET_CLIPPING.

This commit is contained in:
Erik de Castro Lopo 2004-02-17 03:04:02 +00:00
parent a8a36a0843
commit a64e0c0f9c
3 changed files with 75 additions and 1 deletions

View File

@ -1,3 +1,8 @@
2004-02-17 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* doc/command.html
Document SFC_SET_CLIPPING and SFC_GET_CLIPPING.
2004-02-14 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* doc/*.html

View File

@ -3,7 +3,7 @@
dnl Require autoconf version
AC_PREREQ(2.54)
AC_INIT(libsndfile,1.0.6,<erikd@mega-nerd.com>)
AC_INIT(libsndfile,1.0.6,erikd@mega-nerd.com)
AC_CONFIG_SRCDIR([src/sndfile.c])
AC_CANONICAL_TARGET([])
AM_INIT_AUTOMAKE($PACKAGE_NAME,$PACKAGE_VERSION)

View File

@ -139,6 +139,16 @@
<TD>Change the data start offset for files opened up as SF_FORMAT_RAW.</TD>
</TR>
<TR>
<TD><A HREF="#SFC_SET_CLIPPING">SFC_SET_CLIPPING</A></TD>
<TD>Turn on/off automatic clipping when doing floating point to integer
conversion.</TD>
</TR>
<TR>
<TD><A HREF="#SFC_GET_CLIPPING">SFC_GET_CLIPPING</A></TD>
<TD>Retreive current clipping setting.</TD>
</TR>
<!--
@ -929,6 +939,65 @@ Example:
<DD>Zero on sucess, non-zero otherwise.
</DL>
<!-- ========================================================================= -->
<A NAME="SFC_SET_CLIPPING"></A>
<H2><BR><B>SFC_SET_CLIPPING</B></H2>
<P>
Turn on/off automatic clipping when doing floating point to integer conversion.
</P>
<P>
Parameters:
<PRE>
sndfile : A valid SNDFILE* pointer
cmd : SFC_SET_CLIPPING
data : NULL
datasize : SF_TRUE or SF_FALSE.
</PRE>
<P>
Turn on (datasize == SF_TRUE) or off (datasize == SF_FALSE) clipping.
</P>
<P>
Example:
</P>
<PRE>
sf_command (sndfile, SFC_SET_CLIPPING, NULL, SF_TRUE) ;
</PRE>
<DL>
<DT>Return value:</DT>
<DD>Clipping mode (SF_TRUE or SF_FALSE).
</DL>
<!-- ========================================================================= -->
<A NAME="SFC_GET_CLIPPING"></A>
<H2><BR><B>SFC_GET_CLIPPING</B></H2>
<P>
Turn on/off automatic clipping when doing floating point to integer conversion.
</P>
<P>
Parameters:
<PRE>
sndfile : A valid SNDFILE* pointer
cmd : SFC_GET_CLIPPING
data : NULL
datasize : 0
</PRE>
<P>
Retrieve the current cliiping setting.
</P>
<P>
Example:
</P>
<PRE>
sf_command (sndfile, SFC_GET_CLIPPING, NULL, 0) ;
</PRE>
<DL>
<DT>Return value:</DT>
<DD>Clipping mode (SF_TRUE or SF_FALSE).
</DL>
<!-- ========================================================================= -->
<HR>