Firelight Technologies FMOD Studio API

ChannelGroup::addGroup

Adds a channel group as a child of the current channel group.

C++ Syntax

FMOD_RESULT ChannelGroup::addGroup(
  FMOD::ChannelGroup *group,
  bool propagatedspclock,
  FMOD::DSPConnection **connection
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_AddGroup(
  FMOD_CHANNELGROUP *channelgroup,
  FMOD_CHANNELGROUP *group,
  FMOD_BOOL propagatedspclock,
  FMOD_DSPCONNECTION **connection
);

C# Syntax

RESULT ChannelGroup.addGroup(
  ChannelGroup group,
  bool propagatedspclock,
  out DSPConnection connection
);

JavaScript Syntax

ChannelGroup.addGroup(
  group,                           
  propagatedspclock,               
  connection                       // writes value to connection.val
);

Parameters

group

Channel group to add as a child.

propagatedspclock

When a child group is added to a parent group, the clock values from the parent will be propogated down into the child.

connection

Address of a variable to receive a pointer to a DSP connection, which is the connection between the parent and the child group's DSP units.

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::getNumGroups
• ChannelGroup::getGroup
• ChannelGroup::getParentGroup

Version 1.10.03 Built on Feb 1, 2018