SDL_BindAudioStream

Bind a single audio stream to an audio device.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

bool SDL_BindAudioStream(SDL_AudioDeviceID devid, SDL_AudioStream *stream);

Function Parameters

SDL_AudioDeviceID devid an audio device to bind a stream to.
SDL_AudioStream * stream an audio stream to bind to a device.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This is a convenience function, equivalent to calling SDL_BindAudioStreams(devid, &stream, 1).

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryAudio