1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
.TH "al_load_audio_stream" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_load_audio_stream \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>
ALLEGRO_AUDIO_STREAM\ *al_load_audio_stream(const\ char\ *filename,
\ \ \ size_t\ buffer_count,\ unsigned\ int\ samples)
\f[]
.fi
.SH DESCRIPTION
.PP
Loads an audio file from disk as it is needed.
.PP
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 \f[I]buffer_count\f[] buffers with
\f[I]samples\f[] samples.
.PP
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.
.PP
Returns the stream on success, NULL on failure.
.RS
.PP
\f[I]Note:\f[] 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
.PP
al_load_audio_stream_f(3), al_register_audio_stream_loader(3),
al_init_acodec_addon(3)
|
