Firelight Technologies FMOD Studio API

Sound::getNumSubSounds

Retrieves the number of subsounds stored within a sound.

C++ Syntax

FMOD_RESULT Sound::getNumSubSounds(
  int *numsubsounds
);

C Syntax

FMOD_RESULT FMOD_Sound_GetNumSubSounds(
  FMOD_SOUND *sound,
  int *numsubsounds
);

C# Syntax

RESULT Sound.getNumSubSounds(
  out int numsubsounds
);

JavaScript Syntax

Sound.getNumSubSounds(
  numsubsounds                     // writes value to numsubsounds.val
);

Parameters

numsubsounds

Address of a variable that receives the number of subsounds stored within this sound.

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

A format that has subsounds is usually a container format, such as FSB, DLS, MOD, S3M, XM, IT.

See Also

• Sound::getSubSound

Version 1.10.03 Built on Feb 1, 2018