Firelight Technologies FMOD Studio API

ChannelGroup::getNumChannels

Retrieves the number of assigned channels to this channel group.

C++ Syntax

FMOD_RESULT ChannelGroup::getNumChannels(
  int *numchannels
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetNumChannels(
  FMOD_CHANNELGROUP *channelgroup,
  int *numchannels
);

Parameters

numchannels

Address of a variable to receive the current number of channels in this channel group.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Use this function to enumerate the channels within the channel group. You can then use ChannelGroup::getChannel to retrieve each individual channel.

See Also

• ChannelGroup::getChannel
• System::getMasterChannelGroup
• System::createChannelGroup

Version 1.03.06 Built on Apr 17, 2014