Firelight Technologies FMOD Studio API

Studio::EventInstance::getChannelGroup

Retrieves the Low Level ChannelGroup for the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getChannelGroup(
  FMOD::ChannelGroup **group
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetChannelGroup(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  FMOD_CHANNELGROUP **group
);

Parameters

group
Address of a variable to receive the 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 retrieved ChannelGroup corresponds to the Master Track of the event instance.




Version 1.03.06 Built on Apr 17, 2014