diff options
| author | Erik de Castro Lopo <erikd@mega-nerd.com> | 2012-06-20 21:49:14 +1000 |
|---|---|---|
| committer | Erik de Castro Lopo <erikd@mega-nerd.com> | 2012-06-20 21:49:14 +1000 |
| commit | 86aee7deba31219cc3262813d506fba2e7d1370d (patch) | |
| tree | ab3ee79dd4d76f76664d6e5d820c8b4512514b4e /doc/command.html | |
| parent | 249c9253a7582127d1bbb8601f8bb6bc31dbdcf1 (diff) | |
src/sndfile.h.in : Add SFC_SET_COMPRESSION_LEVEL.
Diffstat (limited to 'doc/command.html')
| -rw-r--r-- | doc/command.html | 39 |
1 files changed, 36 insertions, 3 deletions
diff --git a/doc/command.html b/doc/command.html index 70f611d..d319488 100644 --- a/doc/command.html +++ b/doc/command.html @@ -188,7 +188,12 @@ <TR> <TD><A HREF="#SFC_SET_VBR_ENCODING_QUALITY">SFC_SET_VBR_ENCODING_QUALITY</A></TD> - <TD>Set the the Variable Bit Rate encoding quality</TD> + <TD>Set the Variable Bit Rate encoding quality</TD> +</TR> + +<TR> + <TD><A HREF="#SFC_SET_COMPRESSION_LEVEL">SFC_SET_COMPRESSION_LEVEL</A></TD> + <TD>Set the compression level.</TD> </TR> <TR> @@ -1297,10 +1302,10 @@ This command is currently only supported for files with SF_FORMAT_WAVEX format. <A NAME="SFC_SET_VBR_ENCODING_QUALITY"></A> <H2><BR><B>SFC_SET_VBR_ENCODING_QUALITY</B></H2> <P> -Set the the Variable Bit Rate encoding quality. +Set the Variable Bit Rate encoding quality. The encoding quality value should be between 0.0 (lowest quality) and 1.0 (highest quality). -Currenly this command is only implemented for Ogg/Vorbis files. +Currenly this command is only implemented for FLAC and Ogg/Vorbis files. </P> <P> Parameters: @@ -1322,6 +1327,34 @@ The command must be sent before any audio data is written to the file. </DL> <!-- ========================================================================= --> +<A NAME="SFC_SET_COMPRESSION_LEVEL"></A> +<H2><BR><B>SFC_SET_COMPRESSION_LEVEL</B></H2> +<P> +Set the compression level. +The compression level should be between 0.0 (minimum compression level) and 1.0 +(highest compression level). +Currenly this command is only implemented for FLAC and Ogg/Vorbis files. +</P> +<P> +Parameters: +<PRE> + sndfile : A valid SNDFILE* pointer + cmd : SFC_SET_COMPRESSION_LEVEL + data : A pointer to a double value + datasize : sizeof (double) +</PRE> +<P> +The command must be sent before any audio data is written to the file. +</P> +<P> +</P> +<DL> +<DT>Return value:</DT> + <dd>SF_TRUE if compression level was set. + SF_FALSE otherwise. +</DL> + +<!-- ========================================================================= --> <A NAME="SFC_RAW_NEEDS_ENDSWAP"></A> <H2><BR><B>SFC_RAW_NEEDS_ENDSWAP</B></H2> <P> |