ALgetfilled(3dm)ALgetfilled(3dm)NAMEALgetfilled - (obsolete) return the number of filled sample locations in
an audio port
SYNOPSIS
#include <dmedia/audio.h>
long ALgetfilled(ALport port)
PARAMETER
port expects the audio port you want to query. This structure is the
returned value of an ALopenport(3dm) call.
DESCRIPTIONALgetfilled is obsolete and is provided for backward compatibility. The
preferred function is alGetFilled(3dm), which returns the number of
filled sample frames in a port.
ALgetfilled(3dm) returns the number of samples now in the audio port.
How you interpret this number depends on whether port is an input port or
an output port.
For an input port, the return value is the greatest number of samples
that can be read from the port without blocking (waiting for more samples
to come into the port).
For an output port, the return value is the number of samples yet to be
played.
Because the port continues to empty or fill, the number returned by
ALgetfilled(3dm) is an instantaneous measurement of the number of filled
locations. For input ports this number will increase over time as new
samples arrive. For output ports this number will decrease as samples
are played.
In order to insure the best possible performance, ALgetfilled(3dm)
performs no verification of port. You should make certain that port is a
valid ALport structure before passing it as a parameter to
ALgetfilled(3dm).
DIAGNOSTICS
Upon successful completion, ALgetfilled(3dm) will return a non-negative
number.
SEE ALSOALopenport(3dm), ALgetfillable(3dm), ALgetfillpoint(3dm)
Page 1
