← Back to branch summary

~ubuntu-branches/ubuntu/raring/flac/raring

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Joshua Kwan
  • Date: 2007-05-29 22:56:36 UTC
  • mto: (8.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: james.westby@ubuntu.com-20070529225636-p8lkii0r0kp50pns
Tags: upstream-1.1.4
Import upstream version 1.1.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/api/classOggFLAC_1_1Decoder_1_1Stream.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>OggFLAC::Decoder::Stream class Reference</title>
4
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
 
</head><body>
6
 
<!-- Generated by Doxygen 1.2.14 -->
7
 
<center>
8
 
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
9
 
<hr><h1>OggFLAC::Decoder::Stream  Class Reference<br>
10
 
<small>
11
 
[<a class="el" href="group__oggflacpp__stream__decoder.html">OggFLAC++/decoder.h: stream decoder class</a>]</small>
12
 
</h1><code>#include &lt;<a class="el" href="OggFLAC++_2decoder_8h-source.html">decoder.h</a>&gt;</code>
13
 
<p>
14
 
<a href="classOggFLAC_1_1Decoder_1_1Stream-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
15
 
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
16
 
<tr><td nowrap align=right valign=top><a name="a0" doxytag="OggFLAC::Decoder::Stream::Stream"></a>
17
 
&nbsp;</td><td valign=bottom><b>Stream</b> ()</td></tr>
18
 
<tr><td nowrap align=right valign=top><a name="a1" doxytag="OggFLAC::Decoder::Stream::~Stream"></a>
19
 
virtual&nbsp;</td><td valign=bottom><b>~Stream</b> ()</td></tr>
20
 
<tr><td nowrap align=right valign=top><a name="a2" doxytag="OggFLAC::Decoder::Stream::is_valid"></a>
21
 
bool&nbsp;</td><td valign=bottom><b>is_valid</b> () const</td></tr>
22
 
<tr><td nowrap align=right valign=top><a name="a3" doxytag="OggFLAC::Decoder::Stream::operator bool"></a>
23
 
&nbsp;</td><td valign=bottom><b>operator bool</b> () const</td></tr>
24
 
<tr><td nowrap align=right valign=top><a name="a4" doxytag="OggFLAC::Decoder::Stream::set_serial_number"></a>
25
 
bool&nbsp;</td><td valign=bottom><b>set_serial_number</b> (long value)</td></tr>
26
 
<tr><td nowrap align=right valign=top><a name="a5" doxytag="OggFLAC::Decoder::Stream::set_metadata_respond"></a>
27
 
bool&nbsp;</td><td valign=bottom><b>set_metadata_respond</b> (::<a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> type)</td></tr>
28
 
<tr><td nowrap align=right valign=top><a name="a6" doxytag="OggFLAC::Decoder::Stream::set_metadata_respond_application"></a>
29
 
bool&nbsp;</td><td valign=bottom><b>set_metadata_respond_application</b> (const FLAC__byte id[4])</td></tr>
30
 
<tr><td nowrap align=right valign=top><a name="a7" doxytag="OggFLAC::Decoder::Stream::set_metadata_respond_all"></a>
31
 
bool&nbsp;</td><td valign=bottom><b>set_metadata_respond_all</b> ()</td></tr>
32
 
<tr><td nowrap align=right valign=top><a name="a8" doxytag="OggFLAC::Decoder::Stream::set_metadata_ignore"></a>
33
 
bool&nbsp;</td><td valign=bottom><b>set_metadata_ignore</b> (::<a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> type)</td></tr>
34
 
<tr><td nowrap align=right valign=top><a name="a9" doxytag="OggFLAC::Decoder::Stream::set_metadata_ignore_application"></a>
35
 
bool&nbsp;</td><td valign=bottom><b>set_metadata_ignore_application</b> (const FLAC__byte id[4])</td></tr>
36
 
<tr><td nowrap align=right valign=top><a name="a10" doxytag="OggFLAC::Decoder::Stream::set_metadata_ignore_all"></a>
37
 
bool&nbsp;</td><td valign=bottom><b>set_metadata_ignore_all</b> ()</td></tr>
38
 
<tr><td nowrap align=right valign=top><a name="a11" doxytag="OggFLAC::Decoder::Stream::get_state"></a>
39
 
State&nbsp;</td><td valign=bottom><b>get_state</b> () const</td></tr>
40
 
<tr><td nowrap align=right valign=top><a name="a12" doxytag="OggFLAC::Decoder::Stream::get_FLAC_stream_decoder_state"></a>
41
 
FLAC::Decoder::Stream::State&nbsp;</td><td valign=bottom><b>get_FLAC_stream_decoder_state</b> () const</td></tr>
42
 
<tr><td nowrap align=right valign=top><a name="a13" doxytag="OggFLAC::Decoder::Stream::get_channels"></a>
43
 
unsigned&nbsp;</td><td valign=bottom><b>get_channels</b> () const</td></tr>
44
 
<tr><td nowrap align=right valign=top><a name="a14" doxytag="OggFLAC::Decoder::Stream::get_channel_assignment"></a>
45
 
::<a class="el" href="group__flac__format.html#a95">FLAC__ChannelAssignment</a>&nbsp;</td><td valign=bottom><b>get_channel_assignment</b> () const</td></tr>
46
 
<tr><td nowrap align=right valign=top><a name="a15" doxytag="OggFLAC::Decoder::Stream::get_bits_per_sample"></a>
47
 
unsigned&nbsp;</td><td valign=bottom><b>get_bits_per_sample</b> () const</td></tr>
48
 
<tr><td nowrap align=right valign=top><a name="a16" doxytag="OggFLAC::Decoder::Stream::get_sample_rate"></a>
49
 
unsigned&nbsp;</td><td valign=bottom><b>get_sample_rate</b> () const</td></tr>
50
 
<tr><td nowrap align=right valign=top><a name="a17" doxytag="OggFLAC::Decoder::Stream::get_blocksize"></a>
51
 
unsigned&nbsp;</td><td valign=bottom><b>get_blocksize</b> () const</td></tr>
52
 
<tr><td nowrap align=right valign=top>State&nbsp;</td><td valign=bottom><a class="el" href="classOggFLAC_1_1Decoder_1_1Stream.html#a18">init</a> ()</td></tr>
53
 
<tr><td nowrap align=right valign=top><a name="a19" doxytag="OggFLAC::Decoder::Stream::finish"></a>
54
 
void&nbsp;</td><td valign=bottom><b>finish</b> ()</td></tr>
55
 
<tr><td nowrap align=right valign=top><a name="a20" doxytag="OggFLAC::Decoder::Stream::flush"></a>
56
 
bool&nbsp;</td><td valign=bottom><b>flush</b> ()</td></tr>
57
 
<tr><td nowrap align=right valign=top><a name="a21" doxytag="OggFLAC::Decoder::Stream::reset"></a>
58
 
bool&nbsp;</td><td valign=bottom><b>reset</b> ()</td></tr>
59
 
<tr><td nowrap align=right valign=top><a name="a22" doxytag="OggFLAC::Decoder::Stream::process_single"></a>
60
 
bool&nbsp;</td><td valign=bottom><b>process_single</b> ()</td></tr>
61
 
<tr><td nowrap align=right valign=top><a name="a23" doxytag="OggFLAC::Decoder::Stream::process_until_end_of_metadata"></a>
62
 
bool&nbsp;</td><td valign=bottom><b>process_until_end_of_metadata</b> ()</td></tr>
63
 
<tr><td nowrap align=right valign=top><a name="a24" doxytag="OggFLAC::Decoder::Stream::process_until_end_of_stream"></a>
64
 
bool&nbsp;</td><td valign=bottom><b>process_until_end_of_stream</b> ()</td></tr>
65
 
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
66
 
<tr><td nowrap align=right valign=top><a name="b0" doxytag="OggFLAC::Decoder::Stream::read_callback"></a>
67
 
<a class="el" href="group__flac__stream__decoder.html#a37">virtual::FLAC__StreamDecoderReadStatus</a>&nbsp;</td><td valign=bottom><b>read_callback</b> (FLAC__byte buffer[], unsigned *bytes)=0</td></tr>
68
 
<tr><td nowrap align=right valign=top><a name="b1" doxytag="OggFLAC::Decoder::Stream::write_callback"></a>
69
 
<a class="el" href="group__flac__stream__decoder.html#a38">virtual::FLAC__StreamDecoderWriteStatus</a>&nbsp;</td><td valign=bottom><b>write_callback</b> (const::FLAC__Frame *frame, const FLAC__int32 *const buffer[])=0</td></tr>
70
 
<tr><td nowrap align=right valign=top><a name="b2" doxytag="OggFLAC::Decoder::Stream::metadata_callback"></a>
71
 
virtual void&nbsp;</td><td valign=bottom><b>metadata_callback</b> (const::FLAC__StreamMetadata *metadata)=0</td></tr>
72
 
<tr><td nowrap align=right valign=top><a name="b3" doxytag="OggFLAC::Decoder::Stream::error_callback"></a>
73
 
virtual void&nbsp;</td><td valign=bottom><b>error_callback</b> (::<a class="el" href="group__flac__stream__decoder.html#a39">FLAC__StreamDecoderErrorStatus</a> status)=0</td></tr>
74
 
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
75
 
<tr><td nowrap align=right valign=top><a name="n0" doxytag="OggFLAC::Decoder::Stream::decoder_"></a>
76
 
::<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td><td valign=bottom><b>decoder_</b></td></tr>
77
 
</table>
78
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
79
 
This class wraps the OggFLAC__StreamDecoder. 
80
 
<p>
81
 
<hr><h2>Member Function Documentation</h2>
82
 
<a name="a18" doxytag="OggFLAC::Decoder::Stream::init"></a><p>
83
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
84
 
  <tr>
85
 
    <td class="md">
86
 
      <table cellpadding="0" cellspacing="0" border="0">
87
 
        <tr>
88
 
          <td class="md" nowrap valign="top"> State OggFLAC::Decoder::Stream::init </td>
89
 
          <td class="md" valign="top">(&nbsp;</td>
90
 
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
91
 
          <td class="md" valign="top">)&nbsp;</td>
92
 
          <td class="md" nowrap></td>
93
 
        </tr>
94
 
 
95
 
      </table>
96
 
    </td>
97
 
  </tr>
98
 
</table>
99
 
<table cellspacing=5 cellpadding=0 border=0>
100
 
  <tr>
101
 
    <td>
102
 
      &nbsp;
103
 
    </td>
104
 
    <td>
105
 
 
106
 
<p>
107
 
Initialize the instance; as with the C interface, <a class="el" href="classOggFLAC_1_1Decoder_1_1Stream.html#a18">init</a>() should be called after construction and 'set' calls but before any of the 'process' calls.     </td>
108
 
  </tr>
109
 
</table>
110
 
<hr>The documentation for this class was generated from the following file:<ul>
111
 
<li>include/OggFLAC++/<a class="el" href="OggFLAC++_2decoder_8h-source.html">decoder.h</a></ul>
112
 
<hr><address><small>Generated on Fri Feb 4 18:39:22 2005 for FLAC by
113
 
<a href="http://www.doxygen.org/index.html">
114
 
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
115
 
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
116
 
 &copy;&nbsp;1997-2002</small></address>
117
 
</body>
118
 
</html>