SDL_SetAudioStreamFrequencyRatio - Change the frequency ratio of an audio stream.
Contents
Availability
This function is available since SDL 3.2.0.
Description
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.
Function Parameters
stream the stream the frequency ratio is being changed.
ratio the frequency ratio. 1.0 is normal speed. Must be between 0.01 and 100.
Header File
Defined in SDL3/SDL_audio.h
Name
SDL_SetAudioStreamFrequencyRatio - Change the frequency ratio of an audio stream.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
See Also
•(3), SDL_GetAudioStreamFrequencyRatio(3), •(3), SDL_SetAudioStreamFormat(3) Simple Directmedia Layer SDL 3.2.10 SDL_SetAudioStreamFrequencyRatio(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_SetAudioStreamFrequencyRatio(SDL_AudioStream*stream,floatratio);
Thread Safety
It is safe to call this function from any thread, as it holds a stream-specific mutex while running.
