Firelight Technologies FMOD Studio API
Studio::Bus::unlockChannelGroup
Releases the Low Level ChannelGroup locked by Studio::Bus::lockChannelGroup.
C++ Syntax
FMOD_RESULT Studio::Bus::unlockChannelGroup();C Syntax
FMOD_RESULT FMOD_Studio_Bus_UnlockChannelGroup(FMOD_STUDIO_BUS *bus);C# Syntax
RESULT Studio.Bus.unlockChannelGroup();JavaScript Syntax
Bus.unlockChannelGroup();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
You can force a bus's ChannelGroup to be created by calling Studio::Bus::lockChannelGroup. This function reverts to the default behavior of creating and destroying the ChannelGroup on demand, meaning it will only exist if at least one event instance routes into the bus.
Calling this function will cause the ChannelGroup to be destroyed if there are currently no event instances routing into the bus.
See Also
Version 1.10.03 Built on Feb 1, 2018