AGMGainRestricted(3X)

NAME

AGMGainRestricted − find out if the audio controller restricts gain entries in gain matrix structures

SYNOPSIS

#include <Alib.h> Bool
AGMGainRestricted (

Audio ∗ audio );

DESCRIPTION

audio specifies the Audio structure associated with this connection.

RETURN VALUE

Upon succesful completion, AGMGainRestricted() returns TRUE if the audio controller restricts gain entries to AUnityGain or AZeroGain. The function returns FALSE if other values can be used for gain entries in gain matrix structures.

ERRORS

AGMGainRestricted() 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 queries the audio controller to see if gain entries are restricted.

Boolean restricted; /∗ gain restricted ∗/

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

/∗ find out if gain values are restricted ∗/

restricted = AGMGainRestricted(audio);

NOTES

AGMGainRestricted() 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

AGMGainRestricted() was developed by HP.

Museum

Related Articles