Firelight Technologies FMOD Studio API

SoundGroup::getNumPlaying

Retrieves the number of currently playing channels for the sound group.

C++ Syntax

FMOD_RESULT SoundGroup::getNumPlaying(
  int *numplaying
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_GetNumPlaying(
  FMOD_SOUNDGROUP *soundgroup,
  int *numplaying
);

Parameters

numplaying

Address of a variable to receive the number of actively playing channels from sounds in this sound 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

This routine returns the number of channels playing. If the sound group only has 1 sound, and that sound is playing twice, the figure returned will be 2.

See Also

• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.03.06 Built on Apr 17, 2014