Copyright © 2008-2018 MultiMedia Soft

Effects.VolumeAutomationPointAddNew method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds a new volume point to the volume automation procedure.

 

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 Effects COM object.

 

 

Syntax

 

[Visual Basic]

control.Effects.VolumeAutomationPointAddNew (

fPosition as Single,

fVolumeLevel as Single,

nCurveType as enumVolumeCurves,

nDesignerUniqueId as Long

) as enumErrorCodes


 

[C++]

short control.Effects.VolumeAutomationPointAddNew (

float fPosition,

float fVolumeLevel,

short nCurveType,

long nDesignerUniqueId

);


 

 

Parameter

Description

 

 

fPosition

Position, expressed in the unit set through the Effects.VolumeAutomationSetScales method, where the volume point will be applied

fVolumeLevel

Volume applied starting from the current automation point: the value is expressed in the unit set through the Effects.VolumeAutomationSetScales method.

nCurveType

Type of curve applied to reach the next volume point.

Supported values are the following:

Mnemonic constant

Value

Meaning

 

 

 

VOLUME_CURVE_NONE

0

No curve is applied: volume will be changed immediately and will be kept till next volume point.

VOLUME_CURVE_LINEAR

1

Linear curve

VOLUME_CURVE_EXPONENTIAL

2

Exponential curve

VOLUME_CURVE_COSINE

3

Cosine curve

VOLUME_CURVE_SMOOTH

4

Smooth curve

VOLUME_CURVE_CUSTOM

5

Custom Bézier curve.

nDesignerUniqueId

Unique identifier of the curve editor control containing custom curve settings to apply. This unique identifier is returned by a previous call to the Effects.CurveDesigner.Create method.

 

The custom curve designer manages a windowed control, whose visual aspect can be defined programmatically, which allows designing volume curves based upon Bézier curves whose shape is defined through the manual positioning of 2 control points (displayed in cyan color on the graphic below). For further information about the use of the embedded CurveDesigner refer to the tutorial How to create custom volume curves.

 

 

 

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.