generated/FMOD_Channel_SetChannelGroup.html

<LINK REL="stylesheet" HREF="../static/styles.css">
<HTML>
<HEAD>
<TITLE>Channel::setChannelGroup</TITLE>
</HEAD>
<BODY TOPMARGIN="0" class="api_reference">
<p class="header">Firelight Technologies FMOD Studio API</p>
<H1>Channel::setChannelGroup</H1>
<P>
<p>Sets a channel to belong to a specified channel group. A channel group can contain many channels.</p>
</P>
<h3>C++ Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT Channel::setChannelGroup(
  FMOD::ChannelGroup *<I>channelgroup</I>
);
</CODE></PRE>
<h3>C Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT FMOD_Channel_SetChannelGroup(
  FMOD_CHANNEL *<I>channel</I>,
  FMOD_CHANNELGROUP *<I>channelgroup</I>
);
</CODE></PRE>
<h2>Parameters</h2>
<dl>
<dt>channelgroup</dt>
<dd>Pointer to a ChannelGroup object.</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>Setting a channel to a channel group removes it from any previous group, it does not allow sharing of channel groups.</p>
</P>
<h2>See Also</h2>
<UL type=disc>
<LI><A HREF="FMOD_Channel_GetChannelGroup.html">Channel::getChannelGroup</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>