1al_play_sample(3)                                            al_play_sample(3)
2
3
4

NAME

6       al_play_sample - Allegro 5 API
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 al_re‐
16       serve_samples(3).  Returns true on success, false on failure.  Playback
17       may fail because all the reserved sample instances are currently used.
18
19       Parameters:
20
21       • gain - relative volume at which the sample is played; 1.0 is normal.
22
23       • pan  -  0.0  is  centred,  -1.0 is left, 1.0 is right, or ALLEGRO_AU‐
24         DIO_PAN_NONE.
25
26       • speed - relative speed at which the sample is played; 1.0 is normal.
27
28       • loop - ALLEGRO_PLAYMODE_ONCE, ALLEGRO_PLAYMODE_LOOP, or ALLEGRO_PLAY‐
29         MODE_BIDIR
30
31       • ret_id  -  if  non-NULL the variable which this points to will be as‐
32         signed an id representing the sample being played.   If  al_play_sam‐
33         ple(3)  returns  false,  then  the contents of ret_id are invalid and
34         must not be used as argument to other functions.
35

SEE ALSO

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