al_play_audio_stream - Man Page

Allegro 5 API

Synopsis

#include <allegro5/allegro_audio.h>

ALLEGRO_AUDIO_STREAM *al_play_audio_stream(const char *filename)

Description

Loads and plays an audio file, streaming from disk as it is needed. This API can only play one audio stream at a time. This requires a default mixer to be set, which is typically done via al_reserve_samples(3), but can also be done via al_set_default_mixer(3).

Returns the stream on success, NULL on failure. You must not destroy the returned stream, it will be automatically destroyed when the addon is shut down.

Note: the allegro_audio library does not support any audio file formats by default. You must use the allegro_acodec addon, or register your own format handler.

See Also

al_play_audio_stream_f(3), al_load_audio_stream(3)

Since

5.2.8

[Unstable API]: New API.

Referenced By

al_get_audio_stream_length_secs(3), al_get_audio_stream_position_secs(3), ALLEGRO_AUDIO_STREAM(3), al_load_sample(3), al_play_audio_stream_f(3), al_register_audio_stream_loader(3), al_rewind_audio_stream(3), al_seek_audio_stream_secs(3), al_set_audio_stream_loop_secs(3).

Allegro reference manual