Copyright © 2008-2018 MultiMedia Soft

Effects.DynamicAmplifierApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies a dynamic amplifier effect to the given audio channels of the sound under editing

 

A successful call to this method will fire the SoundEditStarted event followed by a number of SoundEditPerc events and finally by the SoundEditDone event.

 

For further details about methods related to the use of special effects refer to the Effects COM object.

 

 

Syntax

 

[Visual Basic]

control.Effects.DynamicAmplifierApply (

nStartPosition as Long,

nEndPosition as Long,

nAffectedChannel as enumChannelMasks,

fTarget as Single,

fQuiet as Single,

fRate as Single,

fGain as Single,

fDelay as Single

) as enumErrorCodes


 

[C++]

short control.Effects.DynamicAmplifierApply (

long nStartPosition,

long nEndPosition,

short nAffectedChannel,

float fTarget,

float fQuiet,

float fRate,

float fGain,

float fDelay

);


 

 

Parameter

Description

 

 

nStartPosition

Start position, expressed in milliseconds, of the affected sound range.

nEndPosition

End position, expressed in milliseconds, of the affected sound range.. If set to -1 the end position will be set to the end of the sound.

nAffectedChannel

Numeric value that determines the combination of affected channels.

Supported values are the following:

Mnemonic constant

Value

Meaning

CHANNEL_MASK_0

1 (0x01)

Channel 0 or left channel

CHANNEL_MASK_1

2 (0x02)

Channel 1 or right channel

CHANNEL_MASK_2

4 (0x04)

Channel 2

CHANNEL_MASK_3

8 (0x08)

Channel 3

CHANNEL_MASK_4

16 (0x10)

Channel 4

CHANNEL_MASK_5

32 (0x20)

Channel 5

CHANNEL_MASK_6

64 (0x40)

Channel 6

CHANNEL_MASK_7

128 (0x80)

Channel 7

CHANNEL_MASK_LEFTS

85 (0x55)

All left channels

CHANNEL_MASK_RIGHTS

170 (0xAA)

All right channels

CHANNEL_MASK_ALL

255 (0xFF)

All available channels

fTarget

Numeric value representing the target volume level.

Supported values are up to 1 and can assume negative values.

fQuiet

Quiet volume level.

Supported values are in the range from 0 to 1.

fRate

Amplification adjustment rate.

Supported values are in the range from 0 to 1.

fGain

Amplification level.

Supported values are in the range from 0 to "n" with center value (no gain) at 1.

fDelay

Delay in seconds before increasing level.

Supported values are in the range from 0 to "n"

 

Below some sample:

 

Effect type

fTarget

fQuiet

fRate

fGain

fDelay


 

 

 

 

 

Hard

0.98

0.04

0.02

2.0

0.2

Medium

0.94

0.03

0.01

1.0

0.35

Soft

0.92

0.02

0.01

1.0

0.5

 

 

Return value

 

Value

Meaning

 

 

Negative value

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

enumErrorCodes.NOERROR (0)

The method call was successful.