Firelight Technologies FMOD Studio API

SoundGroup::getName

Retrieves the name of the sound group.

C++ Syntax

FMOD_RESULT SoundGroup::getName(
  char *name,
  int namelen
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_GetName(
  FMOD_SOUNDGROUP *soundgroup,
  char *name,
  int namelen
);

C# Syntax

RESULT SoundGroup.getName(
  StringBuilder name,
  int namelen
);

JavaScript Syntax

SoundGroup.getName(
  name                             // writes value to name.val
);

Parameters

name

Address of a variable that receives the name of the sound group.

namelen

Length in bytes of the target buffer to receieve the string.

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

JavaScript only :

Note: For the "name" parameter, the maximum string length is 512.

See Also

• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018