1al_play_sample(3)          Library Functions Manual          al_play_sample(3)
2
3
4

NAME

6       al_play_sample
7

SYNOPSIS

9              #include <allegro5/allegro_audio.h>
10
11              bool al_play_sample(ALLEGRO_SAMPLE *spl, float gain, float pan, float speed,
12                 ALLEGRO_PLAYMODE loop, ALLEGRO_SAMPLE_ID *ret_id)
13

DESCRIPTION

15       Plays   a   sample   on   one   of  the  sample  instances  created  by
16       al_reserve_samples(3).  Returns true  on  success,  false  on  failure.
17       Playback  may  fail  because all the reserved sample instances are cur‐
18       rently used.
19
20       Parameters:
21
22       · gain - relative volume at which the sample is played; 1.0 is normal.
23
24       · pan -  0.0  is  centred,  –1.0  is  left,  1.0  is  right,  or  ALLE‐
25         GRO_AUDIO_PAN_NONE.
26
27       · speed - relative speed at which the sample is played; 1.0 is normal.
28
29       · loop - ALLEGRO_PLAYMODE_ONCE, ALLEGRO_PLAYMODE_LOOP, or ALLEGRO_PLAY‐
30         MODE_BIDIR
31
32       · ret_id - if non-NULL the  variable  which  this  points  to  will  be
33         assigned an id representing the sample being played.
34

SEE ALSO

36       ALLEGRO_PLAYMODE(3),  ALLEGRO_AUDIO_PAN_NONE(3),  ALLEGRO_SAMPLE_ID(3),
37       al_stop_sample(3), al_stop_samples(3).
38
39
40
41Allegro reference manual                                     al_play_sample(3)
Impressum