ALgetconfig(3dm)

ALgetconfig, ALsetconfig - (obsolete) get/set the ALconfig structure of an audio ALport structure

Showing IRIX 6.5.30 (default release). Unchanged since IRIX 6.5.

NAME
     ALgetconfig, ALsetconfig - (obsolete) get/set the ALconfig structure of
     an audio ALport structure

SYNOPSIS
     #include <dmedia/audio.h>

     ALconfig ALgetconfig(ALport port)
     int ALsetconfig(ALport port, ALconfig config)

PARAMETER
     port     expects an ALport structure, the returned value of an
              ALopenport(3dm) call.

     config   expects an ALconfig structure, the returned value of a call to
              ALnewconfig(3dm) or ALgetconfig(3dm).

DESCRIPTION
     ALsetconfig and ALgetconfig are obsolete and are provided for backward
     compatibility. The preferred functions are alSetConfig(3dm) and
     alGetConfig(3dm).

     ALgetconfig(3dm) leaves port unchanged, but returns an ALconfig structure
     initialized to the configuration values of the audio port.
     ALfreeconfig(3dm) should be called when the returned ALconfig is no
     longer needed.

     ALgetconfig(3dm) can fail for the following reasons:

     AL_BAD_PORT         port is either invalid or null.

     AL_BAD_OUT_OF_MEM   insufficient memory is available to allocate the
                         ALconfig structure.

     ALsetconfig(3dm) changes the configuration of the audio port, port, to
     match that described by the ALconfig structure, config.

     ALconfig structures contain information which specifies configuration
     options for a port such as queuesize, sample width, and channel setting.

     ALsetconfig(3dm) can fail for the following reasons:

     AL_BAD_PORT       port is either invalid or null.

     AL_BAD_CONFIG     config is either invalid or null.

     AL_BAD_DEVICE     port and config have conflicting device settings.

     AL_BAD_QSIZE      port and config have conflicting values for queue size.
     AL_BAD_CHANNELS   port and config have conflicting channels settings.

DIAGNOSTICS
     When ALgetconfig(3dm) fails, it returns a null-valued ALconfig.

     Upon successful completion, ALsetconfig(3dm) returns 0. Otherwise,
     ALsetconfig(3dm) returns -1 and sets an error number which can be
     retrieved using oserror(3C).

NOTE
     The device, queue size, and the number of channels of a port are static
     attributes; they cannot be changed once a port is opened.
      If you attempt to change any of these values, ALsetconfig(3dm) will
     fail.

SEE ALSO
     ALfreeconfig(3dm), ALnewconfig(3dm), ALsetqueuesize(3dm),
     ALsetwidth(3dm), ALsetchannels(3dm), oserror(3C)