al_get_aud...m_fragment(3)

👑 NAME 👑

al_get_audio_stream_fragment — the Allegro 5 API function that hands you a fresh buffer to fill, bestie 💅 (this page lives in the Allegro reference manual, and heads up, its short name is literally al_get_aud...m_fragment, iconic truncation ✨)

---

🌸 SYNOPSIS 🌸

#include <allegro5/allegro_audio.h>

void *al_get_audio_stream_fragment(const ALLEGRO_AUDIO_STREAM *stream)

---

🦋 DESCRIPTION 🦋

okay so — when you're doing Allegro's audio streaming, this function is the one you'll be calling over and over to keep feeding new sample data into a stream. Like, continuously. It's giving "refill the snack bowl" energy 🍓

If the stream is ready for new data, it returns the address of an internal buffer that you fill up with audio data. The length and format of that buffer are set by al_create_audio_stream(3), or you can query them with the various functions described here. Once you've filled the buffer, you must signal that back to Allegro by passing the buffer to al_set_audio_stream_fragment(3) 🫶

If the stream is not ready for new data, it just returns NULL. no drama, no buffer, just NULL 😭

Note: if you listen to events from the stream, an ALLEGRO_EVENT_AUDIO_STREAM_FRAGMENT(3) event gets generated whenever a new fragment is ready. BUT — and this is the part people miss — getting that event is not a guarantee that al_get_audio_stream_fragment(3) won't return NULL, so you still have to check for it. fr fr, always check 💀

---

⭐ SEE ALSO ⭐

• al_set_audio_stream_fragment(3)
• al_get_audio_stream_event_source(3)
• al_get_audio_stream_frequency(3)
• al_get_audio_stream_channels(3)
• al_get_audio_stream_depth(3)
• al_get_audio_stream_length(3)

---

that's the whole page, bestie 🎀 go forth and fill your buffers 💖 — with love from the Allegro reference manual 👑