<!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::AudioReader 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_1AudioReader.html">AudioReader</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioReader Class Reference</h1><!-- doxytag: class="Async::AudioReader" --><!-- doxytag: inherits="Async::AudioSink" -->
<p>An audio pipe component for on demand reading samples.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioReader_8h_source.html">AsyncAudioReader.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioReader:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioReader.png" usemap="#Async::AudioReader_map" alt=""/>
<map id="Async::AudioReader_map" name="Async::AudioReader_map">
<area href="classAsync_1_1AudioSink.html" alt="Async::AudioSink" shape="rect" coords="0,0,128,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioReader-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioReader.html#a01dec60ad1a04399d6a3f4d09295d659">AudioReader</a> (void)
<dl class="el"><dd class="mdescRight">Default constuctor. <a href="#a01dec60ad1a04399d6a3f4d09295d659"></a><br/></dl><li><a class="el" href="classAsync_1_1AudioReader.html#ae7077e141951e330f3c8215cf06fe3d0">~AudioReader</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#ae7077e141951e330f3c8215cf06fe3d0"></a><br/></dl><li>int <a class="el" href="classAsync_1_1AudioReader.html#a9e7b14582e61c0f17d238af05965aa25">readSamples</a> (float *samples, int count)
<dl class="el"><dd class="mdescRight">Read at most the specified number of samples. <a href="#a9e7b14582e61c0f17d238af05965aa25"></a><br/></dl><li>virtual int <a class="el" href="classAsync_1_1AudioReader.html#a17ec719ad036c7f05e6d4d873aac5d5a">writeSamples</a> (const float *samples, int count)
<dl class="el"><dd class="mdescRight">Write samples into this audio sink. <a href="#a17ec719ad036c7f05e6d4d873aac5d5a"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioReader.html#a3a3df8e76a44b3727a85cce05c03552e">flushSamples</a> (void)
<dl class="el"><dd class="mdescRight">Tell the sink to flush the previously written samples. <a href="#a3a3df8e76a44b3727a85cce05c03552e"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An audio pipe component for on demand reading samples. </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-02-22</dd></dl>
<p>This audio pipe component is used when reading samples on demand is preferred rather than getting them pushed at you. </p>
<p>Definition at line <a class="el" href="AsyncAudioReader_8h_source.html#l00112">112</a> of file <a class="el" href="AsyncAudioReader_8h_source.html">AsyncAudioReader.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a01dec60ad1a04399d6a3f4d09295d659"></a><!-- doxytag: member="Async::AudioReader::AudioReader" ref="a01dec60ad1a04399d6a3f4d09295d659" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioReader::AudioReader </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constuctor. </p>
</div>
</div>
<a class="anchor" id="ae7077e141951e330f3c8215cf06fe3d0"></a><!-- doxytag: member="Async::AudioReader::~AudioReader" ref="ae7077e141951e330f3c8215cf06fe3d0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioReader::~AudioReader </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="a3a3df8e76a44b3727a85cce05c03552e"></a><!-- doxytag: member="Async::AudioReader::flushSamples" ref="a3a3df8e76a44b3727a85cce05c03552e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioReader::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 sourceAllSamplesFlushed function will be called. 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="a9e7b14582e61c0f17d238af05965aa25"></a><!-- doxytag: member="Async::AudioReader::readSamples" ref="a9e7b14582e61c0f17d238af05965aa25" args="(float *samples, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Async::AudioReader::readSamples </td>
<td>(</td>
<td class="paramtype">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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read at most the specified number of samples. </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>A buffer to put the read samples into </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The maximum number of samples to read. This value must not be larger than the size of the "samples" buffer given in the first argument. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the number of samples actually read </dd></dl>
</div>
</div>
<a class="anchor" id="a17ec719ad036c7f05e6d4d873aac5d5a"></a><!-- doxytag: member="Async::AudioReader::writeSamples" ref="a17ec719ad036c7f05e6d4d873aac5d5a" args="(const float *samples, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Async::AudioReader::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="AsyncAudioReader_8h_source.html">AsyncAudioReader.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
>
184
