Firelight Technologies FMOD Studio API

ChannelGroup::getGroup

Retrieves a handle to a specified sub channel group.

C++ Syntax

FMOD_RESULT ChannelGroup::getGroup(
  int index,
  FMOD::ChannelGroup **group
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetGroup(
  FMOD_CHANNELGROUP *channelgroup,
  int index,
  FMOD_CHANNELGROUP **group
);

C# Syntax

RESULT ChannelGroup.getGroup(
  int index,
  out ChannelGroup group
);

JavaScript Syntax

ChannelGroup.getGroup(
  index,                           
  group                            // writes value to group.val
);

Parameters

index

Index to specify which sub channel group to receieve.

group

Address of a variable to receieve a pointer to a 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

• ChannelGroup::addGroup
• ChannelGroup::getNumGroups
• ChannelGroup::getParentGroup

Version 1.10.03 Built on Feb 1, 2018