<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Async: Async::AudioDecoder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceAsync.html">Async</a>::<a class="el" href="classAsync_1_1AudioDecoder.html">AudioDecoder</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioDecoder Class Reference</h1><!-- doxytag: class="Async::AudioDecoder" --><!-- doxytag: inherits="Async::AudioSource" -->
<p>Base class for an audio decoder.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioDecoder:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioDecoder.png" usemap="#Async::AudioDecoder_map" alt=""/>
<map id="Async::AudioDecoder_map" name="Async::AudioDecoder_map">
<area href="classAsync_1_1AudioSource.html" alt="Async::AudioSource" shape="rect" coords="0,0,136,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioDecoder-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioDecoder.html#a9dc437504bd0d8699fe2ef7a8c0f779e">AudioDecoder</a> (void)
<dl class="el"><dd class="mdescRight">Default constuctor. <a href="#a9dc437504bd0d8699fe2ef7a8c0f779e"></a><br/></dl><li>virtual <a class="el" href="classAsync_1_1AudioDecoder.html#a43853d92c822157a905495877e54e3d3">~AudioDecoder</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a43853d92c822157a905495877e54e3d3"></a><br/></dl><li>virtual const char * <a class="el" href="classAsync_1_1AudioDecoder.html#a2999f42c9d268c8767f94ea9aa80bc05">name</a> (void) const =0
<dl class="el"><dd class="mdescRight">Get the name of the codec. <a href="#a2999f42c9d268c8767f94ea9aa80bc05"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDecoder.html#ac0339d803ae1ac1c22d7a13944aee82c">setOption</a> (const std::string &name, const std::string &value)
<dl class="el"><dd class="mdescRight">Set an option for the decoder. <a href="#ac0339d803ae1ac1c22d7a13944aee82c"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDecoder.html#af2fd1b8793d94eedef35904257b56600">printCodecParams</a> (void) const
<dl class="el"><dd class="mdescRight">Print codec parameter settings. <a href="#af2fd1b8793d94eedef35904257b56600"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDecoder.html#aef366ba92f7bcc565cf1e57e44c088d9">writeEncodedSamples</a> (void *buf, int size)=0
<dl class="el"><dd class="mdescRight">Write encoded samples into the decoder. <a href="#aef366ba92f7bcc565cf1e57e44c088d9"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDecoder.html#af31bb1c7433e58c15c37ddd242ee8ce0">flushEncodedSamples</a> (void)
<dl class="el"><dd class="mdescRight">Call this function when all encoded samples have been received. <a href="#af31bb1c7433e58c15c37ddd242ee8ce0"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDecoder.html#a3ed27974c629701e6285ab2c7bd438bb">resumeOutput</a> (void)
<dl class="el"><dd class="mdescRight">Resume audio output to the sink. <a href="#a3ed27974c629701e6285ab2c7bd438bb"></a><br/></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classAsync_1_1AudioDecoder.html">AudioDecoder</a> * <a class="el" href="classAsync_1_1AudioDecoder.html#a2c654b4c125cb29e166b1afe6818629a">create</a> (const std::string &name)
</ul>
<h2>Public Attributes</h2>
<ul>
<li>SigC::Signal0< void > <a class="el" href="classAsync_1_1AudioDecoder.html#a5e9b1087ff23a1dc0b997b7022631dff">allEncodedSamplesFlushed</a>
<dl class="el"><dd class="mdescRight">This signal is emitted when all encoded samples have been flushed. <a href="#a5e9b1087ff23a1dc0b997b7022631dff"></a><br/></dl></ul>
<h2>Protected Member Functions</h2>
<ul>
<li>virtual void <a class="el" href="classAsync_1_1AudioDecoder.html#a9dc81d6d23e356e401daba589f214472">allSamplesFlushed</a> (void)
<dl class="el"><dd class="mdescRight">The registered sink has flushed all samples. <a href="#a9dc81d6d23e356e401daba589f214472"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base class for an audio decoder. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Tobias Blomberg / SM0SVX </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2008-10-06</dd></dl>
<p>This is the base class for an audio decoder. </p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00113">113</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9dc437504bd0d8699fe2ef7a8c0f779e"></a><!-- doxytag: member="Async::AudioDecoder::AudioDecoder" ref="a9dc437504bd0d8699fe2ef7a8c0f779e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioDecoder::AudioDecoder </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constuctor. </p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00121">121</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a43853d92c822157a905495877e54e3d3"></a><!-- doxytag: member="Async::AudioDecoder::~AudioDecoder" ref="a43853d92c822157a905495877e54e3d3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Async::AudioDecoder::~AudioDecoder </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00126">126</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9dc81d6d23e356e401daba589f214472"></a><!-- doxytag: member="Async::AudioDecoder::allSamplesFlushed" ref="a9dc81d6d23e356e401daba589f214472" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDecoder::allSamplesFlushed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The registered sink has flushed all samples. </p>
<p>This function will be called when all samples have been flushed in the registered sink. This function is normally only called from a connected sink object. </p>
<p>Reimplemented from <a class="el" href="classAsync_1_1AudioSource.html#a563adf6411eddbd056abf206a12354b6">Async::AudioSource</a>.</p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00181">181</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
<p>References <a class="el" href="AsyncAudioDecoder_8h_source.html#l00170">allEncodedSamplesFlushed</a>.</p>
</div>
</div>
<a class="anchor" id="a2c654b4c125cb29e166b1afe6818629a"></a><!-- doxytag: member="Async::AudioDecoder::create" ref="a2c654b4c125cb29e166b1afe6818629a" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classAsync_1_1AudioDecoder.html">AudioDecoder</a>* Async::AudioDecoder::create </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af31bb1c7433e58c15c37ddd242ee8ce0"></a><!-- doxytag: member="Async::AudioDecoder::flushEncodedSamples" ref="af31bb1c7433e58c15c37ddd242ee8ce0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDecoder::flushEncodedSamples </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call this function when all encoded samples have been received. </p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00156">156</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
<p>References <a class="el" href="classAsync_1_1AudioSource.html#a5837ec95fef7d668d1c5241cee54646c">Async::AudioSource::sinkFlushSamples()</a>.</p>
</div>
</div>
<a class="anchor" id="a2999f42c9d268c8767f94ea9aa80bc05"></a><!-- doxytag: member="Async::AudioDecoder::name" ref="a2999f42c9d268c8767f94ea9aa80bc05" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Async::AudioDecoder::name </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the name of the codec. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Return the name of the codec </dd></dl>
</div>
</div>
<a class="anchor" id="af2fd1b8793d94eedef35904257b56600"></a><!-- doxytag: member="Async::AudioDecoder::printCodecParams" ref="af2fd1b8793d94eedef35904257b56600" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDecoder::printCodecParams </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print codec parameter settings. </p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00144">144</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3ed27974c629701e6285ab2c7bd438bb"></a><!-- doxytag: member="Async::AudioDecoder::resumeOutput" ref="a3ed27974c629701e6285ab2c7bd438bb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDecoder::resumeOutput </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resume audio output to the sink. </p>
<p>This function will be called when the registered audio sink is ready to accept more samples. This function is normally only called from a connected sink object. </p>
<p>Reimplemented from <a class="el" href="classAsync_1_1AudioSource.html#ac187f89a6094ec066dab5b4fd3108754">Async::AudioSource</a>.</p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00165">165</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac0339d803ae1ac1c22d7a13944aee82c"></a><!-- doxytag: member="Async::AudioDecoder::setOption" ref="ac0339d803ae1ac1c22d7a13944aee82c" args="(const std::string &name, const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDecoder::setOption </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set an option for the decoder. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the option </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value of the option </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00139">139</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
</div>
</div>
<a class="anchor" id="aef366ba92f7bcc565cf1e57e44c088d9"></a><!-- doxytag: member="Async::AudioDecoder::writeEncodedSamples" ref="aef366ba92f7bcc565cf1e57e44c088d9" args="(void *buf, int size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDecoder::writeEncodedSamples </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write encoded samples into the decoder. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Buffer containing encoded samples </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The size of the buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a5e9b1087ff23a1dc0b997b7022631dff"></a><!-- doxytag: member="Async::AudioDecoder::allEncodedSamplesFlushed" ref="a5e9b1087ff23a1dc0b997b7022631dff" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SigC::Signal0<void> <a class="el" href="classAsync_1_1AudioDecoder.html#a5e9b1087ff23a1dc0b997b7022631dff">Async::AudioDecoder::allEncodedSamplesFlushed</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when all encoded samples have been flushed. </p>
<p>Definition at line <a class="el" href="AsyncAudioDecoder_8h_source.html#l00170">170</a> of file <a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a>.</p>
<p>Referenced by <a class="el" href="AsyncAudioDecoder_8h_source.html#l00181">allSamplesFlushed()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioDecoder_8h_source.html">AsyncAudioDecoder.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
os
>
by-pkgid
>
9c481c872fb0ae0cbadccdc2f4a18ab6
>
files
>
151
