Prosody signal path processing: API: sm_path_agc

Prototype Definition

int sm_path_agc(struct sm_path_agc_parms *agcp)

Parameters

*agcp
a structure of the following type: 
typedef struct sm_path_agc_parms {
	tSMPathId path;						/* in */
	tSM_INT agc;						/* in */
	tSM_INT volume;						/* in */
} SM_PATH_AGC_PARMS;

Description

Configures automatic gain control and fixed volume adjustment on a signal path. The agc parameter controls whether or not automatic gain control is applied to the signal. If agc is non-zero then automatic gain control is applied. The volume adjustment specified is performed after the AGC and has a range of at least -24 to +8 dB. Volume adjustment is always applied, even if AGC is disabled.

Requires the module gainbg.

Fields

path
The signal path to be configured
agc
Indicator of whether automatic gain control is to be enabled (non-zero) or disabled (zero).
volume
The volume adjustment (dBm0).

Returns

0 if call completed successfully, otherwise a standard error such as:

This function is part of the Prosody signal path processing API.