alGetFilled(3dm)alGetFilled(3dm)NAMEalGetFilled - return the number of filled sample frames in an audio port
SYNOPSIS
#include <dmedia/audio.h>
int 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 returns the number of sample frames of audio 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 sample
frames 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 sample frames yet
to be played.
Because the port may continue to empty or fill, the number returned by
alGetFilled 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 performs no
verification of port. You should make certain that port is a valid ALport
structure before passing it as a parameter to alGetFilled.
DIAGNOSTICS
Upon successful completion, alGetFilled will return a non-negative
number.
SEE ALSOalOpenPort(3dm), alGetFillable(3dm), alGetFillPoint(3dm)
Page 1