.\" Automatically generated by Pandoc 3.6.1
.\"
.TH "al_play_audio_stream" "3" "" "Allegro reference manual"
.SH NAME
al_play_audio_stream \- Allegro 5 API
.SH SYNOPSIS
.IP
.EX
#include \f[B]<allegro5/allegro_audio.h>\f[R]

ALLEGRO_AUDIO_STREAM *al_play_audio_stream(const char *filename)
.EE
.SH DESCRIPTION
Loads and plays an audio file, streaming from disk as it is needed.
This API can only play one audio stream at a time.
This requires a default mixer to be set, which is typically done via
al_reserve_samples(3), but can also be done via al_set_default_mixer(3).
.PP
Returns the stream on success, NULL on failure.
You must not destroy the returned stream, it will be automatically
destroyed when the addon is shut down.
.RS
.PP
\f[I]Note:\f[R] 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.
.RE
.SH SEE ALSO
al_play_audio_stream_f(3), al_load_audio_stream(3)
.SH SINCE
5.2.8
.RS
.PP
\f[I][Unstable API]:\f[R] New API.
.RE