ALgetfloatmax(3dm)ALgetfloatmax(3dm)NAME
ALgetfloatmax, ALsetfloatmax - (obsolete) get/set the maximum value of
floating point sample data.
SYNOPSIS
#include <dmedia/audio.h>
double ALgetfloatmax(ALconfig config)
int ALsetfloatmax(ALconfig config, double maximum_value)
PARAMETER
config expects an ALconfig structure, the returned value of a
call to ALnewconfig(3dm) or ALgetconfig(3dm).
maximum_value expects an IEEE double precision floating point value
which defines the range of the floating point data for
the ALreadsamps(3dm) or ALwritesamps(3dm) functions.
DESCRIPTION
ALsetfloatmax and ALgetfloatmax are obsolete and provided for backward
compatibility. The preferred functions are alSetFloatMax(3dm) and
alGetFloatMax(3dm).
ALsetfloatmax(3dm) simultaneously sets the upper and lower bounds of the
data read from a port with the ALreadsamps(3dm) function or written with
the ALwritesamps(3dm) function.
The data transferred into a program with ALreadsamps(3dm) will be scaled
to the range (-maximum_value, maximum_value), where the maximum value of
the input data (32767 in the case of 16-bit analog input) will correspond
to maximum_value. Likewise, the value -32768 will correspond to
-maximum_value in this case.
Data output with ALwritesamps(3dm) should fall in the range (-
maximum_value, maximum_value) to avoid limiting.
ALsetfloatmax(3dm) is only meaningful when the sample format for config
is set to AL_SAMPFMT_FLOAT or AL_SAMPFMT_DOUBLE. See ALsetsampfmt(3dm)
for more details regarding setting the sample data format.
ALsetfloatmax(3dm) can fail for the following reasons:
AL_BAD_CONFIG config is invalid or null.
AL_BAD_FLOATMAX maximum_value is zero.
ALgetfloatmax(3dm) returns the current double precision value of the
bounds in ALconfig structure config.
ALgetfloatmax(3dm) can fail for the following reason:
Page 1
ALgetfloatmax(3dm)ALgetfloatmax(3dm)
AL_BAD_CONFIG config is invalid or null.
DIAGNOSTICS
Upon successful completion, ALsetfloatmax(3dm) returns 0. Otherwise,
ALsetfloatmax(3dm) returns -1 and sets an error number which can be
retrieved with oserror(3C).
ALgetfloatmax(3dm) returns 0 in the case of failure and sets an error
number which can be retrieved with oserror(3C). When successful,
ALgetfloatmax(3dm) returns a non-zero value.
SEE ALSOALnewconfig(3dm), ALgetconfig(3dm), ALopenport(3dm), ALsetconfig(3dm),
ALsetsampfmt(3dm), oserror(3C)
Page 2