NAME¶

SDL_SetAudioStreamFormat - Change the input and output formats of an audio stream.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_SetAudioStreamFormat(SDL_AudioStream *stream,
                             const SDL_AudioSpec *src_spec,
                             const SDL_AudioSpec *dst_spec);

DESCRIPTION¶

Future calls to and

SDL_GetAudioStreamAvailable
and

SDL_GetAudioStreamData
will reflect the new format, and future calls to

SDL_PutAudioStreamData
must provide data in the new input formats.

FUNCTION PARAMETERS¶

stream

The stream the format is being changed

src_spec

The new format of the audio input; if NULL, it is not changed.

dst_spec

The new format of the audio output; if NULL, it is not changed.

RETURN VALUE¶

Returns 0 on success, or -1 on error.

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

SEE ALSO¶

SDL_GetAudioStreamFormat(3), SDL_SetAudioStreamFrequencyRatio(3)