Firelight Technologies FMOD Studio API
System::getMasterChannelGroup
Retrieves a handle to the internal master channel group.
This is the default channel group that all channels play on.
This channel group can be used to do things like set the master volume for all playing sounds.
See the ChannelGroup API for more functionality.
C++ Syntax
FMOD_RESULT System::getMasterChannelGroup(
FMOD::ChannelGroup **channelgroup
);
C Syntax
FMOD_RESULT FMOD_System_GetMasterChannelGroup(
FMOD_SYSTEM *system,
FMOD_CHANNELGROUP **channelgroup
);
C# Syntax
RESULT System.getMasterChannelGroup(
out ChannelGroup channelgroup
);
JavaScript Syntax
System.getMasterChannelGroup(
channelgroup // writes value to channelgroup.val
);
Parameters
- channelgroup
- Address of a variable that receives a pointer to the master System object channel group.
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
Version 1.10.03 Built on Feb 1, 2018