<!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::AudioSelector 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_1AudioSelector.html">AudioSelector</a> </div> </div> <div class="contents"> <h1>Async::AudioSelector Class Reference</h1><!-- doxytag: class="Async::AudioSelector" --><!-- doxytag: inherits="Async::AudioSource" --> <p>This class is used to select one of many audio streams. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="AsyncAudioSelector_8h_source.html">AsyncAudioSelector.h</a>></code></p> <div class="dynheader"> Inheritance diagram for Async::AudioSelector:</div> <div class="dynsection"> <div class="center"> <img src="classAsync_1_1AudioSelector.png" usemap="#Async::AudioSelector_map" alt=""/> <map id="Async::AudioSelector_map" name="Async::AudioSelector_map"> <area href="classAsync_1_1AudioSource.html" alt="Async::AudioSource" shape="rect" coords="0,0,134,24"/> </map> </div> </div> <p><a href="classAsync_1_1AudioSelector-members.html">List of all members.</a></p> <h2>Public Member Functions</h2> <ul> <li><a class="el" href="classAsync_1_1AudioSelector.html#aee8cde930809923a8cdddffd1c61dcb6">AudioSelector</a> (void) <dl class="el"><dd class="mdescRight">Default constuctor. <a href="#aee8cde930809923a8cdddffd1c61dcb6"></a><br/></dl><li><a class="el" href="classAsync_1_1AudioSelector.html#a12985137ee93d13a1cfd6676b967bd8c">~AudioSelector</a> (void) <dl class="el"><dd class="mdescRight">Destructor. <a href="#a12985137ee93d13a1cfd6676b967bd8c"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioSelector.html#a79ff596390b030fb1115421d4da0dc0c">addSource</a> (<a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> *source) <dl class="el"><dd class="mdescRight">Add an audio source to the selector. <a href="#a79ff596390b030fb1115421d4da0dc0c"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioSelector.html#af103c4018bb86a502af989839995024d">removeSource</a> (<a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> *source) <dl class="el"><dd class="mdescRight">Remove a previously added audio source from the selector. <a href="#af103c4018bb86a502af989839995024d"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioSelector.html#a7dec7fe2482e00f235449eb0c4b5319e">setSelectionPrio</a> (<a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> *source, int prio) <dl class="el"><dd class="mdescRight">Set the prio to be used for selection. <a href="#a7dec7fe2482e00f235449eb0c4b5319e"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioSelector.html#aa121b52addd8936e38ee967f9c5d71ad">enableAutoSelect</a> (<a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> *source, int prio) <dl class="el"><dd class="mdescRight">Enable autoselection on the given source. <a href="#aa121b52addd8936e38ee967f9c5d71ad"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioSelector.html#a33b3cc51aa54979610564bfcd0fca4bc">disableAutoSelect</a> (<a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> *source) <dl class="el"><dd class="mdescRight">Disable autoselection on the given source. <a href="#a33b3cc51aa54979610564bfcd0fca4bc"></a><br/></dl><li>bool <a class="el" href="classAsync_1_1AudioSelector.html#a3b60b1b814cec1ecb9cf19e0a0fbe082">autoSelectEnabled</a> (<a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> *source) <dl class="el"><dd class="mdescRight">Find out if auto select is enabled or not for the given source. <a href="#a3b60b1b814cec1ecb9cf19e0a0fbe082"></a><br/></dl><li>void <a class="el" href="classAsync_1_1AudioSelector.html#ab15e0babb1913f7c585b25e20afc58f9">selectSource</a> (<a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> *source) <dl class="el"><dd class="mdescRight">Select one of the previously added audio sources. <a href="#ab15e0babb1913f7c585b25e20afc58f9"></a><br/></dl></ul> <h2>Friends</h2> <ul> <li>class <a class="el" href="classAsync_1_1AudioSelector.html#a34af6289162369d1407283667daf73f1">Branch</a> </ul> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This class is used to select one of many audio streams. </p> <dl class="author"><dt><b>Author:</b></dt><dd>Tobias Blomberg / SM0SVX </dd></dl> <dl class="date"><dt><b>Date:</b></dt><dd>2006-08-01</dd></dl> <p>This class is used to select one of many incoming audio streams. Incoming samples on non-selected branches will be thrown away. </p> <p>Definition at line <a class="el" href="AsyncAudioSelector_8h_source.html#l00114">114</a> of file <a class="el" href="AsyncAudioSelector_8h_source.html">AsyncAudioSelector.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aee8cde930809923a8cdddffd1c61dcb6"></a><!-- doxytag: member="Async::AudioSelector::AudioSelector" ref="aee8cde930809923a8cdddffd1c61dcb6" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Async::AudioSelector::AudioSelector </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="a12985137ee93d13a1cfd6676b967bd8c"></a><!-- doxytag: member="Async::AudioSelector::~AudioSelector" ref="a12985137ee93d13a1cfd6676b967bd8c" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Async::AudioSelector::~AudioSelector </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="a79ff596390b030fb1115421d4da0dc0c"></a><!-- doxytag: member="Async::AudioSelector::addSource" ref="a79ff596390b030fb1115421d4da0dc0c" args="(AudioSource *source)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Async::AudioSelector::addSource </td> <td>(</td> <td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> * </td> <td class="paramname"> <em>source</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Add an audio source to the selector. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The audio source to add </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a3b60b1b814cec1ecb9cf19e0a0fbe082"></a><!-- doxytag: member="Async::AudioSelector::autoSelectEnabled" ref="a3b60b1b814cec1ecb9cf19e0a0fbe082" args="(AudioSource *source)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Async::AudioSelector::autoSelectEnabled </td> <td>(</td> <td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> * </td> <td class="paramname"> <em>source</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Find out if auto select is enabled or not for the given source. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The audio source </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>Returns <em>true</em> if auto select is enabled for the given source or else <em>false</em> is returned </dd></dl> </div> </div> <a class="anchor" id="a33b3cc51aa54979610564bfcd0fca4bc"></a><!-- doxytag: member="Async::AudioSelector::disableAutoSelect" ref="a33b3cc51aa54979610564bfcd0fca4bc" args="(AudioSource *source)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Async::AudioSelector::disableAutoSelect </td> <td>(</td> <td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> * </td> <td class="paramname"> <em>source</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Disable autoselection on the given source. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The audio source </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aa121b52addd8936e38ee967f9c5d71ad"></a><!-- doxytag: member="Async::AudioSelector::enableAutoSelect" ref="aa121b52addd8936e38ee967f9c5d71ad" args="(AudioSource *source, int prio)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Async::AudioSelector::enableAutoSelect </td> <td>(</td> <td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> * </td> <td class="paramname"> <em>source</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>prio</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Enable autoselection on the given source. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The audio source </td></tr> <tr><td valign="top"></td><td valign="top"><em>prio</em> </td><td>The priority to set. Higher numbers give higher priority. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af103c4018bb86a502af989839995024d"></a><!-- doxytag: member="Async::AudioSelector::removeSource" ref="af103c4018bb86a502af989839995024d" args="(AudioSource *source)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Async::AudioSelector::removeSource </td> <td>(</td> <td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> * </td> <td class="paramname"> <em>source</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Remove a previously added audio source from the selector. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The audio source to remove </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ab15e0babb1913f7c585b25e20afc58f9"></a><!-- doxytag: member="Async::AudioSelector::selectSource" ref="ab15e0babb1913f7c585b25e20afc58f9" args="(AudioSource *source)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Async::AudioSelector::selectSource </td> <td>(</td> <td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> * </td> <td class="paramname"> <em>source</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Select one of the previously added audio sources. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The audio source to select. 0 = none selected. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a7dec7fe2482e00f235449eb0c4b5319e"></a><!-- doxytag: member="Async::AudioSelector::setSelectionPrio" ref="a7dec7fe2482e00f235449eb0c4b5319e" args="(AudioSource *source, int prio)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Async::AudioSelector::setSelectionPrio </td> <td>(</td> <td class="paramtype"><a class="el" href="classAsync_1_1AudioSource.html">AudioSource</a> * </td> <td class="paramname"> <em>source</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>prio</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Set the prio to be used for selection. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The audio source </td></tr> <tr><td valign="top"></td><td valign="top"><em>prio</em> </td><td>The priority to set. Higher numbers give higher priority. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a34af6289162369d1407283667daf73f1"></a><!-- doxytag: member="Async::AudioSelector::Branch" ref="a34af6289162369d1407283667daf73f1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class Branch<code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="AsyncAudioSelector_8h_source.html#l00188">188</a> of file <a class="el" href="AsyncAudioSelector_8h_source.html">AsyncAudioSelector.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="AsyncAudioSelector_8h_source.html">AsyncAudioSelector.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>