<!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::AudioPacer 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_1AudioPacer.html">AudioPacer</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioPacer Class Reference</h1><!-- doxytag: class="Async::AudioPacer" --><!-- doxytag: inherits="Async::AudioSink,Async::AudioSource" -->
<p>An audio pipe class that pace audio output.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioPacer_8h_source.html">AsyncAudioPacer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioPacer:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioPacer.png" usemap="#Async::AudioPacer_map" alt=""/>
<map id="Async::AudioPacer_map" name="Async::AudioPacer_map">
<area href="classAsync_1_1AudioSink.html" alt="Async::AudioSink" shape="rect" coords="0,0,128,24"/>
<area href="classAsync_1_1AudioSource.html" alt="Async::AudioSource" shape="rect" coords="138,0,266,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioPacer-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioPacer.html#a0b8ace0c3986757c94d4c4c5fc75b044">AudioPacer</a> (int sample_rate, int block_size, int prebuf_time)
<dl class="el"><dd class="mdescRight">Constuctor. <a href="#a0b8ace0c3986757c94d4c4c5fc75b044"></a><br/></dl><li><a class="el" href="classAsync_1_1AudioPacer.html#ab4970e79ce5d8f30d7c6dd2893daa7e2">~AudioPacer</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#ab4970e79ce5d8f30d7c6dd2893daa7e2"></a><br/></dl><li>virtual int <a class="el" href="classAsync_1_1AudioPacer.html#a8e22bd32dc5554311fe302d661c17cc8">writeSamples</a> (const float *samples, int count)
<dl class="el"><dd class="mdescRight">Write samples into this audio sink. <a href="#a8e22bd32dc5554311fe302d661c17cc8"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioPacer.html#a541d3c29ccd9e0db563f93a5bc666abd">flushSamples</a> (void)
<dl class="el"><dd class="mdescRight">Tell the sink to flush the previously written samples. <a href="#a541d3c29ccd9e0db563f93a5bc666abd"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioPacer.html#a1ef0821e8a2e5b42772d7873ecb027af">resumeOutput</a> (void)
<dl class="el"><dd class="mdescRight">Resume audio output to the sink. <a href="#a1ef0821e8a2e5b42772d7873ecb027af"></a><br/></dl></ul>
<h2>Protected Member Functions</h2>
<ul>
<li>virtual void <a class="el" href="classAsync_1_1AudioPacer.html#a7abb7e35757c80527a145a483a025c4c">allSamplesFlushed</a> (void)
<dl class="el"><dd class="mdescRight">The registered sink has flushed all samples. <a href="#a7abb7e35757c80527a145a483a025c4c"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An audio pipe class that pace audio output. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Tobias Blomberg </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2007-11-17</dd></dl>
<p>This class is used in an audio pipe chain to pace audio output. </p>
<p>Definition at line <a class="el" href="AsyncAudioPacer_8h_source.html#l00115">115</a> of file <a class="el" href="AsyncAudioPacer_8h_source.html">AsyncAudioPacer.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0b8ace0c3986757c94d4c4c5fc75b044"></a><!-- doxytag: member="Async::AudioPacer::AudioPacer" ref="a0b8ace0c3986757c94d4c4c5fc75b044" args="(int sample_rate, int block_size, int prebuf_time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioPacer::AudioPacer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sample_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>block_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>prebuf_time</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constuctor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sample_rate</em> </td><td>The sample rate of the incoming samples </td></tr>
<tr><td valign="top"></td><td valign="top"><em>block_size</em> </td><td>The size of the audio blocks </td></tr>
<tr><td valign="top"></td><td valign="top"><em>prebuf_time</em> </td><td>The time (ms) to wait before starting to send audio </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab4970e79ce5d8f30d7c6dd2893daa7e2"></a><!-- doxytag: member="Async::AudioPacer::~AudioPacer" ref="ab4970e79ce5d8f30d7c6dd2893daa7e2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioPacer::~AudioPacer </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7abb7e35757c80527a145a483a025c4c"></a><!-- doxytag: member="Async::AudioPacer::allSamplesFlushed" ref="a7abb7e35757c80527a145a483a025c4c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioPacer::allSamplesFlushed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [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. If it is not reimplemented, a handler must be set that handle the function call. 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>
</div>
</div>
<a class="anchor" id="a541d3c29ccd9e0db563f93a5bc666abd"></a><!-- doxytag: member="Async::AudioPacer::flushSamples" ref="a541d3c29ccd9e0db563f93a5bc666abd" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioPacer::flushSamples </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [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>
</div>
</div>
<a class="anchor" id="a1ef0821e8a2e5b42772d7873ecb027af"></a><!-- doxytag: member="Async::AudioPacer::resumeOutput" ref="a1ef0821e8a2e5b42772d7873ecb027af" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioPacer::resumeOutput </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [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>
</div>
</div>
<a class="anchor" id="a8e22bd32dc5554311fe302d661c17cc8"></a><!-- doxytag: member="Async::AudioPacer::writeSamples" ref="a8e22bd32dc5554311fe302d661c17cc8" args="(const float *samples, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Async::AudioPacer::writeSamples </td>
<td>(</td>
<td class="paramtype">const float * </td>
<td class="paramname"> <em>samples</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write samples into this audio sink. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>samples</em> </td><td>The buffer containing the samples </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of samples in the buffer </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the number of samples that has been taken care of</dd></dl>
<p>This function is used to write audio into this audio sink. If it returns 0, no more samples should be written until the resumeOutput function in the source have been called. This function is normally only called from a connected source object. </p>
<p>Reimplemented from <a class="el" href="classAsync_1_1AudioSink.html#a490aa6380d6b0069fc501f0d9f62e236">Async::AudioSink</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioPacer_8h_source.html">AsyncAudioPacer.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
>
175
