Firelight Technologies FMOD Studio API

ChannelGroup::getMode

Retrieves the mode bit flags for the channel.

C++ Syntax

FMOD_RESULT ChannelGroup::getMode(
  FMOD_MODE *mode
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetMode(
  FMOD_CHANNELGROUP *channelgroup,
  FMOD_MODE *mode
);

C# Syntax

RESULT ChannelGroup.getMode(
  out MODE mode
);

JavaScript Syntax

ChannelGroup.getMode(
  mode                             // writes value to mode.val
);

Parameters

mode

Address of a variable to receive the mode bits.

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

• Channel::setMode
• FMOD_MODE

Version 1.10.03 Built on Feb 1, 2018