Firelight Technologies FMOD Studio API

Sound::getSoundGroup

Retrieves the sound's current soundgroup.

C++ Syntax

FMOD_RESULT Sound::getSoundGroup(
  FMOD::SoundGroup **soundgroup
);

C Syntax

FMOD_RESULT FMOD_Sound_GetSoundGroup(
  FMOD_SOUND *sound,
  FMOD_SOUNDGROUP **soundgroup
);

C# Syntax

RESULT Sound.getSoundGroup(
  out SoundGroup soundgroup
);

JavaScript Syntax

Sound.getSoundGroup(
  soundgroup                       // writes value to soundgroup.val
);

Parameters

soundgroup

Address of a pointer to a SoundGroup to receive the sound's current soundgroup.

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

• Sound::setSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018