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>OggFLAC/seekable_stream_encoder.h: seekable stream encoder interface</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
<!-- Generated by Doxygen 1.2.14 -->
8
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
9
<hr><h1>OggFLAC/seekable_stream_encoder.h: seekable stream encoder interface<br>
11
[<a class="el" href="group__oggflac__encoder.html">OggFLAC/_encoder.h: encoder interfaces</a>]</small>
12
</h1>This module contains the functions which implement the seekable stream encoder. The Ogg seekable stream encoder is derived from the FLAC seekable stream 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 </td><td valign=bottom><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a></td></tr>
16
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
17
<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__oggflac__seekable__stream__encoder.html#a59">OggFLAC__SeekableStreamEncoderReadStatus</a>(* </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a2">OggFLAC__SeekableStreamEncoderReadCallback</a> )(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)</td></tr>
18
<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__seekable__stream__encoder.html#a57">FLAC__SeekableStreamEncoderSeekStatus</a>(* </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a3">OggFLAC__SeekableStreamEncoderSeekCallback</a> )(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td></tr>
19
<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__seekable__stream__encoder.html#a58">FLAC__SeekableStreamEncoderTellStatus</a>(* </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a4">OggFLAC__SeekableStreamEncoderTellCallback</a> )(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)</td></tr>
20
<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__stream__encoder.html#a53">FLAC__StreamEncoderWriteStatus</a>(* </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a5">OggFLAC__SeekableStreamEncoderWriteCallback</a> )(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data)</td></tr>
21
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
22
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a58">OggFLAC__SeekableStreamEncoderState</a> { <br>
23
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a6">OggFLAC__SEEKABLE_STREAM_ENCODER_OK</a> = 0,
24
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a7">OggFLAC__SEEKABLE_STREAM_ENCODER_OGG_ERROR</a>,
25
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a8">OggFLAC__SEEKABLE_STREAM_ENCODER_FLAC_STREAM_ENCODER_ERROR</a>,
26
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a9">OggFLAC__SEEKABLE_STREAM_ENCODER_MEMORY_ALLOCATION_ERROR</a>,
28
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a10">OggFLAC__SEEKABLE_STREAM_ENCODER_WRITE_ERROR</a>,
29
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a11">OggFLAC__SEEKABLE_STREAM_ENCODER_READ_ERROR</a>,
30
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a12">OggFLAC__SEEKABLE_STREAM_ENCODER_SEEK_ERROR</a>,
31
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a13">OggFLAC__SEEKABLE_STREAM_ENCODER_TELL_ERROR</a>,
33
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a14">OggFLAC__SEEKABLE_STREAM_ENCODER_ALREADY_INITIALIZED</a>,
34
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a15">OggFLAC__SEEKABLE_STREAM_ENCODER_INVALID_CALLBACK</a>,
35
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a16">OggFLAC__SEEKABLE_STREAM_ENCODER_INVALID_SEEKTABLE</a>,
36
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a58a17">OggFLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED</a>
39
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a59">OggFLAC__SeekableStreamEncoderReadStatus</a> { <a class="el" href="group__oggflac__seekable__stream__encoder.html#a59a18">OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_CONTINUE</a>,
40
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a59a19">OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_END_OF_STREAM</a>,
41
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a59a20">OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_ABORT</a>
43
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
44
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a6">OggFLAC__seekable_stream_encoder_new</a> ()</td></tr>
45
<tr><td nowrap align=right valign=top>OggFLAC_API void </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a7">OggFLAC__seekable_stream_encoder_delete</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
46
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a8">OggFLAC__seekable_stream_encoder_set_serial_number</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, long serial_number)</td></tr>
47
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a9">OggFLAC__seekable_stream_encoder_set_verify</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
48
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a10">OggFLAC__seekable_stream_encoder_set_streamable_subset</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
49
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a11">OggFLAC__seekable_stream_encoder_set_do_mid_side_stereo</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
50
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a12">OggFLAC__seekable_stream_encoder_set_loose_mid_side_stereo</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
51
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a13">OggFLAC__seekable_stream_encoder_set_channels</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
52
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a14">OggFLAC__seekable_stream_encoder_set_bits_per_sample</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
53
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a15">OggFLAC__seekable_stream_encoder_set_sample_rate</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
54
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a16">OggFLAC__seekable_stream_encoder_set_blocksize</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
55
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a17">OggFLAC__seekable_stream_encoder_set_max_lpc_order</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
56
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a18">OggFLAC__seekable_stream_encoder_set_qlp_coeff_precision</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
57
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a19">OggFLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
58
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a20">OggFLAC__seekable_stream_encoder_set_do_escape_coding</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
59
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a21">OggFLAC__seekable_stream_encoder_set_do_exhaustive_model_search</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
60
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a22">OggFLAC__seekable_stream_encoder_set_min_residual_partition_order</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
61
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a23">OggFLAC__seekable_stream_encoder_set_max_residual_partition_order</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
62
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a24">OggFLAC__seekable_stream_encoder_set_rice_parameter_search_dist</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, unsigned value)</td></tr>
63
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a25">OggFLAC__seekable_stream_encoder_set_total_samples_estimate</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 value)</td></tr>
64
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a26">OggFLAC__seekable_stream_encoder_set_metadata</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, unsigned num_blocks)</td></tr>
65
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a27">OggFLAC__seekable_stream_encoder_set_read_callback</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="group__oggflac__seekable__stream__encoder.html#a2">OggFLAC__SeekableStreamEncoderReadCallback</a> value)</td></tr>
66
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a28">OggFLAC__seekable_stream_encoder_set_seek_callback</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="group__oggflac__seekable__stream__encoder.html#a3">OggFLAC__SeekableStreamEncoderSeekCallback</a> value)</td></tr>
67
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a29">OggFLAC__seekable_stream_encoder_set_tell_callback</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="group__oggflac__seekable__stream__encoder.html#a4">OggFLAC__SeekableStreamEncoderTellCallback</a> value)</td></tr>
68
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a30">OggFLAC__seekable_stream_encoder_set_write_callback</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, <a class="el" href="group__oggflac__seekable__stream__encoder.html#a5">OggFLAC__SeekableStreamEncoderWriteCallback</a> value)</td></tr>
69
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a31">OggFLAC__seekable_stream_encoder_set_client_data</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, void *value)</td></tr>
70
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__oggflac__seekable__stream__encoder.html#a58">OggFLAC__SeekableStreamEncoderState</a> </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a32">OggFLAC__seekable_stream_encoder_get_state</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
71
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__flac__stream__encoder.html#a52">FLAC__StreamEncoderState</a> </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a33">OggFLAC__seekable_stream_encoder_get_FLAC_stream_encoder_state</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
72
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a> </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a34">OggFLAC__seekable_stream_encoder_get_verify_decoder_state</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
73
<tr><td nowrap align=right valign=top>OggFLAC_API const char * </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a35">OggFLAC__seekable_stream_encoder_get_resolved_state_string</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
74
<tr><td nowrap align=right valign=top>OggFLAC_API void </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a36">OggFLAC__seekable_stream_encoder_get_verify_decoder_error_stats</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got)</td></tr>
75
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a37">OggFLAC__seekable_stream_encoder_get_verify</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
76
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a38">OggFLAC__seekable_stream_encoder_get_streamable_subset</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
77
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a39">OggFLAC__seekable_stream_encoder_get_do_mid_side_stereo</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
78
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a40">OggFLAC__seekable_stream_encoder_get_loose_mid_side_stereo</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
79
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a41">OggFLAC__seekable_stream_encoder_get_channels</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
80
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a42">OggFLAC__seekable_stream_encoder_get_bits_per_sample</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
81
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a43">OggFLAC__seekable_stream_encoder_get_sample_rate</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
82
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a44">OggFLAC__seekable_stream_encoder_get_blocksize</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
83
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a45">OggFLAC__seekable_stream_encoder_get_max_lpc_order</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
84
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a46">OggFLAC__seekable_stream_encoder_get_qlp_coeff_precision</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
85
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a47">OggFLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
86
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a48">OggFLAC__seekable_stream_encoder_get_do_escape_coding</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
87
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a49">OggFLAC__seekable_stream_encoder_get_do_exhaustive_model_search</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
88
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a50">OggFLAC__seekable_stream_encoder_get_min_residual_partition_order</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
89
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a51">OggFLAC__seekable_stream_encoder_get_max_residual_partition_order</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
90
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a52">OggFLAC__seekable_stream_encoder_get_rice_parameter_search_dist</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
91
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__uint64 </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a53">OggFLAC__seekable_stream_encoder_get_total_samples_estimate</a> (const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
92
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__oggflac__seekable__stream__encoder.html#a58">OggFLAC__SeekableStreamEncoderState</a> </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a54">OggFLAC__seekable_stream_encoder_init</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
93
<tr><td nowrap align=right valign=top>OggFLAC_API void </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a55">OggFLAC__seekable_stream_encoder_finish</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder)</td></tr>
94
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a56">OggFLAC__seekable_stream_encoder_process</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, const FLAC__int32 *const buffer[], unsigned samples)</td></tr>
95
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a57">OggFLAC__seekable_stream_encoder_process_interleaved</a> (<a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, const FLAC__int32 buffer[], unsigned samples)</td></tr>
96
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
97
<tr><td nowrap align=right valign=top>OggFLAC_API const char *const </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a0">OggFLAC__SeekableStreamEncoderStateString</a> []</td></tr>
98
<tr><td nowrap align=right valign=top>OggFLAC_API const char *const </td><td valign=bottom><a class="el" href="group__oggflac__seekable__stream__encoder.html#a1">OggFLAC__SeekableStreamEncoderReadStatusString</a> []</td></tr>
100
<hr><a name="_details"></a><h2>Detailed Description</h2>
101
This module contains the functions which implement the seekable stream encoder. The Ogg seekable stream encoder is derived from the FLAC seekable stream encoder.
105
The interface here is nearly identical to FLAC's seekable stream encoder, including the callbacks, with the addition of a new required read callback (needed when writing back STREAMINFO after encoding) and <a class="el" href="group__oggflac__seekable__stream__encoder.html#a8">OggFLAC__seekable_stream_encoder_set_serial_number</a>(). See the <a class="el" href="group__flac__seekable__stream__encoder.html">FLAC seekable stream encoder module</a> for full documentation. <hr><h2>Typedef Documentation</h2>
106
<a name="a2" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderReadCallback"></a><p>
107
<table width="100%" cellpadding="2" cellspacing="0" border="0">
110
<table cellpadding="0" cellspacing="0" border="0">
112
<td class="md" nowrap valign="top"> typedef <a class="el" href="group__oggflac__seekable__stream__encoder.html#a59">OggFLAC__SeekableStreamEncoderReadStatus</a>(* OggFLAC__SeekableStreamEncoderReadCallback)(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)
117
<table cellspacing=5 cellpadding=0 border=0>
125
Signature for the read callback. See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a27">OggFLAC__seekable_stream_encoder_set_read_callback</a>() for more info.<dl compact><dt><b>
127
<table border=0 cellspacing=2 cellpadding=0>
128
<tr><td valign=top><em>encoder</em> </td><td>
129
The encoder instance calling the callback. </td></tr>
130
<tr><td valign=top><em>buffer</em> </td><td>
131
A pointer to a location for the callee to store data to be encoded. </td></tr>
132
<tr><td valign=top><em>bytes</em> </td><td>
133
A pointer to the size of the buffer. On entry to the callback, it contains the maximum number of bytes that may be stored in <em>buffer</em>. The callee must set it to the actual number of bytes stored (0 in case of error or end-of-stream) before returning. </td></tr>
134
<tr><td valign=top><em>client_data</em> </td><td>
135
The callee's client data set through <a class="el" href="group__oggflac__seekable__stream__encoder.html#a31">OggFLAC__seekable_stream_encoder_set_client_data</a>(). </td></tr>
137
</dl><dl compact><dt><b>
138
Return values: </b><dd>
139
<table border=0 cellspacing=2 cellpadding=0>
140
<tr><td valign=top><em>OggFLAC__SeekableStreamEncoderReadStatus</em> </td><td>
141
The callee's return status. </td></tr>
146
<a name="a3" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderSeekCallback"></a><p>
147
<table width="100%" cellpadding="2" cellspacing="0" border="0">
150
<table cellpadding="0" cellspacing="0" border="0">
152
<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__seekable__stream__encoder.html#a57">FLAC__SeekableStreamEncoderSeekStatus</a>(* OggFLAC__SeekableStreamEncoderSeekCallback)(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)
157
<table cellspacing=5 cellpadding=0 border=0>
165
Signature for the seek callback. See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a28">OggFLAC__seekable_stream_encoder_set_seek_callback</a>() and FLAC__SeekableStreamEncoderSeekCallback for more info.<dl compact><dt><b>
167
<table border=0 cellspacing=2 cellpadding=0>
168
<tr><td valign=top><em>encoder</em> </td><td>
169
The encoder instance calling the callback. </td></tr>
170
<tr><td valign=top><em>absolute_byte_offset</em> </td><td>
171
The offset from the beginning of the stream to seek to. </td></tr>
172
<tr><td valign=top><em>client_data</em> </td><td>
173
The callee's client data set through <a class="el" href="group__oggflac__seekable__stream__encoder.html#a31">OggFLAC__seekable_stream_encoder_set_client_data</a>(). </td></tr>
175
</dl><dl compact><dt><b>
176
Return values: </b><dd>
177
<table border=0 cellspacing=2 cellpadding=0>
178
<tr><td valign=top><em>FLAC__SeekableStreamEncoderSeekStatus</em> </td><td>
179
The callee's return status. </td></tr>
184
<a name="a4" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderTellCallback"></a><p>
185
<table width="100%" cellpadding="2" cellspacing="0" border="0">
188
<table cellpadding="0" cellspacing="0" border="0">
190
<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__seekable__stream__encoder.html#a58">FLAC__SeekableStreamEncoderTellStatus</a>(* OggFLAC__SeekableStreamEncoderTellCallback)(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)
195
<table cellspacing=5 cellpadding=0 border=0>
203
Signature for the tell callback. See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a29">OggFLAC__seekable_stream_encoder_set_tell_callback</a>() and FLAC__SeekableStreamEncoderTellCallback for more info.<dl compact><dt><b>
205
<table border=0 cellspacing=2 cellpadding=0>
206
<tr><td valign=top><em>encoder</em> </td><td>
207
The encoder instance calling the callback. </td></tr>
208
<tr><td valign=top><em>absolute_byte_offset</em> </td><td>
209
The address at which to store the current position of the output. </td></tr>
210
<tr><td valign=top><em>client_data</em> </td><td>
211
The callee's client data set through <a class="el" href="group__oggflac__seekable__stream__encoder.html#a31">OggFLAC__seekable_stream_encoder_set_client_data</a>(). </td></tr>
213
</dl><dl compact><dt><b>
214
Return values: </b><dd>
215
<table border=0 cellspacing=2 cellpadding=0>
216
<tr><td valign=top><em>FLAC__SeekableStreamEncoderTellStatus</em> </td><td>
217
The callee's return status. </td></tr>
222
<a name="a5" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderWriteCallback"></a><p>
223
<table width="100%" cellpadding="2" cellspacing="0" border="0">
226
<table cellpadding="0" cellspacing="0" border="0">
228
<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__stream__encoder.html#a53">FLAC__StreamEncoderWriteStatus</a>(* OggFLAC__SeekableStreamEncoderWriteCallback)(const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data)
233
<table cellspacing=5 cellpadding=0 border=0>
241
Signature for the write callback. See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a30">OggFLAC__seekable_stream_encoder_set_write_callback</a>() and FLAC__SeekableStreamEncoderWriteCallback for more info.<dl compact><dt><b>
243
<table border=0 cellspacing=2 cellpadding=0>
244
<tr><td valign=top><em>encoder</em> </td><td>
245
The encoder instance calling the callback. </td></tr>
246
<tr><td valign=top><em>buffer</em> </td><td>
247
An array of encoded data of length <em>bytes</em>. </td></tr>
248
<tr><td valign=top><em>bytes</em> </td><td>
249
The byte length of <em>buffer</em>. </td></tr>
250
<tr><td valign=top><em>samples</em> </td><td>
251
The number of samples encoded by <em>buffer</em>. <code>0</code> has a special meaning; see <a class="el" href="group__oggflac__seekable__stream__encoder.html#a30">OggFLAC__seekable_stream_encoder_set_write_callback</a>(). </td></tr>
252
<tr><td valign=top><em>current_frame</em> </td><td>
253
The number of current frame being encoded. </td></tr>
254
<tr><td valign=top><em>client_data</em> </td><td>
255
The callee's client data set through <a class="el" href="group__oggflac__seekable__stream__encoder.html#a31">OggFLAC__seekable_stream_encoder_set_client_data</a>(). </td></tr>
257
</dl><dl compact><dt><b>
258
Return values: </b><dd>
259
<table border=0 cellspacing=2 cellpadding=0>
260
<tr><td valign=top><em>FLAC__StreamEncoderWriteStatus</em> </td><td>
261
The callee's return status. </td></tr>
266
<hr><h2>Enumeration Type Documentation</h2>
267
<a name="a58" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderState"></a><p>
268
<table width="100%" cellpadding="2" cellspacing="0" border="0">
271
<table cellpadding="0" cellspacing="0" border="0">
273
<td class="md" nowrap valign="top"> enum OggFLAC__SeekableStreamEncoderState
278
<table cellspacing=5 cellpadding=0 border=0>
286
State values for an <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a>
288
The encoder's state can be obtained by calling <a class="el" href="group__oggflac__stream__encoder.html#a27">OggFLAC__stream_encoder_get_state</a>(). <dl compact><dt><b>
289
Enumeration values:</b><dd>
290
<table border=0 cellspacing=2 cellpadding=0>
291
<tr><td valign=top><em><a name="a58a6" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_OK"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_OK</em></em> </td><td>
292
The encoder is in the normal OK state. </td></tr>
293
<tr><td valign=top><em><a name="a58a7" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_OGG_ERROR"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_OGG_ERROR</em></em> </td><td>
294
An error occurred in the underlying Ogg layer. </td></tr>
295
<tr><td valign=top><em><a name="a58a8" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_FLAC_STREAM_ENCODER_ERROR"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_FLAC_STREAM_ENCODER_ERROR</em></em> </td><td>
296
An error occurred in the underlying FLAC stream encoder; check <a class="el" href="group__oggflac__seekable__stream__encoder.html#a33">OggFLAC__seekable_stream_encoder_get_FLAC_stream_encoder_state</a>(). </td></tr>
297
<tr><td valign=top><em><a name="a58a9" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_MEMORY_ALLOCATION_ERROR"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_MEMORY_ALLOCATION_ERROR</em></em> </td><td>
298
Memory allocation failed. </td></tr>
299
<tr><td valign=top><em><a name="a58a10" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_WRITE_ERROR"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_WRITE_ERROR</em></em> </td><td>
300
The write callback returned an error. </td></tr>
301
<tr><td valign=top><em><a name="a58a11" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_READ_ERROR"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_READ_ERROR</em></em> </td><td>
302
The read callback returned an error. </td></tr>
303
<tr><td valign=top><em><a name="a58a12" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_SEEK_ERROR"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_SEEK_ERROR</em></em> </td><td>
304
The seek callback returned an error. </td></tr>
305
<tr><td valign=top><em><a name="a58a13" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_TELL_ERROR"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_TELL_ERROR</em></em> </td><td>
306
The tell callback returned an error. </td></tr>
307
<tr><td valign=top><em><a name="a58a14" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_ALREADY_INITIALIZED"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_ALREADY_INITIALIZED</em></em> </td><td>
308
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a54">OggFLAC__seekable_stream_encoder_init</a>() was called when the encoder was already initialized, usually because <a class="el" href="group__oggflac__seekable__stream__encoder.html#a55">OggFLAC__seekable_stream_encoder_finish</a>() was not called. </td></tr>
309
<tr><td valign=top><em><a name="a58a15" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_INVALID_CALLBACK"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_INVALID_CALLBACK</em></em> </td><td>
310
<a class="el" href="group__oggflac__seekable__stream__encoder.html#a54">OggFLAC__seekable_stream_encoder_init</a>() was called without all callbacks being set. </td></tr>
311
<tr><td valign=top><em><a name="a58a16" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_INVALID_SEEKTABLE"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_INVALID_SEEKTABLE</em></em> </td><td>
312
An invalid seek table was passed is the metadata to <a class="el" href="group__oggflac__seekable__stream__encoder.html#a26">OggFLAC__seekable_stream_encoder_set_metadata</a>(). </td></tr>
313
<tr><td valign=top><em><a name="a58a17" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED</em></em> </td><td>
314
The encoder is in the uninitialized state. </td></tr>
320
<a name="a59" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderReadStatus"></a><p>
321
<table width="100%" cellpadding="2" cellspacing="0" border="0">
324
<table cellpadding="0" cellspacing="0" border="0">
326
<td class="md" nowrap valign="top"> enum OggFLAC__SeekableStreamEncoderReadStatus
331
<table cellspacing=5 cellpadding=0 border=0>
339
Return values for the <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> read callback. <dl compact><dt><b>
340
Enumeration values:</b><dd>
341
<table border=0 cellspacing=2 cellpadding=0>
342
<tr><td valign=top><em><a name="a59a18" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_CONTINUE"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_CONTINUE</em></em> </td><td>
343
The read was OK and decoding can continue. </td></tr>
344
<tr><td valign=top><em><a name="a59a19" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_END_OF_STREAM"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_END_OF_STREAM</em></em> </td><td>
345
The read was attempted at the end of the stream. </td></tr>
346
<tr><td valign=top><em><a name="a59a20" doxytag="OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_ABORT"></a><em>OggFLAC__SEEKABLE_STREAM_ENCODER_READ_STATUS_ABORT</em></em> </td><td>
347
An unrecoverable error occurred. </td></tr>
353
<hr><h2>Function Documentation</h2>
354
<a name="a6" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_new"></a><p>
355
<table width="100%" cellpadding="2" cellspacing="0" border="0">
358
<table cellpadding="0" cellspacing="0" border="0">
360
<td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a>* OggFLAC__seekable_stream_encoder_new </td>
361
<td class="md" valign="top">( </td>
362
<td class="mdname1" valign="top" nowrap> </td>
363
<td class="md" valign="top">) </td>
364
<td class="md" nowrap></td>
371
<table cellspacing=5 cellpadding=0 border=0>
379
Create a new seekable stream encoder instance. The instance is created with default settings; see the individual OggFLAC__seekable_stream_encoder_set_*() functions for each setting's default.<dl compact><dt><b>
380
Return values: </b><dd>
381
<table border=0 cellspacing=2 cellpadding=0>
382
<tr><td valign=top><em><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a></em> </td><td>
383
* <code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>
388
<a name="a7" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_delete"></a><p>
389
<table width="100%" cellpadding="2" cellspacing="0" border="0">
392
<table cellpadding="0" cellspacing="0" border="0">
394
<td class="md" nowrap valign="top"> OggFLAC_API void OggFLAC__seekable_stream_encoder_delete </td>
395
<td class="md" valign="top">( </td>
396
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
397
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
398
<td class="md" valign="top">) </td>
399
<td class="md" nowrap></td>
406
<table cellspacing=5 cellpadding=0 border=0>
414
Free an encoder instance. Deletes the object pointed to by <em>encoder</em>.<dl compact><dt><b>
416
<table border=0 cellspacing=2 cellpadding=0>
417
<tr><td valign=top><em>encoder</em> </td><td>
418
A pointer to an existing encoder. </td></tr>
420
</dl><dl compact><dt><b>
422
<div class="fragment"><pre>encoder != NULL
423
</pre></div> </dl> </td>
426
<a name="a8" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_serial_number"></a><p>
427
<table width="100%" cellpadding="2" cellspacing="0" border="0">
430
<table cellpadding="0" cellspacing="0" border="0">
432
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_serial_number </td>
433
<td class="md" valign="top">( </td>
434
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
435
<td class="mdname" nowrap> <em>encoder</em>, </td>
440
<td class="md" nowrap>long </td>
441
<td class="mdname" nowrap> <em>serial_number</em></td>
445
<td class="md">) </td>
446
<td class="md" colspan="2"></td>
453
<table cellspacing=5 cellpadding=0 border=0>
461
Set the serial number for the FLAC stream.<dl compact><dt><b>
462
Default Value:</b><dd>
463
<code>0</code> </dl><dl compact><dt><b>
465
<table border=0 cellspacing=2 cellpadding=0>
466
<tr><td valign=top><em>encoder</em> </td><td>
467
An encoder instance to set. </td></tr>
468
<tr><td valign=top><em>serial_number</em> </td><td>
469
See above. </td></tr>
471
</dl><dl compact><dt><b>
473
<div class="fragment"><pre>encoder != NULL
474
</pre></div> </dl><dl compact><dt><b>
475
Return values: </b><dd>
476
<table border=0 cellspacing=2 cellpadding=0>
477
<tr><td valign=top><em>FLAC__bool</em> </td><td>
478
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
483
<a name="a9" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_verify"></a><p>
484
<table width="100%" cellpadding="2" cellspacing="0" border="0">
487
<table cellpadding="0" cellspacing="0" border="0">
489
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_verify </td>
490
<td class="md" valign="top">( </td>
491
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
492
<td class="mdname" nowrap> <em>encoder</em>, </td>
497
<td class="md" nowrap>FLAC__bool </td>
498
<td class="mdname" nowrap> <em>value</em></td>
502
<td class="md">) </td>
503
<td class="md" colspan="2"></td>
510
<table cellspacing=5 cellpadding=0 border=0>
518
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a6">FLAC__stream_encoder_set_verify</a>()<dl compact><dt><b>
519
Default Value:</b><dd>
520
<code>false</code> </dl><dl compact><dt><b>
522
<table border=0 cellspacing=2 cellpadding=0>
523
<tr><td valign=top><em>encoder</em> </td><td>
524
An encoder instance to set. </td></tr>
525
<tr><td valign=top><em>value</em> </td><td>
526
Flag value (see above). </td></tr>
528
</dl><dl compact><dt><b>
530
<div class="fragment"><pre>encoder != NULL
531
</pre></div> </dl><dl compact><dt><b>
532
Return values: </b><dd>
533
<table border=0 cellspacing=2 cellpadding=0>
534
<tr><td valign=top><em>FLAC__bool</em> </td><td>
535
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
540
<a name="a10" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_streamable_subset"></a><p>
541
<table width="100%" cellpadding="2" cellspacing="0" border="0">
544
<table cellpadding="0" cellspacing="0" border="0">
546
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_streamable_subset </td>
547
<td class="md" valign="top">( </td>
548
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
549
<td class="mdname" nowrap> <em>encoder</em>, </td>
554
<td class="md" nowrap>FLAC__bool </td>
555
<td class="mdname" nowrap> <em>value</em></td>
559
<td class="md">) </td>
560
<td class="md" colspan="2"></td>
567
<table cellspacing=5 cellpadding=0 border=0>
575
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a7">FLAC__stream_encoder_set_streamable_subset</a>()<dl compact><dt><b>
576
Default Value:</b><dd>
577
<code>true</code> </dl><dl compact><dt><b>
579
<table border=0 cellspacing=2 cellpadding=0>
580
<tr><td valign=top><em>encoder</em> </td><td>
581
An encoder instance to set. </td></tr>
582
<tr><td valign=top><em>value</em> </td><td>
583
Flag value (see above). </td></tr>
585
</dl><dl compact><dt><b>
587
<div class="fragment"><pre>encoder != NULL
588
</pre></div> </dl><dl compact><dt><b>
589
Return values: </b><dd>
590
<table border=0 cellspacing=2 cellpadding=0>
591
<tr><td valign=top><em>FLAC__bool</em> </td><td>
592
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
597
<a name="a11" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_do_mid_side_stereo"></a><p>
598
<table width="100%" cellpadding="2" cellspacing="0" border="0">
601
<table cellpadding="0" cellspacing="0" border="0">
603
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_do_mid_side_stereo </td>
604
<td class="md" valign="top">( </td>
605
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
606
<td class="mdname" nowrap> <em>encoder</em>, </td>
611
<td class="md" nowrap>FLAC__bool </td>
612
<td class="mdname" nowrap> <em>value</em></td>
616
<td class="md">) </td>
617
<td class="md" colspan="2"></td>
624
<table cellspacing=5 cellpadding=0 border=0>
632
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a8">FLAC__stream_encoder_set_do_mid_side_stereo</a>()<dl compact><dt><b>
633
Default Value:</b><dd>
634
<code>false</code> </dl><dl compact><dt><b>
636
<table border=0 cellspacing=2 cellpadding=0>
637
<tr><td valign=top><em>encoder</em> </td><td>
638
An encoder instance to set. </td></tr>
639
<tr><td valign=top><em>value</em> </td><td>
640
Flag value (see above). </td></tr>
642
</dl><dl compact><dt><b>
644
<div class="fragment"><pre>encoder != NULL
645
</pre></div> </dl><dl compact><dt><b>
646
Return values: </b><dd>
647
<table border=0 cellspacing=2 cellpadding=0>
648
<tr><td valign=top><em>FLAC__bool</em> </td><td>
649
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
654
<a name="a12" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_loose_mid_side_stereo"></a><p>
655
<table width="100%" cellpadding="2" cellspacing="0" border="0">
658
<table cellpadding="0" cellspacing="0" border="0">
660
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_loose_mid_side_stereo </td>
661
<td class="md" valign="top">( </td>
662
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
663
<td class="mdname" nowrap> <em>encoder</em>, </td>
668
<td class="md" nowrap>FLAC__bool </td>
669
<td class="mdname" nowrap> <em>value</em></td>
673
<td class="md">) </td>
674
<td class="md" colspan="2"></td>
681
<table cellspacing=5 cellpadding=0 border=0>
689
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a9">FLAC__stream_encoder_set_loose_mid_side_stereo</a>()<dl compact><dt><b>
690
Default Value:</b><dd>
691
<code>false</code> </dl><dl compact><dt><b>
693
<table border=0 cellspacing=2 cellpadding=0>
694
<tr><td valign=top><em>encoder</em> </td><td>
695
An encoder instance to set. </td></tr>
696
<tr><td valign=top><em>value</em> </td><td>
697
Flag value (see above). </td></tr>
699
</dl><dl compact><dt><b>
701
<div class="fragment"><pre>encoder != NULL
702
</pre></div> </dl><dl compact><dt><b>
703
Return values: </b><dd>
704
<table border=0 cellspacing=2 cellpadding=0>
705
<tr><td valign=top><em>FLAC__bool</em> </td><td>
706
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
711
<a name="a13" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_channels"></a><p>
712
<table width="100%" cellpadding="2" cellspacing="0" border="0">
715
<table cellpadding="0" cellspacing="0" border="0">
717
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_channels </td>
718
<td class="md" valign="top">( </td>
719
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
720
<td class="mdname" nowrap> <em>encoder</em>, </td>
725
<td class="md" nowrap>unsigned </td>
726
<td class="mdname" nowrap> <em>value</em></td>
730
<td class="md">) </td>
731
<td class="md" colspan="2"></td>
738
<table cellspacing=5 cellpadding=0 border=0>
746
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a10">FLAC__stream_encoder_set_channels</a>()<dl compact><dt><b>
747
Default Value:</b><dd>
748
<code>2</code> </dl><dl compact><dt><b>
750
<table border=0 cellspacing=2 cellpadding=0>
751
<tr><td valign=top><em>encoder</em> </td><td>
752
An encoder instance to set. </td></tr>
753
<tr><td valign=top><em>value</em> </td><td>
754
See above. </td></tr>
756
</dl><dl compact><dt><b>
758
<div class="fragment"><pre>encoder != NULL
759
</pre></div> </dl><dl compact><dt><b>
760
Return values: </b><dd>
761
<table border=0 cellspacing=2 cellpadding=0>
762
<tr><td valign=top><em>FLAC__bool</em> </td><td>
763
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
768
<a name="a14" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_bits_per_sample"></a><p>
769
<table width="100%" cellpadding="2" cellspacing="0" border="0">
772
<table cellpadding="0" cellspacing="0" border="0">
774
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_bits_per_sample </td>
775
<td class="md" valign="top">( </td>
776
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
777
<td class="mdname" nowrap> <em>encoder</em>, </td>
782
<td class="md" nowrap>unsigned </td>
783
<td class="mdname" nowrap> <em>value</em></td>
787
<td class="md">) </td>
788
<td class="md" colspan="2"></td>
795
<table cellspacing=5 cellpadding=0 border=0>
803
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a11">FLAC__stream_encoder_set_bits_per_sample</a>()<dl compact><dt><b>
804
Default Value:</b><dd>
805
<code>16</code> </dl><dl compact><dt><b>
807
<table border=0 cellspacing=2 cellpadding=0>
808
<tr><td valign=top><em>encoder</em> </td><td>
809
An encoder instance to set. </td></tr>
810
<tr><td valign=top><em>value</em> </td><td>
811
See above. </td></tr>
813
</dl><dl compact><dt><b>
815
<div class="fragment"><pre>encoder != NULL
816
</pre></div> </dl><dl compact><dt><b>
817
Return values: </b><dd>
818
<table border=0 cellspacing=2 cellpadding=0>
819
<tr><td valign=top><em>FLAC__bool</em> </td><td>
820
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
825
<a name="a15" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_sample_rate"></a><p>
826
<table width="100%" cellpadding="2" cellspacing="0" border="0">
829
<table cellpadding="0" cellspacing="0" border="0">
831
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_sample_rate </td>
832
<td class="md" valign="top">( </td>
833
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
834
<td class="mdname" nowrap> <em>encoder</em>, </td>
839
<td class="md" nowrap>unsigned </td>
840
<td class="mdname" nowrap> <em>value</em></td>
844
<td class="md">) </td>
845
<td class="md" colspan="2"></td>
852
<table cellspacing=5 cellpadding=0 border=0>
860
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a12">FLAC__stream_encoder_set_sample_rate</a>()<dl compact><dt><b>
861
Default Value:</b><dd>
862
<code>44100</code> </dl><dl compact><dt><b>
864
<table border=0 cellspacing=2 cellpadding=0>
865
<tr><td valign=top><em>encoder</em> </td><td>
866
An encoder instance to set. </td></tr>
867
<tr><td valign=top><em>value</em> </td><td>
868
See above. </td></tr>
870
</dl><dl compact><dt><b>
872
<div class="fragment"><pre>encoder != NULL
873
</pre></div> </dl><dl compact><dt><b>
874
Return values: </b><dd>
875
<table border=0 cellspacing=2 cellpadding=0>
876
<tr><td valign=top><em>FLAC__bool</em> </td><td>
877
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
882
<a name="a16" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_blocksize"></a><p>
883
<table width="100%" cellpadding="2" cellspacing="0" border="0">
886
<table cellpadding="0" cellspacing="0" border="0">
888
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_blocksize </td>
889
<td class="md" valign="top">( </td>
890
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
891
<td class="mdname" nowrap> <em>encoder</em>, </td>
896
<td class="md" nowrap>unsigned </td>
897
<td class="mdname" nowrap> <em>value</em></td>
901
<td class="md">) </td>
902
<td class="md" colspan="2"></td>
909
<table cellspacing=5 cellpadding=0 border=0>
917
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a13">FLAC__stream_encoder_set_blocksize</a>()<dl compact><dt><b>
918
Default Value:</b><dd>
919
<code>1152</code> </dl><dl compact><dt><b>
921
<table border=0 cellspacing=2 cellpadding=0>
922
<tr><td valign=top><em>encoder</em> </td><td>
923
An encoder instance to set. </td></tr>
924
<tr><td valign=top><em>value</em> </td><td>
925
See above. </td></tr>
927
</dl><dl compact><dt><b>
929
<div class="fragment"><pre>encoder != NULL
930
</pre></div> </dl><dl compact><dt><b>
931
Return values: </b><dd>
932
<table border=0 cellspacing=2 cellpadding=0>
933
<tr><td valign=top><em>FLAC__bool</em> </td><td>
934
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
939
<a name="a17" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_max_lpc_order"></a><p>
940
<table width="100%" cellpadding="2" cellspacing="0" border="0">
943
<table cellpadding="0" cellspacing="0" border="0">
945
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_max_lpc_order </td>
946
<td class="md" valign="top">( </td>
947
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
948
<td class="mdname" nowrap> <em>encoder</em>, </td>
953
<td class="md" nowrap>unsigned </td>
954
<td class="mdname" nowrap> <em>value</em></td>
958
<td class="md">) </td>
959
<td class="md" colspan="2"></td>
966
<table cellspacing=5 cellpadding=0 border=0>
974
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a14">FLAC__stream_encoder_set_max_lpc_order</a>()<dl compact><dt><b>
975
Default Value:</b><dd>
976
<code>0</code> </dl><dl compact><dt><b>
978
<table border=0 cellspacing=2 cellpadding=0>
979
<tr><td valign=top><em>encoder</em> </td><td>
980
An encoder instance to set. </td></tr>
981
<tr><td valign=top><em>value</em> </td><td>
982
See above. </td></tr>
984
</dl><dl compact><dt><b>
986
<div class="fragment"><pre>encoder != NULL
987
</pre></div> </dl><dl compact><dt><b>
988
Return values: </b><dd>
989
<table border=0 cellspacing=2 cellpadding=0>
990
<tr><td valign=top><em>FLAC__bool</em> </td><td>
991
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
996
<a name="a18" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_qlp_coeff_precision"></a><p>
997
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1000
<table cellpadding="0" cellspacing="0" border="0">
1002
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_qlp_coeff_precision </td>
1003
<td class="md" valign="top">( </td>
1004
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1005
<td class="mdname" nowrap> <em>encoder</em>, </td>
1010
<td class="md" nowrap>unsigned </td>
1011
<td class="mdname" nowrap> <em>value</em></td>
1015
<td class="md">) </td>
1016
<td class="md" colspan="2"></td>
1023
<table cellspacing=5 cellpadding=0 border=0>
1031
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a15">FLAC__stream_encoder_set_qlp_coeff_precision</a>()<dl compact><dt><b>
1032
Default Value:</b><dd>
1033
<code>0</code> </dl><dl compact><dt><b>
1034
Parameters: </b><dd>
1035
<table border=0 cellspacing=2 cellpadding=0>
1036
<tr><td valign=top><em>encoder</em> </td><td>
1037
An encoder instance to set. </td></tr>
1038
<tr><td valign=top><em>value</em> </td><td>
1039
See above. </td></tr>
1041
</dl><dl compact><dt><b>
1043
<div class="fragment"><pre>encoder != NULL
1044
</pre></div> </dl><dl compact><dt><b>
1045
Return values: </b><dd>
1046
<table border=0 cellspacing=2 cellpadding=0>
1047
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1048
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1053
<a name="a19" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search"></a><p>
1054
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1057
<table cellpadding="0" cellspacing="0" border="0">
1059
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search </td>
1060
<td class="md" valign="top">( </td>
1061
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1062
<td class="mdname" nowrap> <em>encoder</em>, </td>
1067
<td class="md" nowrap>FLAC__bool </td>
1068
<td class="mdname" nowrap> <em>value</em></td>
1072
<td class="md">) </td>
1073
<td class="md" colspan="2"></td>
1080
<table cellspacing=5 cellpadding=0 border=0>
1088
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see FLAC__stream_encoder_set_qlp_coeff_prec_search()<dl compact><dt><b>
1089
Default Value:</b><dd>
1090
<code>false</code> </dl><dl compact><dt><b>
1091
Parameters: </b><dd>
1092
<table border=0 cellspacing=2 cellpadding=0>
1093
<tr><td valign=top><em>encoder</em> </td><td>
1094
An encoder instance to set. </td></tr>
1095
<tr><td valign=top><em>value</em> </td><td>
1096
See above. </td></tr>
1098
</dl><dl compact><dt><b>
1100
<div class="fragment"><pre>encoder != NULL
1101
</pre></div> </dl><dl compact><dt><b>
1102
Return values: </b><dd>
1103
<table border=0 cellspacing=2 cellpadding=0>
1104
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1105
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1110
<a name="a20" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_do_escape_coding"></a><p>
1111
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1114
<table cellpadding="0" cellspacing="0" border="0">
1116
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_do_escape_coding </td>
1117
<td class="md" valign="top">( </td>
1118
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1119
<td class="mdname" nowrap> <em>encoder</em>, </td>
1124
<td class="md" nowrap>FLAC__bool </td>
1125
<td class="mdname" nowrap> <em>value</em></td>
1129
<td class="md">) </td>
1130
<td class="md" colspan="2"></td>
1137
<table cellspacing=5 cellpadding=0 border=0>
1145
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a17">FLAC__stream_encoder_set_do_escape_coding</a>()<dl compact><dt><b>
1146
Default Value:</b><dd>
1147
<code>false</code> </dl><dl compact><dt><b>
1148
Parameters: </b><dd>
1149
<table border=0 cellspacing=2 cellpadding=0>
1150
<tr><td valign=top><em>encoder</em> </td><td>
1151
An encoder instance to set. </td></tr>
1152
<tr><td valign=top><em>value</em> </td><td>
1153
See above. </td></tr>
1155
</dl><dl compact><dt><b>
1157
<div class="fragment"><pre>encoder != NULL
1158
</pre></div> </dl><dl compact><dt><b>
1159
Return values: </b><dd>
1160
<table border=0 cellspacing=2 cellpadding=0>
1161
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1162
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1167
<a name="a21" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_do_exhaustive_model_search"></a><p>
1168
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1171
<table cellpadding="0" cellspacing="0" border="0">
1173
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_do_exhaustive_model_search </td>
1174
<td class="md" valign="top">( </td>
1175
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1176
<td class="mdname" nowrap> <em>encoder</em>, </td>
1181
<td class="md" nowrap>FLAC__bool </td>
1182
<td class="mdname" nowrap> <em>value</em></td>
1186
<td class="md">) </td>
1187
<td class="md" colspan="2"></td>
1194
<table cellspacing=5 cellpadding=0 border=0>
1202
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a18">FLAC__stream_encoder_set_do_exhaustive_model_search</a>()<dl compact><dt><b>
1203
Default Value:</b><dd>
1204
<code>false</code> </dl><dl compact><dt><b>
1205
Parameters: </b><dd>
1206
<table border=0 cellspacing=2 cellpadding=0>
1207
<tr><td valign=top><em>encoder</em> </td><td>
1208
An encoder instance to set. </td></tr>
1209
<tr><td valign=top><em>value</em> </td><td>
1210
See above. </td></tr>
1212
</dl><dl compact><dt><b>
1214
<div class="fragment"><pre>encoder != NULL
1215
</pre></div> </dl><dl compact><dt><b>
1216
Return values: </b><dd>
1217
<table border=0 cellspacing=2 cellpadding=0>
1218
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1219
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1224
<a name="a22" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_min_residual_partition_order"></a><p>
1225
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1228
<table cellpadding="0" cellspacing="0" border="0">
1230
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_min_residual_partition_order </td>
1231
<td class="md" valign="top">( </td>
1232
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1233
<td class="mdname" nowrap> <em>encoder</em>, </td>
1238
<td class="md" nowrap>unsigned </td>
1239
<td class="mdname" nowrap> <em>value</em></td>
1243
<td class="md">) </td>
1244
<td class="md" colspan="2"></td>
1251
<table cellspacing=5 cellpadding=0 border=0>
1259
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a19">FLAC__stream_encoder_set_min_residual_partition_order</a>()<dl compact><dt><b>
1260
Default Value:</b><dd>
1261
<code>0</code> </dl><dl compact><dt><b>
1262
Parameters: </b><dd>
1263
<table border=0 cellspacing=2 cellpadding=0>
1264
<tr><td valign=top><em>encoder</em> </td><td>
1265
An encoder instance to set. </td></tr>
1266
<tr><td valign=top><em>value</em> </td><td>
1267
See above. </td></tr>
1269
</dl><dl compact><dt><b>
1271
<div class="fragment"><pre>encoder != NULL
1272
</pre></div> </dl><dl compact><dt><b>
1273
Return values: </b><dd>
1274
<table border=0 cellspacing=2 cellpadding=0>
1275
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1276
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1281
<a name="a23" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_max_residual_partition_order"></a><p>
1282
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1285
<table cellpadding="0" cellspacing="0" border="0">
1287
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_max_residual_partition_order </td>
1288
<td class="md" valign="top">( </td>
1289
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1290
<td class="mdname" nowrap> <em>encoder</em>, </td>
1295
<td class="md" nowrap>unsigned </td>
1296
<td class="mdname" nowrap> <em>value</em></td>
1300
<td class="md">) </td>
1301
<td class="md" colspan="2"></td>
1308
<table cellspacing=5 cellpadding=0 border=0>
1316
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a20">FLAC__stream_encoder_set_max_residual_partition_order</a>()<dl compact><dt><b>
1317
Default Value:</b><dd>
1318
<code>0</code> </dl><dl compact><dt><b>
1319
Parameters: </b><dd>
1320
<table border=0 cellspacing=2 cellpadding=0>
1321
<tr><td valign=top><em>encoder</em> </td><td>
1322
An encoder instance to set. </td></tr>
1323
<tr><td valign=top><em>value</em> </td><td>
1324
See above. </td></tr>
1326
</dl><dl compact><dt><b>
1328
<div class="fragment"><pre>encoder != NULL
1329
</pre></div> </dl><dl compact><dt><b>
1330
Return values: </b><dd>
1331
<table border=0 cellspacing=2 cellpadding=0>
1332
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1333
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1338
<a name="a24" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_rice_parameter_search_dist"></a><p>
1339
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1342
<table cellpadding="0" cellspacing="0" border="0">
1344
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_rice_parameter_search_dist </td>
1345
<td class="md" valign="top">( </td>
1346
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1347
<td class="mdname" nowrap> <em>encoder</em>, </td>
1352
<td class="md" nowrap>unsigned </td>
1353
<td class="mdname" nowrap> <em>value</em></td>
1357
<td class="md">) </td>
1358
<td class="md" colspan="2"></td>
1365
<table cellspacing=5 cellpadding=0 border=0>
1373
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a21">FLAC__stream_encoder_set_rice_parameter_search_dist</a>()<dl compact><dt><b>
1374
Default Value:</b><dd>
1375
<code>0</code> </dl><dl compact><dt><b>
1376
Parameters: </b><dd>
1377
<table border=0 cellspacing=2 cellpadding=0>
1378
<tr><td valign=top><em>encoder</em> </td><td>
1379
An encoder instance to set. </td></tr>
1380
<tr><td valign=top><em>value</em> </td><td>
1381
See above. </td></tr>
1383
</dl><dl compact><dt><b>
1385
<div class="fragment"><pre>encoder != NULL
1386
</pre></div> </dl><dl compact><dt><b>
1387
Return values: </b><dd>
1388
<table border=0 cellspacing=2 cellpadding=0>
1389
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1390
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1395
<a name="a25" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_total_samples_estimate"></a><p>
1396
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1399
<table cellpadding="0" cellspacing="0" border="0">
1401
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_total_samples_estimate </td>
1402
<td class="md" valign="top">( </td>
1403
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1404
<td class="mdname" nowrap> <em>encoder</em>, </td>
1409
<td class="md" nowrap>FLAC__uint64 </td>
1410
<td class="mdname" nowrap> <em>value</em></td>
1414
<td class="md">) </td>
1415
<td class="md" colspan="2"></td>
1422
<table cellspacing=5 cellpadding=0 border=0>
1430
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a22">FLAC__stream_encoder_set_total_samples_estimate</a>()<dl compact><dt><b>
1431
Default Value:</b><dd>
1432
<code>0</code> </dl><dl compact><dt><b>
1433
Parameters: </b><dd>
1434
<table border=0 cellspacing=2 cellpadding=0>
1435
<tr><td valign=top><em>encoder</em> </td><td>
1436
An encoder instance to set. </td></tr>
1437
<tr><td valign=top><em>value</em> </td><td>
1438
See above. </td></tr>
1440
</dl><dl compact><dt><b>
1442
<div class="fragment"><pre>encoder != NULL
1443
</pre></div> </dl><dl compact><dt><b>
1444
Return values: </b><dd>
1445
<table border=0 cellspacing=2 cellpadding=0>
1446
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1447
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1452
<a name="a26" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_metadata"></a><p>
1453
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1456
<table cellpadding="0" cellspacing="0" border="0">
1458
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_metadata </td>
1459
<td class="md" valign="top">( </td>
1460
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1461
<td class="mdname" nowrap> <em>encoder</em>, </td>
1466
<td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> ** </td>
1467
<td class="mdname" nowrap> <em>metadata</em>, </td>
1472
<td class="md" nowrap>unsigned </td>
1473
<td class="mdname" nowrap> <em>num_blocks</em></td>
1477
<td class="md">) </td>
1478
<td class="md" colspan="2"></td>
1485
<table cellspacing=5 cellpadding=0 border=0>
1493
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a23">FLAC__stream_encoder_set_metadata</a>()
1497
The Ogg FLAC mapping requires that the VORBIS_COMMENT block be the second metadata block of the stream. The encoder already supplies the STREAMINFO block automatically. If <em>metadata</em> does not contain a VORBIS_COMMENT block, the encoder will supply that too. Otherwise, if <em>metadata</em> does contain a VORBIS_COMMENT block and it is not the first, this function will reorder <em>metadata</em> by moving the VORBIS_COMMENT block to the front; the relative ordering of the other blocks will remain as they were.</dl><dl compact><dt><b>
1499
The Ogg FLAC mapping limits the number of metadata blocks per stream to <code>65535</code>. If <em>num_blocks</em> exceeds this the function will return <code>false</code>.</dl><dl compact><dt><b>
1500
Default Value:</b><dd>
1501
<code>NULL</code>, 0 </dl><dl compact><dt><b>
1502
Parameters: </b><dd>
1503
<table border=0 cellspacing=2 cellpadding=0>
1504
<tr><td valign=top><em>encoder</em> </td><td>
1505
An encoder instance to set. </td></tr>
1506
<tr><td valign=top><em>metadata</em> </td><td>
1507
See above. </td></tr>
1508
<tr><td valign=top><em>num_blocks</em> </td><td>
1509
See above. </td></tr>
1511
</dl><dl compact><dt><b>
1513
<div class="fragment"><pre>encoder != NULL
1514
</pre></div> </dl><dl compact><dt><b>
1515
Return values: </b><dd>
1516
<table border=0 cellspacing=2 cellpadding=0>
1517
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1518
<code>false</code> if the encoder is already initialized, or if <em>num_blocks</em> > 65535, else <code>true</code>. </td></tr>
1523
<a name="a27" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_read_callback"></a><p>
1524
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1527
<table cellpadding="0" cellspacing="0" border="0">
1529
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_read_callback </td>
1530
<td class="md" valign="top">( </td>
1531
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1532
<td class="mdname" nowrap> <em>encoder</em>, </td>
1537
<td class="md" nowrap><a class="el" href="group__oggflac__seekable__stream__encoder.html#a2">OggFLAC__SeekableStreamEncoderReadCallback</a> </td>
1538
<td class="mdname" nowrap> <em>value</em></td>
1542
<td class="md">) </td>
1543
<td class="md" colspan="2"></td>
1550
<table cellspacing=5 cellpadding=0 border=0>
1558
Set the read callback. The supplied function will be called when the encoder needs to read back encoded data. This happens during the metadata callback, when the encoder has to read, modify, and rewrite the metadata (e.g. seekpoints) gathered while encoding. The address of the buffer to be filled is supplied, along with the number of bytes the buffer can hold. The callback may choose to supply less data and modify the byte count but must be careful not to overflow the buffer. The callback then returns a status code chosen from OggFLAC__SeekableStreamEncoderReadStatus.
1562
The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
1563
Default Value:</b><dd>
1564
<code>NULL</code> </dl><dl compact><dt><b>
1565
Parameters: </b><dd>
1566
<table border=0 cellspacing=2 cellpadding=0>
1567
<tr><td valign=top><em>encoder</em> </td><td>
1568
A encoder instance to set. </td></tr>
1569
<tr><td valign=top><em>value</em> </td><td>
1570
See above. </td></tr>
1572
</dl><dl compact><dt><b>
1574
<div class="fragment"><pre>encoder != NULL
1575
</pre></div> <div class="fragment"><pre>value != NULL
1576
</pre></div> </dl><dl compact><dt><b>
1577
Return values: </b><dd>
1578
<table border=0 cellspacing=2 cellpadding=0>
1579
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1580
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1585
<a name="a28" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_seek_callback"></a><p>
1586
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1589
<table cellpadding="0" cellspacing="0" border="0">
1591
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_seek_callback </td>
1592
<td class="md" valign="top">( </td>
1593
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1594
<td class="mdname" nowrap> <em>encoder</em>, </td>
1599
<td class="md" nowrap><a class="el" href="group__oggflac__seekable__stream__encoder.html#a3">OggFLAC__SeekableStreamEncoderSeekCallback</a> </td>
1600
<td class="mdname" nowrap> <em>value</em></td>
1604
<td class="md">) </td>
1605
<td class="md" colspan="2"></td>
1612
<table cellspacing=5 cellpadding=0 border=0>
1620
Set the seek callback. The supplied function will be called when the encoder needs to seek the output stream. The encoder will pass the absolute byte offset to seek to, 0 meaning the beginning of the stream.
1624
The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
1625
Default Value:</b><dd>
1626
<code>NULL</code> </dl><dl compact><dt><b>
1627
Parameters: </b><dd>
1628
<table border=0 cellspacing=2 cellpadding=0>
1629
<tr><td valign=top><em>encoder</em> </td><td>
1630
An encoder instance to set. </td></tr>
1631
<tr><td valign=top><em>value</em> </td><td>
1632
See above. </td></tr>
1634
</dl><dl compact><dt><b>
1636
<div class="fragment"><pre>encoder != NULL
1637
</pre></div> <div class="fragment"><pre>value != NULL
1638
</pre></div> </dl><dl compact><dt><b>
1639
Return values: </b><dd>
1640
<table border=0 cellspacing=2 cellpadding=0>
1641
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1642
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1647
<a name="a29" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_tell_callback"></a><p>
1648
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1651
<table cellpadding="0" cellspacing="0" border="0">
1653
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_tell_callback </td>
1654
<td class="md" valign="top">( </td>
1655
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1656
<td class="mdname" nowrap> <em>encoder</em>, </td>
1661
<td class="md" nowrap><a class="el" href="group__oggflac__seekable__stream__encoder.html#a4">OggFLAC__SeekableStreamEncoderTellCallback</a> </td>
1662
<td class="mdname" nowrap> <em>value</em></td>
1666
<td class="md">) </td>
1667
<td class="md" colspan="2"></td>
1674
<table cellspacing=5 cellpadding=0 border=0>
1682
Set the tell callback. The supplied function will be called when the encoder needs to know the current position of the output stream.
1686
The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
1687
Default Value:</b><dd>
1688
<code>NULL</code> </dl><dl compact><dt><b>
1689
Parameters: </b><dd>
1690
<table border=0 cellspacing=2 cellpadding=0>
1691
<tr><td valign=top><em>encoder</em> </td><td>
1692
An encoder instance to set. </td></tr>
1693
<tr><td valign=top><em>value</em> </td><td>
1694
See above. </td></tr>
1696
</dl><dl compact><dt><b>
1698
<div class="fragment"><pre>encoder != NULL
1699
</pre></div> <div class="fragment"><pre>value != NULL
1700
</pre></div> </dl><dl compact><dt><b>
1701
Return values: </b><dd>
1702
<table border=0 cellspacing=2 cellpadding=0>
1703
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1704
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1709
<a name="a30" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_write_callback"></a><p>
1710
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1713
<table cellpadding="0" cellspacing="0" border="0">
1715
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_write_callback </td>
1716
<td class="md" valign="top">( </td>
1717
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1718
<td class="mdname" nowrap> <em>encoder</em>, </td>
1723
<td class="md" nowrap><a class="el" href="group__oggflac__seekable__stream__encoder.html#a5">OggFLAC__SeekableStreamEncoderWriteCallback</a> </td>
1724
<td class="mdname" nowrap> <em>value</em></td>
1728
<td class="md">) </td>
1729
<td class="md" colspan="2"></td>
1736
<table cellspacing=5 cellpadding=0 border=0>
1744
Set the write callback. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a24">FLAC__stream_encoder_set_write_callback</a>().
1748
Unlike the FLAC seekable stream encoder write callback, the Ogg seekable stream encoder write callback will be called twice when writing audio frames; once for the page header, and once for the page body. When writing the page header, the <em>samples</em> argument to the write callback will be <code>0</code>.</dl><dl compact><dt><b>
1750
The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
1751
Default Value:</b><dd>
1752
<code>NULL</code> </dl><dl compact><dt><b>
1753
Parameters: </b><dd>
1754
<table border=0 cellspacing=2 cellpadding=0>
1755
<tr><td valign=top><em>encoder</em> </td><td>
1756
An encoder instance to set. </td></tr>
1757
<tr><td valign=top><em>value</em> </td><td>
1758
See above. </td></tr>
1760
</dl><dl compact><dt><b>
1762
<div class="fragment"><pre>encoder != NULL
1763
</pre></div> <div class="fragment"><pre>value != NULL
1764
</pre></div> </dl><dl compact><dt><b>
1765
Return values: </b><dd>
1766
<table border=0 cellspacing=2 cellpadding=0>
1767
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1768
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1773
<a name="a31" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_set_client_data"></a><p>
1774
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1777
<table cellpadding="0" cellspacing="0" border="0">
1779
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_set_client_data </td>
1780
<td class="md" valign="top">( </td>
1781
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1782
<td class="mdname" nowrap> <em>encoder</em>, </td>
1787
<td class="md" nowrap>void * </td>
1788
<td class="mdname" nowrap> <em>value</em></td>
1792
<td class="md">) </td>
1793
<td class="md" colspan="2"></td>
1800
<table cellspacing=5 cellpadding=0 border=0>
1808
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>
1809
Default Value:</b><dd>
1810
<code>NULL</code> </dl><dl compact><dt><b>
1811
Parameters: </b><dd>
1812
<table border=0 cellspacing=2 cellpadding=0>
1813
<tr><td valign=top><em>encoder</em> </td><td>
1814
An encoder instance to set. </td></tr>
1815
<tr><td valign=top><em>value</em> </td><td>
1816
See above. </td></tr>
1818
</dl><dl compact><dt><b>
1820
<div class="fragment"><pre>encoder != NULL
1821
</pre></div> </dl><dl compact><dt><b>
1822
Return values: </b><dd>
1823
<table border=0 cellspacing=2 cellpadding=0>
1824
<tr><td valign=top><em>FLAC__bool</em> </td><td>
1825
<code>false</code> if the encoder is already initialized, else <code>true</code>. </td></tr>
1830
<a name="a32" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_state"></a><p>
1831
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1834
<table cellpadding="0" cellspacing="0" border="0">
1836
<td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__oggflac__seekable__stream__encoder.html#a58">OggFLAC__SeekableStreamEncoderState</a> OggFLAC__seekable_stream_encoder_get_state </td>
1837
<td class="md" valign="top">( </td>
1838
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1839
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
1840
<td class="md" valign="top">) </td>
1841
<td class="md" nowrap></td>
1848
<table cellspacing=5 cellpadding=0 border=0>
1856
Get the current encoder state.<dl compact><dt><b>
1857
Parameters: </b><dd>
1858
<table border=0 cellspacing=2 cellpadding=0>
1859
<tr><td valign=top><em>encoder</em> </td><td>
1860
An encoder instance to query. </td></tr>
1862
</dl><dl compact><dt><b>
1864
<div class="fragment"><pre>encoder != NULL
1865
</pre></div> </dl><dl compact><dt><b>
1866
Return values: </b><dd>
1867
<table border=0 cellspacing=2 cellpadding=0>
1868
<tr><td valign=top><em>OggFLAC__SeekableStreamEncoderState</em> </td><td>
1869
The current encoder state. </td></tr>
1874
<a name="a33" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_FLAC_stream_encoder_state"></a><p>
1875
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1878
<table cellpadding="0" cellspacing="0" border="0">
1880
<td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__flac__stream__encoder.html#a52">FLAC__StreamEncoderState</a> OggFLAC__seekable_stream_encoder_get_FLAC_stream_encoder_state </td>
1881
<td class="md" valign="top">( </td>
1882
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1883
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
1884
<td class="md" valign="top">) </td>
1885
<td class="md" nowrap></td>
1892
<table cellspacing=5 cellpadding=0 border=0>
1900
Get the state of the underlying FLAC stream encoder. Useful when the seekable stream encoder state is <code>OggFLAC__SEEKABLE_STREAM_ENCODER_FLAC_STREAM_ENCODER_ERROR</code>.<dl compact><dt><b>
1901
Parameters: </b><dd>
1902
<table border=0 cellspacing=2 cellpadding=0>
1903
<tr><td valign=top><em>encoder</em> </td><td>
1904
An encoder instance to query. </td></tr>
1906
</dl><dl compact><dt><b>
1908
<div class="fragment"><pre>encoder != NULL
1909
</pre></div> </dl><dl compact><dt><b>
1910
Return values: </b><dd>
1911
<table border=0 cellspacing=2 cellpadding=0>
1912
<tr><td valign=top><em>FLAC__StreamEncoderState</em> </td><td>
1913
The FLAC stream encoder state. </td></tr>
1918
<a name="a34" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_verify_decoder_state"></a><p>
1919
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1922
<table cellpadding="0" cellspacing="0" border="0">
1924
<td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a> OggFLAC__seekable_stream_encoder_get_verify_decoder_state </td>
1925
<td class="md" valign="top">( </td>
1926
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1927
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
1928
<td class="md" valign="top">) </td>
1929
<td class="md" nowrap></td>
1936
<table cellspacing=5 cellpadding=0 border=0>
1944
Get the state of the underlying FLAC encoder's verify decoder. Useful when the seekable stream encoder state is <code>OggFLAC__SEEKABLE_STREAM_ENCODER_FLAC_STREAM_ENCODER_ERROR</code> and the FLAC stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>.<dl compact><dt><b>
1945
Parameters: </b><dd>
1946
<table border=0 cellspacing=2 cellpadding=0>
1947
<tr><td valign=top><em>encoder</em> </td><td>
1948
An encoder instance to query. </td></tr>
1950
</dl><dl compact><dt><b>
1952
<div class="fragment"><pre>encoder != NULL
1953
</pre></div> </dl><dl compact><dt><b>
1954
Return values: </b><dd>
1955
<table border=0 cellspacing=2 cellpadding=0>
1956
<tr><td valign=top><em>FLAC__StreamDecoderState</em> </td><td>
1957
The FLAC verify decoder state. </td></tr>
1962
<a name="a35" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_resolved_state_string"></a><p>
1963
<table width="100%" cellpadding="2" cellspacing="0" border="0">
1966
<table cellpadding="0" cellspacing="0" border="0">
1968
<td class="md" nowrap valign="top"> OggFLAC_API const char* OggFLAC__seekable_stream_encoder_get_resolved_state_string </td>
1969
<td class="md" valign="top">( </td>
1970
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
1971
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
1972
<td class="md" valign="top">) </td>
1973
<td class="md" nowrap></td>
1980
<table cellspacing=5 cellpadding=0 border=0>
1988
Get the current encoder state as a C string. This version automatically resolves <code>OggFLAC__SEEKABLE_STREAM_ENCODER_FLAC_STREAM_ENCODER_ERROR</code> by getting the FLAC stream encoder's resolved state.<dl compact><dt><b>
1989
Parameters: </b><dd>
1990
<table border=0 cellspacing=2 cellpadding=0>
1991
<tr><td valign=top><em>encoder</em> </td><td>
1992
A encoder instance to query. </td></tr>
1994
</dl><dl compact><dt><b>
1996
<div class="fragment"><pre>encoder != NULL
1997
</pre></div> </dl><dl compact><dt><b>
1998
Return values: </b><dd>
1999
<table border=0 cellspacing=2 cellpadding=0>
2000
<tr><td valign=top><em>const</em> </td><td>
2001
char * The encoder state as a C string. Do not modify the contents. </td></tr>
2006
<a name="a36" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_verify_decoder_error_stats"></a><p>
2007
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2010
<table cellpadding="0" cellspacing="0" border="0">
2012
<td class="md" nowrap valign="top"> OggFLAC_API void OggFLAC__seekable_stream_encoder_get_verify_decoder_error_stats </td>
2013
<td class="md" valign="top">( </td>
2014
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2015
<td class="mdname" nowrap> <em>encoder</em>, </td>
2020
<td class="md" nowrap>FLAC__uint64 * </td>
2021
<td class="mdname" nowrap> <em>absolute_sample</em>, </td>
2026
<td class="md" nowrap>unsigned * </td>
2027
<td class="mdname" nowrap> <em>frame_number</em>, </td>
2032
<td class="md" nowrap>unsigned * </td>
2033
<td class="mdname" nowrap> <em>channel</em>, </td>
2038
<td class="md" nowrap>unsigned * </td>
2039
<td class="mdname" nowrap> <em>sample</em>, </td>
2044
<td class="md" nowrap>FLAC__int32 * </td>
2045
<td class="mdname" nowrap> <em>expected</em>, </td>
2050
<td class="md" nowrap>FLAC__int32 * </td>
2051
<td class="mdname" nowrap> <em>got</em></td>
2055
<td class="md">) </td>
2056
<td class="md" colspan="2"></td>
2063
<table cellspacing=5 cellpadding=0 border=0>
2071
Get relevant values about the nature of a verify decoder error. Inherited from <a class="el" href="group__flac__stream__encoder.html#a30">FLAC__stream_encoder_get_verify_decoder_error_stats</a>(). Useful when the seekable stream encoder state is <code>OggFLAC__SEEKABLE_STREAM_ENCODER_FLAC_STREAM_ENCODER_ERROR</code> and the FLAC stream encoder state is <code>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</code>.<dl compact><dt><b>
2072
Parameters: </b><dd>
2073
<table border=0 cellspacing=2 cellpadding=0>
2074
<tr><td valign=top><em>encoder</em> </td><td>
2075
An encoder instance to query. </td></tr>
2076
<tr><td valign=top><em>absolute_sample</em> </td><td>
2077
The absolute sample number of the mismatch. </td></tr>
2078
<tr><td valign=top><em>frame_number</em> </td><td>
2079
The number of the frame in which the mismatch occurred. </td></tr>
2080
<tr><td valign=top><em>channel</em> </td><td>
2081
The channel in which the mismatch occurred. </td></tr>
2082
<tr><td valign=top><em>sample</em> </td><td>
2083
The number of the sample (relative to the frame) in which the mismatch occurred. </td></tr>
2084
<tr><td valign=top><em>expected</em> </td><td>
2085
The expected value for the sample in question. </td></tr>
2086
<tr><td valign=top><em>got</em> </td><td>
2087
The actual value returned by the decoder. </td></tr>
2089
</dl><dl compact><dt><b>
2091
<div class="fragment"><pre>encoder != NULL
2092
</pre></div> <div class="fragment"><pre>absolute_sample != NULL
2093
</pre></div> <div class="fragment"><pre>frame_number != NULL
2094
</pre></div> <div class="fragment"><pre>channel != NULL
2095
</pre></div> <div class="fragment"><pre>sample != NULL
2096
</pre></div> <div class="fragment"><pre>expected != NULL
2097
</pre></div> </dl> </td>
2100
<a name="a37" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_verify"></a><p>
2101
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2104
<table cellpadding="0" cellspacing="0" border="0">
2106
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_get_verify </td>
2107
<td class="md" valign="top">( </td>
2108
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2109
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2110
<td class="md" valign="top">) </td>
2111
<td class="md" nowrap></td>
2118
<table cellspacing=5 cellpadding=0 border=0>
2126
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a31">FLAC__stream_encoder_get_verify</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> </td><td>
2130
An encoder instance to query. </td></tr>
2132
</dl><dl compact><dt><b>
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>FLAC__bool</em> </td><td>
2139
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a9">OggFLAC__seekable_stream_encoder_set_verify</a>(). </td></tr>
2144
<a name="a38" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_streamable_subset"></a><p>
2145
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2148
<table cellpadding="0" cellspacing="0" border="0">
2150
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_get_streamable_subset </td>
2151
<td class="md" valign="top">( </td>
2152
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2153
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2154
<td class="md" valign="top">) </td>
2155
<td class="md" nowrap></td>
2162
<table cellspacing=5 cellpadding=0 border=0>
2170
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a32">FLAC__stream_encoder_get_streamable_subset</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> </td><td>
2174
An encoder instance to query. </td></tr>
2176
</dl><dl compact><dt><b>
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>FLAC__bool</em> </td><td>
2183
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a10">OggFLAC__seekable_stream_encoder_set_streamable_subset</a>(). </td></tr>
2188
<a name="a39" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_do_mid_side_stereo"></a><p>
2189
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2192
<table cellpadding="0" cellspacing="0" border="0">
2194
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_get_do_mid_side_stereo </td>
2195
<td class="md" valign="top">( </td>
2196
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2197
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2198
<td class="md" valign="top">) </td>
2199
<td class="md" nowrap></td>
2206
<table cellspacing=5 cellpadding=0 border=0>
2214
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a33">FLAC__stream_encoder_get_do_mid_side_stereo</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> </td><td>
2218
An encoder instance to query. </td></tr>
2220
</dl><dl compact><dt><b>
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>FLAC__bool</em> </td><td>
2227
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a39">OggFLAC__seekable_stream_encoder_get_do_mid_side_stereo</a>(). </td></tr>
2232
<a name="a40" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_loose_mid_side_stereo"></a><p>
2233
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2236
<table cellpadding="0" cellspacing="0" border="0">
2238
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_get_loose_mid_side_stereo </td>
2239
<td class="md" valign="top">( </td>
2240
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2241
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2242
<td class="md" valign="top">) </td>
2243
<td class="md" nowrap></td>
2250
<table cellspacing=5 cellpadding=0 border=0>
2258
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a34">FLAC__stream_encoder_get_loose_mid_side_stereo</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> </td><td>
2262
An encoder instance to query. </td></tr>
2264
</dl><dl compact><dt><b>
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> </td><td>
2271
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a12">OggFLAC__seekable_stream_encoder_set_loose_mid_side_stereo</a>(). </td></tr>
2276
<a name="a41" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_channels"></a><p>
2277
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2280
<table cellpadding="0" cellspacing="0" border="0">
2282
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_channels </td>
2283
<td class="md" valign="top">( </td>
2284
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2285
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2286
<td class="md" valign="top">) </td>
2287
<td class="md" nowrap></td>
2294
<table cellspacing=5 cellpadding=0 border=0>
2302
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a35">FLAC__stream_encoder_get_channels</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> </td><td>
2306
An encoder instance to query. </td></tr>
2308
</dl><dl compact><dt><b>
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>unsigned</em> </td><td>
2315
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a13">OggFLAC__seekable_stream_encoder_set_channels</a>(). </td></tr>
2320
<a name="a42" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_bits_per_sample"></a><p>
2321
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2324
<table cellpadding="0" cellspacing="0" border="0">
2326
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_bits_per_sample </td>
2327
<td class="md" valign="top">( </td>
2328
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2329
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2330
<td class="md" valign="top">) </td>
2331
<td class="md" nowrap></td>
2338
<table cellspacing=5 cellpadding=0 border=0>
2346
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a36">FLAC__stream_encoder_get_bits_per_sample</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> </td><td>
2350
An encoder instance to query. </td></tr>
2352
</dl><dl compact><dt><b>
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>unsigned</em> </td><td>
2359
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a14">OggFLAC__seekable_stream_encoder_set_bits_per_sample</a>(). </td></tr>
2364
<a name="a43" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_sample_rate"></a><p>
2365
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2368
<table cellpadding="0" cellspacing="0" border="0">
2370
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_sample_rate </td>
2371
<td class="md" valign="top">( </td>
2372
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2373
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2374
<td class="md" valign="top">) </td>
2375
<td class="md" nowrap></td>
2382
<table cellspacing=5 cellpadding=0 border=0>
2390
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a37">FLAC__stream_encoder_get_sample_rate</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> </td><td>
2394
An encoder instance to query. </td></tr>
2396
</dl><dl compact><dt><b>
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> </td><td>
2403
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a15">OggFLAC__seekable_stream_encoder_set_sample_rate</a>(). </td></tr>
2408
<a name="a44" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_blocksize"></a><p>
2409
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2412
<table cellpadding="0" cellspacing="0" border="0">
2414
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_blocksize </td>
2415
<td class="md" valign="top">( </td>
2416
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2417
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2418
<td class="md" valign="top">) </td>
2419
<td class="md" nowrap></td>
2426
<table cellspacing=5 cellpadding=0 border=0>
2434
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a38">FLAC__stream_encoder_get_blocksize</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> </td><td>
2438
An encoder instance to query. </td></tr>
2440
</dl><dl compact><dt><b>
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> </td><td>
2447
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a16">OggFLAC__seekable_stream_encoder_set_blocksize</a>(). </td></tr>
2452
<a name="a45" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_max_lpc_order"></a><p>
2453
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2456
<table cellpadding="0" cellspacing="0" border="0">
2458
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_max_lpc_order </td>
2459
<td class="md" valign="top">( </td>
2460
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2461
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2462
<td class="md" valign="top">) </td>
2463
<td class="md" nowrap></td>
2470
<table cellspacing=5 cellpadding=0 border=0>
2478
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a39">FLAC__stream_encoder_get_max_lpc_order</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> </td><td>
2482
An encoder instance to query. </td></tr>
2484
</dl><dl compact><dt><b>
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> </td><td>
2491
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a17">OggFLAC__seekable_stream_encoder_set_max_lpc_order</a>(). </td></tr>
2496
<a name="a46" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_qlp_coeff_precision"></a><p>
2497
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2500
<table cellpadding="0" cellspacing="0" border="0">
2502
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_qlp_coeff_precision </td>
2503
<td class="md" valign="top">( </td>
2504
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2505
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2506
<td class="md" valign="top">) </td>
2507
<td class="md" nowrap></td>
2514
<table cellspacing=5 cellpadding=0 border=0>
2522
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a40">FLAC__stream_encoder_get_qlp_coeff_precision</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> </td><td>
2526
An encoder instance to query. </td></tr>
2528
</dl><dl compact><dt><b>
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>unsigned</em> </td><td>
2535
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a18">OggFLAC__seekable_stream_encoder_set_qlp_coeff_precision</a>(). </td></tr>
2540
<a name="a47" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search"></a><p>
2541
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2544
<table cellpadding="0" cellspacing="0" border="0">
2546
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search </td>
2547
<td class="md" valign="top">( </td>
2548
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2549
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2550
<td class="md" valign="top">) </td>
2551
<td class="md" nowrap></td>
2558
<table cellspacing=5 cellpadding=0 border=0>
2566
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a41">FLAC__stream_encoder_get_do_qlp_coeff_prec_search</a>()<dl compact><dt><b>
2567
Parameters: </b><dd>
2568
<table border=0 cellspacing=2 cellpadding=0>
2569
<tr><td valign=top><em>encoder</em> </td><td>
2570
An encoder instance to query. </td></tr>
2572
</dl><dl compact><dt><b>
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__bool</em> </td><td>
2579
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a19">OggFLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search</a>(). </td></tr>
2584
<a name="a48" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_do_escape_coding"></a><p>
2585
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2588
<table cellpadding="0" cellspacing="0" border="0">
2590
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_get_do_escape_coding </td>
2591
<td class="md" valign="top">( </td>
2592
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2593
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2594
<td class="md" valign="top">) </td>
2595
<td class="md" nowrap></td>
2602
<table cellspacing=5 cellpadding=0 border=0>
2610
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a42">FLAC__stream_encoder_get_do_escape_coding</a>()<dl compact><dt><b>
2611
Parameters: </b><dd>
2612
<table border=0 cellspacing=2 cellpadding=0>
2613
<tr><td valign=top><em>encoder</em> </td><td>
2614
An encoder instance to query. </td></tr>
2616
</dl><dl compact><dt><b>
2618
<div class="fragment"><pre>encoder != NULL
2619
</pre></div> </dl><dl compact><dt><b>
2620
Return values: </b><dd>
2621
<table border=0 cellspacing=2 cellpadding=0>
2622
<tr><td valign=top><em>FLAC__bool</em> </td><td>
2623
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a20">OggFLAC__seekable_stream_encoder_set_do_escape_coding</a>(). </td></tr>
2628
<a name="a49" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_do_exhaustive_model_search"></a><p>
2629
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2632
<table cellpadding="0" cellspacing="0" border="0">
2634
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_get_do_exhaustive_model_search </td>
2635
<td class="md" valign="top">( </td>
2636
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2637
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2638
<td class="md" valign="top">) </td>
2639
<td class="md" nowrap></td>
2646
<table cellspacing=5 cellpadding=0 border=0>
2654
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a43">FLAC__stream_encoder_get_do_exhaustive_model_search</a>()<dl compact><dt><b>
2655
Parameters: </b><dd>
2656
<table border=0 cellspacing=2 cellpadding=0>
2657
<tr><td valign=top><em>encoder</em> </td><td>
2658
An encoder instance to query. </td></tr>
2660
</dl><dl compact><dt><b>
2662
<div class="fragment"><pre>encoder != NULL
2663
</pre></div> </dl><dl compact><dt><b>
2664
Return values: </b><dd>
2665
<table border=0 cellspacing=2 cellpadding=0>
2666
<tr><td valign=top><em>FLAC__bool</em> </td><td>
2667
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a21">OggFLAC__seekable_stream_encoder_set_do_exhaustive_model_search</a>(). </td></tr>
2672
<a name="a50" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_min_residual_partition_order"></a><p>
2673
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2676
<table cellpadding="0" cellspacing="0" border="0">
2678
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_min_residual_partition_order </td>
2679
<td class="md" valign="top">( </td>
2680
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2681
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2682
<td class="md" valign="top">) </td>
2683
<td class="md" nowrap></td>
2690
<table cellspacing=5 cellpadding=0 border=0>
2698
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a44">FLAC__stream_encoder_get_min_residual_partition_order</a>()<dl compact><dt><b>
2699
Parameters: </b><dd>
2700
<table border=0 cellspacing=2 cellpadding=0>
2701
<tr><td valign=top><em>encoder</em> </td><td>
2702
An encoder instance to query. </td></tr>
2704
</dl><dl compact><dt><b>
2706
<div class="fragment"><pre>encoder != NULL
2707
</pre></div> </dl><dl compact><dt><b>
2708
Return values: </b><dd>
2709
<table border=0 cellspacing=2 cellpadding=0>
2710
<tr><td valign=top><em>unsigned</em> </td><td>
2711
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a22">OggFLAC__seekable_stream_encoder_set_min_residual_partition_order</a>(). </td></tr>
2716
<a name="a51" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_max_residual_partition_order"></a><p>
2717
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2720
<table cellpadding="0" cellspacing="0" border="0">
2722
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_max_residual_partition_order </td>
2723
<td class="md" valign="top">( </td>
2724
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2725
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2726
<td class="md" valign="top">) </td>
2727
<td class="md" nowrap></td>
2734
<table cellspacing=5 cellpadding=0 border=0>
2742
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see FLAC__stream_encoder_get_man_residual_partition_order()<dl compact><dt><b>
2743
Parameters: </b><dd>
2744
<table border=0 cellspacing=2 cellpadding=0>
2745
<tr><td valign=top><em>encoder</em> </td><td>
2746
An encoder instance to query. </td></tr>
2748
</dl><dl compact><dt><b>
2750
<div class="fragment"><pre>encoder != NULL
2751
</pre></div> </dl><dl compact><dt><b>
2752
Return values: </b><dd>
2753
<table border=0 cellspacing=2 cellpadding=0>
2754
<tr><td valign=top><em>unsigned</em> </td><td>
2755
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a23">OggFLAC__seekable_stream_encoder_set_max_residual_partition_order</a>(). </td></tr>
2760
<a name="a52" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_rice_parameter_search_dist"></a><p>
2761
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2764
<table cellpadding="0" cellspacing="0" border="0">
2766
<td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__seekable_stream_encoder_get_rice_parameter_search_dist </td>
2767
<td class="md" valign="top">( </td>
2768
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2769
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2770
<td class="md" valign="top">) </td>
2771
<td class="md" nowrap></td>
2778
<table cellspacing=5 cellpadding=0 border=0>
2786
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a46">FLAC__stream_encoder_get_rice_parameter_search_dist</a>()<dl compact><dt><b>
2787
Parameters: </b><dd>
2788
<table border=0 cellspacing=2 cellpadding=0>
2789
<tr><td valign=top><em>encoder</em> </td><td>
2790
An encoder instance to query. </td></tr>
2792
</dl><dl compact><dt><b>
2794
<div class="fragment"><pre>encoder != NULL
2795
</pre></div> </dl><dl compact><dt><b>
2796
Return values: </b><dd>
2797
<table border=0 cellspacing=2 cellpadding=0>
2798
<tr><td valign=top><em>unsigned</em> </td><td>
2799
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a24">OggFLAC__seekable_stream_encoder_set_rice_parameter_search_dist</a>(). </td></tr>
2804
<a name="a53" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_get_total_samples_estimate"></a><p>
2805
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2808
<table cellpadding="0" cellspacing="0" border="0">
2810
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__uint64 OggFLAC__seekable_stream_encoder_get_total_samples_estimate </td>
2811
<td class="md" valign="top">( </td>
2812
<td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2813
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2814
<td class="md" valign="top">) </td>
2815
<td class="md" nowrap></td>
2822
<table cellspacing=5 cellpadding=0 border=0>
2830
This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a47">FLAC__stream_encoder_get_total_samples_estimate</a>()<dl compact><dt><b>
2831
Parameters: </b><dd>
2832
<table border=0 cellspacing=2 cellpadding=0>
2833
<tr><td valign=top><em>encoder</em> </td><td>
2834
An encoder instance to set. </td></tr>
2836
</dl><dl compact><dt><b>
2838
<div class="fragment"><pre>encoder != NULL
2839
</pre></div> </dl><dl compact><dt><b>
2840
Return values: </b><dd>
2841
<table border=0 cellspacing=2 cellpadding=0>
2842
<tr><td valign=top><em>FLAC__uint64</em> </td><td>
2843
See <a class="el" href="group__oggflac__seekable__stream__encoder.html#a53">OggFLAC__seekable_stream_encoder_get_total_samples_estimate</a>(). </td></tr>
2848
<a name="a54" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_init"></a><p>
2849
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2852
<table cellpadding="0" cellspacing="0" border="0">
2854
<td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__oggflac__seekable__stream__encoder.html#a58">OggFLAC__SeekableStreamEncoderState</a> OggFLAC__seekable_stream_encoder_init </td>
2855
<td class="md" valign="top">( </td>
2856
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2857
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2858
<td class="md" valign="top">) </td>
2859
<td class="md" nowrap></td>
2866
<table cellspacing=5 cellpadding=0 border=0>
2874
Initialize the encoder instance. Should be called after <a class="el" href="group__oggflac__seekable__stream__encoder.html#a6">OggFLAC__seekable_stream_encoder_new</a>() and OggFLAC__seekable_stream_encoder_set_*() but before <a class="el" href="group__oggflac__seekable__stream__encoder.html#a56">OggFLAC__seekable_stream_encoder_process</a>() or <a class="el" href="group__oggflac__seekable__stream__encoder.html#a57">OggFLAC__seekable_stream_encoder_process_interleaved</a>(). Will set and return the encoder state, which will be OggFLAC__SEEKABLE_STREAM_ENCODER_OK if initialization succeeded.
2876
The call to <a class="el" href="group__oggflac__seekable__stream__encoder.html#a54">OggFLAC__seekable_stream_encoder_init</a>() currently will also immediately call the write callback several times, once with the <code>fLaC</code> signature, and once for each encoded metadata block.<dl compact><dt><b>
2877
Parameters: </b><dd>
2878
<table border=0 cellspacing=2 cellpadding=0>
2879
<tr><td valign=top><em>encoder</em> </td><td>
2880
An uninitialized encoder instance. </td></tr>
2882
</dl><dl compact><dt><b>
2884
<div class="fragment"><pre>encoder != NULL
2885
</pre></div> </dl><dl compact><dt><b>
2886
Return values: </b><dd>
2887
<table border=0 cellspacing=2 cellpadding=0>
2888
<tr><td valign=top><em>OggFLAC__SeekableStreamEncoderState</em> </td><td>
2889
<code>OggFLAC__SEEKABLE_STREAM_ENCODER_OK</code> if initialization was successful; see OggFLAC__SeekableStreamEncoderState for the meanings of other return values. </td></tr>
2894
<a name="a55" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_finish"></a><p>
2895
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2898
<table cellpadding="0" cellspacing="0" border="0">
2900
<td class="md" nowrap valign="top"> OggFLAC_API void OggFLAC__seekable_stream_encoder_finish </td>
2901
<td class="md" valign="top">( </td>
2902
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2903
<td class="mdname1" valign="top" nowrap> <em>encoder</em> </td>
2904
<td class="md" valign="top">) </td>
2905
<td class="md" nowrap></td>
2912
<table cellspacing=5 cellpadding=0 border=0>
2920
Finish the encoding process. Flushes the encoding buffer, releases resources, resets the encoder settings to their defaults, and returns the encoder state to OggFLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED. Note that this can generate one or more write callbacks before returning.
2922
In the event of a prematurely-terminated encode, it is not strictly necessary to call this immediately before <a class="el" href="group__oggflac__seekable__stream__encoder.html#a7">OggFLAC__seekable_stream_encoder_delete</a>() but it is good practice to match every <a class="el" href="group__oggflac__seekable__stream__encoder.html#a54">OggFLAC__seekable_stream_encoder_init</a>() with an <a class="el" href="group__oggflac__seekable__stream__encoder.html#a55">OggFLAC__seekable_stream_encoder_finish</a>().<dl compact><dt><b>
2923
Parameters: </b><dd>
2924
<table border=0 cellspacing=2 cellpadding=0>
2925
<tr><td valign=top><em>encoder</em> </td><td>
2926
An uninitialized encoder instance. </td></tr>
2928
</dl><dl compact><dt><b>
2930
<div class="fragment"><pre>encoder != NULL
2931
</pre></div> </dl> </td>
2934
<a name="a56" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_process"></a><p>
2935
<table width="100%" cellpadding="2" cellspacing="0" border="0">
2938
<table cellpadding="0" cellspacing="0" border="0">
2940
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_process </td>
2941
<td class="md" valign="top">( </td>
2942
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
2943
<td class="mdname" nowrap> <em>encoder</em>, </td>
2948
<td class="md" nowrap>const FLAC__int32 *const </td>
2949
<td class="mdname" nowrap> <em>buffer</em>[], </td>
2954
<td class="md" nowrap>unsigned </td>
2955
<td class="mdname" nowrap> <em>samples</em></td>
2959
<td class="md">) </td>
2960
<td class="md" colspan="2"></td>
2967
<table cellspacing=5 cellpadding=0 border=0>
2975
Submit data for encoding. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a50">FLAC__stream_encoder_process</a>().<dl compact><dt><b>
2976
Parameters: </b><dd>
2977
<table border=0 cellspacing=2 cellpadding=0>
2978
<tr><td valign=top><em>encoder</em> </td><td>
2979
An initialized encoder instance in the OK state. </td></tr>
2980
<tr><td valign=top><em>buffer</em> </td><td>
2981
An array of pointers to each channel's signal. </td></tr>
2982
<tr><td valign=top><em>samples</em> </td><td>
2983
The number of samples in one channel. </td></tr>
2985
</dl><dl compact><dt><b>
2987
<div class="fragment"><pre>encoder != NULL
2988
</pre></div> <div class="fragment"><pre><a class="code" href="OggFLAC_2seekable__stream__encoder_8h.html#a32">OggFLAC__seekable_stream_encoder_get_state</a>(encoder) == <a class="code" href="OggFLAC_2seekable__stream__encoder_8h.html#a58a6">OggFLAC__SEEKABLE_STREAM_ENCODER_OK</a>
2989
</pre></div> </dl><dl compact><dt><b>
2990
Return values: </b><dd>
2991
<table border=0 cellspacing=2 cellpadding=0>
2992
<tr><td valign=top><em>FLAC__bool</em> </td><td>
2993
<code>true</code> if successful, else <code>false</code>; in this case, check the encoder state with <a class="el" href="group__oggflac__seekable__stream__encoder.html#a32">OggFLAC__seekable_stream_encoder_get_state</a>() to see what went wrong. </td></tr>
2998
<a name="a57" doxytag="seekable_stream_encoder.h::OggFLAC__seekable_stream_encoder_process_interleaved"></a><p>
2999
<table width="100%" cellpadding="2" cellspacing="0" border="0">
3002
<table cellpadding="0" cellspacing="0" border="0">
3004
<td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__seekable_stream_encoder_process_interleaved </td>
3005
<td class="md" valign="top">( </td>
3006
<td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____SeekableStreamEncoder.html">OggFLAC__SeekableStreamEncoder</a> * </td>
3007
<td class="mdname" nowrap> <em>encoder</em>, </td>
3012
<td class="md" nowrap>const FLAC__int32 </td>
3013
<td class="mdname" nowrap> <em>buffer</em>[], </td>
3018
<td class="md" nowrap>unsigned </td>
3019
<td class="mdname" nowrap> <em>samples</em></td>
3023
<td class="md">) </td>
3024
<td class="md" colspan="2"></td>
3031
<table cellspacing=5 cellpadding=0 border=0>
3039
Submit data for encoding. This is inherited from <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>; see <a class="el" href="group__flac__stream__encoder.html#a51">FLAC__stream_encoder_process_interleaved</a>().<dl compact><dt><b>
3040
Parameters: </b><dd>
3041
<table border=0 cellspacing=2 cellpadding=0>
3042
<tr><td valign=top><em>encoder</em> </td><td>
3043
An initialized encoder instance in the OK state. </td></tr>
3044
<tr><td valign=top><em>buffer</em> </td><td>
3045
An array of channel-interleaved data (see above). </td></tr>
3046
<tr><td valign=top><em>samples</em> </td><td>
3047
The number of samples in one channel, the same as for <a class="el" href="group__oggflac__seekable__stream__encoder.html#a56">OggFLAC__seekable_stream_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>
3049
</dl><dl compact><dt><b>
3051
<div class="fragment"><pre>encoder != NULL
3052
</pre></div> <div class="fragment"><pre><a class="code" href="OggFLAC_2seekable__stream__encoder_8h.html#a32">OggFLAC__seekable_stream_encoder_get_state</a>(encoder) == <a class="code" href="OggFLAC_2seekable__stream__encoder_8h.html#a58a6">OggFLAC__SEEKABLE_STREAM_ENCODER_OK</a>
3053
</pre></div> </dl><dl compact><dt><b>
3054
Return values: </b><dd>
3055
<table border=0 cellspacing=2 cellpadding=0>
3056
<tr><td valign=top><em>FLAC__bool</em> </td><td>
3057
<code>true</code> if successful, else <code>false</code>; in this case, check the encoder state with <a class="el" href="group__oggflac__seekable__stream__encoder.html#a32">OggFLAC__seekable_stream_encoder_get_state</a>() to see what went wrong. </td></tr>
3062
<hr><h2>Variable Documentation</h2>
3063
<a name="a0" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderStateString"></a><p>
3064
<table width="100%" cellpadding="2" cellspacing="0" border="0">
3067
<table cellpadding="0" cellspacing="0" border="0">
3069
<td class="md" nowrap valign="top"> OggFLAC_API const char* const OggFLAC__SeekableStreamEncoderStateString[]
3074
<table cellspacing=5 cellpadding=0 border=0>
3082
Maps an OggFLAC__StreamEncoderState to a C string.
3084
Using an OggFLAC__StreamEncoderState as the index to this array will give the string equivalent. The contents should not be modified. </td>
3087
<a name="a1" doxytag="seekable_stream_encoder.h::OggFLAC__SeekableStreamEncoderReadStatusString"></a><p>
3088
<table width="100%" cellpadding="2" cellspacing="0" border="0">
3091
<table cellpadding="0" cellspacing="0" border="0">
3093
<td class="md" nowrap valign="top"> OggFLAC_API const char* const OggFLAC__SeekableStreamEncoderReadStatusString[]
3098
<table cellspacing=5 cellpadding=0 border=0>
3106
Maps a OggFLAC__SeekableStreamEncoderReadStatus to a C string.
3108
Using a OggFLAC__SeekableStreamEncoderReadStatus as the index to this array will give the string equivalent. The contents should not be modified. </td>
3111
<hr><address><small>Generated on Fri Feb 4 18:39:19 2005 for FLAC by
3112
<a href="http://www.doxygen.org/index.html">
3113
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
3114
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
3115
© 1997-2002</small></address>