diff options
| author | Erik de Castro Lopo <erikd@mega-nerd.com> | 2007-10-22 19:48:34 +1000 |
|---|---|---|
| committer | Erik de Castro Lopo <erikd@mega-nerd.com> | 2007-10-22 19:48:34 +1000 |
| commit | 2d02bb2bbf1350f0925679ebc2d47c27311f8bc2 (patch) | |
| tree | f6b6f44622108064d7b9f955dcd21472ea7bac46 /doc/command.html | |
| parent | 8c9d0101f1f7132bd5727bea9f1fcea34eae65e4 (diff) | |
doc/command.html : Add docs for SFC_SET_INT_FLOAT_WRITE command.
Diffstat (limited to 'doc/command.html')
| -rw-r--r-- | doc/command.html | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/command.html b/doc/command.html index ee5bf59..4b90592 100644 --- a/doc/command.html +++ b/doc/command.html @@ -95,6 +95,13 @@ <TD>Set/clear the scale factor when integer (short/int) data is read from a file containing floating point data.</TD> </TR> + +<TR> + <TD><A HREF="#SFC_SET_SCALE_INT_FLOAT_WRITE">SFC_SET_SCALE_INT_FLOAT_WRITE</A></TD> + <TD>Set/clear the scale factor when integer (short/int) data is written to a file + as floating point data.</TD> +</TR> + <TR> <TD><A HREF="#SFC_GET_SIMPLE_FORMAT_COUNT">SFC_GET_SIMPLE_FORMAT_COUNT</A></TD> <TD>Retrieve the number of simple formats supported by libsndfile.</TD> @@ -604,6 +611,33 @@ Example: <!-- ========================================================================= --> +<A NAME="SFC_SET_SCALE_INT_FLOAT_WRITE"></A> +<H2><BR><B>SFC_SET_SCALE_INT_FLOAT_WRITE</B></H2> +<P> +Set/clear the scale factor when integer (short/int) data is written to a file +as floating point data. +</P> +<P> +Parameters: +</P> +<PRE> + sndfile : A valid SNDFILE* pointer + cmd : SFC_SET_SCALE_FLOAT_INT_READ + data : NULL + datasize : TRUE or FALSE +</PRE> +<P> +Example: +</P> +<PRE> + sf_command (sndfile, SFC_SET_SCALE_INT_FLOAT_WRITE, NULL, SF_TRUE) ; +</PRE> +<DL> +<DT>Return value: </DT> + <DD>Returns the previous SFC_SET_SCALE_INT_FLOAT_WRITE setting for this file. +</DL> + +<!-- ========================================================================= --> <A NAME="SFC_GET_SIMPLE_FORMAT_COUNT"></A> <H2><BR><B>SFC_GET_SIMPLE_FORMAT_COUNT</B></H2> <P> |