1ALLEGRO_SAMPLE_INSTANCE(3)                          ALLEGRO_SAMPLE_INSTANCE(3)
2
3
4

NAME

6       ALLEGRO_SAMPLE_INSTANCE - Allegro 5 API
7

SYNOPSIS

9              #include <allegro5/allegro_audio.h>
10
11              typedef struct ALLEGRO_SAMPLE_INSTANCE ALLEGRO_SAMPLE_INSTANCE;
12

DESCRIPTION

14       An  ALLEGRO_SAMPLE_INSTANCE  object represents a playable instance of a
15       predefined sound effect.  It holds information  about  how  the  effect
16       should  be  played:  These  playback  parameters consist of the looping
17       mode, loop start/end points, playing position, speed, gain, pan and the
18       playmode.   Whether a sample instance is currently playing or paused is
19       also one of its properties.
20
21       An instance uses the data from an ALLEGRO_SAMPLE(3)  object.   Multiple
22       instances may be created from the same ALLEGRO_SAMPLE.  An ALLEGRO_SAM‐
23       PLE must not be destroyed while there are instances which reference it.
24
25       To actually produce audio output, an  ALLEGRO_SAMPLE_INSTANCE  must  be
26       attached  to  an  ALLEGRO_MIXER(3)  which  eventually  reaches an ALLE‐
27       GRO_VOICE(3) object.
28

SEE ALSO

30       ALLEGRO_SAMPLE(3)
31
32
33
34Allegro reference manual                            ALLEGRO_SAMPLE_INSTANCE(3)
Impressum