Copyright © 2001-2018 MultiMedia Soft

Fader.FadeOutVolumeCurveSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the volume curve for fade-out operations.

 

This setting is lost after invoking the Fader.Exit method so you should call again this method after a new eventual call to the Fader.Init method.

 

 

Syntax

 

[Visual Basic]

control.Fader.FadeOutVolumeCurveSet (

nCurveType as enumVolumeCurves,

nDesignerUniqueId as Long

) as enumErrorCodes


 

[C++]

short control.Fader.FadeOutVolumeCurveSet (

short nCurveType,

long nDesignerUniqueId

);


 

 

Parameter

Description

 

 

nCurveType

Type of curve applied to the volume sliding.

Supported values are the following:

Mnemonic constant

Value

Meaning

 

 

 

VOLUME_CURVE_LINEAR

1

Linear curve

amp3dj_i000090

VOLUME_CURVE_EXPONENTIAL

2

Exponential curve

amp3dj_i000091

VOLUME_CURVE_COSINE

3

Cosine curve

amp3dj_i000092

VOLUME_CURVE_SMOOTH

4

Smooth curve

amp3dj_i000093

VOLUME_CURVE_CUSTOM

5

Custom Bézier curve.

amp3dj_i000094

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 VolumeAutomation.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.

 

amp3dj_i00009a

 

This parameter is ignored if the nScaleType parameter above has been set to a value different from VOLUME_CURVE_CUSTOM.

 

If you don't want to display the custom curve designer on your user interface but you know the exact position of the control points to set, you can use the Fader.FadeOutVolumeCurveSetEx method.

 

 

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.