Firelight Technologies FMOD Studio API
Studio::Bus::getChannelGroup
Retrieves the Low Level ChannelGroup used by the bus.
C++ Syntax
FMOD_RESULT Studio::Bus::getChannelGroup(
FMOD::ChannelGroup **group
);
C Syntax
FMOD_RESULT FMOD_Studio_Bus_GetChannelGroup(
FMOD_STUDIO_BUS *bus,
FMOD_CHANNELGROUP **group
);
C# Syntax
RESULT Studio.Bus.getChannelGroup(
out FMOD.ChannelGroup group
);
JavaScript Syntax
Bus.getChannelGroup(
channelgroup // writes value to channelgroup.val
);
Parameters
- group
- Address of a variable to receive a pointer to the Low Level ChannelGroup.
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
The ChannelGroup is created and destroyed on demand. This means it only exists if at least one event instance routes into the bus. If it doesn't exist, this function will return FMOD_ERR_STUDIO_NOT_LOADED.
You can force the ChannelGroup to be created by calling Studio::Bus::lockChannelGroup.
See Also
Version 1.10.03 Built on Feb 1, 2018