.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "al_lock_sample_id" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_lock_sample_id \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

ALLEGRO_SAMPLE_INSTANCE*\ al_lock_sample_id(ALLEGRO_SAMPLE_ID\ *spl_id)
\f[]
.fi
.SH DESCRIPTION
.PP
Locks a ALLEGRO_SAMPLE_ID(3alleg5), returning the underlying
ALLEGRO_SAMPLE_INSTANCE(3alleg5).
This allows you to adjust the various properties of the instance (such
as volume, pan, etc) while the sound is playing.
.PP
This function will return \f[C]NULL\f[] if the sound corresponding to
the id is no longer playing.
.PP
While locked, \f[C]ALLEGRO_SAMPLE_ID\f[] will be unavailable to
additional calls to al_play_sample(3alleg5), even if the sound stops
while locked.
To put the \f[C]ALLEGRO_SAMPLE_ID\f[] back into the pool for reuse, make
sure to call \f[C]al_unlock_sample_id\f[] when you're done with the
instance.
.SH SEE ALSO
.PP
al_play_sample(3alleg5), al_unlock_sample_id(3alleg5)
.SH SINCE
.PP
5.2.3
.RS
.PP
\f[I][Unstable API]:\f[] New API.
.RE