al_attach_sample_instance_to_voice(3)

al_attach_sample_instance_to_voice3

Allegro 5 api

Usage

#include <allegro5/allegro_audio.h>
bool al_attach_sample_instance_to_voice(ALLEGRO_SAMPLE_INSTANCE *spl,
   ALLEGRO_VOICE *voice)

Overview

Attaches a sample instance to a voice, and allows it to play. The instance’s gain and loop mode will be ignored, and it must have the same frequency, channel configuration and depth (including signed-ness) as the voice. This function may fail if the selected driver doesn’t support preloading sample data.

At this time, we don’t recommend attaching sample instances directly to voices. Use a mixer inbetween.

Returns true on success, false on failure.

From allegro 5.2.11.3-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.