.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_SetAudioStreamFrequencyRatio:
.\"   https://wiki.libsdl.org/SDL_SetAudioStreamFrequencyRatio
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_SetAudioStreamFrequencyRatio
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_SetAudioStreamFrequencyRatio 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_SetAudioStreamFrequencyRatio \- Change the frequency ratio of an audio stream\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_SetAudioStreamFrequencyRatio(SDL_AudioStream *stream, float ratio);
.fi
.SH DESCRIPTION
The frequency ratio is used to adjust the rate at which input data is
consumed\[char46] Changing this effectively modifies the speed and pitch of the
audio\[char46] A value greater than 1\[char46]0 will play the audio faster, and at a higher
pitch\[char46] A value less than 1\[char46]0 will play the audio slower, and at a lower
pitch\[char46]

This is applied during 
.BR SDL_GetAudioStreamData
,
and can be continuously changed to create various effects\[char46]

.SH FUNCTION PARAMETERS
.TP
.I stream
The stream the frequency ratio is being changed
.TP
.I ratio
The frequency ratio\[char46] 1\[char46]0 is normal speed\[char46] Must be between 0\[char46]01 and 100\[char46]
.SH RETURN VALUE
Returns 0 on success, or -1 on error\[char46]

.SH THREAD SAFETY
It is safe to call this function from any thread, as it holds a
stream-specific mutex while running\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GetAudioStreamFrequencyRatio (3),
.BR SDL_SetAudioStreamFormat (3)