Channel::getChannelGroup

FMOD Studio API

Firelight Technologies FMOD Studio API

Channel::getChannelGroup

Retrieves the currently assigned channel group for the channel.

C++ Syntax

FMOD_RESULT Channel::getChannelGroup(
  FMOD::ChannelGroup **channelgroup
);

C Syntax

FMOD_RESULT FMOD_Channel_GetChannelGroup(
  FMOD_CHANNEL *channel,
  FMOD_CHANNELGROUP **channelgroup
);

C# Syntax

RESULT Channel.getChannelGroup(
  out ChannelGroup channelgroup
);

JavaScript Syntax

Channel.getChannelGroup(
  channelgroup                     // writes value to channelgroup.val
);

Parameters

channelgroup
Address of a variable to receive a pointer to the currently assigned 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