SDL_SetAudioStreamFrequencyRatio

Change the frequency ratio of an audio stream.

The frequency ratio is used to adjust the rate at which input data is consumed. Changing this effectively modifies the speed and pitch of the audio. A value greater than 1.0 will play the audio faster, and at a higher pitch. A value less than 1.0 will play the audio slower, and at a lower pitch.

This is applied during SDL_GetAudioStreamData, and can be continuously changed to create various effects.

extern (C) nothrow @nogc extern
bool
SDL_SetAudioStreamFrequencyRatio

Parameters

stream SDL_AudioStream*

the stream the frequency ratio is being changed.

ratio float

the frequency ratio. 1.0 is normal speed. Must be between 0.01 and 100.

Return Value

Type: bool

true on success or false on failure; call SDL_GetError() for more information.

Threadsafety: It is safe to call this function from any thread, as it holds a stream-specific mutex while running.

See Also

Meta