diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1UAudioMixer.html | 1398 |
1 files changed, 1398 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1UAudioMixer.html b/docs/doxygen/nel/classNLSOUND_1_1UAudioMixer.html new file mode 100644 index 00000000..b7176d85 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1UAudioMixer.html @@ -0,0 +1,1398 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLSOUND::UAudioMixer Class Reference</h1>Game interface for audio. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="u__audio__mixer_8h-source.html">u_audio_mixer.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::UAudioMixer: +<p><center><img src="classNLSOUND_1_1UAudioMixer.gif" usemap="#NLSOUND::UAudioMixer_map" border="0"></center> +<map name="NLSOUND::UAudioMixer_map"> +<area href="classNLSOUND_1_1CAudioMixerUser.html" alt="NLSOUND::CAudioMixerUser" shape="rect" coords="0,56,178,80"> +</map> +<a href="classNLSOUND_1_1UAudioMixer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a0">init</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Initialization.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a1">setPriorityReserve</a> (<a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> priorityChannel, <a class="el" href="memory__common_8h.html#a15">uint</a> reserve)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the priority channel reserve.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a2">setLowWaterMark</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> <a class="el" href="driver__opengl__extension__def_8h.html#a415">value</a>)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the Low water mark.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a3">reset</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Resets the audio system (deletes all the sources, include envsounds).</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a4">enable</a> (bool b)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Disables or reenables the sound.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a5">loadSampleBank</a> (bool async, const std::string &filename, std::vector< std::string > *notfoundfiles=NULL)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Load buffers.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a6">unloadSampleBank</a> (const std::string &filename)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Unload buffers.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a7">reloadSampleBanks</a> (bool async)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Reload all the sample bank.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a8">getLoadedSampleSize</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the total size in byte of loaded samples.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a9">getSoundId</a> (const std::string &name)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get a TSoundId from a name (returns NULL if not found).</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLSOUND_1_1USource.html">USource</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a10">createSource</a> (const std::string &name, bool spawn=false, <a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> cb=NULL, void *callbackUserParam=NULL, <a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> *context=0)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Add a logical sound source (returns NULL if name not found).</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLSOUND_1_1USource.html">USource</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a11">createSource</a> (<a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> <a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>, bool spawn=false, <a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> cb=NULL, void *callbackUserParam=NULL, <a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> *context=0)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Add a logical sound source (by sound id). To remove a source, just delete it. See createSource(const char*).</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a12">setListenerPos</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &pos)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Use this method to set the listener position instead of using getListener->setPos(); It's because we have to update the background sounds in this case.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLSOUND_1_1UListener.html">UListener</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a13">getListener</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the listener interface.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a14">selectEnvEffects</a> (const std::string &tag)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Choose the environmental effect(s) corresponding to tag.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a15">update</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Update audio mixer (call evenly).</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a16">getSoundNames</a> (std::vector< std::string > &names) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the names of the sounds (call this method after loadSounds()).</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a17">getPolyphony</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of mixing tracks (voices).</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a18">getSourcesNumber</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of sources.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a19">getPlayingSourcesNumber</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of playing sources.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a20">getNumberAvailableTracks</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of available tracks.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a21">getSourcesStats</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return a string showing the playing sources.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a22">setSamplePath</a> (const std::string &path)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the global path to the sample banks.</em> <a href="#a22">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a23">writeProfile</a> (std::ostream &out)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Write profiling information about the mixer to the output stream.</em> <a href="#a23">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a24">setBackgroundFlags</a> (const <a class="el" href="structNLSOUND_1_1UAudioMixer_1_1TBackgroundFlags.html">TBackgroundFlags</a> &backgroundFlags)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a25">loadBackgroundSoundFromRegion</a> (const <a class="el" href="classNLLIGO_1_1CPrimRegion.html">NLLIGO::CPrimRegion</a> &region)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a26">loadBackgroundEffectsFromRegion</a> (const <a class="el" href="classNLLIGO_1_1CPrimRegion.html">NLLIGO::CPrimRegion</a> &region)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a27">loadBackgroundSamplesFromRegion</a> (const <a class="el" href="classNLLIGO_1_1CPrimRegion.html">NLLIGO::CPrimRegion</a> &region)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a28">loadBackgroundSound</a> (const std::string &continent)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a29">playBackgroundSound</a> ()=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a30">stopBackgroundSound</a> ()=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a31">getPlayingSoundsPos</a> (std::vector< std::pair< bool, <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> > > &pos)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#a32">~UAudioMixer</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a32">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>UAudioMixer * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#d0">createAudioMixer</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Create the audio mixer singleton and return a pointer to its instance.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1UAudioMixer.html#b0">UAudioMixer</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Game interface for audio. +<p> +The logical sources represent all entities in the world, from the client's point of view. Their number can be higher than the number of simultaneous playable sound on the soundcard. +<p> +When there are more sources than tracks, the process of choosing which sources go into the tracks is called "balancing". The source are auto-balanced according to the argument passed to <a class="el" href="classNLSOUND_1_1UAudioMixer.html#a0">init</a>(). The sources are also balanced when<ul> +<li>Adding a new source<li>Removing a new source<li>Entering/Exiting from an envsound area</ul> +Important: The user is responsible for deleting the sources that have been allocated by <a class="el" href="classNLSOUND_1_1UAudioMixer.html#a10">createSource</a>(), before deleting the audio mixer object. +<p> +<dl compact><dt><b> +Author: </b><dd> +Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="u__audio__mixer_8h-source.html#l00065">65</a> of file <a class="el" href="u__audio__mixer_8h-source.html">u_audio_mixer.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a32" doxytag="NLSOUND::UAudioMixer::~UAudioMixer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NLSOUND::UAudioMixer::~UAudioMixer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="u__audio__mixer_8h-source.html#l00225">225</a> of file <a class="el" href="u__audio__mixer_8h-source.html">u_audio_mixer.h</a>. </td> + </tr> +</table> +<a name="b0" doxytag="NLSOUND::UAudioMixer::UAudioMixer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::UAudioMixer::UAudioMixer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="u__audio__mixer_8h-source.html#l00230">230</a> of file <a class="el" href="u__audio__mixer_8h-source.html">u_audio_mixer.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="d0" doxytag="NLSOUND::UAudioMixer::createAudioMixer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> UAudioMixer * NLSOUND::UAudioMixer::createAudioMixer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create the audio mixer singleton and return a pointer to its instance. +<p> + +<p> +Definition at line <a class="el" href="audio__mixer__user_8cpp-source.html#l00093">93</a> of file <a class="el" href="audio__mixer__user_8cpp-source.html">audio_mixer_user.cpp</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::UAudioMixer::createSource"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classNLSOUND_1_1USource.html">USource</a>* NLSOUND::UAudioMixer::createSource </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> </td> + <td class="mdname" nowrap> <em>id</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawn</em> = false, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> </td> + <td class="mdname" nowrap> <em>cb</em> = NULL, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>callbackUserParam</em> = NULL, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> * </td> + <td class="mdname" nowrap> <em>context</em> = 0</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Add a logical sound source (by sound id). To remove a source, just delete it. See createSource(const char*). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a13">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::UAudioMixer::createSource"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classNLSOUND_1_1USource.html">USource</a>* NLSOUND::UAudioMixer::createSource </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawn</em> = false, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> </td> + <td class="mdname" nowrap> <em>cb</em> = NULL, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>callbackUserParam</em> = NULL, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> * </td> + <td class="mdname" nowrap> <em>context</em> = 0</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Add a logical sound source (returns NULL if name not found). +<p> +If spawn is true, the source will auto-delete after playing. If so, the return <a class="el" href="classNLSOUND_1_1USource.html">USource</a>* pointer is valid only before the time when calling play() plus the duration of the sound. You can pass a callback function that will be called (if not NULL) just before deleting the spawned source. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a12">NLSOUND::CAudioMixerUser</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00163">NL3D::CPSSoundServImpl::createSound</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::UAudioMixer::enable"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::enable </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>b</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Disables or reenables the sound. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a6">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLSOUND::UAudioMixer::getListener"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classNLSOUND_1_1UListener.html">UListener</a>* NLSOUND::UAudioMixer::getListener </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the listener interface. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a17">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::UAudioMixer::getLoadedSampleSize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> NLSOUND::UAudioMixer::getLoadedSampleSize </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the total size in byte of loaded samples. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a10">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a20" doxytag="NLSOUND::UAudioMixer::getNumberAvailableTracks"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a15">uint</a> NLSOUND::UAudioMixer::getNumberAvailableTracks </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the number of available tracks. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a24">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a31" doxytag="NLSOUND::UAudioMixer::getPlayingSoundsPos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::getPlayingSoundsPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< std::pair< bool, <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> > > & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#b1">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a19" doxytag="NLSOUND::UAudioMixer::getPlayingSourcesNumber"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a15">uint</a> NLSOUND::UAudioMixer::getPlayingSourcesNumber </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the number of playing sources. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a23">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a17" doxytag="NLSOUND::UAudioMixer::getPolyphony"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a15">uint</a> NLSOUND::UAudioMixer::getPolyphony </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the number of mixing tracks (voices). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a21">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::UAudioMixer::getSoundId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> NLSOUND::UAudioMixer::getSoundId </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get a TSoundId from a name (returns NULL if not found). +<p> +<dl compact><dt><b> +Deprecated: </b><dd> +</dl> +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a11">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a16" doxytag="NLSOUND::UAudioMixer::getSoundNames"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::getSoundNames </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< std::string > & </td> + <td class="mdname1" valign="top" nowrap> <em>names</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the names of the sounds (call this method after loadSounds()). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a20">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a18" doxytag="NLSOUND::UAudioMixer::getSourcesNumber"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a15">uint</a> NLSOUND::UAudioMixer::getSourcesNumber </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the number of sources. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a22">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a21" doxytag="NLSOUND::UAudioMixer::getSourcesStats"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual std::string NLSOUND::UAudioMixer::getSourcesStats </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a string showing the playing sources. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a25">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NLSOUND::UAudioMixer::init"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::init </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initialization. +<p> +In case of failure, can throw one of these <a class="el" href="classNLSOUND_1_1ESoundDriver.html">ESoundDriver</a> (Exception) objects: <a class="el" href="classNLSOUND_1_1ESoundDriverNotFound.html">ESoundDriverNotFound</a>, <a class="el" href="classNLSOUND_1_1ESoundDriverCorrupted.html">ESoundDriverCorrupted</a>, <a class="el" href="classNLSOUND_1_1ESoundDriverOldVersion.html">ESoundDriverOldVersion</a>, <a class="el" href="classNLSOUND_1_1ESoundDriverUnknownVersion.html">ESoundDriverUnknownVersion</a>. +<p> +The sources will be auto-balanced every "balance_period" in millisecond (but in <a class="el" href="classNLSOUND_1_1UAudioMixer.html#a15">update</a>()) (set 0 for "never auto-balance") +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a2">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a26" doxytag="NLSOUND::UAudioMixer::loadBackgroundEffectsFromRegion"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::loadBackgroundEffectsFromRegion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLLIGO_1_1CPrimRegion.html">NLLIGO::CPrimRegion</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>region</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a32">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a27" doxytag="NLSOUND::UAudioMixer::loadBackgroundSamplesFromRegion"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::loadBackgroundSamplesFromRegion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLLIGO_1_1CPrimRegion.html">NLLIGO::CPrimRegion</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>region</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a33">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a28" doxytag="NLSOUND::UAudioMixer::loadBackgroundSound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::loadBackgroundSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>continent</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a34">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a25" doxytag="NLSOUND::UAudioMixer::loadBackgroundSoundFromRegion"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::loadBackgroundSoundFromRegion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLLIGO_1_1CPrimRegion.html">NLLIGO::CPrimRegion</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>region</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a31">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::UAudioMixer::loadSampleBank"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> NLSOUND::UAudioMixer::loadSampleBank </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname" nowrap> <em>async</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>filename</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>std::vector< std::string > * </td> + <td class="mdname" nowrap> <em>notfoundfiles</em> = NULL</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load buffers. +<p> +Returns the number of buffers successfully loaded. If you specify a non null notfoundfiles vector, it is filled with the names of missing files if any. <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>async</em> </td><td> +If true, the sample are loaded in a background thread. </td></tr> +<tr><td valign=top><em>filename</em> </td><td> +Name of the directory that contains the samples to load. </td></tr> +<tr><td valign=top><em>notfoundfiles</em> </td><td> +An optionnal pointer to a vector that will be filled with the list of not found files. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a7">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a29" doxytag="NLSOUND::UAudioMixer::playBackgroundSound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::playBackgroundSound </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a35">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::UAudioMixer::reloadSampleBanks"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::reloadSampleBanks </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>async</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Reload all the sample bank. +<p> +Thid method use provided for use in a sound editor or sound tool to update the list of available samples. \async If true, the samples are loaded in a background thread. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a9">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::UAudioMixer::reset"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::reset </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Resets the audio system (deletes all the sources, include envsounds). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a5">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a14" doxytag="NLSOUND::UAudioMixer::selectEnvEffects"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::selectEnvEffects </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>tag</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Choose the environmental effect(s) corresponding to tag. +<p> +<dl compact><dt><b> +Deprecated: </b><dd> +</dl> +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a18">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a24" doxytag="NLSOUND::UAudioMixer::setBackgroundFlags"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::setBackgroundFlags </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="structNLSOUND_1_1UAudioMixer_1_1TBackgroundFlags.html">TBackgroundFlags</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>backgroundFlags</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a41">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::UAudioMixer::setListenerPos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::setListenerPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Use this method to set the listener position instead of using getListener->setPos(); It's because we have to update the background sounds in this case. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a16">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::UAudioMixer::setLowWaterMark"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::setLowWaterMark </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>value</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the Low water mark. +<p> +This value is use to mute sound source that try to play when there priority channel is full (see setPriorityReserve). Set a value 1 to 4 to keep some extra track available when a HighestPri source need to play. By default, the value is set to 0, witch mean no special treatment is done and the mixer will mute sound with no user control at all. Note also that the availability of a track is not guarantie if the sum of the priority reserve (see setPriorityReserve) is grater than the number od available tracks (witch is almos alwais the case). But this value will help the mixer make it's best. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a4">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::UAudioMixer::setPriorityReserve"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::setPriorityReserve </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> </td> + <td class="mdname" nowrap> <em>priorityChannel</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>reserve</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the priority channel reserve. +<p> +Each priority channel can be assign a restrictive reserve value. This value is used when the number free track available for playing drop under the low water mark value (see setLowWaterMark). The mixer count the number of playing source in each priority channel. A priority channel can orverflow it's reserve value only if the low water mark is not reach. In other word, when the number of played source increase, you can control a 'smooth' cut in priority layer. The idea is to try to keep some free track for the HighestPri source. By default, reserve are set for each channel to the number of available tracks. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a3">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a22" doxytag="NLSOUND::UAudioMixer::setSamplePath"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::setSamplePath </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>path</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the global path to the sample banks. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a28">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a30" doxytag="NLSOUND::UAudioMixer::stopBackgroundSound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::stopBackgroundSound </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a36">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::UAudioMixer::unloadSampleBank"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::UAudioMixer::unloadSampleBank </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Unload buffers. +<p> +Return false if the bank can't be unloaded because an async loading is running. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a8">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a15" doxytag="NLSOUND::UAudioMixer::update"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::update </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Update audio mixer (call evenly). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a19">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a name="a23" doxytag="NLSOUND::UAudioMixer::writeProfile"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UAudioMixer::writeProfile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::ostream & </td> + <td class="mdname1" valign="top" nowrap> <em>out</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Write profiling information about the mixer to the output stream. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>out</em> </td><td> +The output stream to which to write the information </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CAudioMixerUser.html#a30">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="u__audio__mixer_8h-source.html">u_audio_mixer.h</a><li><a class="el" href="audio__mixer__user_8cpp-source.html">audio_mixer_user.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |