al_load_audio_stream(3)

NAME 💖 — al_load_audio_stream(3)

Okay bestie, we're in the Library Functions Manual and this is the Allegro 5 API page for al_load_audio_stream. The NAME line is al_load_audio_stream - Allegro 5 API, and it's giving "audio stream loading, but make it Allegro." 💅✨

SYNOPSIS 📜

#include <allegro5/allegro_audio.h>

ALLEGRO_AUDIO_STREAM *al_load_audio_stream(const char *filename,
   size_t buffer_count, unsigned int samples)

DESCRIPTION 🌸

Okay so picture this: you need an audio file from disk, loaded as it is needed. That is exactly what al_load_audio_stream does. 💖

Unlike regular streams, the one returned by this function need not be fed by the user; the library will automatically read more of the file as it is needed. The stream will contain buffer_count buffers with samples samples. Those are literally the args, so yes, they matter, bestie. 🎀

The audio stream will start in the playing state. It should be attached to a voice or mixer to generate any output. See ALLEGRO_AUDIO_STREAM(3) for more details. 🦋

Returns the stream on success, NULL on failure. That's the return tea, no cap. 🔥

⚠️ Note: the allegro_audio library does not support any audio file formats by default. You must use the allegro_acodec addon, or register your own format handler. Like, this note is important, bestie — do not skip it. 😭

SEE ALSO 🔗

• al_load_audio_stream_f(3)
• al_register_audio_stream_loader(3)
• al_init_acodec_addon(3)

---

Source/version sign-off 🫶: this page is from the Allegro reference manual, under the Library Functions Manual name, and the original footer just repeats al_load_audio_stream(3) — no date is shown, so no date to spill. Bye bestie, go attach that stream to a voice or mixer and slay. 💖✨