Firelight Technologies FMOD Studio API

Channel::getPosition

Returns the current playback position for the specified channel.

C++ Syntax

FMOD_RESULT Channel::getPosition(
  unsigned int *position,
  FMOD_TIMEUNIT postype
);

C Syntax

FMOD_RESULT FMOD_Channel_GetPosition(
  FMOD_CHANNEL *channel,
  unsigned int *position,
  FMOD_TIMEUNIT postype
);

Parameters

position

Address of a variable that receives the position of the sound.

postype

Time unit to retrieve into the position parameter. 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.

Remarks

Certain timeunits do not work depending on the file format. For example FMOD_TIMEUNIT_MODORDER will not work with an MP3 file.

See Also

• Channel::setPosition
• FMOD_TIMEUNIT

Version 1.03.06 Built on Apr 17, 2014