SDL_CreateAudioStream - Man Page

Create a new audio stream.

Synopsis

#include <SDL3/SDL_audio.h>

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

Description

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

Function Parameters

src_spec

the format details of the input audio. May be NULL.

dst_spec

the format details of the output audio. May be NULL.

Return Value

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

Thread Safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_PutAudioStreamData(3), SDL_GetAudioStreamData(3), SDL_GetAudioStreamAvailable(3), SDL_FlushAudioStream(3), SDL_ClearAudioStream(3), SDL_SetAudioStreamFormat(3), SDL_DestroyAudioStream(3)

Referenced By

SDL_AudioStream.3type(3), SDL_DestroyAudioStream(3).

SDL 3.4.10 Simple Directmedia Layer SDL3 FUNCTIONS