aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03540.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a03540.html387
1 files changed, 387 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03540.html b/docs/doxygen/nel/a03540.html
new file mode 100644
index 00000000..469ad844
--- /dev/null
+++ b/docs/doxygen/nel/a03540.html
@@ -0,0 +1,387 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: NLSOUND::CTrack class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NLSOUND::CTrack Class Reference</h1><code>#include &lt;<a class="el" href="a06037.html">mixing_track.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+A source selected for playing <dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00046">46</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.<table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracka0">CTrack</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1CTracka0"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03395.html">CSimpleSource</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracka1">getSource</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the logical source. <a href="#NLSOUND_1_1CTracka1"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracka2">init</a> (<a class="el" href="a03419.html">ISoundDriver</a> *sd)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Init. <a href="#NLSOUND_1_1CTracka2"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracka3">isAvailable</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return availability. <a href="#NLSOUND_1_1CTracka3"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracka4">isPlaying</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the track is physically playing (different from getUserSource()-&gt;<a class="el" href="a03540.html#NLSOUND_1_1CTracka4">isPlaying()</a>). <a href="#NLSOUND_1_1CTracka4"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracka5">setSource</a> (<a class="el" href="a03395.html">CSimpleSource</a> *<a class="el" href="a04223.html#a652">src</a>)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set logical source (if NULL, the track becomes available). <a href="#NLSOUND_1_1CTracka5"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracka6">~CTrack</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1CTracka6"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03428.html">ISource</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTracko0">DrvSource</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Physical source played by the driver. <a href="#NLSOUND_1_1CTracko0"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03395.html">CSimpleSource</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03540.html#NLSOUND_1_1CTrackr0">_SimpleSource</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The current logical source. <a href="#NLSOUND_1_1CTrackr0"></a><br><br></td></tr>
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1CTracka0" doxytag="NLSOUND::CTrack::CTrack" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NLSOUND::CTrack::CTrack </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Constructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00051">51</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+References <a class="el" href="a06037.html#l00076">_SimpleSource</a>, and <a class="el" href="a06037.html#l00071">DrvSource</a>.
+<p>
+<div class="fragment"><pre>00051 : <a class="code" href="a03540.html#NLSOUND_1_1CTracko0">DrvSource</a>(NULL), <a class="code" href="a03540.html#NLSOUND_1_1CTrackr0">_SimpleSource</a>(NULL) {}
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CTracka6" doxytag="NLSOUND::CTrack::~CTrack" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual NLSOUND::CTrack::~<a class="el" href="a03540.html">CTrack</a> </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Destructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00055">55</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+References <a class="el" href="a06037.html#l00071">DrvSource</a>.
+<p>
+<div class="fragment"><pre>00055 { <span class="keywordflow">if</span> ( <a class="code" href="a03540.html#NLSOUND_1_1CTracko0">DrvSource</a> != NULL ) <span class="keyword">delete</span> <a class="code" href="a03540.html#NLSOUND_1_1CTracko0">DrvSource</a>; }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1CTracka1" doxytag="NLSOUND::CTrack::getSource" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="a03395.html">CSimpleSource</a>* NLSOUND::CTrack::getSource </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Return the logical source.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00067">67</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+References <a class="el" href="a06037.html#l00076">_SimpleSource</a>.
+<p>
+Referenced by <a class="el" href="a05465.html#l01052">NLSOUND::CAudioMixerUser::bufferUnloaded()</a>, <a class="el" href="a05465.html#l01217">NLSOUND::CAudioMixerUser::freeTrack()</a>, <a class="el" href="a05465.html#l01152">NLSOUND::CAudioMixerUser::getFreeTrack()</a>, <a class="el" href="a05465.html#l00288">NLSOUND::CAudioMixerUser::reset()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>.
+<p>
+<div class="fragment"><pre>00067 { <span class="keywordflow">return</span> <a class="code" href="a03540.html#NLSOUND_1_1CTrackr0">_SimpleSource</a>; }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CTracka2" doxytag="NLSOUND::CTrack::init" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::CTrack::init </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a03419.html">ISoundDriver</a> *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>sd</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Init.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00053">53</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+References <a class="el" href="a03419.html#NLSOUND_1_1ISoundDrivera4">NLSOUND::ISoundDriver::createSource()</a>, and <a class="el" href="a06037.html#l00071">DrvSource</a>.
+<p>
+Referenced by <a class="el" href="a05465.html#l00358">NLSOUND::CAudioMixerUser::init()</a>.
+<p>
+<div class="fragment"><pre>00053 { <a class="code" href="a03540.html#NLSOUND_1_1CTracko0">DrvSource</a> = sd-&gt;createSource(); }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CTracka3" doxytag="NLSOUND::CTrack::isAvailable" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool NLSOUND::CTrack::isAvailable </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const<code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Return availability.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00061">61</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+References <a class="el" href="a06037.html#l00076">_SimpleSource</a>, <a class="el" href="a06037.html#l00071">DrvSource</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_3">NLSOUND::ISource::isStopped()</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>.
+<p>
+<div class="fragment"><pre>00061 { <a class="code" href="a04199.html#a6">nlassert</a>( DrvSource != NULL ); <span class="keywordflow">return</span> (<a class="code" href="a03540.html#NLSOUND_1_1CTrackr0">_SimpleSource</a>==NULL) &amp;&amp; <a class="code" href="a03540.html#NLSOUND_1_1CTracko0">DrvSource</a>-&gt;isStopped(); }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CTracka4" doxytag="NLSOUND::CTrack::isPlaying" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool NLSOUND::CTrack::isPlaying </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const<code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Returns true if the track is physically playing (different from getUserSource()-&gt;<a class="el" href="a03540.html#NLSOUND_1_1CTracka4">isPlaying()</a>).
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00063">63</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+References <a class="el" href="a06037.html#l00071">DrvSource</a>, <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_2">NLSOUND::ISource::isPlaying()</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>.
+<p>
+Referenced by <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>.
+<p>
+<div class="fragment"><pre>00063 { <a class="code" href="a04199.html#a6">nlassert</a>( DrvSource != NULL ); <span class="keywordflow">return</span> <a class="code" href="a03540.html#NLSOUND_1_1CTracko0">DrvSource</a>-&gt;isPlaying(); }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CTracka5" doxytag="NLSOUND::CTrack::setSource" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::CTrack::setSource </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a03395.html">CSimpleSource</a> *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>src</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set logical source (if NULL, the track becomes available).
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00065">65</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+References <a class="el" href="a06037.html#l00076">_SimpleSource</a>, and <a class="el" href="a05646.html#l01124">src</a>.
+<p>
+Referenced by <a class="el" href="a05465.html#l01217">NLSOUND::CAudioMixerUser::freeTrack()</a>, and <a class="el" href="a05465.html#l01152">NLSOUND::CAudioMixerUser::getFreeTrack()</a>.
+<p>
+<div class="fragment"><pre>00065 { <a class="code" href="a03540.html#NLSOUND_1_1CTrackr0">_SimpleSource</a> = <a class="code" href="a04223.html#a652">src</a>; }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1CTrackr0" doxytag="NLSOUND::CTrack::_SimpleSource" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="a03395.html">CSimpleSource</a>* <a class="el" href="a03540.html#NLSOUND_1_1CTrackr0">NLSOUND::CTrack::_SimpleSource</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The current logical source.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00076">76</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+Referenced by <a class="el" href="a06037.html#l00051">CTrack()</a>, <a class="el" href="a06037.html#l00067">getSource()</a>, <a class="el" href="a06037.html#l00061">isAvailable()</a>, and <a class="el" href="a06037.html#l00065">setSource()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CTracko0" doxytag="NLSOUND::CTrack::DrvSource" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="a03428.html">ISource</a>* <a class="el" href="a03540.html#NLSOUND_1_1CTracko0">NLSOUND::CTrack::DrvSource</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Physical source played by the driver.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06037.html#l00071">71</a> of file <a class="el" href="a06037.html">mixing_track.h</a>.
+<p>
+Referenced by <a class="el" href="a06037.html#l00051">CTrack()</a>, <a class="el" href="a06390.html#l00071">NLSOUND::CSimpleSource::getTime()</a>, <a class="el" href="a06037.html#l00053">init()</a>, <a class="el" href="a06037.html#l00061">isAvailable()</a>, <a class="el" href="a06037.html#l00063">isPlaying()</a>, <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, <a class="el" href="a06390.html#l00290">NLSOUND::CSimpleSource::setDirection()</a>, <a class="el" href="a06390.html#l00326">NLSOUND::CSimpleSource::setGain()</a>, <a class="el" href="a06390.html#l00093">NLSOUND::CSimpleSource::setLooping()</a>, <a class="el" href="a06390.html#l00352">NLSOUND::CSimpleSource::setPitch()</a>, <a class="el" href="a06390.html#l00258">NLSOUND::CSimpleSource::setPos()</a>, <a class="el" href="a06390.html#l00337">NLSOUND::CSimpleSource::setRelativeGain()</a>, <a class="el" href="a06390.html#l00367">NLSOUND::CSimpleSource::setSourceRelativeMode()</a>, <a class="el" href="a06390.html#l00274">NLSOUND::CSimpleSource::setVelocity()</a>, <a class="el" href="a06390.html#l00217">NLSOUND::CSimpleSource::stop()</a>, and <a class="el" href="a06037.html#l00055">~CTrack()</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="a06037.html">mixing_track.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:49:32 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>