← Back to branch summary

~ubuntu-branches/ubuntu/precise/flac/precise-updates

« back to all changes in this revision

Viewing changes to doc/html/api/group__flac__file__encoder.html

  • Committer: Bazaar Package Importer
  • Author(s): Joshua Kwan
  • Date: 2007-05-29 22:56:36 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070529225636-ljeff8xxip09qaap
Tags: 1.1.4-1
http://bugs.debian.org/405167
http://bugs.debian.org/411311
* New upstream release. closes: #405167, #411311
  - libOggFLAC and libOggFLAC++ have been merged into libFLAC, so
    remove their corresponding packages.
  - Because of the API changes required to effect the above, there has
    been yet another soname bump. libflac7 -> libflac8 and
    libflac++5 -> libflac++6. Emails have been dispatched to the
    maintainers of dependent packages.
* Some notes on patches that were removed:
  - 02_stdin_stdout, 06_manpage_mention_utf8_convert: merged upstream
  - 08_manpage_warnings: Upstream has changed the manpage so it defintely
    can't fit in in 80 cols, so just forget about it. We'll live.
  - 05_eof_warnings_are_errors: Upstream decided to add a -w option to
    flac to treat all warnings as errors. I am going to defer to that
    for now, but if people think it's stupid let me know and I'll port
    the patch forward.
  - 04_stack_smasher: was a backport from 1.1.3, so it's obsolete.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/api/group__flac__file__encoder.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>FLAC/file_encoder.h: file encoder interface</title>
4
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
 
</head><body>
6
 
<!-- Generated by Doxygen 1.2.14 -->
7
 
<center>
8
 
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
9
 
<hr><h1>FLAC/file_encoder.h: file encoder interface<br>
10
 
<small>
11
 
[<a class="el" href="group__flac__encoder.html">FLAC/_encoder.h: encoder interfaces</a>]</small>
12
 
</h1>This module contains the functions which implement the file encoder. 
13
 
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
14
 
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
15
 
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a></td></tr>
16
 
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
17
 
