SDL_BuildAudioCVT

Use this function to initialize an SDL_AudioCVT structure for conversion.

Syntax

int SDL_BuildAudioCVT(SDL_AudioCVT*   cvt, 
                      SDL_AudioFormat src_format, 
                      Uint8           src_channels, 
                      int             src_rate, 
                      SDL_AudioFormat dst_format, 
                      Uint8           dst_channels, 
                      int             dst_rate)

Function Parameters

Should "frequency or samples-per-second" be changed to "frequency (samples per second)" or can rate be two different types of units?

Return Value

Returns 1 if the audio filter is set up, 0 if there is no conversion needed, or a negative error code on failure; call SDL_GetError() for more information.

If audio format conversion is not supported this function returns -1.

Code Examples

You can add your code example here

Remarks

Before an SDL_AudioCVT structure can be used to convert audio data it must be initialized with source and destination information.

For information on audio formats see SDL_AudioSpec.

*
Currently only rate conversions of 2^x and (1/2)^x with x > 0 are done, _nearing ^{whichever most closely approximates} the requested rate conversion.
*

Is there a 'you can call' function to "automatically" get more information in this case like there was for SDL_SetTextureColorMod SDL_SetTextureBlendMode SDL_SetTextureAlphaMod etc? I thought it would be SDL_ConvertAudio() but that seems to use the struct not set it up. If this is the only other RF then does the programmer need to determine whether conversion is possible and manually set that as a fixed data value when the struct is first set up?

^{You can call [[some function]]() to fill in an [[SDL_AudioCVT]] structure with the remaining information about the current audio converter. This structure will have the `needed` member/mask set to 1 if conversion is possible.}

Related Functions

• SDL_ConvertAudio

CategoryAPI, CategoryAudio