Copyright © 2008-2015 MultiMedia Soft

Effects.VolumeAutomationApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies a previously set volume automation procedure to the given song's range.

 

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 defining a volume automation procedure refer to the How to define a volume automation procedure section.

For further details about methods related to the use of special effects refer to the EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function VolumeAutomationApply (

nStartPosition as Int32,

nEndPosition as Int32,

nAffectedChannel as enumChannels

) as enumErrorCodes


 

[C#]

public enumErrorCodes VolumeAutomationApply (

Int32 nStartPosition,

Int32 nEndPosition,

enumChannels nAffectedChannel

);


 

[C++]

public: enumErrorCodes VolumeAutomationApply (

Int32 nStartPosition,

Int32 nEndPosition,

enumChannels nAffectedChannel

);


 

 

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 channel affected by the volume change

Supported values are the following:

Mnemonic constant

Value

Meaning

CHANNELS_BOTH

0

All available channels will be affected

CHANNELS_0 or CHANNELS_LEFT

1

Only channel 0 (front left in a multi-channel) will be affected

CHANNELS_1 or CHANNELS_RIGHT

2

Only channel 1 (front right in a multi-channel) will be affected

CHANNELS_2

3

Only channel 2 will be affected

CHANNELS_3

4

Only channel 3 will be affected

CHANNELS_4

5

Only channel 4 will be affected

CHANNELS_5

6

Only channel 5 will be affected

CHANNELS_6

7

Only channel 6 will be affected

CHANNELS_7

8

Only channel 7 will be affected

 

 

 

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.