Firelight Technologies FMOD Studio API
Channel::setChannelGroup
Sets a channel to belong to a specified channel group. A channel group can contain many channels.
C++ Syntax
FMOD_RESULT Channel::setChannelGroup(
FMOD::ChannelGroup *channelgroup
);
C Syntax
FMOD_RESULT FMOD_Channel_SetChannelGroup(
FMOD_CHANNEL *channel,
FMOD_CHANNELGROUP *channelgroup
);
C# Syntax
RESULT Channel.setChannelGroup(
ChannelGroup channelgroup
);
JavaScript Syntax
Channel.setChannelGroup(
channelgroup
);
Parameters
- channelgroup
- Pointer to a 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
Setting a channel to a channel group removes it from any previous group, it does not allow sharing of channel groups.
See Also
Version 1.10.03 Built on Feb 1, 2018