ChannelGroup::getNumGroups

FMOD Studio API

Firelight Technologies FMOD Studio API

ChannelGroup::getNumGroups

Retrieves the number of sub groups under this channel group.

C++ Syntax

FMOD_RESULT ChannelGroup::getNumGroups(
  int *numgroups
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetNumGroups(
  FMOD_CHANNELGROUP *channelgroup,
  int *numgroups
);

C# Syntax

RESULT ChannelGroup.getNumGroups(
  out int numgroups
);

JavaScript Syntax

ChannelGroup.getNumGroups(
  numgroups                        // writes value to numgroups.val
);

Parameters

numgroups
Address of a variable to receive the number of channel groups within 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.

See Also




Version 1.10.03 Built on Feb 1, 2018