<tr><td nowrap align=right valign=top>typedef void(*&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a1">FLAC__FileEncoderProgressCallback</a> )(const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data)</td></tr>
18
 
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
19
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a> { <br>
20
 
&nbsp;&nbsp;<a class="el" href="group__flac__file__encoder.html#a52a2">FLAC__FILE_ENCODER_OK</a> =  0, 
21
 
<a class="el" href="group__flac__file__encoder.html#a52a3">FLAC__FILE_ENCODER_NO_FILENAME</a>, 
22
 
<a class="el" href="group__flac__file__encoder.html#a52a4">FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</a>, 
23
 
<a class="el" href="group__flac__file__encoder.html#a52a5">FLAC__FILE_ENCODER_FATAL_ERROR_WHILE_WRITING</a>, 
24
 
<br>
25
 
&nbsp;&nbsp;<a class="el" href="group__flac__file__encoder.html#a52a6">FLAC__FILE_ENCODER_ERROR_OPENING_FILE</a>, 
26
 
<a class="el" href="group__flac__file__encoder.html#a52a7">FLAC__FILE_ENCODER_MEMORY_ALLOCATION_ERROR</a>, 
27
 
<a class="el" href="group__flac__file__encoder.html#a52a8">FLAC__FILE_ENCODER_ALREADY_INITIALIZED</a>, 
28
 
<a class="el" href="group__flac__file__encoder.html#a52a9">FLAC__FILE_ENCODER_UNINITIALIZED</a>
29
 
<br>
30
 
 }</td></tr>
31
 
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
32
 
<tr><td nowrap align=right valign=top><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a2">FLAC__file_encoder_new</a> ()</td></tr>
33
 
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a3">FLAC__file_encoder_delete</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
34
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a4">FLAC__file_encoder_set_verify</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
35
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a5">FLAC__file_encoder_set_streamable_subset</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
36
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a6">FLAC__file_encoder_set_do_mid_side_stereo</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
37
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a7">FLAC__file_encoder_set_loose_mid_side_stereo</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
38
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a8">FLAC__file_encoder_set_channels</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
39
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a9">FLAC__file_encoder_set_bits_per_sample</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
40
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a10">FLAC__file_encoder_set_sample_rate</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
41
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a11">FLAC__file_encoder_set_blocksize</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
42
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a12">FLAC__file_encoder_set_max_lpc_order</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
43
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a13">FLAC__file_encoder_set_qlp_coeff_precision</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
44
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a14">FLAC__file_encoder_set_do_qlp_coeff_prec_search</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
45
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a15">FLAC__file_encoder_set_do_escape_coding</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
46
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a16">FLAC__file_encoder_set_do_exhaustive_model_search</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value)</td></tr>
47
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a17">FLAC__file_encoder_set_min_residual_partition_order</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
48
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a18">FLAC__file_encoder_set_max_residual_partition_order</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
49
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a19">FLAC__file_encoder_set_rice_parameter_search_dist</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value)</td></tr>
50
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a20">FLAC__file_encoder_set_total_samples_estimate</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 value)</td></tr>
51
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a21">FLAC__file_encoder_set_metadata</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, unsigned num_blocks)</td></tr>
52
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a22">FLAC__file_encoder_set_filename</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const char *value)</td></tr>
53
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a23">FLAC__file_encoder_set_progress_callback</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, <a class="el" href="group__flac__file__encoder.html#a1">FLAC__FileEncoderProgressCallback</a> value)</td></tr>
54
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a24">FLAC__file_encoder_set_client_data</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, void *value)</td></tr>
55
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a25">FLAC__file_encoder_get_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
56
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__encoder.html#a56">FLAC__SeekableStreamEncoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a26">FLAC__file_encoder_get_seekable_stream_encoder_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
57
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__encoder.html#a52">FLAC__StreamEncoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a27">FLAC__file_encoder_get_stream_encoder_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
58
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a28">FLAC__file_encoder_get_verify_decoder_state</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
59
 
<tr><td nowrap align=right valign=top>const char *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a29">FLAC__file_encoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
60
 
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a30">FLAC__file_encoder_get_verify_decoder_error_stats</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got)</td></tr>
61
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a31">FLAC__file_encoder_get_verify</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
62
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a32">FLAC__file_encoder_get_streamable_subset</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
63
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a33">FLAC__file_encoder_get_do_mid_side_stereo</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
64
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a34">FLAC__file_encoder_get_loose_mid_side_stereo</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
65
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a35">FLAC__file_encoder_get_channels</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
66
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a36">FLAC__file_encoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
67
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a37">FLAC__file_encoder_get_sample_rate</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
68
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a38">FLAC__file_encoder_get_blocksize</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
69
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a39">FLAC__file_encoder_get_max_lpc_order</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
70
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a40">FLAC__file_encoder_get_qlp_coeff_precision</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
71
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a41">FLAC__file_encoder_get_do_qlp_coeff_prec_search</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
72
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a42">FLAC__file_encoder_get_do_escape_coding</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
73
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a43">FLAC__file_encoder_get_do_exhaustive_model_search</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
74
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a44">FLAC__file_encoder_get_min_residual_partition_order</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
75
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a45">FLAC__file_encoder_get_max_residual_partition_order</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
76
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a46">FLAC__file_encoder_get_rice_parameter_search_dist</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
77
 
<tr><td nowrap align=right valign=top>FLAC__uint64&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a47">FLAC__file_encoder_get_total_samples_estimate</a> (const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
78
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a48">FLAC__file_encoder_init</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
79
 
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a49">FLAC__file_encoder_finish</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder)</td></tr>
80
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a50">FLAC__file_encoder_process</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const FLAC__int32 *const buffer[], unsigned samples)</td></tr>
81
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a51">FLAC__file_encoder_process_interleaved</a> (<a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const FLAC__int32 buffer[], unsigned samples)</td></tr>
82
 
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
83
 
<tr><td nowrap align=right valign=top>const char *const&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__encoder.html#a0">FLAC__FileEncoderStateString</a> []</td></tr>
84
 
</table>
85
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
86
 
This module contains the functions which implement the file encoder.
87
 
<p>
88
 
 
89
 
<p>
90
 
 The basic usage of this encoder is as follows:<ul>
91
 
<li>The program creates an instance of an encoder using <a class="el" href="group__flac__file__encoder.html#a2">FLAC__file_encoder_new</a>().<li>The program overrides the default settings using FLAC__file_encoder_set_*() functions.<li>The program initializes the instance to validate the settings and prepare for encoding using <a class="el" href="group__flac__file__encoder.html#a48">FLAC__file_encoder_init</a>().<li>The program calls <a class="el" href="group__flac__file__encoder.html#a50">FLAC__file_encoder_process</a>() or <a class="el" href="group__flac__file__encoder.html#a51">FLAC__file_encoder_process_interleaved</a>() to encode data, which subsequently writes data to the output file.<li>The program finishes the encoding with <a class="el" href="group__flac__file__encoder.html#a49">FLAC__file_encoder_finish</a>(), which causes the encoder to encode any data still in its input pipe, rewind and write the STREAMINFO metadata to file, and finally reset the encoder to the uninitialized state.<li>The instance may be used again or deleted with <a class="el" href="group__flac__file__encoder.html#a3">FLAC__file_encoder_delete</a>().</ul>
92
 
The file encoder is a wrapper around the <a class="el" href="group__flac__seekable__stream__encoder.html">seekable stream encoder</a> which supplies all callbacks internally; the user need specify only the filename.
93
 
<p>
94
 
Make sure to read the detailed description of the <a class="el" href="group__flac__seekable__stream__encoder.html">seekable stream encoder module</a> since the <a class="el" href="group__flac__stream__encoder.html">stream encoder module</a> since the file encoder inherits much of its behavior from them.
95
 
<p>
96
 
<dl compact><dt><b>
97
 
Note: </b><dd>
98
 
 The "set" functions may only be called when the encoder is in the state FLAC__FILE_ENCODER_UNINITIALIZED, i.e. after <a class="el" href="group__flac__file__encoder.html#a2">FLAC__file_encoder_new</a>() or <a class="el" href="group__flac__file__encoder.html#a49">FLAC__file_encoder_finish</a>(), but before <a class="el" href="group__flac__file__encoder.html#a48">FLAC__file_encoder_init</a>(). If this is the case they will return <code>true</code>, otherwise <code>false</code>.</dl><dl compact><dt><b>
99
 
Note: </b><dd>
100
 
 <a class="el" href="group__flac__file__encoder.html#a49">FLAC__file_encoder_finish</a>() resets all settings to the constructor defaults. </dl><hr><h2>Typedef Documentation</h2>
101
 
<a name="a1" doxytag="file_encoder.h::FLAC__FileEncoderProgressCallback"></a><p>
102
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
103
 
  <tr>
104
 
    <td class="md">
105
 
      <table cellpadding="0" cellspacing="0" border="0">
106
 
        <tr>
107
 
          <td class="md" nowrap valign="top"> typedef void(* FLAC__FileEncoderProgressCallback)(const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data)
108
 
      </table>
109
 
    </td>
110
 
  </tr>
111
 
</table>
112
 
<table cellspacing=5 cellpadding=0 border=0>
113
 
  <tr>
114
 
    <td>
115
 
      &nbsp;
116
 
    </td>
117
 
    <td>
118
 
 
119
 
<p>
120
 
Signature for the progress callback. See <a class="el" href="group__flac__file__encoder.html#a23">FLAC__file_encoder_set_progress_callback</a>() for more info.<dl compact><dt><b>
121
 
Parameters: </b><dd>
122
 
<table border=0 cellspacing=2 cellpadding=0>
123
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
124
 
The encoder instance calling the callback. </td></tr>
125
 
<tr><td valign=top><em>bytes_written</em>&nbsp;</td><td>
126
 
Bytes written so far. </td></tr>
127
 
<tr><td valign=top><em>samples_written</em>&nbsp;</td><td>
128
 
Samples written so far. </td></tr>
129
 
<tr><td valign=top><em>frames_written</em>&nbsp;</td><td>
130
 
Frames written so far. </td></tr>
131
 
<tr><td valign=top><em>total_frames_estimate</em>&nbsp;</td><td>
132
 
The estimate of the total number of frames to be written. </td></tr>
133
 
<tr><td valign=top><em>client_data</em>&nbsp;</td><td>
134
 
The callee's client data set through <a class="el" href="group__flac__file__encoder.html#a24">FLAC__file_encoder_set_client_data</a>(). </td></tr>
135
 
</table>
136
 
</dl>    </td>
137
 
  </tr>
138
 
</table>
139
 
<hr><h2>Enumeration Type Documentation</h2>
140
 
<a name="a52" doxytag="file_encoder.h::FLAC__FileEncoderState"></a><p>
141
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
142
 
  <tr>
143
 
    <td class="md">
144
 
      <table cellpadding="0" cellspacing="0" border="0">
145
 
        <tr>
146
 
          <td class="md" nowrap valign="top"> enum FLAC__FileEncoderState
147
 
      </table>
148
 
    </td>
149
 
  </tr>
150
 
</table>
151
 
<table cellspacing=5 cellpadding=0 border=0>
152
 
  <tr>
153
 
    <td>
154
 
      &nbsp;
155
 
    </td>
156
 
    <td>
157
 
 
158
 
<p>
159
 
State values for a <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a>
160
 
<p>
161
 
The encoder's state can be obtained by calling <a class="el" href="group__flac__file__encoder.html#a25">FLAC__file_encoder_get_state</a>(). <dl compact><dt><b>
162
 
Enumeration values:</b><dd>
163
 
<table border=0 cellspacing=2 cellpadding=0>
164
 
<tr><td valign=top><em><a name="a52a2" doxytag="FLAC__FILE_ENCODER_OK"></a><em>FLAC__FILE_ENCODER_OK</em></em>&nbsp;</td><td>
165
 
The encoder is in the normal OK state. </td></tr>
166
 
<tr><td valign=top><em><a name="a52a3" doxytag="FLAC__FILE_ENCODER_NO_FILENAME"></a><em>FLAC__FILE_ENCODER_NO_FILENAME</em></em>&nbsp;</td><td>
167
 
<a class="el" href="group__flac__file__encoder.html#a48">FLAC__file_encoder_init</a>() was called without first calling <a class="el" href="group__flac__file__encoder.html#a22">FLAC__file_encoder_set_filename</a>(). </td></tr>
168
 
<tr><td valign=top><em><a name="a52a4" doxytag="FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR"></a><em>FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</em></em>&nbsp;</td><td>
169
 
An error occurred in the underlying seekable stream encoder; check <a class="el" href="group__flac__file__encoder.html#a26">FLAC__file_encoder_get_seekable_stream_encoder_state</a>(). </td></tr>
170
 
<tr><td valign=top><em><a name="a52a5" doxytag="FLAC__FILE_ENCODER_FATAL_ERROR_WHILE_WRITING"></a><em>FLAC__FILE_ENCODER_FATAL_ERROR_WHILE_WRITING</em></em>&nbsp;</td><td>
171
 
A fatal error occurred while writing to the encoded file. </td></tr>
172
 
<tr><td valign=top><em><a name="a52a6" doxytag="FLAC__FILE_ENCODER_ERROR_OPENING_FILE"></a><em>FLAC__FILE_ENCODER_ERROR_OPENING_FILE</em></em>&nbsp;</td><td>
173
 
An error occurred opening the output file for writing. </td></tr>
174
 
<tr><td valign=top><em><a name="a52a7" doxytag="FLAC__FILE_ENCODER_MEMORY_ALLOCATION_ERROR"></a><em>FLAC__FILE_ENCODER_MEMORY_ALLOCATION_ERROR</em></em>&nbsp;</td><td>
175
 
Memory allocation failed. </td></tr>
176
 
<tr><td valign=top><em><a name="a52a8" doxytag="FLAC__FILE_ENCODER_ALREADY_INITIALIZED"></a><em>FLAC__FILE_ENCODER_ALREADY_INITIALIZED</em></em>&nbsp;</td><td>
177
 
<a class="el" href="group__flac__file__encoder.html#a48">FLAC__file_encoder_init</a>() was called when the encoder was already initialized, usually because <a class="el" href="group__flac__file__encoder.html#a49">FLAC__file_encoder_finish</a>() was not called. </td></tr>
178
 
<tr><td valign=top><em><a name="a52a9" doxytag="FLAC__FILE_ENCODER_UNINITIALIZED"></a><em>FLAC__FILE_ENCODER_UNINITIALIZED</em></em>&nbsp;</td><td>
179
 
The encoder is in the uninitialized state. </td></tr>
180
 
</table>
181
 
</dl>
182
 
    </td>
183
 
  </tr>
184
 
</table>
185
 
<hr><h2>Function Documentation</h2>
186
 
<a name="a2" doxytag="file_encoder.h::FLAC__file_encoder_new"></a><p>
187
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
188
 
  <tr>
189
 
    <td class="md">
190
 
      <table cellpadding="0" cellspacing="0" border="0">
191
 
        <tr>
192
 
          <td class="md" nowrap valign="top"> <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a>* FLAC__file_encoder_new </td>
193
 
          <td class="md" valign="top">(&nbsp;</td>
194
 
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
195
 
          <td class="md" valign="top">)&nbsp;</td>
196
 
          <td class="md" nowrap></td>
197
 
        </tr>
198
 
 
199
 
      </table>
200
 
    </td>
201
 
  </tr>
202
 
</table>
203
 
<table cellspacing=5 cellpadding=0 border=0>
204
 
  <tr>
205
 
    <td>
206
 
      &nbsp;
207
 
    </td>
208
 
    <td>
209
 
 
210
 
<p>
211
 
Create a new file encoder instance. The instance is created with default settings; see the individual FLAC__file_encoder_set_*() functions for each setting's default.<dl compact><dt><b>
212
 
Return values: </b><dd>
213
 
<table border=0 cellspacing=2 cellpadding=0>
214
 
<tr><td valign=top><em><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a></em>&nbsp;</td><td>
215
 
* <code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>
216
 
</table>
217
 
</dl>    </td>
218
 
  </tr>
219
 
</table>
220
 
<a name="a3" doxytag="file_encoder.h::FLAC__file_encoder_delete"></a><p>
221
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
222
 
  <tr>
223
 
    <td class="md">
224
 
      <table cellpadding="0" cellspacing="0" border="0">
225
 
        <tr>
226
 
          <td class="md" nowrap valign="top"> void FLAC__file_encoder_delete </td>
227
 
          <td class="md" valign="top">(&nbsp;</td>
228
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
229
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
230
 
          <td class="md" valign="top">)&nbsp;</td>
231
 
          <td class="md" nowrap></td>
232
 
        </tr>
233
 
 
234
 
      </table>
235
 
    </td>
236
 
  </tr>
237
 
</table>
238
 
<table cellspacing=5 cellpadding=0 border=0>
239
 
  <tr>
240
 
    <td>
241
 
      &nbsp;
242
 
    </td>
243
 
    <td>
244
 
 
245
 
<p>
246
 
Free an encoder instance. Deletes the object pointed to by <em>encoder</em>.<dl compact><dt><b>
247
 
Parameters: </b><dd>
248
 
<table border=0 cellspacing=2 cellpadding=0>
249
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
250
 
A pointer to an existing encoder. </td></tr>
251
 
</table>
252
 
</dl><dl compact><dt><b>
253
 
Assertions:</b><dd>
254
 
 <div class="fragment"><pre>encoder != NULL 
255
 
</pre></div> </dl>    </td>
256
 
  </tr>
257
 
</table>
258
 
<a name="a4" doxytag="file_encoder.h::FLAC__file_encoder_set_verify"></a><p>
259
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
260
 
  <tr>
261
 
    <td class="md">
262
 
      <table cellpadding="0" cellspacing="0" border="0">
263
 
        <tr>
264
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_verify </td>
265
 
          <td class="md" valign="top">(&nbsp;</td>
266
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
267
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
268
 
        </tr>
269
 
        <tr>
270
 
          <td></td>
271
 
          <td></td>
272
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
273
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
274
 
        </tr>
275
 
        <tr>
276
 
          <td></td>
277
 
          <td class="md">)&nbsp;</td>
278
 
          <td class="md" colspan="2"></td>
279
 
        </tr>
280
 
 
281
 
      </table>
282
 
    </td>
283
 
  </tr>
284
 
</table>
285
 
<table cellspacing=5 cellpadding=0 border=0>
286
 
  <tr>
287
 
    <td>
288
 
      &nbsp;
289
 
    </td>
290
 
    <td>
291
 
 
292
 
<p>
293
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a8">FLAC__seekable_stream_encoder_set_verify</a>().<dl compact><dt><b>
294
 
Default Value:</b><dd>
295
 
 <code>true</code> </dl><dl compact><dt><b>
296
 
Parameters: </b><dd>
297
 
<table border=0 cellspacing=2 cellpadding=0>
298
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
299
 
An encoder instance to set. </td></tr>
300
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
301
 
See above. </td></tr>
302
 
</table>
303
 
</dl><dl compact><dt><b>
304
 
Assertions:</b><dd>
305
 
 <div class="fragment"><pre>encoder != NULL 
306
 
</pre></div> </dl><dl compact><dt><b>
307
 
Return values: </b><dd>
308
 
<table border=0 cellspacing=2 cellpadding=0>
309
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
310
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
311
 
</table>
312
 
</dl>    </td>
313
 
  </tr>
314
 
</table>
315
 
<a name="a5" doxytag="file_encoder.h::FLAC__file_encoder_set_streamable_subset"></a><p>
316
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
317
 
  <tr>
318
 
    <td class="md">
319
 
      <table cellpadding="0" cellspacing="0" border="0">
320
 
        <tr>
321
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_streamable_subset </td>
322
 
          <td class="md" valign="top">(&nbsp;</td>
323
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
324
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
325
 
        </tr>
326
 
        <tr>
327
 
          <td></td>
328
 
          <td></td>
329
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
330
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
331
 
        </tr>
332
 
        <tr>
333
 
          <td></td>
334
 
          <td class="md">)&nbsp;</td>
335
 
          <td class="md" colspan="2"></td>
336
 
        </tr>
337
 
 
338
 
      </table>
339
 
    </td>
340
 
  </tr>
341
 
</table>
342
 
<table cellspacing=5 cellpadding=0 border=0>
343
 
  <tr>
344
 
    <td>
345
 
      &nbsp;
346
 
    </td>
347
 
    <td>
348
 
 
349
 
<p>
350
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a9">FLAC__seekable_stream_encoder_set_streamable_subset</a>().<dl compact><dt><b>
351
 
Default Value:</b><dd>
352
 
 <code>true</code> </dl><dl compact><dt><b>
353
 
Parameters: </b><dd>
354
 
<table border=0 cellspacing=2 cellpadding=0>
355
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
356
 
An encoder instance to set. </td></tr>
357
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
358
 
See above. </td></tr>
359
 
</table>
360
 
</dl><dl compact><dt><b>
361
 
Assertions:</b><dd>
362
 
 <div class="fragment"><pre>encoder != NULL 
363
 
</pre></div> </dl><dl compact><dt><b>
364
 
Return values: </b><dd>
365
 
<table border=0 cellspacing=2 cellpadding=0>
366
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
367
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
368
 
</table>
369
 
</dl>    </td>
370
 
  </tr>
371
 
</table>
372
 
<a name="a6" doxytag="file_encoder.h::FLAC__file_encoder_set_do_mid_side_stereo"></a><p>
373
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
374
 
  <tr>
375
 
    <td class="md">
376
 
      <table cellpadding="0" cellspacing="0" border="0">
377
 
        <tr>
378
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_do_mid_side_stereo </td>
379
 
          <td class="md" valign="top">(&nbsp;</td>
380
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
381
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
382
 
        </tr>
383
 
        <tr>
384
 
          <td></td>
385
 
          <td></td>
386
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
387
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
388
 
        </tr>
389
 
        <tr>
390
 
          <td></td>
391
 
          <td class="md">)&nbsp;</td>
392
 
          <td class="md" colspan="2"></td>
393
 
        </tr>
394
 
 
395
 
      </table>
396
 
    </td>
397
 
  </tr>
398
 
</table>
399
 
<table cellspacing=5 cellpadding=0 border=0>
400
 
  <tr>
401
 
    <td>
402
 
      &nbsp;
403
 
    </td>
404
 
    <td>
405
 
 
406
 
<p>
407
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a10">FLAC__seekable_stream_encoder_set_do_mid_side_stereo</a>().<dl compact><dt><b>
408
 
Default Value:</b><dd>
409
 
 <code>false</code> </dl><dl compact><dt><b>
410
 
Parameters: </b><dd>
411
 
<table border=0 cellspacing=2 cellpadding=0>
412
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
413
 
An encoder instance to set. </td></tr>
414
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
415
 
See above. </td></tr>
416
 
</table>
417
 
</dl><dl compact><dt><b>
418
 
Assertions:</b><dd>
419
 
 <div class="fragment"><pre>encoder != NULL 
420
 
</pre></div> </dl><dl compact><dt><b>
421
 
Return values: </b><dd>
422
 
<table border=0 cellspacing=2 cellpadding=0>
423
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
424
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
425
 
</table>
426
 
</dl>    </td>
427
 
  </tr>
428
 
</table>
429
 
<a name="a7" doxytag="file_encoder.h::FLAC__file_encoder_set_loose_mid_side_stereo"></a><p>
430
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
431
 
  <tr>
432
 
    <td class="md">
433
 
      <table cellpadding="0" cellspacing="0" border="0">
434
 
        <tr>
435
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_loose_mid_side_stereo </td>
436
 
          <td class="md" valign="top">(&nbsp;</td>
437
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
438
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
439
 
        </tr>
440
 
        <tr>
441
 
          <td></td>
442
 
          <td></td>
443
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
444
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
445
 
        </tr>
446
 
        <tr>
447
 
          <td></td>
448
 
          <td class="md">)&nbsp;</td>
449
 
          <td class="md" colspan="2"></td>
450
 
        </tr>
451
 
 
452
 
      </table>
453
 
    </td>
454
 
  </tr>
455
 
</table>
456
 
<table cellspacing=5 cellpadding=0 border=0>
457
 
  <tr>
458
 
    <td>
459
 
      &nbsp;
460
 
    </td>
461
 
    <td>
462
 
 
463
 
<p>
464
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a11">FLAC__seekable_stream_encoder_set_loose_mid_side_stereo</a>().<dl compact><dt><b>
465
 
Default Value:</b><dd>
466
 
 <code>false</code> </dl><dl compact><dt><b>
467
 
Parameters: </b><dd>
468
 
<table border=0 cellspacing=2 cellpadding=0>
469
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
470
 
An encoder instance to set. </td></tr>
471
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
472
 
See above. </td></tr>
473
 
</table>
474
 
</dl><dl compact><dt><b>
475
 
Assertions:</b><dd>
476
 
 <div class="fragment"><pre>encoder != NULL 
477
 
</pre></div> </dl><dl compact><dt><b>
478
 
Return values: </b><dd>
479
 
<table border=0 cellspacing=2 cellpadding=0>
480
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
481
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
482
 
</table>
483
 
</dl>    </td>
484
 
  </tr>
485
 
</table>
486
 
<a name="a8" doxytag="file_encoder.h::FLAC__file_encoder_set_channels"></a><p>
487
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
488
 
  <tr>
489
 
    <td class="md">
490
 
      <table cellpadding="0" cellspacing="0" border="0">
491
 
        <tr>
492
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_channels </td>
493
 
          <td class="md" valign="top">(&nbsp;</td>
494
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
495
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
496
 
        </tr>
497
 
        <tr>
498
 
          <td></td>
499
 
          <td></td>
500
 
          <td class="md" nowrap>unsigned&nbsp;</td>
501
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
502
 
        </tr>
503
 
        <tr>
504
 
          <td></td>
505
 
          <td class="md">)&nbsp;</td>
506
 
          <td class="md" colspan="2"></td>
507
 
        </tr>
508
 
 
509
 
      </table>
510
 
    </td>
511
 
  </tr>
512
 
</table>
513
 
<table cellspacing=5 cellpadding=0 border=0>
514
 
  <tr>
515
 
    <td>
516
 
      &nbsp;
517
 
    </td>
518
 
    <td>
519
 
 
520
 
<p>
521
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a12">FLAC__seekable_stream_encoder_set_channels</a>().<dl compact><dt><b>
522
 
Default Value:</b><dd>
523
 
 <code>2</code> </dl><dl compact><dt><b>
524
 
Parameters: </b><dd>
525
 
<table border=0 cellspacing=2 cellpadding=0>
526
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
527
 
An encoder instance to set. </td></tr>
528
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
529
 
See above. </td></tr>
530
 
</table>
531
 
</dl><dl compact><dt><b>
532
 
Assertions:</b><dd>
533
 
 <div class="fragment"><pre>encoder != NULL 
534
 
</pre></div> </dl><dl compact><dt><b>
535
 
Return values: </b><dd>
536
 
<table border=0 cellspacing=2 cellpadding=0>
537
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
538
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
539
 
</table>
540
 
</dl>    </td>
541
 
  </tr>
542
 
</table>
543
 
<a name="a9" doxytag="file_encoder.h::FLAC__file_encoder_set_bits_per_sample"></a><p>
544
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
545
 
  <tr>
546
 
    <td class="md">
547
 
      <table cellpadding="0" cellspacing="0" border="0">
548
 
        <tr>
549
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_bits_per_sample </td>
550
 
          <td class="md" valign="top">(&nbsp;</td>
551
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
552
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
553
 
        </tr>
554
 
        <tr>
555
 
          <td></td>
556
 
          <td></td>
557
 
          <td class="md" nowrap>unsigned&nbsp;</td>
558
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
559
 
        </tr>
560
 
        <tr>
561
 
          <td></td>
562
 
          <td class="md">)&nbsp;</td>
563
 
          <td class="md" colspan="2"></td>
564
 
        </tr>
565
 
 
566
 
      </table>
567
 
    </td>
568
 
  </tr>
569
 
</table>
570
 
<table cellspacing=5 cellpadding=0 border=0>
571
 
  <tr>
572
 
    <td>
573
 
      &nbsp;
574
 
    </td>
575
 
    <td>
576
 
 
577
 
<p>
578
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a13">FLAC__seekable_stream_encoder_set_bits_per_sample</a>().
579
 
<p>
580
 
<dl compact><dt><b>
581
 
Warning: </b><dd>
582
 
 Do not feed the encoder data that is wider than the value you set here or you will generate an invalid stream.</dl><dl compact><dt><b>
583
 
Default Value:</b><dd>
584
 
 <code>16</code> </dl><dl compact><dt><b>
585
 
Parameters: </b><dd>
586
 
<table border=0 cellspacing=2 cellpadding=0>
587
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
588
 
An encoder instance to set. </td></tr>
589
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
590
 
See above. </td></tr>
591
 
</table>
592
 
</dl><dl compact><dt><b>
593
 
Assertions:</b><dd>
594
 
 <div class="fragment"><pre>encoder != NULL 
595
 
</pre></div> </dl><dl compact><dt><b>
596
 
Return values: </b><dd>
597
 
<table border=0 cellspacing=2 cellpadding=0>
598
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
599
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
600
 
</table>
601
 
</dl>    </td>
602
 
  </tr>
603
 
</table>
604
 
<a name="a10" doxytag="file_encoder.h::FLAC__file_encoder_set_sample_rate"></a><p>
605
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
606
 
  <tr>
607
 
    <td class="md">
608
 
      <table cellpadding="0" cellspacing="0" border="0">
609
 
        <tr>
610
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_sample_rate </td>
611
 
          <td class="md" valign="top">(&nbsp;</td>
612
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
613
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
614
 
        </tr>
615
 
        <tr>
616
 
          <td></td>
617
 
          <td></td>
618
 
          <td class="md" nowrap>unsigned&nbsp;</td>
619
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
620
 
        </tr>
621
 
        <tr>
622
 
          <td></td>
623
 
          <td class="md">)&nbsp;</td>
624
 
          <td class="md" colspan="2"></td>
625
 
        </tr>
626
 
 
627
 
      </table>
628
 
    </td>
629
 
  </tr>
630
 
</table>
631
 
<table cellspacing=5 cellpadding=0 border=0>
632
 
  <tr>
633
 
    <td>
634
 
      &nbsp;
635
 
    </td>
636
 
    <td>
637
 
 
638
 
<p>
639
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a14">FLAC__seekable_stream_encoder_set_sample_rate</a>().<dl compact><dt><b>
640
 
Default Value:</b><dd>
641
 
 <code>44100</code> </dl><dl compact><dt><b>
642
 
Parameters: </b><dd>
643
 
<table border=0 cellspacing=2 cellpadding=0>
644
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
645
 
An encoder instance to set. </td></tr>
646
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
647
 
See above. </td></tr>
648
 
</table>
649
 
</dl><dl compact><dt><b>
650
 
Assertions:</b><dd>
651
 
 <div class="fragment"><pre>encoder != NULL 
652
 
</pre></div> </dl><dl compact><dt><b>
653
 
Return values: </b><dd>
654
 
<table border=0 cellspacing=2 cellpadding=0>
655
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
656
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
657
 
</table>
658
 
</dl>    </td>
659
 
  </tr>
660
 
</table>
661
 
<a name="a11" doxytag="file_encoder.h::FLAC__file_encoder_set_blocksize"></a><p>
662
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
663
 
  <tr>
664
 
    <td class="md">
665
 
      <table cellpadding="0" cellspacing="0" border="0">
666
 
        <tr>
667
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_blocksize </td>
668
 
          <td class="md" valign="top">(&nbsp;</td>
669
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
670
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
671
 
        </tr>
672
 
        <tr>
673
 
          <td></td>
674
 
          <td></td>
675
 
          <td class="md" nowrap>unsigned&nbsp;</td>
676
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
677
 
        </tr>
678
 
        <tr>
679
 
          <td></td>
680
 
          <td class="md">)&nbsp;</td>
681
 
          <td class="md" colspan="2"></td>
682
 
        </tr>
683
 
 
684
 
      </table>
685
 
    </td>
686
 
  </tr>
687
 
</table>
688
 
<table cellspacing=5 cellpadding=0 border=0>
689
 
  <tr>
690
 
    <td>
691
 
      &nbsp;
692
 
    </td>
693
 
    <td>
694
 
 
695
 
<p>
696
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a15">FLAC__seekable_stream_encoder_set_blocksize</a>().<dl compact><dt><b>
697
 
Default Value:</b><dd>
698
 
 <code>1152</code> </dl><dl compact><dt><b>
699
 
Parameters: </b><dd>
700
 
<table border=0 cellspacing=2 cellpadding=0>
701
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
702
 
An encoder instance to set. </td></tr>
703
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
704
 
See above. </td></tr>
705
 
</table>
706
 
</dl><dl compact><dt><b>
707
 
Assertions:</b><dd>
708
 
 <div class="fragment"><pre>encoder != NULL 
709
 
</pre></div> </dl><dl compact><dt><b>
710
 
Return values: </b><dd>
711
 
<table border=0 cellspacing=2 cellpadding=0>
712
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
713
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
714
 
</table>
715
 
</dl>    </td>
716
 
  </tr>
717
 
</table>
718
 
<a name="a12" doxytag="file_encoder.h::FLAC__file_encoder_set_max_lpc_order"></a><p>
719
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
720
 
  <tr>
721
 
    <td class="md">
722
 
      <table cellpadding="0" cellspacing="0" border="0">
723
 
        <tr>
724
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_max_lpc_order </td>
725
 
          <td class="md" valign="top">(&nbsp;</td>
726
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
727
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
728
 
        </tr>
729
 
        <tr>
730
 
          <td></td>
731
 
          <td></td>
732
 
          <td class="md" nowrap>unsigned&nbsp;</td>
733
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
734
 
        </tr>
735
 
        <tr>
736
 
          <td></td>
737
 
          <td class="md">)&nbsp;</td>
738
 
          <td class="md" colspan="2"></td>
739
 
        </tr>
740
 
 
741
 
      </table>
742
 
    </td>
743
 
  </tr>
744
 
</table>
745
 
<table cellspacing=5 cellpadding=0 border=0>
746
 
  <tr>
747
 
    <td>
748
 
      &nbsp;
749
 
    </td>
750
 
    <td>
751
 
 
752
 
<p>
753
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a16">FLAC__seekable_stream_encoder_set_max_lpc_order</a>().<dl compact><dt><b>
754
 
Default Value:</b><dd>
755
 
 <code>0</code> </dl><dl compact><dt><b>
756
 
Parameters: </b><dd>
757
 
<table border=0 cellspacing=2 cellpadding=0>
758
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
759
 
An encoder instance to set. </td></tr>
760
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
761
 
See above. </td></tr>
762
 
</table>
763
 
</dl><dl compact><dt><b>
764
 
Assertions:</b><dd>
765
 
 <div class="fragment"><pre>encoder != NULL 
766
 
</pre></div> </dl><dl compact><dt><b>
767
 
Return values: </b><dd>
768
 
<table border=0 cellspacing=2 cellpadding=0>
769
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
770
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
771
 
</table>
772
 
</dl>    </td>
773
 
  </tr>
774
 
</table>
775
 
<a name="a13" doxytag="file_encoder.h::FLAC__file_encoder_set_qlp_coeff_precision"></a><p>
776
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
777
 
  <tr>
778
 
    <td class="md">
779
 
      <table cellpadding="0" cellspacing="0" border="0">
780
 
        <tr>
781
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_qlp_coeff_precision </td>
782
 
          <td class="md" valign="top">(&nbsp;</td>
783
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
784
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
785
 
        </tr>
786
 
        <tr>
787
 
          <td></td>
788
 
          <td></td>
789
 
          <td class="md" nowrap>unsigned&nbsp;</td>
790
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
791
 
        </tr>
792
 
        <tr>
793
 
          <td></td>
794
 
          <td class="md">)&nbsp;</td>
795
 
          <td class="md" colspan="2"></td>
796
 
        </tr>
797
 
 
798
 
      </table>
799
 
    </td>
800
 
  </tr>
801
 
</table>
802
 
<table cellspacing=5 cellpadding=0 border=0>
803
 
  <tr>
804
 
    <td>
805
 
      &nbsp;
806
 
    </td>
807
 
    <td>
808
 
 
809
 
<p>
810
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a17">FLAC__seekable_stream_encoder_set_qlp_coeff_precision</a>().
811
 
<p>
812
 
<dl compact><dt><b>
813
 
Note: </b><dd>
814
 
 In the current implementation, qlp_coeff_precision + bits_per_sample must be less than 32.</dl><dl compact><dt><b>
815
 
Default Value:</b><dd>
816
 
 <code>0</code> </dl><dl compact><dt><b>
817
 
Parameters: </b><dd>
818
 
<table border=0 cellspacing=2 cellpadding=0>
819
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
820
 
An encoder instance to set. </td></tr>
821
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
822
 
See above. </td></tr>
823
 
</table>
824
 
</dl><dl compact><dt><b>
825
 
Assertions:</b><dd>
826
 
 <div class="fragment"><pre>encoder != NULL 
827
 
</pre></div> </dl><dl compact><dt><b>
828
 
Return values: </b><dd>
829
 
<table border=0 cellspacing=2 cellpadding=0>
830
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
831
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
832
 
</table>
833
 
</dl>    </td>
834
 
  </tr>
835
 
</table>
836
 
<a name="a14" doxytag="file_encoder.h::FLAC__file_encoder_set_do_qlp_coeff_prec_search"></a><p>
837
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
838
 
  <tr>
839
 
    <td class="md">
840
 
      <table cellpadding="0" cellspacing="0" border="0">
841
 
        <tr>
842
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_do_qlp_coeff_prec_search </td>
843
 
          <td class="md" valign="top">(&nbsp;</td>
844
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
845
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
846
 
        </tr>
847
 
        <tr>
848
 
          <td></td>
849
 
          <td></td>
850
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
851
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
852
 
        </tr>
853
 
        <tr>
854
 
          <td></td>
855
 
          <td class="md">)&nbsp;</td>
856
 
          <td class="md" colspan="2"></td>
857
 
        </tr>
858
 
 
859
 
      </table>
860
 
    </td>
861
 
  </tr>
862
 
</table>
863
 
<table cellspacing=5 cellpadding=0 border=0>
864
 
  <tr>
865
 
    <td>
866
 
      &nbsp;
867
 
    </td>
868
 
    <td>
869
 
 
870
 
<p>
871
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a18">FLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search</a>().<dl compact><dt><b>
872
 
Default Value:</b><dd>
873
 
 <code>false</code> </dl><dl compact><dt><b>
874
 
Parameters: </b><dd>
875
 
<table border=0 cellspacing=2 cellpadding=0>
876
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
877
 
An encoder instance to set. </td></tr>
878
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
879
 
See above. </td></tr>
880
 
</table>
881
 
</dl><dl compact><dt><b>
882
 
Assertions:</b><dd>
883
 
 <div class="fragment"><pre>encoder != NULL 
884
 
</pre></div> </dl><dl compact><dt><b>
885
 
Return values: </b><dd>
886
 
<table border=0 cellspacing=2 cellpadding=0>
887
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
888
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
889
 
</table>
890
 
</dl>    </td>
891
 
  </tr>
892
 
</table>
893
 
<a name="a15" doxytag="file_encoder.h::FLAC__file_encoder_set_do_escape_coding"></a><p>
894
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
895
 
  <tr>
896
 
    <td class="md">
897
 
      <table cellpadding="0" cellspacing="0" border="0">
898
 
        <tr>
899
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_do_escape_coding </td>
900
 
          <td class="md" valign="top">(&nbsp;</td>
901
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
902
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
903
 
        </tr>
904
 
        <tr>
905
 
          <td></td>
906
 
          <td></td>
907
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
908
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
909
 
        </tr>
910
 
        <tr>
911
 
          <td></td>
912
 
          <td class="md">)&nbsp;</td>
913
 
          <td class="md" colspan="2"></td>
914
 
        </tr>
915
 
 
916
 
      </table>
917
 
    </td>
918
 
  </tr>
919
 
</table>
920
 
<table cellspacing=5 cellpadding=0 border=0>
921
 
  <tr>
922
 
    <td>
923
 
      &nbsp;
924
 
    </td>
925
 
    <td>
926
 
 
927
 
<p>
928
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a19">FLAC__seekable_stream_encoder_set_do_escape_coding</a>().<dl compact><dt><b>
929
 
Default Value:</b><dd>
930
 
 <code>false</code> </dl><dl compact><dt><b>
931
 
Parameters: </b><dd>
932
 
<table border=0 cellspacing=2 cellpadding=0>
933
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
934
 
An encoder instance to set. </td></tr>
935
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
936
 
See above. </td></tr>
937
 
</table>
938
 
</dl><dl compact><dt><b>
939
 
Assertions:</b><dd>
940
 
 <div class="fragment"><pre>encoder != NULL 
941
 
</pre></div> </dl><dl compact><dt><b>
942
 
Return values: </b><dd>
943
 
<table border=0 cellspacing=2 cellpadding=0>
944
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
945
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
946
 
</table>
947
 
</dl>    </td>
948
 
  </tr>
949
 
</table>
950
 
<a name="a16" doxytag="file_encoder.h::FLAC__file_encoder_set_do_exhaustive_model_search"></a><p>
951
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
952
 
  <tr>
953
 
    <td class="md">
954
 
      <table cellpadding="0" cellspacing="0" border="0">
955
 
        <tr>
956
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_do_exhaustive_model_search </td>
957
 
          <td class="md" valign="top">(&nbsp;</td>
958
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
959
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
960
 
        </tr>
961
 
        <tr>
962
 
          <td></td>
963
 
          <td></td>
964
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
965
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
966
 
        </tr>
967
 
        <tr>
968
 
          <td></td>
969
 
          <td class="md">)&nbsp;</td>
970
 
          <td class="md" colspan="2"></td>
971
 
        </tr>
972
 
 
973
 
      </table>
974
 
    </td>
975
 
  </tr>
976
 
</table>
977
 
<table cellspacing=5 cellpadding=0 border=0>
978
 
  <tr>
979
 
    <td>
980
 
      &nbsp;
981
 
    </td>
982
 
    <td>
983
 
 
984
 
<p>
985
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a20">FLAC__seekable_stream_encoder_set_do_exhaustive_model_search</a>().<dl compact><dt><b>
986
 
Default Value:</b><dd>
987
 
 <code>false</code> </dl><dl compact><dt><b>
988
 
Parameters: </b><dd>
989
 
<table border=0 cellspacing=2 cellpadding=0>
990
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
991
 
An encoder instance to set. </td></tr>
992
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
993
 
See above. </td></tr>
994
 
</table>
995
 
</dl><dl compact><dt><b>
996
 
Assertions:</b><dd>
997
 
 <div class="fragment"><pre>encoder != NULL 
998
 
</pre></div> </dl><dl compact><dt><b>
999
 
Return values: </b><dd>
1000
 
<table border=0 cellspacing=2 cellpadding=0>
1001
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1002
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1003
 
</table>
1004
 
</dl>    </td>
1005
 
  </tr>
1006
 
</table>
1007
 
<a name="a17" doxytag="file_encoder.h::FLAC__file_encoder_set_min_residual_partition_order"></a><p>
1008
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1009
 
  <tr>
1010
 
    <td class="md">
1011
 
      <table cellpadding="0" cellspacing="0" border="0">
1012
 
        <tr>
1013
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_min_residual_partition_order </td>
1014
 
          <td class="md" valign="top">(&nbsp;</td>
1015
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1016
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1017
 
        </tr>
1018
 
        <tr>
1019
 
          <td></td>
1020
 
          <td></td>
1021
 
          <td class="md" nowrap>unsigned&nbsp;</td>
1022
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1023
 
        </tr>
1024
 
        <tr>
1025
 
          <td></td>
1026
 
          <td class="md">)&nbsp;</td>
1027
 
          <td class="md" colspan="2"></td>
1028
 
        </tr>
1029
 
 
1030
 
      </table>
1031
 
    </td>
1032
 
  </tr>
1033
 
</table>
1034
 
<table cellspacing=5 cellpadding=0 border=0>
1035
 
  <tr>
1036
 
    <td>
1037
 
      &nbsp;
1038
 
    </td>
1039
 
    <td>
1040
 
 
1041
 
<p>
1042
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a21">FLAC__seekable_stream_encoder_set_min_residual_partition_order</a>().<dl compact><dt><b>
1043
 
Default Value:</b><dd>
1044
 
 <code>0</code> </dl><dl compact><dt><b>
1045
 
Parameters: </b><dd>
1046
 
<table border=0 cellspacing=2 cellpadding=0>
1047
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1048
 
An encoder instance to set. </td></tr>
1049
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
1050
 
See above. </td></tr>
1051
 
</table>
1052
 
</dl><dl compact><dt><b>
1053
 
Assertions:</b><dd>
1054
 
 <div class="fragment"><pre>encoder != NULL 
1055
 
</pre></div> </dl><dl compact><dt><b>
1056
 
Return values: </b><dd>
1057
 
<table border=0 cellspacing=2 cellpadding=0>
1058
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1059
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1060
 
</table>
1061
 
</dl>    </td>
1062
 
  </tr>
1063
 
</table>
1064
 
<a name="a18" doxytag="file_encoder.h::FLAC__file_encoder_set_max_residual_partition_order"></a><p>
1065
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1066
 
  <tr>
1067
 
    <td class="md">
1068
 
      <table cellpadding="0" cellspacing="0" border="0">
1069
 
        <tr>
1070
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_max_residual_partition_order </td>
1071
 
          <td class="md" valign="top">(&nbsp;</td>
1072
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1073
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1074
 
        </tr>
1075
 
        <tr>
1076
 
          <td></td>
1077
 
          <td></td>
1078
 
          <td class="md" nowrap>unsigned&nbsp;</td>
1079
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1080
 
        </tr>
1081
 
        <tr>
1082
 
          <td></td>
1083
 
          <td class="md">)&nbsp;</td>
1084
 
          <td class="md" colspan="2"></td>
1085
 
        </tr>
1086
 
 
1087
 
      </table>
1088
 
    </td>
1089
 
  </tr>
1090
 
</table>
1091
 
<table cellspacing=5 cellpadding=0 border=0>
1092
 
  <tr>
1093
 
    <td>
1094
 
      &nbsp;
1095
 
    </td>
1096
 
    <td>
1097
 
 
1098
 
<p>
1099
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a22">FLAC__seekable_stream_encoder_set_max_residual_partition_order</a>().<dl compact><dt><b>
1100
 
Default Value:</b><dd>
1101
 
 <code>0</code> </dl><dl compact><dt><b>
1102
 
Parameters: </b><dd>
1103
 
<table border=0 cellspacing=2 cellpadding=0>
1104
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1105
 
An encoder instance to set. </td></tr>
1106
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
1107
 
See above. </td></tr>
1108
 
</table>
1109
 
</dl><dl compact><dt><b>
1110
 
Assertions:</b><dd>
1111
 
 <div class="fragment"><pre>encoder != NULL 
1112
 
</pre></div> </dl><dl compact><dt><b>
1113
 
Return values: </b><dd>
1114
 
<table border=0 cellspacing=2 cellpadding=0>
1115
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1116
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1117
 
</table>
1118
 
</dl>    </td>
1119
 
  </tr>
1120
 
</table>
1121
 
<a name="a19" doxytag="file_encoder.h::FLAC__file_encoder_set_rice_parameter_search_dist"></a><p>
1122
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1123
 
  <tr>
1124
 
    <td class="md">
1125
 
      <table cellpadding="0" cellspacing="0" border="0">
1126
 
        <tr>
1127
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_rice_parameter_search_dist </td>
1128
 
          <td class="md" valign="top">(&nbsp;</td>
1129
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1130
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1131
 
        </tr>
1132
 
        <tr>
1133
 
          <td></td>
1134
 
          <td></td>
1135
 
          <td class="md" nowrap>unsigned&nbsp;</td>
1136
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1137
 
        </tr>
1138
 
        <tr>
1139
 
          <td></td>
1140
 
          <td class="md">)&nbsp;</td>
1141
 
          <td class="md" colspan="2"></td>
1142
 
        </tr>
1143
 
 
1144
 
      </table>
1145
 
    </td>
1146
 
  </tr>
1147
 
</table>
1148
 
<table cellspacing=5 cellpadding=0 border=0>
1149
 
  <tr>
1150
 
    <td>
1151
 
      &nbsp;
1152
 
    </td>
1153
 
    <td>
1154
 
 
1155
 
<p>
1156
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a23">FLAC__seekable_stream_encoder_set_rice_parameter_search_dist</a>().<dl compact><dt><b>
1157
 
Default Value:</b><dd>
1158
 
 <code>0</code> </dl><dl compact><dt><b>
1159
 
Parameters: </b><dd>
1160
 
<table border=0 cellspacing=2 cellpadding=0>
1161
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1162
 
An encoder instance to set. </td></tr>
1163
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
1164
 
See above. </td></tr>
1165
 
</table>
1166
 
</dl><dl compact><dt><b>
1167
 
Assertions:</b><dd>
1168
 
 <div class="fragment"><pre>encoder != NULL 
1169
 
</pre></div> </dl><dl compact><dt><b>
1170
 
Return values: </b><dd>
1171
 
<table border=0 cellspacing=2 cellpadding=0>
1172
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1173
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1174
 
</table>
1175
 
</dl>    </td>
1176
 
  </tr>
1177
 
</table>
1178
 
<a name="a20" doxytag="file_encoder.h::FLAC__file_encoder_set_total_samples_estimate"></a><p>
1179
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1180
 
  <tr>
1181
 
    <td class="md">
1182
 
      <table cellpadding="0" cellspacing="0" border="0">
1183
 
        <tr>
1184
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_total_samples_estimate </td>
1185
 
          <td class="md" valign="top">(&nbsp;</td>
1186
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1187
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1188
 
        </tr>
1189
 
        <tr>
1190
 
          <td></td>
1191
 
          <td></td>
1192
 
          <td class="md" nowrap>FLAC__uint64&nbsp;</td>
1193
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1194
 
        </tr>
1195
 
        <tr>
1196
 
          <td></td>
1197
 
          <td class="md">)&nbsp;</td>
1198
 
          <td class="md" colspan="2"></td>
1199
 
        </tr>
1200
 
 
1201
 
      </table>
1202
 
    </td>
1203
 
  </tr>
1204
 
</table>
1205
 
<table cellspacing=5 cellpadding=0 border=0>
1206
 
  <tr>
1207
 
    <td>
1208
 
      &nbsp;
1209
 
    </td>
1210
 
    <td>
1211
 
 
1212
 
<p>
1213
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a24">FLAC__seekable_stream_encoder_set_total_samples_estimate</a>().<dl compact><dt><b>
1214
 
Default Value:</b><dd>
1215
 
 <code>0</code> </dl><dl compact><dt><b>
1216
 
Parameters: </b><dd>
1217
 
<table border=0 cellspacing=2 cellpadding=0>
1218
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1219
 
An encoder instance to set. </td></tr>
1220
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
1221
 
See above. </td></tr>
1222
 
</table>
1223
 
</dl><dl compact><dt><b>
1224
 
Assertions:</b><dd>
1225
 
 <div class="fragment"><pre>encoder != NULL 
1226
 
</pre></div> </dl><dl compact><dt><b>
1227
 
Return values: </b><dd>
1228
 
<table border=0 cellspacing=2 cellpadding=0>
1229
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1230
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1231
 
</table>
1232
 
</dl>    </td>
1233
 
  </tr>
1234
 
</table>
1235
 
<a name="a21" doxytag="file_encoder.h::FLAC__file_encoder_set_metadata"></a><p>
1236
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1237
 
  <tr>
1238
 
    <td class="md">
1239
 
      <table cellpadding="0" cellspacing="0" border="0">
1240
 
        <tr>
1241
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_metadata </td>
1242
 
          <td class="md" valign="top">(&nbsp;</td>
1243
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1244
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1245
 
        </tr>
1246
 
        <tr>
1247
 
          <td></td>
1248
 
          <td></td>
1249
 
          <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **&nbsp;</td>
1250
 
          <td class="mdname" nowrap>&nbsp; <em>metadata</em>, </td>
1251
 
        </tr>
1252
 
        <tr>
1253
 
          <td></td>
1254
 
          <td></td>
1255
 
          <td class="md" nowrap>unsigned&nbsp;</td>
1256
 
          <td class="mdname" nowrap>&nbsp; <em>num_blocks</em></td>
1257
 
        </tr>
1258
 
        <tr>
1259
 
          <td></td>
1260
 
          <td class="md">)&nbsp;</td>
1261
 
          <td class="md" colspan="2"></td>
1262
 
        </tr>
1263
 
 
1264
 
      </table>
1265
 
    </td>
1266
 
  </tr>
1267
 
</table>
1268
 
<table cellspacing=5 cellpadding=0 border=0>
1269
 
  <tr>
1270
 
    <td>
1271
 
      &nbsp;
1272
 
    </td>
1273
 
    <td>
1274
 
 
1275
 
<p>
1276
 
This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a25">FLAC__seekable_stream_encoder_set_metadata</a>().<dl compact><dt><b>
1277
 
Default Value:</b><dd>
1278
 
 <code>NULL</code>, 0 </dl><dl compact><dt><b>
1279
 
Parameters: </b><dd>
1280
 
<table border=0 cellspacing=2 cellpadding=0>
1281
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1282
 
An encoder instance to set. </td></tr>
1283
 
<tr><td valign=top><em>metadata</em>&nbsp;</td><td>
1284
 
See above. </td></tr>
1285
 
<tr><td valign=top><em>num_blocks</em>&nbsp;</td><td>
1286
 
See above. </td></tr>
1287
 
</table>
1288
 
</dl><dl compact><dt><b>
1289
 
Assertions:</b><dd>
1290
 
 <div class="fragment"><pre>encoder != NULL 
1291
 
</pre></div> </dl><dl compact><dt><b>
1292
 
Return values: </b><dd>
1293
 
<table border=0 cellspacing=2 cellpadding=0>
1294
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1295
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1296
 
</table>
1297
 
</dl>    </td>
1298
 
  </tr>
1299
 
</table>
1300
 
<a name="a22" doxytag="file_encoder.h::FLAC__file_encoder_set_filename"></a><p>
1301
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1302
 
  <tr>
1303
 
    <td class="md">
1304
 
      <table cellpadding="0" cellspacing="0" border="0">
1305
 
        <tr>
1306
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_filename </td>
1307
 
          <td class="md" valign="top">(&nbsp;</td>
1308
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1309
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1310
 
        </tr>
1311
 
        <tr>
1312
 
          <td></td>
1313
 
          <td></td>
1314
 
          <td class="md" nowrap>const char *&nbsp;</td>
1315
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1316
 
        </tr>
1317
 
        <tr>
1318
 
          <td></td>
1319
 
          <td class="md">)&nbsp;</td>
1320
 
          <td class="md" colspan="2"></td>
1321
 
        </tr>
1322
 
 
1323
 
      </table>
1324
 
    </td>
1325
 
  </tr>
1326
 
</table>
1327
 
<table cellspacing=5 cellpadding=0 border=0>
1328
 
  <tr>
1329
 
    <td>
1330
 
      &nbsp;
1331
 
    </td>
1332
 
    <td>
1333
 
 
1334
 
<p>
1335
 
Set the output file name encode to.
1336
 
<p>
1337
 
<dl compact><dt><b>
1338
 
Note: </b><dd>
1339
 
 The filename is mandatory and must be set before initialization.</dl><dl compact><dt><b>
1340
 
Note: </b><dd>
1341
 
 Unlike the <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a>, the filename does not interpret "-" for <code>stdout</code>; writing to <code>stdout</code> is not relevant in the file encoder.</dl><dl compact><dt><b>
1342
 
Default Value:</b><dd>
1343
 
 <code>NULL</code> </dl><dl compact><dt><b>
1344
 
Parameters: </b><dd>
1345
 
<table border=0 cellspacing=2 cellpadding=0>
1346
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1347
 
A encoder instance to set. </td></tr>
1348
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
1349
 
The output file name. </td></tr>
1350
 
</table>
1351
 
</dl><dl compact><dt><b>
1352
 
Assertions:</b><dd>
1353
 
 <div class="fragment"><pre>encoder != NULL 
1354
 
</pre></div> <div class="fragment"><pre>value != NULL 
1355
 
</pre></div> </dl><dl compact><dt><b>
1356
 
Return values: </b><dd>
1357
 
<table border=0 cellspacing=2 cellpadding=0>
1358
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1359
 
<code>false</code> if the encoder is already initialized, or there was a memory allocation error, else <code>true</code>. </td></tr>
1360
 
</table>
1361
 
</dl>    </td>
1362
 
  </tr>
1363
 
</table>
1364
 
<a name="a23" doxytag="file_encoder.h::FLAC__file_encoder_set_progress_callback"></a><p>
1365
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1366
 
  <tr>
1367
 
    <td class="md">
1368
 
      <table cellpadding="0" cellspacing="0" border="0">
1369
 
        <tr>
1370
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_progress_callback </td>
1371
 
          <td class="md" valign="top">(&nbsp;</td>
1372
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1373
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1374
 
        </tr>
1375
 
        <tr>
1376
 
          <td></td>
1377
 
          <td></td>
1378
 
          <td class="md" nowrap><a class="el" href="group__flac__file__encoder.html#a1">FLAC__FileEncoderProgressCallback</a>&nbsp;</td>
1379
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1380
 
        </tr>
1381
 
        <tr>
1382
 
          <td></td>
1383
 
          <td class="md">)&nbsp;</td>
1384
 
          <td class="md" colspan="2"></td>
1385
 
        </tr>
1386
 
 
1387
 
      </table>
1388
 
    </td>
1389
 
  </tr>
1390
 
</table>
1391
 
<table cellspacing=5 cellpadding=0 border=0>
1392
 
  <tr>
1393
 
    <td>
1394
 
      &nbsp;
1395
 
    </td>
1396
 
    <td>
1397
 
 
1398
 
<p>
1399
 
Set the progress callback. The supplied function will be called when the encoder has finished writing a frame. The <code>total_frames_estimate</code> argument to the callback will be based on the value from <a class="el" href="group__flac__file__encoder.html#a20">FLAC__file_encoder_set_total_samples_estimate</a>().
1400
 
<p>
1401
 
<dl compact><dt><b>
1402
 
Note: </b><dd>
1403
 
 Unlike most other callbacks, the progress callback is <b>not</b> mandatory and need not be set before initialization.</dl><dl compact><dt><b>
1404
 
Default Value:</b><dd>
1405
 
 <code>NULL</code> </dl><dl compact><dt><b>
1406
 
Parameters: </b><dd>
1407
 
<table border=0 cellspacing=2 cellpadding=0>
1408
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1409
 
An encoder instance to set. </td></tr>
1410
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
1411
 
See above. </td></tr>
1412
 
</table>
1413
 
</dl><dl compact><dt><b>
1414
 
Assertions:</b><dd>
1415
 
 <div class="fragment"><pre>encoder != NULL 
1416
 
</pre></div> <div class="fragment"><pre>value != NULL 
1417
 
</pre></div> </dl><dl compact><dt><b>
1418
 
Return values: </b><dd>
1419
 
<table border=0 cellspacing=2 cellpadding=0>
1420
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1421
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1422
 
</table>
1423
 
</dl>    </td>
1424
 
  </tr>
1425
 
</table>
1426
 
<a name="a24" doxytag="file_encoder.h::FLAC__file_encoder_set_client_data"></a><p>
1427
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1428
 
  <tr>
1429
 
    <td class="md">
1430
 
      <table cellpadding="0" cellspacing="0" border="0">
1431
 
        <tr>
1432
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_set_client_data </td>
1433
 
          <td class="md" valign="top">(&nbsp;</td>
1434
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1435
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1436
 
        </tr>
1437
 
        <tr>
1438
 
          <td></td>
1439
 
          <td></td>
1440
 
          <td class="md" nowrap>void *&nbsp;</td>
1441
 
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
1442
 
        </tr>
1443
 
        <tr>
1444
 
          <td></td>
1445
 
          <td class="md">)&nbsp;</td>
1446
 
          <td class="md" colspan="2"></td>
1447
 
        </tr>
1448
 
 
1449
 
      </table>
1450
 
    </td>
1451
 
  </tr>
1452
 
</table>
1453
 
<table cellspacing=5 cellpadding=0 border=0>
1454
 
  <tr>
1455
 
    <td>
1456
 
      &nbsp;
1457
 
    </td>
1458
 
    <td>
1459
 
 
1460
 
<p>
1461
 
Set the client data to be passed back to callbacks. This value will be supplied to callbacks in their <em>client_data</em> argument.<dl compact><dt><b>
1462
 
Default Value:</b><dd>
1463
 
 <code>NULL</code> </dl><dl compact><dt><b>
1464
 
Parameters: </b><dd>
1465
 
<table border=0 cellspacing=2 cellpadding=0>
1466
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1467
 
An encoder instance to set. </td></tr>
1468
 
<tr><td valign=top><em>value</em>&nbsp;</td><td>
1469
 
See above. </td></tr>
1470
 
</table>
1471
 
</dl><dl compact><dt><b>
1472
 
Assertions:</b><dd>
1473
 
 <div class="fragment"><pre>encoder != NULL 
1474
 
</pre></div> </dl><dl compact><dt><b>
1475
 
Return values: </b><dd>
1476
 
<table border=0 cellspacing=2 cellpadding=0>
1477
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1478
 
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1479
 
</table>
1480
 
</dl>    </td>
1481
 
  </tr>
1482
 
</table>
1483
 
<a name="a25" doxytag="file_encoder.h::FLAC__file_encoder_get_state"></a><p>
1484
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1485
 
  <tr>
1486
 
    <td class="md">
1487
 
      <table cellpadding="0" cellspacing="0" border="0">
1488
 
        <tr>
1489
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a> FLAC__file_encoder_get_state </td>
1490
 
          <td class="md" valign="top">(&nbsp;</td>
1491
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1492
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1493
 
          <td class="md" valign="top">)&nbsp;</td>
1494
 
          <td class="md" nowrap></td>
1495
 
        </tr>
1496
 
 
1497
 
      </table>
1498
 
    </td>
1499
 
  </tr>
1500
 
</table>
1501
 
<table cellspacing=5 cellpadding=0 border=0>
1502
 
  <tr>
1503
 
    <td>
1504
 
      &nbsp;
1505
 
    </td>
1506
 
    <td>
1507
 
 
1508
 
<p>
1509
 
Get the current encoder state.<dl compact><dt><b>
1510
 
Parameters: </b><dd>
1511
 
<table border=0 cellspacing=2 cellpadding=0>
1512
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1513
 
An encoder instance to query. </td></tr>
1514
 
</table>
1515
 
</dl><dl compact><dt><b>
1516
 
Assertions:</b><dd>
1517
 
 <div class="fragment"><pre>encoder != NULL 
1518
 
</pre></div> </dl><dl compact><dt><b>
1519
 
Return values: </b><dd>
1520
 
<table border=0 cellspacing=2 cellpadding=0>
1521
 
<tr><td valign=top><em>FLAC__FileEncoderState</em>&nbsp;</td><td>
1522
 
The current encoder state. </td></tr>
1523
 
</table>
1524
 
</dl>    </td>
1525
 
  </tr>
1526
 
</table>
1527
 
<a name="a26" doxytag="file_encoder.h::FLAC__file_encoder_get_seekable_stream_encoder_state"></a><p>
1528
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1529
 
  <tr>
1530
 
    <td class="md">
1531
 
      <table cellpadding="0" cellspacing="0" border="0">
1532
 
        <tr>
1533
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__seekable__stream__encoder.html#a56">FLAC__SeekableStreamEncoderState</a> FLAC__file_encoder_get_seekable_stream_encoder_state </td>
1534
 
          <td class="md" valign="top">(&nbsp;</td>
1535
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1536
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1537
 
          <td class="md" valign="top">)&nbsp;</td>
1538
 
          <td class="md" nowrap></td>
1539
 
        </tr>
1540
 
 
1541
 
      </table>
1542
 
    </td>
1543
 
  </tr>
1544
 
</table>
1545
 
<table cellspacing=5 cellpadding=0 border=0>
1546
 
  <tr>
1547
 
    <td>
1548
 
      &nbsp;
1549
 
    </td>
1550
 
    <td>
1551
 
 
1552
 
<p>
1553
 
Get the state of the underlying seekable stream encoder. Useful when the file encoder state is <code>FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</code>.<dl compact><dt><b>
1554
 
Parameters: </b><dd>
1555
 
<table border=0 cellspacing=2 cellpadding=0>
1556
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1557
 
An encoder instance to query. </td></tr>
1558
 
</table>
1559
 
</dl><dl compact><dt><b>
1560
 
Assertions:</b><dd>
1561
 
 <div class="fragment"><pre>encoder != NULL 
1562
 
</pre></div> </dl><dl compact><dt><b>
1563
 
Return values: </b><dd>
1564
 
<table border=0 cellspacing=2 cellpadding=0>
1565
 
<tr><td valign=top><em>FLAC__SeekableStreamEncoderState</em>&nbsp;</td><td>
1566
 
The seekable stream encoder state. </td></tr>
1567
 
</table>
1568
 
</dl>    </td>
1569
 
  </tr>
1570
 
</table>
1571
 
<a name="a27" doxytag="file_encoder.h::FLAC__file_encoder_get_stream_encoder_state"></a><p>
1572
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1573
 
  <tr>
1574
 
    <td class="md">
1575
 
      <table cellpadding="0" cellspacing="0" border="0">
1576
 
        <tr>
1577
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__stream__encoder.html#a52">FLAC__StreamEncoderState</a> FLAC__file_encoder_get_stream_encoder_state </td>
1578
 
          <td class="md" valign="top">(&nbsp;</td>
1579
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1580
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1581
 
          <td class="md" valign="top">)&nbsp;</td>
1582
 
          <td class="md" nowrap></td>
1583
 
        </tr>
1584
 
 
1585
 
      </table>
1586
 
    </td>
1587
 
  </tr>
1588
 
</table>
1589
 
<table cellspacing=5 cellpadding=0 border=0>
1590
 
  <tr>
1591
 
    <td>
1592
 
      &nbsp;
1593
 
    </td>
1594
 
    <td>
1595
 
 
1596
 
<p>
1597
 
Get the state of the underlying stream encoder. Useful when the file encoder state is <code>FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</code> and the seekable stream encoder state is <code>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</code>.<dl compact><dt><b>
1598
 
Parameters: </b><dd>
1599
 
<table border=0 cellspacing=2 cellpadding=0>
1600
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1601
 
An encoder instance to query. </td></tr>
1602
 
</table>
1603
 
</dl><dl compact><dt><b>
1604
 
Assertions:</b><dd>
1605
 
 <div class="fragment"><pre>encoder != NULL 
1606
 
</pre></div> </dl><dl compact><dt><b>
1607
 
Return values: </b><dd>
1608
 
<table border=0 cellspacing=2 cellpadding=0>
1609
 
<tr><td valign=top><em>FLAC__StreamEncoderState</em>&nbsp;</td><td>
1610
 
The seekable stream encoder state. </td></tr>
1611
 
</table>
1612
 
</dl>    </td>
1613
 
  </tr>
1614
 
</table>
1615
 
<a name="a28" doxytag="file_encoder.h::FLAC__file_encoder_get_verify_decoder_state"></a><p>
1616
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1617
 
  <tr>
1618
 
    <td class="md">
1619
 
      <table cellpadding="0" cellspacing="0" border="0">
1620
 
        <tr>
1621
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a> FLAC__file_encoder_get_verify_decoder_state </td>
1622
 
          <td class="md" valign="top">(&nbsp;</td>
1623
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1624
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1625
 
          <td class="md" valign="top">)&nbsp;</td>
1626
 
          <td class="md" nowrap></td>
1627
 
        </tr>
1628
 
 
1629
 
      </table>
1630
 
    </td>
1631
 
  </tr>
1632
 
</table>
1633
 
<table cellspacing=5 cellpadding=0 border=0>
1634
 
  <tr>
1635
 
    <td>
1636
 
      &nbsp;
1637
 
    </td>
1638
 
    <td>
1639
 
 
1640
 
<p>
1641
 
Get the state of the underlying stream encoder's verify decoder. Useful when the file encoder state is <code>FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</code> and the seekable stream encoder state is <code>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</code> and the stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>.<dl compact><dt><b>
1642
 
Parameters: </b><dd>
1643
 
<table border=0 cellspacing=2 cellpadding=0>
1644
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1645
 
An encoder instance to query. </td></tr>
1646
 
</table>
1647
 
</dl><dl compact><dt><b>
1648
 
Assertions:</b><dd>
1649
 
 <div class="fragment"><pre>encoder != NULL 
1650
 
</pre></div> </dl><dl compact><dt><b>
1651
 
Return values: </b><dd>
1652
 
<table border=0 cellspacing=2 cellpadding=0>
1653
 
<tr><td valign=top><em>FLAC__StreamDecoderState</em>&nbsp;</td><td>
1654
 
The stream encoder state. </td></tr>
1655
 
</table>
1656
 
</dl>    </td>
1657
 
  </tr>
1658
 
</table>
1659
 
<a name="a29" doxytag="file_encoder.h::FLAC__file_encoder_get_resolved_state_string"></a><p>
1660
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1661
 
  <tr>
1662
 
    <td class="md">
1663
 
      <table cellpadding="0" cellspacing="0" border="0">
1664
 
        <tr>
1665
 
          <td class="md" nowrap valign="top"> const char* FLAC__file_encoder_get_resolved_state_string </td>
1666
 
          <td class="md" valign="top">(&nbsp;</td>
1667
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1668
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1669
 
          <td class="md" valign="top">)&nbsp;</td>
1670
 
          <td class="md" nowrap></td>
1671
 
        </tr>
1672
 
 
1673
 
      </table>
1674
 
    </td>
1675
 
  </tr>
1676
 
</table>
1677
 
<table cellspacing=5 cellpadding=0 border=0>
1678
 
  <tr>
1679
 
    <td>
1680
 
      &nbsp;
1681
 
    </td>
1682
 
    <td>
1683
 
 
1684
 
<p>
1685
 
Get the current encoder state as a C string. This version automatically resolves <code>FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</code> by getting the seekable stream encoder's state.<dl compact><dt><b>
1686
 
Parameters: </b><dd>
1687
 
<table border=0 cellspacing=2 cellpadding=0>
1688
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1689
 
A encoder instance to query. </td></tr>
1690
 
</table>
1691
 
</dl><dl compact><dt><b>
1692
 
Assertions:</b><dd>
1693
 
 <div class="fragment"><pre>encoder != NULL 
1694
 
</pre></div> </dl><dl compact><dt><b>
1695
 
Return values: </b><dd>
1696
 
<table border=0 cellspacing=2 cellpadding=0>
1697
 
<tr><td valign=top><em>const</em>&nbsp;</td><td>
1698
 
char * The encoder state as a C string. Do not modify the contents. </td></tr>
1699
 
</table>
1700
 
</dl>    </td>
1701
 
  </tr>
1702
 
</table>
1703
 
<a name="a30" doxytag="file_encoder.h::FLAC__file_encoder_get_verify_decoder_error_stats"></a><p>
1704
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1705
 
  <tr>
1706
 
    <td class="md">
1707
 
      <table cellpadding="0" cellspacing="0" border="0">
1708
 
        <tr>
1709
 
          <td class="md" nowrap valign="top"> void FLAC__file_encoder_get_verify_decoder_error_stats </td>
1710
 
          <td class="md" valign="top">(&nbsp;</td>
1711
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1712
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
1713
 
        </tr>
1714
 
        <tr>
1715
 
          <td></td>
1716
 
          <td></td>
1717
 
          <td class="md" nowrap>FLAC__uint64 *&nbsp;</td>
1718
 
          <td class="mdname" nowrap>&nbsp; <em>absolute_sample</em>, </td>
1719
 
        </tr>
1720
 
        <tr>
1721
 
          <td></td>
1722
 
          <td></td>
1723
 
          <td class="md" nowrap>unsigned *&nbsp;</td>
1724
 
          <td class="mdname" nowrap>&nbsp; <em>frame_number</em>, </td>
1725
 
        </tr>
1726
 
        <tr>
1727
 
          <td></td>
1728
 
          <td></td>
1729
 
          <td class="md" nowrap>unsigned *&nbsp;</td>
1730
 
          <td class="mdname" nowrap>&nbsp; <em>channel</em>, </td>
1731
 
        </tr>
1732
 
        <tr>
1733
 
          <td></td>
1734
 
          <td></td>
1735
 
          <td class="md" nowrap>unsigned *&nbsp;</td>
1736
 
          <td class="mdname" nowrap>&nbsp; <em>sample</em>, </td>
1737
 
        </tr>
1738
 
        <tr>
1739
 
          <td></td>
1740
 
          <td></td>
1741
 
          <td class="md" nowrap>FLAC__int32 *&nbsp;</td>
1742
 
          <td class="mdname" nowrap>&nbsp; <em>expected</em>, </td>
1743
 
        </tr>
1744
 
        <tr>
1745
 
          <td></td>
1746
 
          <td></td>
1747
 
          <td class="md" nowrap>FLAC__int32 *&nbsp;</td>
1748
 
          <td class="mdname" nowrap>&nbsp; <em>got</em></td>
1749
 
        </tr>
1750
 
        <tr>
1751
 
          <td></td>
1752
 
          <td class="md">)&nbsp;</td>
1753
 
          <td class="md" colspan="2"></td>
1754
 
        </tr>
1755
 
 
1756
 
      </table>
1757
 
    </td>
1758
 
  </tr>
1759
 
</table>
1760
 
<table cellspacing=5 cellpadding=0 border=0>
1761
 
  <tr>
1762
 
    <td>
1763
 
      &nbsp;
1764
 
    </td>
1765
 
    <td>
1766
 
 
1767
 
<p>
1768
 
Get relevant values about the nature of a verify decoder error. Inherited from <a class="el" href="group__flac__seekable__stream__encoder.html#a34">FLAC__seekable_stream_encoder_get_verify_decoder_error_stats</a>(). Useful when the file encoder state is <code>FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</code> and the seekable stream encoder state is <code>FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR</code> and the stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>.<dl compact><dt><b>
1769
 
Parameters: </b><dd>
1770
 
<table border=0 cellspacing=2 cellpadding=0>
1771
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1772
 
An encoder instance to query. </td></tr>
1773
 
<tr><td valign=top><em>absolute_sample</em>&nbsp;</td><td>
1774
 
The absolute sample number of the mismatch. </td></tr>
1775
 
<tr><td valign=top><em>frame_number</em>&nbsp;</td><td>
1776
 
The number of the frame in which the mismatch occurred. </td></tr>
1777
 
<tr><td valign=top><em>channel</em>&nbsp;</td><td>
1778
 
The channel in which the mismatch occurred. </td></tr>
1779
 
<tr><td valign=top><em>sample</em>&nbsp;</td><td>
1780
 
The number of the sample (relative to the frame) in which the mismatch occurred. </td></tr>
1781
 
<tr><td valign=top><em>expected</em>&nbsp;</td><td>
1782
 
The expected value for the sample in question. </td></tr>
1783
 
<tr><td valign=top><em>got</em>&nbsp;</td><td>
1784
 
The actual value returned by the decoder. </td></tr>
1785
 
</table>
1786
 
</dl><dl compact><dt><b>
1787
 
Assertions:</b><dd>
1788
 
 <div class="fragment"><pre>encoder != NULL 
1789
 
</pre></div> </dl>    </td>
1790
 
  </tr>
1791
 
</table>
1792
 
<a name="a31" doxytag="file_encoder.h::FLAC__file_encoder_get_verify"></a><p>
1793
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1794
 
  <tr>
1795
 
    <td class="md">
1796
 
      <table cellpadding="0" cellspacing="0" border="0">
1797
 
        <tr>
1798
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_get_verify </td>
1799
 
          <td class="md" valign="top">(&nbsp;</td>
1800
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1801
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1802
 
          <td class="md" valign="top">)&nbsp;</td>
1803
 
          <td class="md" nowrap></td>
1804
 
        </tr>
1805
 
 
1806
 
      </table>
1807
 
    </td>
1808
 
  </tr>
1809
 
</table>
1810
 
<table cellspacing=5 cellpadding=0 border=0>
1811
 
  <tr>
1812
 
    <td>
1813
 
      &nbsp;
1814
 
    </td>
1815
 
    <td>
1816
 
 
1817
 
<p>
1818
 
Get the "verify" flag. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a35">FLAC__seekable_stream_encoder_get_verify</a>().<dl compact><dt><b>
1819
 
Parameters: </b><dd>
1820
 
<table border=0 cellspacing=2 cellpadding=0>
1821
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1822
 
An encoder instance to query. </td></tr>
1823
 
</table>
1824
 
</dl><dl compact><dt><b>
1825
 
Assertions:</b><dd>
1826
 
 <div class="fragment"><pre>encoder != NULL 
1827
 
</pre></div> </dl><dl compact><dt><b>
1828
 
Return values: </b><dd>
1829
 
<table border=0 cellspacing=2 cellpadding=0>
1830
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1831
 
See <a class="el" href="group__flac__file__encoder.html#a4">FLAC__file_encoder_set_verify</a>(). </td></tr>
1832
 
</table>
1833
 
</dl>    </td>
1834
 
  </tr>
1835
 
</table>
1836
 
<a name="a32" doxytag="file_encoder.h::FLAC__file_encoder_get_streamable_subset"></a><p>
1837
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1838
 
  <tr>
1839
 
    <td class="md">
1840
 
      <table cellpadding="0" cellspacing="0" border="0">
1841
 
        <tr>
1842
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_get_streamable_subset </td>
1843
 
          <td class="md" valign="top">(&nbsp;</td>
1844
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1845
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1846
 
          <td class="md" valign="top">)&nbsp;</td>
1847
 
          <td class="md" nowrap></td>
1848
 
        </tr>
1849
 
 
1850
 
      </table>
1851
 
    </td>
1852
 
  </tr>
1853
 
</table>
1854
 
<table cellspacing=5 cellpadding=0 border=0>
1855
 
  <tr>
1856
 
    <td>
1857
 
      &nbsp;
1858
 
    </td>
1859
 
    <td>
1860
 
 
1861
 
<p>
1862
 
Get the "streamable subset" flag. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a36">FLAC__seekable_stream_encoder_get_streamable_subset</a>().<dl compact><dt><b>
1863
 
Parameters: </b><dd>
1864
 
<table border=0 cellspacing=2 cellpadding=0>
1865
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1866
 
An encoder instance to query. </td></tr>
1867
 
</table>
1868
 
</dl><dl compact><dt><b>
1869
 
Assertions:</b><dd>
1870
 
 <div class="fragment"><pre>encoder != NULL 
1871
 
</pre></div> </dl><dl compact><dt><b>
1872
 
Return values: </b><dd>
1873
 
<table border=0 cellspacing=2 cellpadding=0>
1874
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1875
 
See <a class="el" href="group__flac__file__encoder.html#a5">FLAC__file_encoder_set_streamable_subset</a>(). </td></tr>
1876
 
</table>
1877
 
</dl>    </td>
1878
 
  </tr>
1879
 
</table>
1880
 
<a name="a33" doxytag="file_encoder.h::FLAC__file_encoder_get_do_mid_side_stereo"></a><p>
1881
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1882
 
  <tr>
1883
 
    <td class="md">
1884
 
      <table cellpadding="0" cellspacing="0" border="0">
1885
 
        <tr>
1886
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_get_do_mid_side_stereo </td>
1887
 
          <td class="md" valign="top">(&nbsp;</td>
1888
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1889
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1890
 
          <td class="md" valign="top">)&nbsp;</td>
1891
 
          <td class="md" nowrap></td>
1892
 
        </tr>
1893
 
 
1894
 
      </table>
1895
 
    </td>
1896
 
  </tr>
1897
 
</table>
1898
 
<table cellspacing=5 cellpadding=0 border=0>
1899
 
  <tr>
1900
 
    <td>
1901
 
      &nbsp;
1902
 
    </td>
1903
 
    <td>
1904
 
 
1905
 
<p>
1906
 
Get the "mid/side stereo coding" flag. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a37">FLAC__seekable_stream_encoder_get_do_mid_side_stereo</a>().<dl compact><dt><b>
1907
 
Parameters: </b><dd>
1908
 
<table border=0 cellspacing=2 cellpadding=0>
1909
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1910
 
An encoder instance to query. </td></tr>
1911
 
</table>
1912
 
</dl><dl compact><dt><b>
1913
 
Assertions:</b><dd>
1914
 
 <div class="fragment"><pre>encoder != NULL 
1915
 
</pre></div> </dl><dl compact><dt><b>
1916
 
Return values: </b><dd>
1917
 
<table border=0 cellspacing=2 cellpadding=0>
1918
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1919
 
See <a class="el" href="group__flac__file__encoder.html#a33">FLAC__file_encoder_get_do_mid_side_stereo</a>(). </td></tr>
1920
 
</table>
1921
 
</dl>    </td>
1922
 
  </tr>
1923
 
</table>
1924
 
<a name="a34" doxytag="file_encoder.h::FLAC__file_encoder_get_loose_mid_side_stereo"></a><p>
1925
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1926
 
  <tr>
1927
 
    <td class="md">
1928
 
      <table cellpadding="0" cellspacing="0" border="0">
1929
 
        <tr>
1930
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_get_loose_mid_side_stereo </td>
1931
 
          <td class="md" valign="top">(&nbsp;</td>
1932
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1933
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1934
 
          <td class="md" valign="top">)&nbsp;</td>
1935
 
          <td class="md" nowrap></td>
1936
 
        </tr>
1937
 
 
1938
 
      </table>
1939
 
    </td>
1940
 
  </tr>
1941
 
</table>
1942
 
<table cellspacing=5 cellpadding=0 border=0>
1943
 
  <tr>
1944
 
    <td>
1945
 
      &nbsp;
1946
 
    </td>
1947
 
    <td>
1948
 
 
1949
 
<p>
1950
 
Get the "adaptive mid/side switching" flag. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a38">FLAC__seekable_stream_encoder_get_loose_mid_side_stereo</a>().<dl compact><dt><b>
1951
 
Parameters: </b><dd>
1952
 
<table border=0 cellspacing=2 cellpadding=0>
1953
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1954
 
An encoder instance to query. </td></tr>
1955
 
</table>
1956
 
</dl><dl compact><dt><b>
1957
 
Assertions:</b><dd>
1958
 
 <div class="fragment"><pre>encoder != NULL 
1959
 
</pre></div> </dl><dl compact><dt><b>
1960
 
Return values: </b><dd>
1961
 
<table border=0 cellspacing=2 cellpadding=0>
1962
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
1963
 
See <a class="el" href="group__flac__file__encoder.html#a7">FLAC__file_encoder_set_loose_mid_side_stereo</a>(). </td></tr>
1964
 
</table>
1965
 
</dl>    </td>
1966
 
  </tr>
1967
 
</table>
1968
 
<a name="a35" doxytag="file_encoder.h::FLAC__file_encoder_get_channels"></a><p>
1969
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1970
 
  <tr>
1971
 
    <td class="md">
1972
 
      <table cellpadding="0" cellspacing="0" border="0">
1973
 
        <tr>
1974
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_channels </td>
1975
 
          <td class="md" valign="top">(&nbsp;</td>
1976
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
1977
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
1978
 
          <td class="md" valign="top">)&nbsp;</td>
1979
 
          <td class="md" nowrap></td>
1980
 
        </tr>
1981
 
 
1982
 
      </table>
1983
 
    </td>
1984
 
  </tr>
1985
 
</table>
1986
 
<table cellspacing=5 cellpadding=0 border=0>
1987
 
  <tr>
1988
 
    <td>
1989
 
      &nbsp;
1990
 
    </td>
1991
 
    <td>
1992
 
 
1993
 
<p>
1994
 
Get the number of input channels being processed. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a39">FLAC__seekable_stream_encoder_get_channels</a>().<dl compact><dt><b>
1995
 
Parameters: </b><dd>
1996
 
<table border=0 cellspacing=2 cellpadding=0>
1997
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
1998
 
An encoder instance to query. </td></tr>
1999
 
</table>
2000
 
</dl><dl compact><dt><b>
2001
 
Assertions:</b><dd>
2002
 
 <div class="fragment"><pre>encoder != NULL 
2003
 
</pre></div> </dl><dl compact><dt><b>
2004
 
Return values: </b><dd>
2005
 
<table border=0 cellspacing=2 cellpadding=0>
2006
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2007
 
See <a class="el" href="group__flac__file__encoder.html#a8">FLAC__file_encoder_set_channels</a>(). </td></tr>
2008
 
</table>
2009
 
</dl>    </td>
2010
 
  </tr>
2011
 
</table>
2012
 
<a name="a36" doxytag="file_encoder.h::FLAC__file_encoder_get_bits_per_sample"></a><p>
2013
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2014
 
  <tr>
2015
 
    <td class="md">
2016
 
      <table cellpadding="0" cellspacing="0" border="0">
2017
 
        <tr>
2018
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_bits_per_sample </td>
2019
 
          <td class="md" valign="top">(&nbsp;</td>
2020
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2021
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2022
 
          <td class="md" valign="top">)&nbsp;</td>
2023
 
          <td class="md" nowrap></td>
2024
 
        </tr>
2025
 
 
2026
 
      </table>
2027
 
    </td>
2028
 
  </tr>
2029
 
</table>
2030
 
<table cellspacing=5 cellpadding=0 border=0>
2031
 
  <tr>
2032
 
    <td>
2033
 
      &nbsp;
2034
 
    </td>
2035
 
    <td>
2036
 
 
2037
 
<p>
2038
 
Get the input sample resolution setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a40">FLAC__seekable_stream_encoder_get_bits_per_sample</a>().<dl compact><dt><b>
2039
 
Parameters: </b><dd>
2040
 
<table border=0 cellspacing=2 cellpadding=0>
2041
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2042
 
An encoder instance to query. </td></tr>
2043
 
</table>
2044
 
</dl><dl compact><dt><b>
2045
 
Assertions:</b><dd>
2046
 
 <div class="fragment"><pre>encoder != NULL 
2047
 
</pre></div> </dl><dl compact><dt><b>
2048
 
Return values: </b><dd>
2049
 
<table border=0 cellspacing=2 cellpadding=0>
2050
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2051
 
See <a class="el" href="group__flac__file__encoder.html#a9">FLAC__file_encoder_set_bits_per_sample</a>(). </td></tr>
2052
 
</table>
2053
 
</dl>    </td>
2054
 
  </tr>
2055
 
</table>
2056
 
<a name="a37" doxytag="file_encoder.h::FLAC__file_encoder_get_sample_rate"></a><p>
2057
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2058
 
  <tr>
2059
 
    <td class="md">
2060
 
      <table cellpadding="0" cellspacing="0" border="0">
2061
 
        <tr>
2062
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_sample_rate </td>
2063
 
          <td class="md" valign="top">(&nbsp;</td>
2064
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2065
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2066
 
          <td class="md" valign="top">)&nbsp;</td>
2067
 
          <td class="md" nowrap></td>
2068
 
        </tr>
2069
 
 
2070
 
      </table>
2071
 
    </td>
2072
 
  </tr>
2073
 
</table>
2074
 
<table cellspacing=5 cellpadding=0 border=0>
2075
 
  <tr>
2076
 
    <td>
2077
 
      &nbsp;
2078
 
    </td>
2079
 
    <td>
2080
 
 
2081
 
<p>
2082
 
Get the input sample rate setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a41">FLAC__seekable_stream_encoder_get_sample_rate</a>().<dl compact><dt><b>
2083
 
Parameters: </b><dd>
2084
 
<table border=0 cellspacing=2 cellpadding=0>
2085
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2086
 
An encoder instance to query. </td></tr>
2087
 
</table>
2088
 
</dl><dl compact><dt><b>
2089
 
Assertions:</b><dd>
2090
 
 <div class="fragment"><pre>encoder != NULL 
2091
 
</pre></div> </dl><dl compact><dt><b>
2092
 
Return values: </b><dd>
2093
 
<table border=0 cellspacing=2 cellpadding=0>
2094
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2095
 
See <a class="el" href="group__flac__file__encoder.html#a10">FLAC__file_encoder_set_sample_rate</a>(). </td></tr>
2096
 
</table>
2097
 
</dl>    </td>
2098
 
  </tr>
2099
 
</table>
2100
 
<a name="a38" doxytag="file_encoder.h::FLAC__file_encoder_get_blocksize"></a><p>
2101
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2102
 
  <tr>
2103
 
    <td class="md">
2104
 
      <table cellpadding="0" cellspacing="0" border="0">
2105
 
        <tr>
2106
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_blocksize </td>
2107
 
          <td class="md" valign="top">(&nbsp;</td>
2108
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2109
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2110
 
          <td class="md" valign="top">)&nbsp;</td>
2111
 
          <td class="md" nowrap></td>
2112
 
        </tr>
2113
 
 
2114
 
      </table>
2115
 
    </td>
2116
 
  </tr>
2117
 
</table>
2118
 
<table cellspacing=5 cellpadding=0 border=0>
2119
 
  <tr>
2120
 
    <td>
2121
 
      &nbsp;
2122
 
    </td>
2123
 
    <td>
2124
 
 
2125
 
<p>
2126
 
Get the blocksize setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a42">FLAC__seekable_stream_encoder_get_blocksize</a>().<dl compact><dt><b>
2127
 
Parameters: </b><dd>
2128
 
<table border=0 cellspacing=2 cellpadding=0>
2129
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2130
 
An encoder instance to query. </td></tr>
2131
 
</table>
2132
 
</dl><dl compact><dt><b>
2133
 
Assertions:</b><dd>
2134
 
 <div class="fragment"><pre>encoder != NULL 
2135
 
</pre></div> </dl><dl compact><dt><b>
2136
 
Return values: </b><dd>
2137
 
<table border=0 cellspacing=2 cellpadding=0>
2138
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2139
 
See <a class="el" href="group__flac__file__encoder.html#a11">FLAC__file_encoder_set_blocksize</a>(). </td></tr>
2140
 
</table>
2141
 
</dl>    </td>
2142
 
  </tr>
2143
 
</table>
2144
 
<a name="a39" doxytag="file_encoder.h::FLAC__file_encoder_get_max_lpc_order"></a><p>
2145
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2146
 
  <tr>
2147
 
    <td class="md">
2148
 
      <table cellpadding="0" cellspacing="0" border="0">
2149
 
        <tr>
2150
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_max_lpc_order </td>
2151
 
          <td class="md" valign="top">(&nbsp;</td>
2152
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2153
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2154
 
          <td class="md" valign="top">)&nbsp;</td>
2155
 
          <td class="md" nowrap></td>
2156
 
        </tr>
2157
 
 
2158
 
      </table>
2159
 
    </td>
2160
 
  </tr>
2161
 
</table>
2162
 
<table cellspacing=5 cellpadding=0 border=0>
2163
 
  <tr>
2164
 
    <td>
2165
 
      &nbsp;
2166
 
    </td>
2167
 
    <td>
2168
 
 
2169
 
<p>
2170
 
Get the maximum LPC order setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a43">FLAC__seekable_stream_encoder_get_max_lpc_order</a>().<dl compact><dt><b>
2171
 
Parameters: </b><dd>
2172
 
<table border=0 cellspacing=2 cellpadding=0>
2173
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2174
 
An encoder instance to query. </td></tr>
2175
 
</table>
2176
 
</dl><dl compact><dt><b>
2177
 
Assertions:</b><dd>
2178
 
 <div class="fragment"><pre>encoder != NULL 
2179
 
</pre></div> </dl><dl compact><dt><b>
2180
 
Return values: </b><dd>
2181
 
<table border=0 cellspacing=2 cellpadding=0>
2182
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2183
 
See <a class="el" href="group__flac__file__encoder.html#a12">FLAC__file_encoder_set_max_lpc_order</a>(). </td></tr>
2184
 
</table>
2185
 
</dl>    </td>
2186
 
  </tr>
2187
 
</table>
2188
 
<a name="a40" doxytag="file_encoder.h::FLAC__file_encoder_get_qlp_coeff_precision"></a><p>
2189
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2190
 
  <tr>
2191
 
    <td class="md">
2192
 
      <table cellpadding="0" cellspacing="0" border="0">
2193
 
        <tr>
2194
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_qlp_coeff_precision </td>
2195
 
          <td class="md" valign="top">(&nbsp;</td>
2196
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2197
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2198
 
          <td class="md" valign="top">)&nbsp;</td>
2199
 
          <td class="md" nowrap></td>
2200
 
        </tr>
2201
 
 
2202
 
      </table>
2203
 
    </td>
2204
 
  </tr>
2205
 
</table>
2206
 
<table cellspacing=5 cellpadding=0 border=0>
2207
 
  <tr>
2208
 
    <td>
2209
 
      &nbsp;
2210
 
    </td>
2211
 
    <td>
2212
 
 
2213
 
<p>
2214
 
Get the quantized linear predictor coefficient precision setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a44">FLAC__seekable_stream_encoder_get_qlp_coeff_precision</a>().<dl compact><dt><b>
2215
 
Parameters: </b><dd>
2216
 
<table border=0 cellspacing=2 cellpadding=0>
2217
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2218
 
An encoder instance to query. </td></tr>
2219
 
</table>
2220
 
</dl><dl compact><dt><b>
2221
 
Assertions:</b><dd>
2222
 
 <div class="fragment"><pre>encoder != NULL 
2223
 
</pre></div> </dl><dl compact><dt><b>
2224
 
Return values: </b><dd>
2225
 
<table border=0 cellspacing=2 cellpadding=0>
2226
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2227
 
See <a class="el" href="group__flac__file__encoder.html#a13">FLAC__file_encoder_set_qlp_coeff_precision</a>(). </td></tr>
2228
 
</table>
2229
 
</dl>    </td>
2230
 
  </tr>
2231
 
</table>
2232
 
<a name="a41" doxytag="file_encoder.h::FLAC__file_encoder_get_do_qlp_coeff_prec_search"></a><p>
2233
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2234
 
  <tr>
2235
 
    <td class="md">
2236
 
      <table cellpadding="0" cellspacing="0" border="0">
2237
 
        <tr>
2238
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_get_do_qlp_coeff_prec_search </td>
2239
 
          <td class="md" valign="top">(&nbsp;</td>
2240
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2241
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2242
 
          <td class="md" valign="top">)&nbsp;</td>
2243
 
          <td class="md" nowrap></td>
2244
 
        </tr>
2245
 
 
2246
 
      </table>
2247
 
    </td>
2248
 
  </tr>
2249
 
</table>
2250
 
<table cellspacing=5 cellpadding=0 border=0>
2251
 
  <tr>
2252
 
    <td>
2253
 
      &nbsp;
2254
 
    </td>
2255
 
    <td>
2256
 
 
2257
 
<p>
2258
 
Get the qlp coefficient precision search flag. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a45">FLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search</a>().<dl compact><dt><b>
2259
 
Parameters: </b><dd>
2260
 
<table border=0 cellspacing=2 cellpadding=0>
2261
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2262
 
An encoder instance to query. </td></tr>
2263
 
</table>
2264
 
</dl><dl compact><dt><b>
2265
 
Assertions:</b><dd>
2266
 
 <div class="fragment"><pre>encoder != NULL 
2267
 
</pre></div> </dl><dl compact><dt><b>
2268
 
Return values: </b><dd>
2269
 
<table border=0 cellspacing=2 cellpadding=0>
2270
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
2271
 
See <a class="el" href="group__flac__file__encoder.html#a14">FLAC__file_encoder_set_do_qlp_coeff_prec_search</a>(). </td></tr>
2272
 
</table>
2273
 
</dl>    </td>
2274
 
  </tr>
2275
 
</table>
2276
 
<a name="a42" doxytag="file_encoder.h::FLAC__file_encoder_get_do_escape_coding"></a><p>
2277
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2278
 
  <tr>
2279
 
    <td class="md">
2280
 
      <table cellpadding="0" cellspacing="0" border="0">
2281
 
        <tr>
2282
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_get_do_escape_coding </td>
2283
 
          <td class="md" valign="top">(&nbsp;</td>
2284
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2285
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2286
 
          <td class="md" valign="top">)&nbsp;</td>
2287
 
          <td class="md" nowrap></td>
2288
 
        </tr>
2289
 
 
2290
 
      </table>
2291
 
    </td>
2292
 
  </tr>
2293
 
</table>
2294
 
<table cellspacing=5 cellpadding=0 border=0>
2295
 
  <tr>
2296
 
    <td>
2297
 
      &nbsp;
2298
 
    </td>
2299
 
    <td>
2300
 
 
2301
 
<p>
2302
 
Get the "escape coding" flag. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a46">FLAC__seekable_stream_encoder_get_do_escape_coding</a>().<dl compact><dt><b>
2303
 
Parameters: </b><dd>
2304
 
<table border=0 cellspacing=2 cellpadding=0>
2305
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2306
 
An encoder instance to query. </td></tr>
2307
 
</table>
2308
 
</dl><dl compact><dt><b>
2309
 
Assertions:</b><dd>
2310
 
 <div class="fragment"><pre>encoder != NULL 
2311
 
</pre></div> </dl><dl compact><dt><b>
2312
 
Return values: </b><dd>
2313
 
<table border=0 cellspacing=2 cellpadding=0>
2314
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
2315
 
See <a class="el" href="group__flac__file__encoder.html#a15">FLAC__file_encoder_set_do_escape_coding</a>(). </td></tr>
2316
 
</table>
2317
 
</dl>    </td>
2318
 
  </tr>
2319
 
</table>
2320
 
<a name="a43" doxytag="file_encoder.h::FLAC__file_encoder_get_do_exhaustive_model_search"></a><p>
2321
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2322
 
  <tr>
2323
 
    <td class="md">
2324
 
      <table cellpadding="0" cellspacing="0" border="0">
2325
 
        <tr>
2326
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_get_do_exhaustive_model_search </td>
2327
 
          <td class="md" valign="top">(&nbsp;</td>
2328
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2329
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2330
 
          <td class="md" valign="top">)&nbsp;</td>
2331
 
          <td class="md" nowrap></td>
2332
 
        </tr>
2333
 
 
2334
 
      </table>
2335
 
    </td>
2336
 
  </tr>
2337
 
</table>
2338
 
<table cellspacing=5 cellpadding=0 border=0>
2339
 
  <tr>
2340
 
    <td>
2341
 
      &nbsp;
2342
 
    </td>
2343
 
    <td>
2344
 
 
2345
 
<p>
2346
 
Get the exhaustive model search flag. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a47">FLAC__seekable_stream_encoder_get_do_exhaustive_model_search</a>().<dl compact><dt><b>
2347
 
Parameters: </b><dd>
2348
 
<table border=0 cellspacing=2 cellpadding=0>
2349
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2350
 
An encoder instance to query. </td></tr>
2351
 
</table>
2352
 
</dl><dl compact><dt><b>
2353
 
Assertions:</b><dd>
2354
 
 <div class="fragment"><pre>encoder != NULL 
2355
 
</pre></div> </dl><dl compact><dt><b>
2356
 
Return values: </b><dd>
2357
 
<table border=0 cellspacing=2 cellpadding=0>
2358
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
2359
 
See <a class="el" href="group__flac__file__encoder.html#a16">FLAC__file_encoder_set_do_exhaustive_model_search</a>(). </td></tr>
2360
 
</table>
2361
 
</dl>    </td>
2362
 
  </tr>
2363
 
</table>
2364
 
<a name="a44" doxytag="file_encoder.h::FLAC__file_encoder_get_min_residual_partition_order"></a><p>
2365
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2366
 
  <tr>
2367
 
    <td class="md">
2368
 
      <table cellpadding="0" cellspacing="0" border="0">
2369
 
        <tr>
2370
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_min_residual_partition_order </td>
2371
 
          <td class="md" valign="top">(&nbsp;</td>
2372
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2373
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2374
 
          <td class="md" valign="top">)&nbsp;</td>
2375
 
          <td class="md" nowrap></td>
2376
 
        </tr>
2377
 
 
2378
 
      </table>
2379
 
    </td>
2380
 
  </tr>
2381
 
</table>
2382
 
<table cellspacing=5 cellpadding=0 border=0>
2383
 
  <tr>
2384
 
    <td>
2385
 
      &nbsp;
2386
 
    </td>
2387
 
    <td>
2388
 
 
2389
 
<p>
2390
 
Get the minimum residual partition order setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a48">FLAC__seekable_stream_encoder_get_min_residual_partition_order</a>().<dl compact><dt><b>
2391
 
Parameters: </b><dd>
2392
 
<table border=0 cellspacing=2 cellpadding=0>
2393
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2394
 
An encoder instance to query. </td></tr>
2395
 
</table>
2396
 
</dl><dl compact><dt><b>
2397
 
Assertions:</b><dd>
2398
 
 <div class="fragment"><pre>encoder != NULL 
2399
 
</pre></div> </dl><dl compact><dt><b>
2400
 
Return values: </b><dd>
2401
 
<table border=0 cellspacing=2 cellpadding=0>
2402
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2403
 
See <a class="el" href="group__flac__file__encoder.html#a17">FLAC__file_encoder_set_min_residual_partition_order</a>(). </td></tr>
2404
 
</table>
2405
 
</dl>    </td>
2406
 
  </tr>
2407
 
</table>
2408
 
<a name="a45" doxytag="file_encoder.h::FLAC__file_encoder_get_max_residual_partition_order"></a><p>
2409
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2410
 
  <tr>
2411
 
    <td class="md">
2412
 
      <table cellpadding="0" cellspacing="0" border="0">
2413
 
        <tr>
2414
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_max_residual_partition_order </td>
2415
 
          <td class="md" valign="top">(&nbsp;</td>
2416
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2417
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2418
 
          <td class="md" valign="top">)&nbsp;</td>
2419
 
          <td class="md" nowrap></td>
2420
 
        </tr>
2421
 
 
2422
 
      </table>
2423
 
    </td>
2424
 
  </tr>
2425
 
</table>
2426
 
<table cellspacing=5 cellpadding=0 border=0>
2427
 
  <tr>
2428
 
    <td>
2429
 
      &nbsp;
2430
 
    </td>
2431
 
    <td>
2432
 
 
2433
 
<p>
2434
 
Get maximum residual partition order setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a49">FLAC__seekable_stream_encoder_get_max_residual_partition_order</a>().<dl compact><dt><b>
2435
 
Parameters: </b><dd>
2436
 
<table border=0 cellspacing=2 cellpadding=0>
2437
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2438
 
An encoder instance to query. </td></tr>
2439
 
</table>
2440
 
</dl><dl compact><dt><b>
2441
 
Assertions:</b><dd>
2442
 
 <div class="fragment"><pre>encoder != NULL 
2443
 
</pre></div> </dl><dl compact><dt><b>
2444
 
Return values: </b><dd>
2445
 
<table border=0 cellspacing=2 cellpadding=0>
2446
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2447
 
See <a class="el" href="group__flac__file__encoder.html#a18">FLAC__file_encoder_set_max_residual_partition_order</a>(). </td></tr>
2448
 
</table>
2449
 
</dl>    </td>
2450
 
  </tr>
2451
 
</table>
2452
 
<a name="a46" doxytag="file_encoder.h::FLAC__file_encoder_get_rice_parameter_search_dist"></a><p>
2453
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2454
 
  <tr>
2455
 
    <td class="md">
2456
 
      <table cellpadding="0" cellspacing="0" border="0">
2457
 
        <tr>
2458
 
          <td class="md" nowrap valign="top"> unsigned FLAC__file_encoder_get_rice_parameter_search_dist </td>
2459
 
          <td class="md" valign="top">(&nbsp;</td>
2460
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2461
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2462
 
          <td class="md" valign="top">)&nbsp;</td>
2463
 
          <td class="md" nowrap></td>
2464
 
        </tr>
2465
 
 
2466
 
      </table>
2467
 
    </td>
2468
 
  </tr>
2469
 
</table>
2470
 
<table cellspacing=5 cellpadding=0 border=0>
2471
 
  <tr>
2472
 
    <td>
2473
 
      &nbsp;
2474
 
    </td>
2475
 
    <td>
2476
 
 
2477
 
<p>
2478
 
Get the Rice parameter search distance setting. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a50">FLAC__seekable_stream_encoder_get_rice_parameter_search_dist</a>().<dl compact><dt><b>
2479
 
Parameters: </b><dd>
2480
 
<table border=0 cellspacing=2 cellpadding=0>
2481
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2482
 
An encoder instance to query. </td></tr>
2483
 
</table>
2484
 
</dl><dl compact><dt><b>
2485
 
Assertions:</b><dd>
2486
 
 <div class="fragment"><pre>encoder != NULL 
2487
 
</pre></div> </dl><dl compact><dt><b>
2488
 
Return values: </b><dd>
2489
 
<table border=0 cellspacing=2 cellpadding=0>
2490
 
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
2491
 
See <a class="el" href="group__flac__file__encoder.html#a19">FLAC__file_encoder_set_rice_parameter_search_dist</a>(). </td></tr>
2492
 
</table>
2493
 
</dl>    </td>
2494
 
  </tr>
2495
 
</table>
2496
 
<a name="a47" doxytag="file_encoder.h::FLAC__file_encoder_get_total_samples_estimate"></a><p>
2497
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2498
 
  <tr>
2499
 
    <td class="md">
2500
 
      <table cellpadding="0" cellspacing="0" border="0">
2501
 
        <tr>
2502
 
          <td class="md" nowrap valign="top"> FLAC__uint64 FLAC__file_encoder_get_total_samples_estimate </td>
2503
 
          <td class="md" valign="top">(&nbsp;</td>
2504
 
          <td class="md" nowrap valign="top">const <a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2505
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2506
 
          <td class="md" valign="top">)&nbsp;</td>
2507
 
          <td class="md" nowrap></td>
2508
 
        </tr>
2509
 
 
2510
 
      </table>
2511
 
    </td>
2512
 
  </tr>
2513
 
</table>
2514
 
<table cellspacing=5 cellpadding=0 border=0>
2515
 
  <tr>
2516
 
    <td>
2517
 
      &nbsp;
2518
 
    </td>
2519
 
    <td>
2520
 
 
2521
 
<p>
2522
 
Get the previously set estimate of the total samples to be encoded. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a51">FLAC__seekable_stream_encoder_get_total_samples_estimate</a>().<dl compact><dt><b>
2523
 
Parameters: </b><dd>
2524
 
<table border=0 cellspacing=2 cellpadding=0>
2525
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2526
 
An encoder instance to query. </td></tr>
2527
 
</table>
2528
 
</dl><dl compact><dt><b>
2529
 
Assertions:</b><dd>
2530
 
 <div class="fragment"><pre>encoder != NULL 
2531
 
</pre></div> </dl><dl compact><dt><b>
2532
 
Return values: </b><dd>
2533
 
<table border=0 cellspacing=2 cellpadding=0>
2534
 
<tr><td valign=top><em>FLAC__uint64</em>&nbsp;</td><td>
2535
 
See <a class="el" href="group__flac__file__encoder.html#a20">FLAC__file_encoder_set_total_samples_estimate</a>(). </td></tr>
2536
 
</table>
2537
 
</dl>    </td>
2538
 
  </tr>
2539
 
</table>
2540
 
<a name="a48" doxytag="file_encoder.h::FLAC__file_encoder_init"></a><p>
2541
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2542
 
  <tr>
2543
 
    <td class="md">
2544
 
      <table cellpadding="0" cellspacing="0" border="0">
2545
 
        <tr>
2546
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__file__encoder.html#a52">FLAC__FileEncoderState</a> FLAC__file_encoder_init </td>
2547
 
          <td class="md" valign="top">(&nbsp;</td>
2548
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2549
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2550
 
          <td class="md" valign="top">)&nbsp;</td>
2551
 
          <td class="md" nowrap></td>
2552
 
        </tr>
2553
 
 
2554
 
      </table>
2555
 
    </td>
2556
 
  </tr>
2557
 
</table>
2558
 
<table cellspacing=5 cellpadding=0 border=0>
2559
 
  <tr>
2560
 
    <td>
2561
 
      &nbsp;
2562
 
    </td>
2563
 
    <td>
2564
 
 
2565
 
<p>
2566
 
Initialize the encoder instance. Should be called after <a class="el" href="group__flac__file__encoder.html#a2">FLAC__file_encoder_new</a>() and FLAC__file_encoder_set_*() but before <a class="el" href="group__flac__file__encoder.html#a50">FLAC__file_encoder_process</a>() or <a class="el" href="group__flac__file__encoder.html#a51">FLAC__file_encoder_process_interleaved</a>(). Will set and return the encoder state, which will be FLAC__FILE_ENCODER_OK if initialization succeeded.<dl compact><dt><b>
2567
 
Parameters: </b><dd>
2568
 
<table border=0 cellspacing=2 cellpadding=0>
2569
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2570
 
An uninitialized encoder instance. </td></tr>
2571
 
</table>
2572
 
</dl><dl compact><dt><b>
2573
 
Assertions:</b><dd>
2574
 
 <div class="fragment"><pre>encoder != NULL 
2575
 
</pre></div> </dl><dl compact><dt><b>
2576
 
Return values: </b><dd>
2577
 
<table border=0 cellspacing=2 cellpadding=0>
2578
 
<tr><td valign=top><em>FLAC__FileEncoderState</em>&nbsp;</td><td>
2579
 
<code>FLAC__FILE_ENCODER_OK</code> if initialization was successful; see FLAC__FileEncoderState for the meanings of other return values. </td></tr>
2580
 
</table>
2581
 
</dl>    </td>
2582
 
  </tr>
2583
 
</table>
2584
 
<a name="a49" doxytag="file_encoder.h::FLAC__file_encoder_finish"></a><p>
2585
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2586
 
  <tr>
2587
 
    <td class="md">
2588
 
      <table cellpadding="0" cellspacing="0" border="0">
2589
 
        <tr>
2590
 
          <td class="md" nowrap valign="top"> void FLAC__file_encoder_finish </td>
2591
 
          <td class="md" valign="top">(&nbsp;</td>
2592
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2593
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>encoder</em>          </td>
2594
 
          <td class="md" valign="top">)&nbsp;</td>
2595
 
          <td class="md" nowrap></td>
2596
 
        </tr>
2597
 
 
2598
 
      </table>
2599
 
    </td>
2600
 
  </tr>
2601
 
</table>
2602
 
<table cellspacing=5 cellpadding=0 border=0>
2603
 
  <tr>
2604
 
    <td>
2605
 
      &nbsp;
2606
 
    </td>
2607
 
    <td>
2608
 
 
2609
 
<p>
2610
 
Finish the encoding process. Flushes the encoding buffer, releases resources, resets the encoder settings to their defaults, and returns the encoder state to FLAC__FILE_ENCODER_UNINITIALIZED.
2611
 
<p>
2612
 
In the event of a prematurely-terminated encode, it is not strictly necessary to call this immediately before <a class="el" href="group__flac__file__encoder.html#a3">FLAC__file_encoder_delete</a>() but it is good practice to match every <a class="el" href="group__flac__file__encoder.html#a48">FLAC__file_encoder_init</a>() with a <a class="el" href="group__flac__file__encoder.html#a49">FLAC__file_encoder_finish</a>().<dl compact><dt><b>
2613
 
Parameters: </b><dd>
2614
 
<table border=0 cellspacing=2 cellpadding=0>
2615
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2616
 
An uninitialized encoder instance. </td></tr>
2617
 
</table>
2618
 
</dl><dl compact><dt><b>
2619
 
Assertions:</b><dd>
2620
 
 <div class="fragment"><pre>encoder != NULL 
2621
 
</pre></div> </dl>    </td>
2622
 
  </tr>
2623
 
</table>
2624
 
<a name="a50" doxytag="file_encoder.h::FLAC__file_encoder_process"></a><p>
2625
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2626
 
  <tr>
2627
 
    <td class="md">
2628
 
      <table cellpadding="0" cellspacing="0" border="0">
2629
 
        <tr>
2630
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_process </td>
2631
 
          <td class="md" valign="top">(&nbsp;</td>
2632
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2633
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
2634
 
        </tr>
2635
 
        <tr>
2636
 
          <td></td>
2637
 
          <td></td>
2638
 
          <td class="md" nowrap>const FLAC__int32 *const&nbsp;</td>
2639
 
          <td class="mdname" nowrap>&nbsp; <em>buffer</em>[], </td>
2640
 
        </tr>
2641
 
        <tr>
2642
 
          <td></td>
2643
 
          <td></td>
2644
 
          <td class="md" nowrap>unsigned&nbsp;</td>
2645
 
          <td class="mdname" nowrap>&nbsp; <em>samples</em></td>
2646
 
        </tr>
2647
 
        <tr>
2648
 
          <td></td>
2649
 
          <td class="md">)&nbsp;</td>
2650
 
          <td class="md" colspan="2"></td>
2651
 
        </tr>
2652
 
 
2653
 
      </table>
2654
 
    </td>
2655
 
  </tr>
2656
 
</table>
2657
 
<table cellspacing=5 cellpadding=0 border=0>
2658
 
  <tr>
2659
 
    <td>
2660
 
      &nbsp;
2661
 
    </td>
2662
 
    <td>
2663
 
 
2664
 
<p>
2665
 
Submit data for encoding. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a54">FLAC__seekable_stream_encoder_process</a>().<dl compact><dt><b>
2666
 
Parameters: </b><dd>
2667
 
<table border=0 cellspacing=2 cellpadding=0>
2668
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2669
 
An initialized encoder instance in the OK state. </td></tr>
2670
 
<tr><td valign=top><em>buffer</em>&nbsp;</td><td>
2671
 
An array of pointers to each channel's signal. </td></tr>
2672
 
<tr><td valign=top><em>samples</em>&nbsp;</td><td>
2673
 
The number of samples in one channel. </td></tr>
2674
 
</table>
2675
 
</dl><dl compact><dt><b>
2676
 
Assertions:</b><dd>
2677
 
 <div class="fragment"><pre>encoder != NULL 
2678
 
</pre></div> <div class="fragment"><pre><a class="code" href="FLAC_2file__encoder_8h.html#a25">FLAC__file_encoder_get_state</a>(encoder) == <a class="code" href="FLAC_2file__encoder_8h.html#a52a2">FLAC__FILE_ENCODER_OK</a> 
2679
 
</pre></div> </dl><dl compact><dt><b>
2680
 
Return values: </b><dd>
2681
 
<table border=0 cellspacing=2 cellpadding=0>
2682
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
2683
 
<code>true</code> if successful, else <code>false</code>; in this case, check the encoder state with <a class="el" href="group__flac__file__encoder.html#a25">FLAC__file_encoder_get_state</a>() to see what went wrong. </td></tr>
2684
 
</table>
2685
 
</dl>    </td>
2686
 
  </tr>
2687
 
</table>
2688
 
<a name="a51" doxytag="file_encoder.h::FLAC__file_encoder_process_interleaved"></a><p>
2689
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2690
 
  <tr>
2691
 
    <td class="md">
2692
 
      <table cellpadding="0" cellspacing="0" border="0">
2693
 
        <tr>
2694
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__file_encoder_process_interleaved </td>
2695
 
          <td class="md" valign="top">(&nbsp;</td>
2696
 
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *&nbsp;</td>
2697
 
          <td class="mdname" nowrap>&nbsp; <em>encoder</em>, </td>
2698
 
        </tr>
2699
 
        <tr>
2700
 
          <td></td>
2701
 
          <td></td>
2702
 
          <td class="md" nowrap>const FLAC__int32&nbsp;</td>
2703
 
          <td class="mdname" nowrap>&nbsp; <em>buffer</em>[], </td>
2704
 
        </tr>
2705
 
        <tr>
2706
 
          <td></td>
2707
 
          <td></td>
2708
 
          <td class="md" nowrap>unsigned&nbsp;</td>
2709
 
          <td class="mdname" nowrap>&nbsp; <em>samples</em></td>
2710
 
        </tr>
2711
 
        <tr>
2712
 
          <td></td>
2713
 
          <td class="md">)&nbsp;</td>
2714
 
          <td class="md" colspan="2"></td>
2715
 
        </tr>
2716
 
 
2717
 
      </table>
2718
 
    </td>
2719
 
  </tr>
2720
 
</table>
2721
 
<table cellspacing=5 cellpadding=0 border=0>
2722
 
  <tr>
2723
 
    <td>
2724
 
      &nbsp;
2725
 
    </td>
2726
 
    <td>
2727
 
 
2728
 
<p>
2729
 
Submit data for encoding. This is inherited from <a class="el" href="structFLAC____SeekableStreamEncoder.html">FLAC__SeekableStreamEncoder</a>; see <a class="el" href="group__flac__seekable__stream__encoder.html#a55">FLAC__seekable_stream_encoder_process_interleaved</a>().<dl compact><dt><b>
2730
 
Parameters: </b><dd>
2731
 
<table border=0 cellspacing=2 cellpadding=0>
2732
 
<tr><td valign=top><em>encoder</em>&nbsp;</td><td>
2733
 
An initialized encoder instance in the OK state. </td></tr>
2734
 
<tr><td valign=top><em>buffer</em>&nbsp;</td><td>
2735
 
An array of channel-interleaved data (see above). </td></tr>
2736
 
<tr><td valign=top><em>samples</em>&nbsp;</td><td>
2737
 
The number of samples in one channel, the same as for <a class="el" href="group__flac__file__encoder.html#a50">FLAC__file_encoder_process</a>(). For example, if encoding two channels, <code>1000</code> <em>samples</em> corresponds to a <em>buffer</em> of 2000 values. </td></tr>
2738
 
</table>
2739
 
</dl><dl compact><dt><b>
2740
 
Assertions:</b><dd>
2741
 
 <div class="fragment"><pre>encoder != NULL 
2742
 
</pre></div> <div class="fragment"><pre><a class="code" href="FLAC_2file__encoder_8h.html#a25">FLAC__file_encoder_get_state</a>(encoder) == <a class="code" href="FLAC_2file__encoder_8h.html#a52a2">FLAC__FILE_ENCODER_OK</a> 
2743
 
</pre></div> </dl><dl compact><dt><b>
2744
 
Return values: </b><dd>
2745
 
<table border=0 cellspacing=2 cellpadding=0>
2746
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
2747
 
<code>true</code> if successful, else <code>false</code>; in this case, check the encoder state with <a class="el" href="group__flac__file__encoder.html#a25">FLAC__file_encoder_get_state</a>() to see what went wrong. </td></tr>
2748
 
</table>
2749
 
</dl>    </td>
2750
 
  </tr>
2751
 
</table>
2752
 
<hr><h2>Variable Documentation</h2>
2753
 
<a name="a0" doxytag="file_encoder.h::FLAC__FileEncoderStateString"></a><p>
2754
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2755
 
  <tr>
2756
 
    <td class="md">
2757
 
      <table cellpadding="0" cellspacing="0" border="0">
2758
 
        <tr>
2759
 
          <td class="md" nowrap valign="top"> const char* const FLAC__FileEncoderStateString[]
2760
 
      </table>
2761
 
    </td>
2762
 
  </tr>
2763
 
</table>
2764
 
<table cellspacing=5 cellpadding=0 border=0>
2765
 
  <tr>
2766
 
    <td>
2767
 
      &nbsp;
2768
 
    </td>
2769
 
    <td>
2770
 
 
2771
 
<p>
2772
 
Maps a FLAC__FileEncoderState to a C string.
2773
 
<p>
2774
 
Using a FLAC__FileEncoderState as the index to this array will give the string equivalent. The contents should not be modified.     </td>
2775
 
  </tr>
2776
 
</table>
2777
 
<hr><address><small>Generated on Fri Feb 4 18:39:15 2005 for FLAC by
2778
 
<a href="http://www.doxygen.org/index.html">
2779
 
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
2780
 
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
2781
 
 &copy;&nbsp;1997-2002</small></address>
2782
 
</body>
2783
 
</html>