Provided by: allegro5-doc_5.2.3.0-1_all bug

NAME

       al_get_audio_stream_fragment - Allegro 5 API

SYNOPSIS

              #include <allegro5/allegro_audio.h>

              void *al_get_audio_stream_fragment(const ALLEGRO_AUDIO_STREAM *stream)

DESCRIPTION

       When  using Allegro's audio streaming, you will use this function to continuously provide new sample data
       to a stream.

       If the stream is ready for new data, the function will return the address of an  internal  buffer  to  be
       filled   with   audio   data.    The   length   and   format   of   the   buffer   are   specified   with
       al_create_audio_stream(3alleg5) or can be queried with the various functions described  here.   Once  the
       buffer    is    filled,    you    must    signal   this   to   Allegro   by   passing   the   buffer   to
       al_set_audio_stream_fragment(3alleg5).

       If the stream is not ready for new data, the function will return NULL.

              Note: If you listen to events from  the  stream,  an  ALLEGRO_EVENT_AUDIO_STREAM_FRAGMENT(3alleg5)
              event  will  be  generated  whenever  a new fragment is ready.  However, getting an event is not a
              guarantee that al_get_audio_stream_fragment(3alleg5) will not return NULL, so you still must check
              for it.

SEE ALSO

       al_set_audio_stream_fragment(3alleg5),                         al_get_audio_stream_event_source(3alleg5),
       al_get_audio_stream_frequency(3alleg5),                            al_get_audio_stream_channels(3alleg5),
       al_get_audio_stream_depth(3alleg5), al_get_audio_stream_length(3alleg5)