Firelight Technologies FMOD Studio API

ChannelGroup::getParentGroup

Retrieves a handle to the channel group parent.

C++ Syntax

FMOD_RESULT ChannelGroup::getParentGroup(
  FMOD::ChannelGroup **group
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetParentGroup(
  FMOD_CHANNELGROUP *channelgroup,
  FMOD_CHANNELGROUP **group
);

C# Syntax

RESULT ChannelGroup.getParentGroup(
  out ChannelGroup group
);

JavaScript Syntax

ChannelGroup.getParentGroup(
  group                            // writes value to group.val
);

Parameters

group

Address of a variable to receive 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::getGroup

Version 1.10.03 Built on Feb 1, 2018