<!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::AudioDebugger 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_1AudioDebugger.html">AudioDebugger</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioDebugger Class Reference</h1><!-- doxytag: class="Async::AudioDebugger" --><!-- doxytag: inherits="Async::AudioSink,Async::AudioSource" -->
<p>This class is used to debug an audio stream.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioDebugger:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioDebugger.png" usemap="#Async::AudioDebugger_map" alt=""/>
<map id="Async::AudioDebugger_map" name="Async::AudioDebugger_map">
<area href="classAsync_1_1AudioSink.html" alt="Async::AudioSink" shape="rect" coords="0,0,143,24"/>
<area href="classAsync_1_1AudioSource.html" alt="Async::AudioSource" shape="rect" coords="153,0,296,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioDebugger-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioDebugger.html#a8fdbbafc75d6bcb539ca53c08e811ce5">AudioDebugger</a> (<a class="el" href="classAsync_1_1AudioSource.html">Async::AudioSource</a> *src=0)
<dl class="el"><dd class="mdescRight">Default constuctor. <a href="#a8fdbbafc75d6bcb539ca53c08e811ce5"></a><br/></dl><li>virtual <a class="el" href="classAsync_1_1AudioDebugger.html#a696647c2d64b4c61c08413c4ac9ed1c9">~AudioDebugger</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a696647c2d64b4c61c08413c4ac9ed1c9"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioDebugger.html#a62057f190705df3e860318e661237266">setName</a> (std::string debug_name)
<dl class="el"><dd class="mdescRight">Set the name that is displayed before debug messages. <a href="#a62057f190705df3e860318e661237266"></a><br/></dl><li>virtual int <a class="el" href="classAsync_1_1AudioDebugger.html#add5fadedaeccb9bbabe0f4997a0f6316">writeSamples</a> (const float *samples, int count)
<dl class="el"><dd class="mdescRight">Write samples into this audio sink. <a href="#add5fadedaeccb9bbabe0f4997a0f6316"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDebugger.html#ab9355e40edacee5e4b4c719f8b3835b6">flushSamples</a> (void)
<dl class="el"><dd class="mdescRight">Tell the sink to flush the previously written samples. <a href="#ab9355e40edacee5e4b4c719f8b3835b6"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDebugger.html#a4a62029f82467d6038b7f54022b189eb">resumeOutput</a> (void)
<dl class="el"><dd class="mdescRight">Resume audio output to the sink. <a href="#a4a62029f82467d6038b7f54022b189eb"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioDebugger.html#aa8efeb9d75957a35673454cac5e25d68">allSamplesFlushed</a> (void)
<dl class="el"><dd class="mdescRight">The registered sink has flushed all samples. <a href="#aa8efeb9d75957a35673454cac5e25d68"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class is used to debug an audio stream. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Tobias Blomberg / SM0SVX </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2007-10-14</dd></dl>
<p>This class is used to debug an audio stream. It can be inserted in the flow and it will print out a debug message for each function call between the sink and the source. </p>
<p>Definition at line <a class="el" href="AsyncAudioDebugger_8h_source.html#l00117">117</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8fdbbafc75d6bcb539ca53c08e811ce5"></a><!-- doxytag: member="Async::AudioDebugger::AudioDebugger" ref="a8fdbbafc75d6bcb539ca53c08e811ce5" args="(Async::AudioSource *src=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioDebugger::AudioDebugger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">Async::AudioSource</a> * </td>
<td class="paramname"> <em>src</em> = <code>0</code></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="AsyncAudioDebugger_8h_source.html#l00123">123</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.h</a>.</p>
<p>References <a class="el" href="classAsync_1_1AudioSource.html#a2254f2e73c5033ee28a569bd205ed345">Async::AudioSource::registerSink()</a>, <a class="el" href="classAsync_1_1AudioSink.html#a355c87f3f763af97de92f5b9ac4b6327">Async::AudioSink::registerSource()</a>, and <a class="el" href="AsyncAudioSource_8h_source.html#l00155">Async::AudioSource::sink()</a>.</p>
</div>
</div>
<a class="anchor" id="a696647c2d64b4c61c08413c4ac9ed1c9"></a><!-- doxytag: member="Async::AudioDebugger::~AudioDebugger" ref="a696647c2d64b4c61c08413c4ac9ed1c9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Async::AudioDebugger::~AudioDebugger </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="AsyncAudioDebugger_8h_source.html#l00141">141</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa8efeb9d75957a35673454cac5e25d68"></a><!-- doxytag: member="Async::AudioDebugger::allSamplesFlushed" ref="aa8efeb9d75957a35673454cac5e25d68" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDebugger::allSamplesFlushed </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>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="AsyncAudioDebugger_8h_source.html#l00202">202</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.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="ab9355e40edacee5e4b4c719f8b3835b6"></a><!-- doxytag: member="Async::AudioDebugger::flushSamples" ref="ab9355e40edacee5e4b4c719f8b3835b6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDebugger::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="AsyncAudioDebugger_8h_source.html#l00176">176</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.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="a4a62029f82467d6038b7f54022b189eb"></a><!-- doxytag: member="Async::AudioDebugger::resumeOutput" ref="a4a62029f82467d6038b7f54022b189eb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioDebugger::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="AsyncAudioDebugger_8h_source.html#l00189">189</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.h</a>.</p>
<p>References <a class="el" href="classAsync_1_1AudioSink.html#a4c16d7b78aade12abc0b57ec1db95f62">Async::AudioSink::sourceResumeOutput()</a>.</p>
</div>
</div>
<a class="anchor" id="a62057f190705df3e860318e661237266"></a><!-- doxytag: member="Async::AudioDebugger::setName" ref="a62057f190705df3e860318e661237266" args="(std::string debug_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Async::AudioDebugger::setName </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>debug_name</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name that is displayed before debug messages. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>debug_name</em> </td><td>The name to set </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AsyncAudioDebugger_8h_source.html#l00147">147</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.h</a>.</p>
</div>
</div>
<a class="anchor" id="add5fadedaeccb9bbabe0f4997a0f6316"></a><!-- doxytag: member="Async::AudioDebugger::writeSamples" ref="add5fadedaeccb9bbabe0f4997a0f6316" args="(const float *samples, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Async::AudioDebugger::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> [inline, 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>
<p>Definition at line <a class="el" href="AsyncAudioDebugger_8h_source.html#l00160">160</a> of file <a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.h</a>.</p>
<p>References <a class="el" href="classAsync_1_1AudioSource.html#ad23a249abf0f8fd39d364301364740a6">Async::AudioSource::sinkWriteSamples()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioDebugger_8h_source.html">AsyncAudioDebugger.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
>
145
