al_attach_...e_to_voice(3)

💖 NAME 💖

okay so this is al_attach_...e_to_voice(3) from the Library Functions Manual — an Allegro 5 API page, and the function is al_attach_sample_instance_to_voice (say that five times fast, bestie 😭).

• al_attach_sample_instance_to_voice — the Allegro 5 API function. yes, the whole name is a mouthful and we love that for it 💅

---

✨ SYNOPSIS ✨

first, the include, bestie:

#include <allegro5/allegro_audio.h>

and here’s the signature, exactly:

bool al_attach_sample_instance_to_voice(ALLEGRO_SAMPLE_INSTANCE *spl,
   ALLEGRO_VOICE *voice)

---

🌸 DESCRIPTION 🌸

okay so what does it do? It attaches a sample instance to a voice, and that lets it play. cute! 🎀

but here’s the catch, bestie: the instance’s gain and loop mode will be ignored, and it must have the same frequency, channel configuration and depth (including signed-ness) as the voice. like, they have to match match, no cap 👑

This function may fail if the selected driver doesn’t support preloading sample data. so if it flops, that might be why 👀

At this time, we don’t recommend attaching sample instances directly to voices. Use a mixer inbetween. this is the official vibe check, bestie — mixer inbetween is the move 🧚

Returns true on success, false on failure. that’s it. that’s the return value. 💅

---

🦋 SEE ALSO 🦋

go check these out too, iykyk:

• al_detach_voice(3)
• al_voice_has_attachments(3)

---

source/version: Allegro reference manual; page: al_attach_...e_to_voice(3). date: not listed on this page, so no imaginary date bestie 🫶 byeee 💖