al_attach_aud...tream_to_voice(3alleg5)

📦
version 5.2.11.3 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 al_attach_audio_stream_to_voice 💖

okay bestie, so this one lives in the Allegro 5 API (that's 3alleg5, the whole Allegro reference manual vibe) and it's literally called al_attach_audio_stream_to_voice. yes, the whole name, we're saying it out loud. let's get into it 🎀

✨ NAME ✨

al_attach_audio_stream_to_voice — the Allegro 5 API function that glues an audio stream onto a voice 🦋

🌸 SYNOPSIS 🌸

#include <allegro5/allegro_audio.h>

bool al_attach_audio_stream_to_voice(ALLEGRO_AUDIO_STREAM *stream,
   ALLEGRO_VOICE *voice)

💅 DESCRIPTION 💅

So what it does is: it attaches an audio stream to a voice. that's the whole thing. 💫

The same rules as al_attach_sample_instance_to_voice(3alleg5) apply here, so if you've read that one you already know the assignment bestie 📚✨

Heads up though — this may fail if the driver can't create a voice with the buffer count and buffer size that the stream uses. like, that's a real possible outcome, not a maybe-sorta thing. 👀

Now for the part where I have to be a little honest with you, because I love you: an audio stream attached directly to a voice has a number of limitations. read these, they're giving real consequences 😭

  • The audio stream plays immediately and cannot be stopped. no off switch. it's main character and it's not taking notes 🫶
  • The stream position, speed, gain and panning cannot be changed. none of it. locked in fr fr 🔒
At this time, we don't recommend attaching audio streams directly to voices. Use a mixer inbetween. seriously bestie, put a mixer in the middle, it's the move 💀

And the return value: returns true on success, false on failure. simple as that 💖

👑 SEE ALSO 👑

that's the whole page, no notes, you ate it 🌈⭐

okay byeee, this was the Allegro reference manual talking about al_attach_aud...tream_to_voice(3alleg5) — yeah the header truncates it like that, we don't make the rules — so go forth and maybe use a mixer inbetween, k? mwah 💜🧚🍓

📦 where this page comes from