mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-07 03:48:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2023-09-04 14:47:15 +00:00
parent 0e552761b7
commit 36b5f3e35c
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/SDL3/SDL_audio.h
View File

@@ -727,16 +727,18 @@ extern DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStream *
/** /**
* Change the frequency ratio of an audio stream. * Change the frequency ratio of an audio stream.
* *
* The frequency ratio is used to adjust the rate at which input data is consumed. * The frequency ratio is used to adjust the rate at which input data is
* Changing this effectively modifies the speed and pitch of the audio. * consumed. Changing this effectively modifies the speed and pitch of the
* A value greater than 1.0 will play the audio faster, and at a higher pitch. * audio. A value greater than 1.0 will play the audio faster, and at a higher
* A value less than 1.0 will play the audio slower, and at a lower pitch. * 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 * This is applied during SDL_GetAudioStreamData, and can be continuously
* to create various effects. * changed to create various effects.
* *
* \param stream The stream the frequency ratio is being changed * \param stream The stream the frequency ratio is being changed
* \param ratio The frequency ratio. 1.0 is normal speed. Must be between 0.01 and 100. * \param ratio The frequency ratio. 1.0 is normal speed. Must be between 0.01
* and 100.
* \returns 0 on success, or -1 on error. * \returns 0 on success, or -1 on error.
* *
* \threadsafety It is safe to call this function from any thread, as it holds * \threadsafety It is safe to call this function from any thread, as it holds