SDL_CreateAudioStream

Create a new audio stream.

Header File

Syntax

SDL_AudioStream * SDL_CreateAudioStream(const SDL_AudioSpec *src_spec, const SDL_AudioSpec *dst_spec);

Function Parameters

const SDL_AudioSpec *	src_spec	the format details of the input audio. May be NULL.
const SDL_AudioSpec *	dst_spec	the format details of the output audio. May be NULL.

Return Value

(SDL_AudioStream *) Returns a new audio stream on success or NULL on failure; call SDL_GetError() for more information.

Remarks

Note that src_spec or dst_spec may be NULL, but any attempts to put or get data from an audio stream will fail until it has valid specs assigned to both ends of the stream. Specs can be assigned later through SDL_SetAudioStreamFormat(), or binding the stream to an audio device (which will set the format of only the input or output, depending on what kind of device the stream was bound to).

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.