<!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::AudioStreamStateDetector 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_1AudioStreamStateDetector.html">AudioStreamStateDetector</a>
</div>
</div>
<div class="contents">
<h1>Async::AudioStreamStateDetector Class Reference</h1><!-- doxytag: class="Async::AudioStreamStateDetector" --><!-- doxytag: inherits="Async::AudioPassthrough" -->
<p>A class that just passes the audio through and fires an event when the stream state changes.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Async::AudioStreamStateDetector:</div>
<div class="dynsection">
<div class="center">
<img src="classAsync_1_1AudioStreamStateDetector.png" usemap="#Async::AudioStreamStateDetector_map" alt=""/>
<map id="Async::AudioStreamStateDetector_map" name="Async::AudioStreamStateDetector_map">
<area href="classAsync_1_1AudioPassthrough.html" alt="Async::AudioPassthrough" shape="rect" coords="106,56,308,80"/>
<area href="classAsync_1_1AudioSink.html" alt="Async::AudioSink" shape="rect" coords="0,0,202,24"/>
<area href="classAsync_1_1AudioSource.html" alt="Async::AudioSource" shape="rect" coords="212,0,414,24"/>
</map>
</div>
</div>
<p><a href="classAsync_1_1AudioStreamStateDetector-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classAsync_1_1AudioStreamStateDetector.html#a03dd6d5e4d8bbf4c6e249b657bf5db6c">AudioStreamStateDetector</a> (void)
<dl class="el"><dd class="mdescRight">Default constuctor. <a href="#a03dd6d5e4d8bbf4c6e249b657bf5db6c"></a><br/></dl><li>virtual <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#a64397183dee0492b5743853bc5f5cbc5">~AudioStreamStateDetector</a> (void)
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a64397183dee0492b5743853bc5f5cbc5"></a><br/></dl><li>virtual int <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#a00df5765e2f3ab843655f34247850d93">writeSamples</a> (const float *samples, int count)
<dl class="el"><dd class="mdescRight">Write samples into this audio sink. <a href="#a00df5765e2f3ab843655f34247850d93"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#a17e1b81ff934e8f31ce116c4f657db8e">flushSamples</a> (void)
<dl class="el"><dd class="mdescRight">Tell the sink to flush the previously written samples. <a href="#a17e1b81ff934e8f31ce116c4f657db8e"></a><br/></dl><li>virtual void <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#ac3c78e78d19c8bfb228b94b1b3e15f75">allSamplesFlushed</a> (void)
<dl class="el"><dd class="mdescRight">The registered sink has flushed all samples. <a href="#ac3c78e78d19c8bfb228b94b1b3e15f75"></a><br/></dl><li>bool <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#af9b89f9ad5035dcaa7dd011ce9e16c65">isIdle</a> (void) const
<dl class="el"><dd class="mdescRight">Check if the steam is idle or not. <a href="#af9b89f9ad5035dcaa7dd011ce9e16c65"></a><br/></dl><li>bool <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#a9947d6b76a58fc9d12d9f26cd3f3fe54">isActive</a> (void) const
<dl class="el"><dd class="mdescRight">Check if the steam is active or not. <a href="#a9947d6b76a58fc9d12d9f26cd3f3fe54"></a><br/></dl><li>bool <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#a3f0343475dfe0240e59d0f0750064a3e">isFlushing</a> (void) const
<dl class="el"><dd class="mdescRight">Check if the steam is flushing or not. <a href="#a3f0343475dfe0240e59d0f0750064a3e"></a><br/></dl></ul>
<h2>Public Attributes</h2>
<ul>
<li>SigC::Signal2< void, bool, bool > <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#ae262d62cbae5502a0081a8a9fcade291">sigStreamStateChanged</a>
<dl class="el"><dd class="mdescRight">A signal that is emitted when the stream state changes. <a href="#ae262d62cbae5502a0081a8a9fcade291"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class that just passes the audio through and fires an event when the stream state changes. </p>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00111">111</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a03dd6d5e4d8bbf4c6e249b657bf5db6c"></a><!-- doxytag: member="Async::AudioStreamStateDetector::AudioStreamStateDetector" ref="a03dd6d5e4d8bbf4c6e249b657bf5db6c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Async::AudioStreamStateDetector::AudioStreamStateDetector </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="AsyncAudioStreamStateDetector_8h_source.html#l00117">117</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
</div>
</div>
<a class="anchor" id="a64397183dee0492b5743853bc5f5cbc5"></a><!-- doxytag: member="Async::AudioStreamStateDetector::~AudioStreamStateDetector" ref="a64397183dee0492b5743853bc5f5cbc5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Async::AudioStreamStateDetector::~AudioStreamStateDetector </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="AsyncAudioStreamStateDetector_8h_source.html#l00122">122</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac3c78e78d19c8bfb228b94b1b3e15f75"></a><!-- doxytag: member="Async::AudioStreamStateDetector::allSamplesFlushed" ref="ac3c78e78d19c8bfb228b94b1b3e15f75" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioStreamStateDetector::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_1AudioPassthrough.html#a73ee065737064e255476bbd9a8b61fc9">Async::AudioPassthrough</a>.</p>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00170">170</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
<p>References <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00205">sigStreamStateChanged</a>.</p>
</div>
</div>
<a class="anchor" id="a17e1b81ff934e8f31ce116c4f657db8e"></a><!-- doxytag: member="Async::AudioStreamStateDetector::flushSamples" ref="a17e1b81ff934e8f31ce116c4f657db8e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Async::AudioStreamStateDetector::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_1AudioPassthrough.html#ad22ce3a3af14c01b6c9e20c0a9672676">Async::AudioPassthrough</a>.</p>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00153">153</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
<p>References <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00205">sigStreamStateChanged</a>.</p>
</div>
</div>
<a class="anchor" id="a9947d6b76a58fc9d12d9f26cd3f3fe54"></a><!-- doxytag: member="Async::AudioStreamStateDetector::isActive" ref="a9947d6b76a58fc9d12d9f26cd3f3fe54" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Async::AudioStreamStateDetector::isActive </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the steam is active or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns <em>true</em> if the stream is active or <em>false</em> if it's not </dd></dl>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00191">191</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3f0343475dfe0240e59d0f0750064a3e"></a><!-- doxytag: member="Async::AudioStreamStateDetector::isFlushing" ref="a3f0343475dfe0240e59d0f0750064a3e" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Async::AudioStreamStateDetector::isFlushing </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the steam is flushing or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns <em>true</em> if the stream is flushing or <em>false</em> if it's not </dd></dl>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00198">198</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
</div>
</div>
<a class="anchor" id="af9b89f9ad5035dcaa7dd011ce9e16c65"></a><!-- doxytag: member="Async::AudioStreamStateDetector::isIdle" ref="af9b89f9ad5035dcaa7dd011ce9e16c65" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Async::AudioStreamStateDetector::isIdle </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the steam is idle or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns <em>true</em> if the stream is idle or <em>false</em> if it's not </dd></dl>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00184">184</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
</div>
</div>
<a class="anchor" id="a00df5765e2f3ab843655f34247850d93"></a><!-- doxytag: member="Async::AudioStreamStateDetector::writeSamples" ref="a00df5765e2f3ab843655f34247850d93" args="(const float *samples, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Async::AudioStreamStateDetector::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_1AudioPassthrough.html#ab0c0ea3766f1be55c2e08c5a4eca4b87">Async::AudioPassthrough</a>.</p>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00135">135</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
<p>References <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00205">sigStreamStateChanged</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae262d62cbae5502a0081a8a9fcade291"></a><!-- doxytag: member="Async::AudioStreamStateDetector::sigStreamStateChanged" ref="ae262d62cbae5502a0081a8a9fcade291" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SigC::Signal2<void, bool, bool> <a class="el" href="classAsync_1_1AudioStreamStateDetector.html#ae262d62cbae5502a0081a8a9fcade291">Async::AudioStreamStateDetector::sigStreamStateChanged</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A signal that is emitted when the stream state changes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>is_active</em> </td><td>Is <em>true</em> if the stream is active </td></tr>
<tr><td valign="top"></td><td valign="top"><em>is_idle</em> </td><td>Is <em>true</em> if the stream is idle </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00205">205</a> of file <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.h</a>.</p>
<p>Referenced by <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00170">allSamplesFlushed()</a>, <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00153">flushSamples()</a>, and <a class="el" href="AsyncAudioStreamStateDetector_8h_source.html#l00135">writeSamples()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AsyncAudioStreamStateDetector_8h_source.html">AsyncAudioStreamStateDetector.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
>
202
