Firelight Technologies FMOD Studio API

Sound::getMusicSpeed

Sets the relative speed of MOD/S3M/XM/IT/MIDI music.

C++ Syntax

FMOD_RESULT Sound::getMusicSpeed(
  float *speed
);

C Syntax

FMOD_RESULT FMOD_Sound_GetMusicSpeed(
  FMOD_SOUND *sound,
  float *speed
);

Parameters

speed

Address of a variable to receive the relative speed of the song from 0.01 to 100.0. 0.5 = half speed, 2.0 = double speed. Default = 1.0.

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

Setting a speed outside the bounds of 0.01 to 100.0 will not return an error, it will clamp the value.

See Also

• Sound::setMusicSpeed
• Sound::setMusicChannelVolume
• Sound::getMusicChannelVolume

Version 1.03.06 Built on Apr 17, 2014