Copyright © 2006-2018 MultiMedia Soft

SetAutoGainControllerSettings method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the current Automatic Gain Controller settings.

 

For further information about the use of the the Automatic Gain Controller refer to the How to use the automatic gain controller section.

 

 

Syntax

 

[Visual Basic]

Public Function SetAutoGainControllerSettings (

nAmplificationTargetLevel as Int16,

nAmplificationQuietLevel as Int16,

nAmplificationAdjustmentRate as Int16,

nAmplificationGain as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes SetAutoGainControllerSettings (

Int16 nAmplificationTargetLevel,

Int16 nAmplificationQuietLevel,

Int16 nAmplificationAdjustmentRate,

Int16 nAmplificationGain

);


 

[C++]

public: enumErrorCodes SetAutoGainControllerSettings (

Int16 nAmplificationTargetLevel,

Int16 nAmplificationQuietLevel,

Int16 nAmplificationAdjustmentRate,

Int16 nAmplificationGain

);


 

 

Parameter

Description

 

 

nAmplificationTargetLevel

The target volume level, expressed in percentage.

The default value is 92%

nAmplificationQuietLevel

The quiet volume level, expressed in percentage.

The default value is 3%

nAmplificationAdjustmentRate

The amplification adjustment rate, expressed in percentage.

The default value is 2%

nAmplificationGain

The amplification gain level, expressed in percentage.

The default value is 100% which means that the input sound level will not be changed: Setting higher values (200, 300, 400, etc.) will amplify the incoming sound level while setting smaller values will attenuate the incoming sound level.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful