diff options
Diffstat (limited to 'docs/doxygen/nel/a02236.html')
| -rw-r--r-- | docs/doxygen/nel/a02236.html | 2082 |
1 files changed, 2082 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02236.html b/docs/doxygen/nel/a02236.html new file mode 100644 index 00000000..ff3d6596 --- /dev/null +++ b/docs/doxygen/nel/a02236.html @@ -0,0 +1,2082 @@ +<!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::UAudioMixer 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 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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLSOUND::UAudioMixer Class Reference</h1><code>#include <<a class="el" href="a06594.html">u_audio_mixer.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::UAudioMixer: +<p><center><img src="a02236.png" usemap="#NLSOUND::UAudioMixer_map" border="0" alt=""></center> +<map name="NLSOUND::UAudioMixer_map"> +<area href="a02235.html" alt="NLSOUND::CAudioMixerUser" shape="rect" coords="0,56,178,80"> +</map> +<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="a02236.html#NLSOUND_1_1UAudioMixerz2128_0">init()</a>. The sources are also balanced when<ul> +<li>Adding a new source</li><li>Removing a new source</li><li>Entering/Exiting from an envsound area</li></ul> +<p> +Important: The user is responsible for deleting the sources that have been allocated by <a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera1">createSource()</a>, before deleting the audio mixer object.<p> +<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="a06594.html#l00082">82</a> of file <a class="el" href="a06594.html">u_audio_mixer.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Move the primitive.</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_0">init</a> (<a class="el" href="a04558.html#a15">uint</a> maxTrack=32, bool useEax=true, bool useADPCM=true, <a class="el" href="a03873.html">NLMISC::IProgressCallback</a> *progressCallBack=NULL, bool autoLoadSample=false)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_1">initClusteredSound</a> (<a class="el" href="a03348.html">NL3D::CScene</a> *scene, float minGain, float maxDistance, float portalInterpolate=20.0f)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_2">initClusteredSound</a> (<a class="el" href="a03351.html">NL3D::UScene</a> *uscene, float minGain, float maxDistance, float portalInterpolate=20.0f)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_3">setLowWaterMark</a> (<a class="el" href="a04558.html#a15">uint</a> <a class="el" href="a04223.html#a658">value</a>)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_4">setPackedSheetOption</a> (const std::string &path, bool update)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_5">setPriorityReserve</a> (<a class="el" href="a05381.html#a82">TSoundPriority</a> priorityChannel, <a class="el" href="a04558.html#a15">uint</a> reserve)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_6">setSamplePath</a> (const std::string &path)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02236.html">UAudioMixer</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2128_7">createAudioMixer</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the audio mixer singleton and return a pointer to its instance. <a href="#NLSOUND_1_1UAudioMixerz2128_7"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03429.html">USource</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera0">createSource</a> (<a class="el" href="a02246.html">TSoundId</a> <a class="el" href="a04223.html#a564">id</a>, bool spawn=false, <a class="el" href="a05381.html#a63">TSpawnEndCallback</a> cb=NULL, void *callbackUserParam=NULL, <a class="el" href="a02362.html">NL3D::CCluster</a> *cluster=0, <a class="el" href="a03417.html">CSoundContext</a> *context=0)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a logical sound source (by sound id). To remove a source, just delete it. See createSource(const char*). <a href="#NLSOUND_1_1UAudioMixera0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03429.html">USource</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera1">createSource</a> (const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> &name, bool spawn=false, <a class="el" href="a05381.html#a63">TSpawnEndCallback</a> cb=NULL, void *callbackUserParam=NULL, <a class="el" href="a02362.html">NL3D::CCluster</a> *cluster=0, <a class="el" href="a03417.html">CSoundContext</a> *context=0)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera2">enable</a> (bool b)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Disables or reenables the sound. <a href="#NLSOUND_1_1UAudioMixera2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03933.html">UListener</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera3">getListener</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the listener interface. <a href="#NLSOUND_1_1UAudioMixera3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a02246.html">TSoundId</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera4">getSoundId</a> (const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> &name)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a TSoundId from a name (returns NULL if not found). <a href="#NLSOUND_1_1UAudioMixera4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera5">reset</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the audio system (deletes all the sources, include envsounds). <a href="#NLSOUND_1_1UAudioMixera5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera6">selectEnvEffects</a> (const std::string &tag)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera7">setListenerPos</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera8">update</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Update audio mixer (call evenly). <a href="#NLSOUND_1_1UAudioMixera8"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera9">~UAudioMixer</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1UAudioMixera9"></a><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader"></div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2133_0">displayDriverBench</a> (<a class="el" href="a02813.html">NLMISC::CLog</a> *log)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2133_1">endDriverBench</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2133_2">startDriverBench</a> ()=0</td></tr> + +<tr><td colspan="2"><div class="groupHeader"></div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_0">getAvailableTracksCount</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of available tracks. <a href="#NLSOUND_1_1UAudioMixerz2130_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_1">getMutedPlayingSourcesCount</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number muted playing source. <a href="#NLSOUND_1_1UAudioMixerz2130_1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_2">getPlayingSoundsPos</a> (bool virtualPos, std::vector< std::pair< bool, <a class="el" href="a03128.html">NLMISC::CVector</a> > > &pos)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of available tracks. <a href="#NLSOUND_1_1UAudioMixerz2130_2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_3">getPlayingSourcesCount</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of playing sources. <a href="#NLSOUND_1_1UAudioMixerz2130_3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_4">getPolyphony</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of mixing tracks (voices). <a href="#NLSOUND_1_1UAudioMixerz2130_4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_5">getSoundNames</a> (std::vector< <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> > &names) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a vector with the names of all loaded sounds. <a href="#NLSOUND_1_1UAudioMixerz2130_5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_6">getSourcesInstanceCount</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of sources. <a href="#NLSOUND_1_1UAudioMixerz2130_6"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_7">getSourcesStats</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string showing the playing sources. <a href="#NLSOUND_1_1UAudioMixerz2130_7"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_8">getUsedTracksCount</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of used tracks. <a href="#NLSOUND_1_1UAudioMixerz2130_8"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2130_9">writeProfile</a> (std::ostream &out)=0</td></tr> + +<tr><td colspan="2"><div class="groupHeader"></div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="a03920.html">TBackgroundFilterFades</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_0">getBackgroundFilterFades</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const std::string & </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_1">getBackgroundFlagName</a> (<a class="el" href="a04558.html#a15">uint</a> flagIndex)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="a03921.html">TBackgroundFlags</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_2">getBackgroundFlags</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const std::string & </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_3">getBackgroundFlagShortName</a> (<a class="el" href="a04558.html#a15">uint</a> flagIndex)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_4">loadBackgroundAudioFromPrimitives</a> (const <a class="el" href="a03123.html">NLLIGO::IPrimitive</a> &audioRoot)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_5">loadBackgroundEffectsFromRegion</a> (const <a class="el" href="a03126.html">NLLIGO::CPrimRegion</a> &region)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#NLSOUND_1_1UAudioMixerz2131_5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_6">loadBackgroundSamplesFromRegion</a> (const <a class="el" href="a03126.html">NLLIGO::CPrimRegion</a> &region)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#NLSOUND_1_1UAudioMixerz2131_6"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_7">loadBackgroundSound</a> (const std::string &continent, <a class="el" href="a02756.html">NLLIGO::CLigoConfig</a> &config)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_8">loadBackgroundSoundFromRegion</a> (const <a class="el" href="a03126.html">NLLIGO::CPrimRegion</a> &region)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deprecated. <a href="#NLSOUND_1_1UAudioMixerz2131_8"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_9">playBackgroundSound</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_10">setBackgroundFilterFades</a> (const <a class="el" href="a03920.html">TBackgroundFilterFades</a> &backgroundFilterFades)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_11">setBackgroundFlagName</a> (<a class="el" href="a04558.html#a15">uint</a> flagIndex, const std::string &flagName)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_12">setBackgroundFlags</a> (const <a class="el" href="a03921.html">TBackgroundFlags</a> &backgroundFlags)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_13">setBackgroundFlagShortName</a> (<a class="el" href="a04558.html#a15">uint</a> flagIndex, const std::string &flagShortName)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2131_14">stopBackgroundSound</a> ()=0</td></tr> + +<tr><td colspan="2"><div class="groupHeader"></div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2129_0">getLoadedSampleBankInfo</a> (std::vector< std::pair< std::string, <a class="el" href="a04558.html#a15">uint</a> > > &result)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a11">uint32</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2129_1">getLoadedSampleSize</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a11">uint32</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2129_2">loadSampleBank</a> (bool async, const std::string &<a class="el" href="a04560.html#a1">filename</a>, std::vector< std::string > *notfoundfiles=NULL)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2129_3">reloadSampleBanks</a> (bool async)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2129_4">unloadSampleBank</a> (const std::string &<a class="el" href="a04560.html#a1">filename</a>)=0</td></tr> + +<tr><td colspan="2"><div class="groupHeader"></div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2132_0">getUserVar</a> (<a class="el" href="a05378.html#a236">NLMISC::TStringId</a> varName)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current value of a user var. <a href="#NLSOUND_1_1UAudioMixerz2132_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02236.html#NLSOUND_1_1UAudioMixerz2132_1">setUserVar</a> (<a class="el" href="a05378.html#a236">NLMISC::TStringId</a> varName, float <a class="el" href="a04223.html#a658">value</a>)=0</td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1UAudioMixera9" doxytag="NLSOUND::UAudioMixer::~UAudioMixer" ></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::UAudioMixer::~<a class="el" href="a02236.html">UAudioMixer</a> </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="a06594.html#l00328">328</a> of file <a class="el" href="a06594.html">u_audio_mixer.h</a>. +<p> +<div class="fragment"><pre>00328 {} +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_7" doxytag="NLSOUND::UAudioMixer::createAudioMixer" ></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="a02236.html">UAudioMixer</a> * 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="a05465.html#l00103">103</a> of file <a class="el" href="a05465.html">audio_mixer_user.cpp</a>. +<p> +<div class="fragment"><pre>00104 { +00105 NL_ALLOC_CONTEXT(NLSOUND_UAudioMixer); +00106 <span class="keywordflow">return</span> <span class="keyword">new</span> CAudioMixerUser(); +00107 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera0" doxytag="NLSOUND::UAudioMixer::createSource" ></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 <a class="el" href="a03429.html">USource</a>* NLSOUND::UAudioMixer::createSource </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02246.html">TSoundId</a> </td> + <td class="mdname" nowrap> <em>id</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawn</em> = false, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a05381.html#a63">TSpawnEndCallback</a> </td> + <td class="mdname" nowrap> <em>cb</em> = NULL, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>callbackUserParam</em> = NULL, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02362.html">NL3D::CCluster</a> * </td> + <td class="mdname" nowrap> <em>cluster</em> = 0, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a03417.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="a02235.html#NLSOUND_1_1CAudioMixerUsera8">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera1" doxytag="NLSOUND::UAudioMixer::createSource" ></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 <a class="el" href="a03429.html">USource</a>* NLSOUND::UAudioMixer::createSource </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> & </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>spawn</em> = false, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a05381.html#a63">TSpawnEndCallback</a> </td> + <td class="mdname" nowrap> <em>cb</em> = NULL, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>callbackUserParam</em> = NULL, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02362.html">NL3D::CCluster</a> * </td> + <td class="mdname" nowrap> <em>cluster</em> = 0, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a03417.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). If spawn is true, the source will auto-delete after playing. If so, the return USource* 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="a02235.html#NLSOUND_1_1CAudioMixerUsera9">NLSOUND::CAudioMixerUser</a>. +<p> +Referenced by <a class="el" href="a06622.html#l00178">NL3D::CPSSoundServImpl::createSound()</a>, and <a class="el" href="a06410.html#l00047">NLSOUND::CSoundAnimMarker::play()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2133_0" doxytag="NLSOUND::UAudioMixer::displayDriverBench" ></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 void NLSOUND::UAudioMixer::displayDriverBench </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02813.html">NLMISC::CLog</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>log</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="a02235.html#NLSOUND_1_1CAudioMixerUsera13">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera2" doxytag="NLSOUND::UAudioMixer::enable" ></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 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="a02235.html#NLSOUND_1_1CAudioMixerUsera14">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2133_1" doxytag="NLSOUND::UAudioMixer::endDriverBench" ></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 void NLSOUND::UAudioMixer::endDriverBench </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="a02235.html#NLSOUND_1_1CAudioMixerUsera15">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_0" doxytag="NLSOUND::UAudioMixer::getAvailableTracksCount" ></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 <a class="el" href="a04558.html#a15">uint</a> NLSOUND::UAudioMixer::getAvailableTracksCount </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="a02235.html#NLSOUND_1_1CAudioMixerUsera17">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_0" doxytag="NLSOUND::UAudioMixer::getBackgroundFilterFades" ></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 const <a class="el" href="a03920.html">TBackgroundFilterFades</a>& NLSOUND::UAudioMixer::getBackgroundFilterFades </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="a02235.html#NLSOUND_1_1CAudioMixerUsera18">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_1" doxytag="NLSOUND::UAudioMixer::getBackgroundFlagName" ></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 const std::string& NLSOUND::UAudioMixer::getBackgroundFlagName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>flagIndex</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="a02235.html#NLSOUND_1_1CAudioMixerUsera19">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_2" doxytag="NLSOUND::UAudioMixer::getBackgroundFlags" ></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 const <a class="el" href="a03921.html">TBackgroundFlags</a>& NLSOUND::UAudioMixer::getBackgroundFlags </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="a02235.html#NLSOUND_1_1CAudioMixerUsera20">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_3" doxytag="NLSOUND::UAudioMixer::getBackgroundFlagShortName" ></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 const std::string& NLSOUND::UAudioMixer::getBackgroundFlagShortName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>flagIndex</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="a02235.html#NLSOUND_1_1CAudioMixerUsera21">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera3" doxytag="NLSOUND::UAudioMixer::getListener" ></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 <a class="el" href="a03933.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="a02235.html#NLSOUND_1_1CAudioMixerUsera25">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2129_0" doxytag="NLSOUND::UAudioMixer::getLoadedSampleBankInfo" ></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 void NLSOUND::UAudioMixer::getLoadedSampleBankInfo </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< std::pair< std::string, <a class="el" href="a04558.html#a15">uint</a> > > & </td> + <td class="mdname1" valign="top" nowrap> <em>result</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> +Return a list of loaded sample bank with theire size. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera27">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2129_1" doxytag="NLSOUND::UAudioMixer::getLoadedSampleSize" ></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 <a class="el" href="a04558.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> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera28">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_1" doxytag="NLSOUND::UAudioMixer::getMutedPlayingSourcesCount" ></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 <a class="el" href="a04558.html#a15">uint</a> NLSOUND::UAudioMixer::getMutedPlayingSourcesCount </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 muted playing source. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera29">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_2" doxytag="NLSOUND::UAudioMixer::getPlayingSoundsPos" ></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 void NLSOUND::UAudioMixer::getPlayingSoundsPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname" nowrap> <em>virtualPos</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>std::vector< std::pair< bool, <a class="el" href="a03128.html">NLMISC::CVector</a> > > & </td> + <td class="mdname" nowrap> <em>pos</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> +Return the number of available tracks. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUserb1">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_3" doxytag="NLSOUND::UAudioMixer::getPlayingSourcesCount" ></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 <a class="el" href="a04558.html#a15">uint</a> NLSOUND::UAudioMixer::getPlayingSourcesCount </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="a02235.html#NLSOUND_1_1CAudioMixerUsera32">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_4" doxytag="NLSOUND::UAudioMixer::getPolyphony" ></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 <a class="el" href="a04558.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="a02235.html#NLSOUND_1_1CAudioMixerUsera33">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera4" doxytag="NLSOUND::UAudioMixer::getSoundId" ></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 <a class="el" href="a02246.html">TSoundId</a> NLSOUND::UAudioMixer::getSoundId </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> & </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> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera35">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_5" doxytag="NLSOUND::UAudioMixer::getSoundNames" ></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 void NLSOUND::UAudioMixer::getSoundNames </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> > & </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> +Fill a vector with the names of all loaded sounds. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera36">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_6" doxytag="NLSOUND::UAudioMixer::getSourcesInstanceCount" ></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 <a class="el" href="a04558.html#a15">uint</a> NLSOUND::UAudioMixer::getSourcesInstanceCount </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="a02235.html#NLSOUND_1_1CAudioMixerUsera37">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_7" doxytag="NLSOUND::UAudioMixer::getSourcesStats" ></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 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="a02235.html#NLSOUND_1_1CAudioMixerUsera38">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_8" doxytag="NLSOUND::UAudioMixer::getUsedTracksCount" ></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 <a class="el" href="a04558.html#a15">uint</a> NLSOUND::UAudioMixer::getUsedTracksCount </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 used tracks. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera39">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2132_0" doxytag="NLSOUND::UAudioMixer::getUserVar" ></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 float NLSOUND::UAudioMixer::getUserVar </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05378.html#a236">NLMISC::TStringId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>varName</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> +Return the current value of a user var. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera40">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_0" doxytag="NLSOUND::UAudioMixer::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"> virtual void NLSOUND::UAudioMixer::init </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>maxTrack</em> = 32, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>useEax</em> = true, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>useADPCM</em> = true, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a03873.html">NLMISC::IProgressCallback</a> * </td> + <td class="mdname" nowrap> <em>progressCallBack</em> = NULL, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>autoLoadSample</em> = false</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> +Initialization<p> +In case of failure, can throw one of these <a class="el" href="a03814.html">ESoundDriver</a> (Exception) objects: <a class="el" href="a03819.html">ESoundDriverNotFound</a>, <a class="el" href="a03816.html">ESoundDriverCorrupted</a>, <a class="el" href="a03821.html">ESoundDriverOldVersion</a>, <a class="el" href="a03822.html">ESoundDriverUnknownVersion</a>.<p> +You can ask for EAX support. If EAX support is requested, then the mixer will try to allocate hardware accelerated audio tracks. If the total of available harware track is less than 10, then EAX is automaticaly deactivated. autoLoadSample is used for tools like george or object viewer where you don't bother to specifie each sample bank to load, you just want to ear the sound. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera43">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_1" doxytag="NLSOUND::UAudioMixer::initClusteredSound" ></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 void NLSOUND::UAudioMixer::initClusteredSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03348.html">NL3D::CScene</a> * </td> + <td class="mdname" nowrap> <em>scene</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>minGain</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>maxDistance</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>portalInterpolate</em> = 20.0f</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> +Initialisation of the clustered sound system. CNELU version +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera44">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_2" doxytag="NLSOUND::UAudioMixer::initClusteredSound" ></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 void NLSOUND::UAudioMixer::initClusteredSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03351.html">NL3D::UScene</a> * </td> + <td class="mdname" nowrap> <em>uscene</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>minGain</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>maxDistance</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>portalInterpolate</em> = 20.0f</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> +Initialisation of the clustered sound system. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera45">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_4" doxytag="NLSOUND::UAudioMixer::loadBackgroundAudioFromPrimitives" ></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 void NLSOUND::UAudioMixer::loadBackgroundAudioFromPrimitives </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03123.html">NLLIGO::IPrimitive</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>audioRoot</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="a02235.html#NLSOUND_1_1CAudioMixerUsera47">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_5" doxytag="NLSOUND::UAudioMixer::loadBackgroundEffectsFromRegion" ></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 void NLSOUND::UAudioMixer::loadBackgroundEffectsFromRegion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03126.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> +Deprecated. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera48">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_6" doxytag="NLSOUND::UAudioMixer::loadBackgroundSamplesFromRegion" ></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 void NLSOUND::UAudioMixer::loadBackgroundSamplesFromRegion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03126.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> +Deprecated. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera49">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_7" doxytag="NLSOUND::UAudioMixer::loadBackgroundSound" ></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 void NLSOUND::UAudioMixer::loadBackgroundSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>continent</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02756.html">NLLIGO::CLigoConfig</a> & </td> + <td class="mdname" nowrap> <em>config</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> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera50">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_8" doxytag="NLSOUND::UAudioMixer::loadBackgroundSoundFromRegion" ></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 void NLSOUND::UAudioMixer::loadBackgroundSoundFromRegion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03126.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> +Deprecated. +<p> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera51">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2129_2" doxytag="NLSOUND::UAudioMixer::loadSampleBank" ></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 <a class="el" href="a04558.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 class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>filename</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></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. 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></dt><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="a02235.html#NLSOUND_1_1CAudioMixerUsera52">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_9" doxytag="NLSOUND::UAudioMixer::playBackgroundSound" ></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 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="a02235.html#NLSOUND_1_1CAudioMixerUsera53">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2129_3" doxytag="NLSOUND::UAudioMixer::reloadSampleBanks" ></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 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. Thid method use provided for use in a sound editor or sound tool to update the list of available samples. If true, the samples are loaded in a background thread. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera56">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera5" doxytag="NLSOUND::UAudioMixer::reset" ></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 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="a02235.html#NLSOUND_1_1CAudioMixerUsera60">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera6" doxytag="NLSOUND::UAudioMixer::selectEnvEffects" ></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 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><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd></dd></dl> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera61">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_10" doxytag="NLSOUND::UAudioMixer::setBackgroundFilterFades" ></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 void NLSOUND::UAudioMixer::setBackgroundFilterFades </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03920.html">TBackgroundFilterFades</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>backgroundFilterFades</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="a02235.html#NLSOUND_1_1CAudioMixerUsera62">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_11" doxytag="NLSOUND::UAudioMixer::setBackgroundFlagName" ></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 void NLSOUND::UAudioMixer::setBackgroundFlagName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>flagIndex</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>flagName</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> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera63">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_12" doxytag="NLSOUND::UAudioMixer::setBackgroundFlags" ></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 void NLSOUND::UAudioMixer::setBackgroundFlags </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03921.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="a02235.html#NLSOUND_1_1CAudioMixerUsera64">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_13" doxytag="NLSOUND::UAudioMixer::setBackgroundFlagShortName" ></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 void NLSOUND::UAudioMixer::setBackgroundFlagShortName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>flagIndex</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>flagShortName</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> + +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera65">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera7" doxytag="NLSOUND::UAudioMixer::setListenerPos" ></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 void NLSOUND::UAudioMixer::setListenerPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.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> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera66">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_3" doxytag="NLSOUND::UAudioMixer::setLowWaterMark" ></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 void NLSOUND::UAudioMixer::setLowWaterMark </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.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. 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="a02235.html#NLSOUND_1_1CAudioMixerUsera67">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_4" doxytag="NLSOUND::UAudioMixer::setPackedSheetOption" ></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 void NLSOUND::UAudioMixer::setPackedSheetOption </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>path</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>update</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 global path to the packeck sheet files. This must be set BEFORE calling init. Default is to store packed sheet in the current directory. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera68">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_5" doxytag="NLSOUND::UAudioMixer::setPriorityReserve" ></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 void NLSOUND::UAudioMixer::setPriorityReserve </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05381.html#a82">TSoundPriority</a> </td> + <td class="mdname" nowrap> <em>priorityChannel</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a04558.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. 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="a02235.html#NLSOUND_1_1CAudioMixerUsera69">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2128_6" doxytag="NLSOUND::UAudioMixer::setSamplePath" ></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 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 If you have specified some sample bank to load in the mixer comfig file, you MUST set the sample path BEFORE calling init. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera70">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2132_1" doxytag="NLSOUND::UAudioMixer::setUserVar" ></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 void NLSOUND::UAudioMixer::setUserVar </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05378.html#a236">NLMISC::TStringId</a> </td> + <td class="mdname" nowrap> <em>varName</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>value</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 value of a user variable. User variable are variable that can be used to control the gain or tranpose of all the instance (source) of a given sound. This has been initialy design to control the gain of any source playing some atmospheric sound (like rain) according to the intensity of the effect (ie small rain or big rain). Binding from user var to sound parameter is done in one or more george sheet .user_var_binding. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera71">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2133_2" doxytag="NLSOUND::UAudioMixer::startDriverBench" ></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 void NLSOUND::UAudioMixer::startDriverBench </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="a02235.html#NLSOUND_1_1CAudioMixerUsera72">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2131_14" doxytag="NLSOUND::UAudioMixer::stopBackgroundSound" ></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 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="a02235.html#NLSOUND_1_1CAudioMixerUsera73">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2129_4" doxytag="NLSOUND::UAudioMixer::unloadSampleBank" ></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 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. Return false if the bank can't be unloaded because an async loading is running. +<p> +Implemented in <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsera74">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixera8" doxytag="NLSOUND::UAudioMixer::update" ></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 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="a02235.html#NLSOUND_1_1CAudioMixerUsera77">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UAudioMixerz2130_9" doxytag="NLSOUND::UAudioMixer::writeProfile" ></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 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. <dl compact><dt><b>Parameters:</b></dt><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="a02235.html#NLSOUND_1_1CAudioMixerUsera79">NLSOUND::CAudioMixerUser</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06594.html">u_audio_mixer.h</a><li><a class="el" href="a05465.html">audio_mixer_user.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:53:13 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> |