Copyright © 2008-2019 MultiMedia Soft

Effects.FreeverbApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies a specific reverberation effect to the given portion of sound under editing.

 

Reverb adds reverberation (rapid, modified repetitions blended with the original sound that gives an impression of ambience). The Reverb effect is based on the original "freeverb" algorithm. Adding reverberation is sometimes desirable for concert halls that are too small or contain so many people that the hall's natural reverberance is diminished. Applying a small amount of stereo reverb to an untreated mono signal duplicated into a two-channel stereo track will usually make it sound more natural.

 

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 EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function FreeverbApply (

nStartPosition as Int32,

nEndPosition as Int32,

nAffectedChannel as enumChannelMasks,

fDryMix as Single,

fWetMix as Single,

fRoomSize as Single,

fDamp as Single,

fWidth as Single,

nReserved as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes FreeverbApply (

Int32 nStartPosition,

Int32 nEndPosition,

enumChannelMasks nAffectedChannel,

float fDryMix,

float fWetMix,

float fRoomSize,

float fDamp,

float fWidth,

Int32 nReserved

);


 

[C++]

public: enumErrorCodes FreeverbApply (

Int32 nStartPosition,

Int32 nEndPosition,

enumChannelMasks nAffectedChannel,

float fDryMix,

float fWetMix,

float fRoomSize,

float fDamp,

float fWidth,

Int32 nReserved

);


 

 

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

fDryMix

Numeric value representing the Dry (unaffected) signal mix.

Supported values are in the range from 0 to 1. The default value is 0.

fWetMix

Numeric value representing the Wet (affected) signal mix.

Supported values are in the range from 0 to 3. The default value is 1.0.

fRoomSize

Numeric value representing the room size.

Supported values are in the range from 0 to 1. The default value is 0.5.

fDamp

Numeric value representing the damping.

Supported values are in the range from 0 to 1. The default value is 0.5.

fWidth

Numeric value representing the stereo width.

Supported values are in the range from 0 to 1. The default value is 1.0.

nReserved

Reserved for future uses should be set to 0.

 

 

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.