SDL_BindAudioStreams(3)

✨ SDL_BindAudioStreams — the girlies are getting bound 💖

okay bestie, welcome to the SDL3 FUNCTIONS</p> corner of the man pages. today's main character is SDL_BindAudioStreams, and she is literally about to marry a whole list of audio streams to one audio device. periodt.

---

🌸 NAME 🌸

SDL_BindAudioStreams — bind a list of audio streams to an audio device. no cap, that's the whole job.

---

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_audio.h>

bool SDL_BindAudioStreams(SDL_AudioDeviceID devid, SDL_AudioStream * const *streams, int num_streams);

like. look at her. three little args and she's changing lives 💅

---

🦋 DESCRIPTION 🦋

so here's the tea, bestie. once streams are bound, audio data will flow through any of them. and it depends on what kind of device you're working with:

• for a playback device, data for all bound streams gets mixed together and fed to the device. it's giving group project but everyone actually shows up. 🔥
• for a recording device, a copy of the recorded data is handed to each bound stream. everyone gets their own lil slice, no fighting. 🍓

also important: audio streams can only be bound to an open device. and this operation is atomic — every stream bound in the same call starts processing at the same time, so they can stay in sync (iykyk, sync is everything). and the atomic thing means: either all streams get bound, or none of them do. it's all or nothing, babe. 💀

⚠️ it is an error to bind an already-bound stream. you must explicitly unbind it first. do not try to double-book her, she will not allow it.

binding a stream to a device will set its output format for playback devices, and its input format for recording devices, so they match the device's settings. but here's the fun part — the caller is totally welcome to change the other end of the stream's format at any time with SDL_SetAudioStreamFormat(). slay, you have options. ✨

and if the other end of the stream's format has never been set (meaning the audio stream was created with a NULL audio spec), this function will set it to match the device end's format. she'll just handle it for you, because she's thoughtful like that. 🫶

---

🌈 FUNCTION PARAMETERS 🌈

• devid — an audio device to bind a stream to. the one, the only, the destination 💖
• streams — an array of audio streams to bind. bring the whole squad.
• num_streams — number streams listed in the streams array. yes bestie, she's counting. 🧮

---

⭐ RETURN VALUE ⭐

returns true on success or false on failure. and if it flops? call SDL_GetError() for more information, she'll tell you what went wrong. no secrets between us. 😭

---

💜 THREAD SAFETY 💜

it is safe to call this function from any thread. go off, queen. run it everywhere. 👑

---

🌟 AVAILABILITY 🌟

this function is available since SDL 3.2.0. so if you're on something older... bestie, upgrade. it's giving ancient. 💅

---

💖 SEE ALSO 💖

• SDL_BindAudioStreams(3) — yes she's linking herself, iconic behavior honestly
• SDL_UnbindAudioStream(3) — the breakup arc, when you need to let her go
• SDL_GetAudioStreamDevice(3) — for when you forgot which device she's bound to 🙈

---

okay that's the whole page, and that's the vibe check passed. 💖 this lil masterpiece comes to you straight from Simple Directmedia Layer, version SDL 3.4.18 — go bind responsibly, bestie, and remember: all streams or none. periodt. 🎀✨🦋🌸🫶