AGetSystemChannelGain(3X) — Series 700 Only

NAME

AGetSystemChannelGain − get system or monitor audio channel gain

SYNOPSIS

#include <audio/Alib.h>

void AGetSystemChannelGain(

Audio *audio,
ASystemGainType gain_type,
AChType channel,
AGainDB *gain_return,
long *status_return

);

DESCRIPTION

AGetSystemChannelGain() returns the current monitor or system gain.

audio Audio structure associated with this connection.

gain_type Type of operation: ASGTPlay, ASGTRecord, or ASGTMonitor. If this field is set to ASGTMonitor, the channel specification must be ACTMono.

channel Type of channel: ACTMono, ACTLeft, or BR ACTRight . If gain_type is ASGTMonitor, this field must be ACTMono.

gain_return Receives the returned gain value.

status_return Receives the returned status of the operation unless it is set to NULL.

ERRORS

If status_return is not set to NULL, one of the following is returned in status_return.

0 AENoError

2 AEBadAudio

3 AEBadValue

EXAMPLES

The following example gets the system monitor gain:

Audio *audio; /* audio connection */"
ASystemGainType *sgtype; /* type of operation
AChType * chtype; /* type of channel
AGainDB chgain_ret; /* gain value*/"
long status; /* error status */"
.
.
.
/* get monitor gain */
sgtype = ASGTMonitor
chtype = ACTMono
ASetSystemChannelGain(audio, sgtype, chtype, &chgain_ret, &status);

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 the hardware manual that accompanies your system.

AUTHOR

AGetSystemChannelGain() was developed by HP.

Museum

Related Articles