Copyright © 2006-2018 MultiMedia Soft

GetAutoGainControllerSettings method

Previous pageReturn to chapter overviewNext page

Remarks

 

Gets 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 GetAutoGainControllerSettings (

ByRef nAmplificationTargetLevel as Int16,

ByRef nAmplificationQuietLevel as Int16,

ByRef nAmplificationAdjustmentRate as Int16,

ByRef nAmplificationGain as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes GetAutoGainControllerSettings (

ref Int16 nAmplificationTargetLevel,

ref Int16 nAmplificationQuietLevel,

ref Int16 nAmplificationAdjustmentRate,

ref Int16 nAmplificationGain

);


 

[C++]

public: enumErrorCodes GetAutoGainControllerSettings (

Int16 __gc *nAmplificationTargetLevel,

Int16 __gc *nAmplificationQuietLevel,

Int16 __gc *nAmplificationAdjustmentRate,

Int16 __gc *nAmplificationGain

);


 

 

Parameter

Description

 

 

nAmplificationTargetLevel

Reference that, after returning from the method call, will contain the target volume level, expressed in percentage.

The default value is 92%

nAmplificationQuietLevel

Reference that, after returning from the method call, will contain the quiet volume level, expressed in percentage.

The default value is 3%

nAmplificationAdjustmentRate

Reference that, after returning from the method call, will contain the amplification adjustment rate, expressed in percentage.

The default value is 2%

nAmplificationGain

Reference that, after returning from the method call, will contain the amplification gain level, expressed in percentage.

The default value is 100% which means that the input sound level will not be changed. Higher values (200, 300, 400, etc.) mean that the incoming sound level will be amplified while smaller values mean that the incoming sound level will be attenuated.

 

 

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