Firelight Technologies FMOD Studio API
System::createChannelGroup
Creates a channel group object. These objects can be used to assign channels to for group channel settings, such as volume.
Channel groups are also used for sub-mixing. Any channels that are assigned to a channel group get submixed into that channel group's DSP.
C++ Syntax
FMOD_RESULT System::createChannelGroup(
const char *name,
FMOD::ChannelGroup **channelgroup
);
C Syntax
FMOD_RESULT FMOD_System_CreateChannelGroup(
FMOD_SYSTEM *system,
const char *name,
FMOD_CHANNELGROUP **channelgroup
);
C# Syntax
RESULT System.createChannelGroup(
string name,
out ChannelGroup channelgroup
);
JavaScript Syntax
System.createChannelGroup(
name,
channelgroup // writes value to channelgroup.val
);
Parameters
- name
- Label to give to the channel group for identification purposes. Optional (can be null).
- channelgroup
- Address of a variable to receive a newly created FMOD::ChannelGroup object.
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
See the channel group class definition for the types of operations that can be performed on 'groups' of channels.
The channel group can for example be used to have 2 seperate groups of master volume, instead of one global master volume.
A channel group can be used for sub-mixing, ie so that a set of channels can be mixed into a channel group, then can have effects
applied to it without affecting other channels. By default newly created channel groups are parented to the system master channel group.
Channel groups can be re-parented using ChannelGroup::addGroup to create a hierarchical mixing layout.
See Also
Version 1.10.03 Built on Feb 1, 2018