AMaxInputGain(3X)

NAME

AMaxInputGain − get the maximum input gain supported by audio controller

SYNOPSIS

#include <Alib.h> AGainDB
AMaxInputGain (

Audio ∗ audio );

DESCRIPTION

AMaxInputGain() gets the maximum input gain, in decibels, supported by the audio controller associated with the audio connection. If the application specifies a gain higher than this, the maximum supported value is used.

audio specifies the Audio structure associated with this connection.

RETURN VALUE

Upon successful completion, AMaxInputGain() returns the maximum input gain, in decibels, that the audio controller supports.

ERRORS

AMaxInputGain() does not return an error status. Note that the application program may crash if audio does not point to a valid Audio structure.

EXAMPLE

The following example gets the maximum input gain supported by the audio controller.

AGainDB max_in; /∗ max input gain ∗/

Audio ∗ audio; /∗ audio connection ∗/
.
.
.

/∗ get max input gain ∗/

max_in = AMaxInputGain(audio);

NOTES

AMaxInputGain() is a convenience function that enables the client program to examine a component of the internal Audio structure that is created by AOpenAudio(). The contents of the structure should be treated as read-only.

In order to ensure that the compiler finds the Audio Library (libAlib.sl) and the Alib.h header file, you must add the following switches:

-L /opt/audio/lib
-I/opt/audio/include

DEPENDENCIES

This function belongs to the Audio Library of functions that manage connections to an audio server. The audio server must run on a system that has audio hardware. To find out whether or not your system has audio hardware, refer to Using the Audio Developer’s Kit or the online help for the Audio control panel. For information about the audio capabilities of a particular system use the online example audioinfo.c.

AUTHOR

AMaxInputGain() was developed by HP.

Museum

Related Articles