alDiscardFrames(3dm)                                      alDiscardFrames(3dm)


NAME
     alDiscardFrames - discard audio from an audio port

SYNOPSIS
     #include <dmedia/audio.h>

     int alDiscardFrames(ALport port, int framecount)

PARAMETER
     port         is the audio port from which you want to discard samples.
                  This is the returned value of an alOpenPort(3dm) call.

     framecount   expects the number of sample frames that you wish to
                  discard.

DESCRIPTION
     alDiscardFrames removes samples from an input or output audio port and
     throws them away. Its behavior differs slightly between input and output
     ports.

     For an input port, alDiscardFrames discards an arbitrary number of sample
     frames. If the given framecount exceeds the number of audio sample frames
     in the port, alDiscardFrames will block until the given number of frames
     have been discarded. It is thus functionally equivalent to calling
     alReadFrames(3dm) and discarding the data, except that alDiscardFrames is
     simpler and more efficient.

     For an output port, alDiscardFrames discards at most as many sample
     frames as are in the port, and returns immediately.

     In either case, the samples are discarded from the end of the audio queue
     closest to the application: on input, the next samples to be read are
     discarded; on output, the most recent samples written are discarded.

DIAGNOSTICS
     Upon successful completion, alDiscardFrames returns the number of frames
     discarded. Otherwise, it returns -1 and sets an error number which can be
     retrieved with oserror(3C).

     alDiscardFrames can fail for the following reasons:

     AL_BAD_PORT            port is invalid.

     AL_BAD_FILLPOINT       framecount is less than zero.

SEE ALSO
     alOpenPort(3dm), alReadFrames(3dm), oserror(3C)


                                                                        Page 1