---
name: "al_play_sample"
section: "3alleg5"
platform: "linux"
package: "allegro5-doc"
version: "2:5.2.10.1+dfsg-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/al_play_sample/3alleg5"
---

# al\_play\_sample(3alleg5)

Allegro 5 API

## NAME

al\_play\_sample - Allegro 5 API

## SYNOPSIS

-

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

## DESCRIPTION

Plays a sample on one of the sample instances created by al\_reserve\_samples(3alleg5). Returns true on success, false on failure. Playback may fail because all the reserved sample instances are currently used.

Parameters:

- •

  gain - relative volume at which the sample is played; 1.0 is normal.

- •

  pan - 0.0 is centred, -1.0 is left, 1.0 is right, or ALLEGRO\_AUDIO\_PAN\_NONE.

- •

  speed - relative speed at which the sample is played; 1.0 is normal.

- •

  loop - ALLEGRO\_PLAYMODE\_ONCE, ALLEGRO\_PLAYMODE\_LOOP, or ALLEGRO\_PLAYMODE\_BIDIR

- •

  ret\_id - if non-NULL the variable which this points to will be assigned an id representing the sample being played. If al\_play\_sample(3alleg5) returns `false`, then the contents of ret\_id are invalid and must not be used as argument to other functions.

## SEE ALSO

al\_load\_sample(3alleg5), ALLEGRO\_PLAYMODE(3alleg5), ALLEGRO\_AUDIO\_PAN\_NONE(3alleg5), ALLEGRO\_SAMPLE\_ID(3alleg5), al\_stop\_sample(3alleg5), al\_stop\_samples(3alleg5), al\_lock\_sample\_id(3alleg5).