ALgetsampfmt(3dm)ALgetsampfmt(3dm)NAME
ALgetsampfmt, ALsetsampfmt - (obsolete) get/set the sample format setting
in an audio ALconfig structure
SYNOPSIS
#include <dmedia/audio.h>
long ALgetsampfmt(ALconfig config)
int ALsetsampfmt(ALconfig config, long sampleformat)
PARAMETER
config expects an ALconfig structure, the returned value of a
call to ALnewconfig(3dm) or ALgetconfig(3dm).
sampleformat expects a symbolic constant that identifies the format of
an audio sample. There are three symbolic constants
defined for this parameter.
DESCRIPTIONALsetsampfmt and ALgetsampfmt are obsolete and are provided for backward
compatibility. The preferred functions are alSetSampFmt(3dm) and
alGetSampFmt(3dm).
ALsetsampfmt(3dm) sets the sample format in the ALconfig structure
config. Any audio port that you then configure using config will have
the audio sample format you specify with sampleformat.
ALgetsampfmt(3dm) returns the current sample format setting in the
ALconfig structure config.
The currently defined set of sample formats found in audio.h are:
AL_SAMPFMT_TWOSCOMP
indicates linear PCM two's complement integer sample
format. Width of the integer data is one of signed char,
short, or long as specified by the ALsetwidth(3dm)
function.
AL_SAMPFMT_FLOAT
indicates linear PCM IEEE 32-bit floating point
sample format.
AL_SAMPFMT_DOUBLE
indicates linear PCM IEEE 64-bit floating
point sample format.
ALsetsampfmt(3dm) can fail for the following reasons:
AL_BAD_CONFIG config is invalid or null.
AL_BAD_SAMPFMT sampleformat is not one of the accepted constants.
Page 1
ALgetsampfmt(3dm)ALgetsampfmt(3dm)ALgetsampfmt(3dm) can fail for the following reason:
AL_BAD_CONFIG config is invalid or null.
DIAGNOSTICS
Upon successful completion, ALgetsampfmt(3dm) returns a long whose value
is the same as one of the symbolic constants described above for
sampleformat. Otherwise, ALgetsampfmt(3dm) returns -1 and sets an error
number which can be retrieved with oserror(3C).
Upon successful completion, ALsetsampfmt(3dm) returns 0. Otherwise, -1 is
returned and an error number is set as described above.
SEE ALSOALnewconfig(3dm), ALgetconfig(3dm), ALopenport(3dm), ALsetconfig(3dm),
ALsetfloatmax(3dm), ALgetfloatmax(3dm), oserror(3C)
Page 2
