devela::_dep::sdl3::sys::audio

Function SDL_SetAudioStreamFrequencyRatio

pub unsafe extern "C" fn SDL_SetAudioStreamFrequencyRatio(
    stream: *mut SDL_AudioStream,
    ratio: f32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

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.

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

§Return value

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

§Thread safety

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

§Availability

This function is available since SDL 3.2.0.

§See also