Firelight Technologies FMOD Studio API

Channel::getLoopCount

Retrieves the current loop count for the specified channel.

C++ Syntax

FMOD_RESULT Channel::getLoopCount(
  int *loopcount
);

C Syntax

FMOD_RESULT FMOD_Channel_GetLoopCount(
  FMOD_CHANNEL *channel,
  int *loopcount
);

C# Syntax

RESULT Channel.getLoopCount(
  out int loopcount
);

JavaScript Syntax

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

Parameters

loopcount

Address of a variable that receives the number of times to loop before stopping. 0 = oneshot, 1 = loop once then stop, -1 = loop forever.

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

This function retrieves the current loop countdown value for the channel being played. This means it will decrement until reaching 0, as it plays. To reset the value, use Channel::setLoopCount.

See Also

• Channel::setLoopCount

Version 1.10.03 Built on Feb 1, 2018