generated/FMOD_ChannelGroup_GetChannel.html

<LINK REL="stylesheet" HREF="../static/styles.css">
<HTML>
<HEAD>
<TITLE>ChannelGroup::getChannel</TITLE>
</HEAD>
<BODY TOPMARGIN="0" class="api_reference">
<p class="header">Firelight Technologies FMOD Studio API</p>
<H1>ChannelGroup::getChannel</H1>
<P>
<p>Retrieves the specified channel from the channel group.</p>
</P>
<h3>C++ Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT ChannelGroup::getChannel(
  int <I>index</I>,
  FMOD::Channel **<I>channel</I>
);
</CODE></PRE>
<h3>C Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT FMOD_ChannelGroup_GetChannel(
  FMOD_CHANNELGROUP *<I>channelgroup</I>,
  int <I>index</I>,
  FMOD_CHANNEL **<I>channel</I>
);
</CODE></PRE>
<h2>Parameters</h2>
<dl>
<dt>index</dt>
<dd>Index of the channel inside the channel group, from 0 to the number of channels returned by <A HREF="FMOD_ChannelGroup_GetNumChannels.html">ChannelGroup::getNumChannels</A>.</dd>
<dt>channel</dt>
<dd>Address of a variable to receieve a pointer to a channel.</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>See Also</h2>
<UL type=disc>
<LI><A HREF="FMOD_ChannelGroup_GetNumChannels.html">ChannelGroup::getNumChannels</A></LI>
<LI><A HREF="FMOD_System_GetMasterChannelGroup.html">System::getMasterChannelGroup</A></LI>
<LI><A HREF="FMOD_System_CreateChannelGroup.html">System::createChannelGroup</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>