al_lock_sample_id(3alleg5)

💖 NAME 💖

al_lock_sample_id — the Allegro 5 API girlie that grabs your sample id and hands you the actual instance underneath it 🎀

---

✨ SYNOPSIS ✨

#include <allegro5/allegro_audio.h>

ALLEGRO_SAMPLE_INSTANCE* al_lock_sample_id(ALLEGRO_SAMPLE_ID *spl_id)

---

🌸 DESCRIPTION 🌸

Okay so bestie, listen. al_lock_sample_id locks an ALLEGRO_SAMPLE_ID and gives you back the ALLEGRO_SAMPLE_INSTANCE hiding underneath it. It's giving peek behind the curtain ✨. And why do we care? Because now you can mess with all the properties of that instance — volume, pan, etc. — while the sound is literally playing. Main character mixing energy, no cap 💅.

Heads up though: this function returns NULL if the sound that corresponds to the id is no longer playing. So vibe check that return value, fr fr 😭.

And here's the part that matters, don't skip it 🙈: while it's locked, the ALLEGRO_SAMPLE_ID is unavailable to any additional calls to al_play_sample — even if the sound stops while it's still locked. Like, it's booked and busy, don't come for it. To put that ALLEGRO_SAMPLE_ID back into the pool for reuse, make sure you call al_unlock_sample_id when you're done with the instance. Periodt 🫶.

---

🦋 SEE ALSO 🦋

• al_play_sample(3alleg5)
• al_unlock_sample_id(3alleg5)

---

⭐ SINCE ⭐

5.2.3

[Unstable API]: New API. Baby's brand new, handle with care 🍓

---

Written down in the Allegro reference manual, version al_lock_sample_id(3alleg5) — mwah, slay, go lock responsibly, ily 🧚💜