.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_load_sample_f" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_load_sample_f - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro_audio.h>

ALLEGRO_SAMPLE *al_load_sample_f(ALLEGRO_FILE* fp, const char *ident)
\f[R]
.fi
.SH DESCRIPTION
.PP
Loads an audio file from an ALLEGRO_FILE(3alleg5) stream into an
ALLEGRO_SAMPLE(3alleg5).
The file type is determined by the passed `ident' parameter, which is a
file name extension including the leading dot.
.PP
Note that this stores the entire file in memory at once, which may be
time consuming.
To read the file as it is needed, use al_load_audio_stream_f(3alleg5) or
al_play_audio_stream_f(3alleg5).
.PP
Returns the sample on success, NULL on failure.
The file remains open afterwards.
.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
.PP
al_register_sample_loader_f(3alleg5), al_init_acodec_addon(3alleg5)