<!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::AudioEncoder 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_1AudioEncoder.html">AudioEncoder</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioEncoder Class Reference</h1><!-- doxytag: class="Async::AudioEncoder" --><!-- doxytag: inherits="Async::AudioSink" -->
<p>Base class for an audio encoder.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioEncoder:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioEncoder.png" usemap="#Async::AudioEncoder_map" alt=""/>
<map id="Async::AudioEncoder_map" name="Async::AudioEncoder_map">
<area href="classAsync_1_1AudioSink.html" alt="Async::AudioSink" shape="rect" coords="0,0,135,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioEncoder-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioEncoder.html#a112efa76f96969ce179d9ec7ff92a03f">AudioEncoder</a> (void)
<dl class="el"><dd class="mdescRight">Default constuctor. <a href="#a112efa76f96969ce179d9ec7ff92a03f"></a><br/></dl><li><a class="el" href="classAsync_1_1AudioEncoder.html#add4a05130fefde0194d97ecdc6d4f61e">~AudioEncoder</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#add4a05130fefde0194d97ecdc6d4f61e"></a><br/></dl><li>virtual const char * <a class="el" href="classAsync_1_1AudioEncoder.html#a7fd35e784de1bd8221f004c4d1d78685">name</a> (void) const =0
<dl class="el"><dd class="mdescRight">Get the name of the codec. <a href="#a7fd35e784de1bd8221f004c4d1d78685"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioEncoder.html#a5c55cd8fb697f74a5ecfcaaab34fa7d9">setOption</a> (const std::string &name, const std::string &value)
<dl class="el"><dd class="mdescRight">Set an option for the encoder. <a href="#a5c55cd8fb697f74a5ecfcaaab34fa7d9"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioEncoder.html#a188051794770e31857dd9d840805803b">printCodecParams</a> (void)
<dl class="el"><dd class="mdescRight">Print codec parameter settings. <a href="#a188051794770e31857dd9d840805803b"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioEncoder.html#a5aa292489f1d8486f6078647c255d093">allEncodedSamplesFlushed</a> (void)
<dl class="el"><dd class="mdescRight">Call this function when all encoded samples have been flushed. <a href="#a5aa292489f1d8486f6078647c255d093"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioEncoder.html#a89a1b3e1994988757a837ecdf6aa91f8">flushSamples</a> (void)
<dl class="el"><dd class="mdescRight">Tell the sink to flush the previously written samples. <a href="#a89a1b3e1994988757a837ecdf6aa91f8"></a><br/></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classAsync_1_1AudioEncoder.html">AudioEncoder</a> * <a class="el" href="classAsync_1_1AudioEncoder.html#ab49653013604516d91628a57fa0b9cc8">create</a> (const std::string &name)
</ul>
<h2>Public Attributes</h2>
<ul>
<li>SigC::Signal2< void, const <br class="typebreak"/>
void *, int > <a class="el" href="classAsync_1_1AudioEncoder.html#af51689a22c0f9b1edc68e1183ba44965">writeEncodedSamples</a>
<dl class="el"><dd class="mdescRight">A signal emitted when encoded samples are available. <a href="#af51689a22c0f9b1edc68e1183ba44965"></a><br/></dl><li>SigC::Signal0< void > <a class="el" href="classAsync_1_1AudioEncoder.html#a96ef1a0110974e2aa5a96d90567b4c65">flushEncodedSamples</a>
<dl class="el"><dd class="mdescRight">This signal is emitted when the source calls flushSamples. <a href="#a96ef1a0110974e2aa5a96d90567b4c65"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base class for an audio encoder. </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 implementing an audio encoder. </p>
<p>Definition at line <a class="el" href="AsyncAudioEncoder_8h_source.html#l00113">113</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a112efa76f96969ce179d9ec7ff92a03f"></a><!-- doxytag: member="Async::AudioEncoder::AudioEncoder" ref="a112efa76f96969ce179d9ec7ff92a03f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioEncoder::AudioEncoder </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="AsyncAudioEncoder_8h_source.html#l00121">121</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
</div>
</div>
<a class="anchor" id="add4a05130fefde0194d97ecdc6d4f61e"></a><!-- doxytag: member="Async::AudioEncoder::~AudioEncoder" ref="add4a05130fefde0194d97ecdc6d4f61e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioEncoder::~AudioEncoder </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>Destructor. </p>
<p>Definition at line <a class="el" href="AsyncAudioEncoder_8h_source.html#l00126">126</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5aa292489f1d8486f6078647c255d093"></a><!-- doxytag: member="Async::AudioEncoder::allEncodedSamplesFlushed" ref="a5aa292489f1d8486f6078647c255d093" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioEncoder::allEncodedSamplesFlushed </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>Call this function when all encoded samples have been flushed. </p>
<p>Definition at line <a class="el" href="AsyncAudioEncoder_8h_source.html#l00149">149</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
<p>References <a class="el" href="classAsync_1_1AudioSink.html#a2548622eb5c52ef80f3bd297f290be3c">Async::AudioSink::sourceAllSamplesFlushed()</a>.</p>
</div>
</div>
<a class="anchor" id="ab49653013604516d91628a57fa0b9cc8"></a><!-- doxytag: member="Async::AudioEncoder::create" ref="ab49653013604516d91628a57fa0b9cc8" 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_1AudioEncoder.html">AudioEncoder</a>* Async::AudioEncoder::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="a89a1b3e1994988757a837ecdf6aa91f8"></a><!-- doxytag: member="Async::AudioEncoder::flushSamples" ref="a89a1b3e1994988757a837ecdf6aa91f8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioEncoder::flushSamples </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>Tell the sink to flush the previously written samples. </p>
<p>This function is used to tell the sink to flush previously written samples. When done flushing, the sink should call the sourceAllSamplesFlushed function. This function is normally only called from a connected source object. </p>
<p>Reimplemented from <a class="el" href="classAsync_1_1AudioSink.html#adde14468248671c6c5c85eb47234e0fa">Async::AudioSink</a>.</p>
<p>Definition at line <a class="el" href="AsyncAudioEncoder_8h_source.html#l00159">159</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
<p>References <a class="el" href="AsyncAudioEncoder_8h_source.html#l00171">flushEncodedSamples</a>.</p>
</div>
</div>
<a class="anchor" id="a7fd35e784de1bd8221f004c4d1d78685"></a><!-- doxytag: member="Async::AudioEncoder::name" ref="a7fd35e784de1bd8221f004c4d1d78685" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Async::AudioEncoder::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="a188051794770e31857dd9d840805803b"></a><!-- doxytag: member="Async::AudioEncoder::printCodecParams" ref="a188051794770e31857dd9d840805803b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioEncoder::printCodecParams </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>Print codec parameter settings. </p>
<p>Definition at line <a class="el" href="AsyncAudioEncoder_8h_source.html#l00144">144</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5c55cd8fb697f74a5ecfcaaab34fa7d9"></a><!-- doxytag: member="Async::AudioEncoder::setOption" ref="a5c55cd8fb697f74a5ecfcaaab34fa7d9" 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::AudioEncoder::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 encoder. </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="AsyncAudioEncoder_8h_source.html#l00139">139</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a96ef1a0110974e2aa5a96d90567b4c65"></a><!-- doxytag: member="Async::AudioEncoder::flushEncodedSamples" ref="a96ef1a0110974e2aa5a96d90567b4c65" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SigC::Signal0<void> <a class="el" href="classAsync_1_1AudioEncoder.html#a96ef1a0110974e2aa5a96d90567b4c65">Async::AudioEncoder::flushEncodedSamples</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when the source calls flushSamples. </p>
<p>Definition at line <a class="el" href="AsyncAudioEncoder_8h_source.html#l00171">171</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
<p>Referenced by <a class="el" href="AsyncAudioEncoder_8h_source.html#l00159">flushSamples()</a>.</p>
</div>
</div>
<a class="anchor" id="af51689a22c0f9b1edc68e1183ba44965"></a><!-- doxytag: member="Async::AudioEncoder::writeEncodedSamples" ref="af51689a22c0f9b1edc68e1183ba44965" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SigC::Signal2<void,const void *,int> <a class="el" href="classAsync_1_1AudioEncoder.html#af51689a22c0f9b1edc68e1183ba44965">Async::AudioEncoder::writeEncodedSamples</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A signal emitted when encoded samples are available. </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>
<p>Definition at line <a class="el" href="AsyncAudioEncoder_8h_source.html#l00166">166</a> of file <a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioEncoder_8h_source.html">AsyncAudioEncoder.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
>
157
