al_play_sample(3)

📦
version 5.2.11.3 · 3 versions
, in arch rolling

okay so this is al_play_sample(3) from the Library Functions Manual — the Allegro 5 API page, bestie. 💅

🎀 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 💖

okay bestie, here's the tea: this plays a sample on one of the sample instances created by al_reserve_samples(3). It returns true on success and false on failure. Playback may fail because all the reserved sample instances are currently used — no cap, that's literally the reason. 😭

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(3) returns false, then the contents of ret_id are invalid and must not be used as an argument to other functions. 🚨

🌈 SEE ALSO 🌈

al_load_sample(3), ALLEGRO_PLAYMODE(3), ALLEGRO_AUDIO_PAN_NONE(3), ALLEGRO_SAMPLE_ID(3), al_stop_sample(3), al_stop_samples(3), al_lock_sample_id(3).

that's the whole page, bestie — straight from the Allegro reference manual, al_play_sample(3). the footer had no date line, so I'm not gonna invent one, okay? 💖🎀✨

📦 where this page comes from
  • arch rolling: allegro 5.2.11.3-2 · Zlib AND BSD-3-Clause AND OFL-1.1 AND LicenseRef-Custom
  • 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms