Firelight Technologies FMOD Studio API

Sound::getLoopCount

Retrieves the current loop count value for the specified sound.

C++ Syntax

FMOD_RESULT Sound::getLoopCount(
  int *loopcount
);

C Syntax

FMOD_RESULT FMOD_Sound_GetLoopCount(
  FMOD_SOUND *sound,
  int *loopcount
);

C# Syntax

RESULT Sound.getLoopCount(
  out int loopcount
);

JavaScript Syntax

Sound.getLoopCount(
  loopcount                        // writes value to loopcount.val
);

Parameters

loopcount

Address of a variable that receives the number of times a sound will loop by default before stopping. 0 = oneshot. 1 = loop once then stop. -1 = loop forever. Default = -1

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

Unlike the channel loop count function, this function simply returns the value set with Sound::setLoopCount. It does not decrement as it plays (especially seeing as one sound can be played multiple times).

See Also

• Sound::setLoopCount

Version 1.10.03 Built on Feb 1, 2018