generated/FMOD_Studio_EventInstance_SetParameterValue.html

<LINK REL="stylesheet" HREF="../static/styles.css">
<HTML>
<HEAD>
<TITLE>Studio::EventInstance::setParameterValue</TITLE>
</HEAD>
<BODY TOPMARGIN="0" class="api_reference">
<p class="header">Firelight Technologies FMOD Studio API</p>
<H1>Studio::EventInstance::setParameterValue</H1>
<P>
<p>Sets a parameter instance value by name.</p>
</P>
<h3>C++ Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT Studio::EventInstance::setParameterValue(
  const char *<I>name</I>,
  float <I>value</I>
);
</CODE></PRE>
<h3>C Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT FMOD_Studio_EventInstance_SetParameterValue(
  FMOD_STUDIO_EVENTINSTANCE *<I>eventinstance</I>,
  const char *<I>name</I>,
  float <I>value</I>
);
</CODE></PRE>
<h2>Parameters</h2>
<dl>
<dt>name</dt>
<dd>Name of the parameter (case-insensitive).</dd>
<dt>value</dt>
<dd>Value to set.</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>This is a convenience function that is equivalent to calling EventInstance::getParameter then ParameterInstance::setValue.</p>
</P>
<h2>See Also</h2>
<UL type=disc>
<LI><A HREF="FMOD_Studio_EventInstance_GetParameter.html">Studio::EventInstance::getParameter</A></LI>
<LI><A HREF="FMOD_Studio_ParameterInstance_SetValue.html">Studio::ParameterInstance::setValue</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>