al_attach_sample_instance_to_voice man page

al_attach_sample_instance_to_voice — Allegro 5 API

Synopsis

#include <allegro5/allegro_audio.h>

bool al_attach_sample_instance_to_voice(ALLEGRO_SAMPLE_INSTANCE *spl,
   ALLEGRO_VOICE *voice)

Description

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.

See Also

al_detach_voice(3)

Referenced By

al_attach_audio_stream_to_voice(3), al_detach_sample_instance(3), al_detach_voice(3), al_get_sample_instance_attached(3).

Allegro reference manual