Firelight Technologies FMOD Studio API

Channel::getLoopPoints

Retrieves the loop points for the channel.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_Channel_GetLoopPoints(
  FMOD_CHANNEL *channel,
  unsigned int *loopstart,
  FMOD_TIMEUNIT loopstarttype,
  unsigned int *loopend,
  FMOD_TIMEUNIT loopendtype
);

C# Syntax

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

JavaScript Syntax

Channel.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

Time format used for the 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

Time format used for the 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

• Channel::setLoopPoints
• FMOD_TIMEUNIT

Version 1.10.03 Built on Feb 1, 2018