generated/FMOD_System_GetReverbProperties.html

<LINK REL="stylesheet" HREF="../static/styles.css">
<HTML>
<HEAD>
<TITLE>System::getReverbProperties</TITLE>
</HEAD>
<BODY TOPMARGIN="0" class="api_reference">
<p class="header">Firelight Technologies FMOD Studio API</p>
<H1>System::getReverbProperties</H1>
<P>
<p>Retrieves the current reverb environment for the specified reverb instance.
You must specify the 'Instance' value (usually 0 unless you are using multiple reverbs) before calling this function.</p>
</P>
<h3>C++ Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT System::getReverbProperties(
  int <I>instance</I>,
  FMOD_REVERB_PROPERTIES *<I>prop</I>
);
</CODE></PRE>
<h3>C Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT FMOD_System_GetReverbProperties(
  FMOD_SYSTEM *<I>system</I>,
  int <I>instance</I>,
  FMOD_REVERB_PROPERTIES *<I>prop</I>
);
</CODE></PRE>
<h2>Parameters</h2>
<dl>
<dt>instance</dt>
<dd>Reverb instance number.  Must be between 0 and 3 inclusive.</dd>
<dt>prop</dt>
<dd>Address of a variable that receives the current reverb environment description. Make sure the 'Instance' value is specified.</dd>
</dl>
<h2>Return Values</h2><P>
If the function succeeds then the return value is <A HREF="fmod_result.html">FMOD_OK</A>.<BR>
If the function fails then the return value will be one of the values defined in the <A HREF="fmod_result.html">FMOD_RESULT</A> enumeration.<BR>
</P>
<h2>Remarks</h2><P>
<p><strong>Note!</strong> It is important to specify the 'Instance' value in the <A HREF="FMOD_REVERB_PROPERTIES.html">FMOD_REVERB_PROPERTIES</A> structure correctly,
otherwise you will get an <A HREF="FMOD_RESULT.html">FMOD_ERR_REVERB_INSTANCE</A> error.</p>
</P>
<h2>See Also</h2>
<UL type=disc>
<LI><A HREF="FMOD_REVERB_PROPERTIES.html">FMOD_REVERB_PROPERTIES</A></LI>
<LI><A HREF="FMOD_System_SetReverbProperties.html">System::setReverbProperties</A></LI>
<LI><A HREF="FMOD_Channel_SetReverbProperties.html">Channel::setReverbProperties</A></LI>
<LI><A HREF="FMOD_Channel_GetReverbProperties.html">Channel::getReverbProperties</A></LI>
</UL>
<BR><BR><BR>
<P align=center><font size=-2>Version 1.03.06 Built on Apr 17, 2014</font></P>
<BR>
</HTML>