---
name: "ALLEGRO_SAMPLE_ID"
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/ALLEGRO_SAMPLE_ID/3alleg5"
---

# ALLEGRO\_SAMPLE\_ID(3alleg5)

Allegro 5 API

## NAME

ALLEGRO\_SAMPLE\_ID - Allegro 5 API

## SYNOPSIS

-

  ```
  #include <allegro5/allegro_audio.h>
  typedef struct ALLEGRO_SAMPLE_ID ALLEGRO_SAMPLE_ID;
  ```

## DESCRIPTION

An ALLEGRO\_SAMPLE\_ID represents a sample being played via al\_play\_sample(3alleg5). It can be used to later stop the sample with al\_stop\_sample(3alleg5). The underlying ALLEGRO\_SAMPLE\_INSTANCE can be extracted using al\_lock\_sample\_id(3alleg5).