Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
al_load_audio_stream_f(3)  Library Functions Manual  al_load_audio_stream_f(3)

NAME
       al_load_audio_stream_f -	Allegro	5 API

SYNOPSIS
	      #include <allegro5/allegro_audio.h>

	      ALLEGRO_AUDIO_STREAM *al_load_audio_stream_f(ALLEGRO_FILE* fp, const char	*ident,
		 size_t	buffer_count, unsigned int samples)

DESCRIPTION
       Loads an	audio file from	ALLEGRO_FILE(3)	stream as it is	needed.

       Unlike  regular	streams, the one returned by this function need	not be
       fed by the user;	the library will automatically read more of  the  file
       as  it  is  needed.   The stream	will contain buffer_count buffers with
       samples samples.

       The file	type is	determined by the passed `ident' parameter, which is a
       file name extension including the leading dot.

       The audio stream	will start in the playing state.   It  should  be  at-
       tached  to  a  voice  or	mixer to generate any output.  See ALLEGRO_AU-
       DIO_STREAM(3) for more details.

       Returns the stream on success, NULL on failure.	On  success  the  file
       should be considered owned by the audio stream, and will	be closed when
       the audio stream	is destroyed.  On failure the file will	be closed.

	      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_load_audio_stream(3),		 al_register_audio_stream_loader_f(3),
       al_init_acodec_addon(3)

Allegro	reference manual			     al_load_audio_stream_f(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=al_load_audio_stream_f&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help