Firelight Technologies FMOD Studio API

Sound::getLoopPoints

Retrieves the loop points for a sound.

C++ Syntax

FMOD_RESULT Sound::getLoopPoints(
  unsigned int *loopstart,
  FMOD_TIMEUNIT loopstarttype,
  unsigned int *loopend,
  FMOD_TIMEUNIT loopendtype
);

C Syntax

FMOD_RESULT FMOD_Sound_GetLoopPoints(
  FMOD_SOUND *sound,
  unsigned int *loopstart,
  FMOD_TIMEUNIT loopstarttype,
  unsigned int *loopend,
  FMOD_TIMEUNIT loopendtype
);

C# Syntax

RESULT Sound.getLoopPoints(
  out uint loopstart,
  TIMEUNIT loopstarttype,
  out uint loopend,
  TIMEUNIT loopendtype
);

JavaScript Syntax

Sound.getLoopPoints(
  loopstart,                       // writes value to loopstart.val
  loopstarttype,                   
  loopend,                         // writes value to loopend.val
  loopendtype                      
);

Parameters

loopstart

Address of a variable to receive the loop start point. This point in time is played, so it is inclusive. Optional. Specify 0 or NULL to ignore.

loopstarttype

The time format used for the returned loop start point. See FMOD_TIMEUNIT.

loopend

Address of a variable to receive the loop end point. This point in time is played, so it is inclusive. Optional. Specify 0 or NULL to ignore.

loopendtype

The time format used for the returned loop end point. See FMOD_TIMEUNIT.

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

• FMOD_TIMEUNIT
• Sound::setLoopPoints

Version 1.10.03 Built on Feb 1, 2018