SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_ConvertAudioSamples

Convert some audio data of one format to another format.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

int SDL_ConvertAudioSamples(const SDL_AudioSpec *src_spec,
                        const Uint8 *src_data,
                        int src_len,
                        const SDL_AudioSpec *dst_spec,
                        Uint8 **dst_data,
                        int *dst_len);

Function Parameters

src_spec The format details of the input audio
src_data The audio data to be converted
src_len The len of src_data
dst_spec The format details of the output audio
dst_data Will be filled with a pointer to converted audio data, which should be freed with SDL_free(). On error, it will be NULL.
dst_len Will be filled with the len of dst_data

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

Please note that this function is for convenience, but should not be used to resample audio in blocks, as it will introduce audio artifacts on the boundaries. You should only use this function if you are converting audio data in its entirety in one call. If you want to convert audio in smaller chunks, use an SDL_AudioStream, which is designed for this situation.

Internally, this function creates and destroys an SDL_AudioStream on each use, so it's also less efficient than using one directly, if you need to convert multiple times.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryAPIFunction, CategoryAudio


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.