Classes > TracksBoard class > Methods > TracksBoard.ItemVolumeFadingSet method

Remarks

Modifies parameters of the requested volume fading that will be applied to the given item.

The volume fading implemented by this method applies to the beginning (fade-in) or to the end (fade-out) of the sound file's audio stream and only for sound files items (doesn't apply to Text-To-Speech items).

Current parameters of a specific volume fading can be obtained through the TracksBoard.ItemVolumeFadingGet method.

A specific volume fading can be removed through the TracksBoard.ItemVolumeFadingRemove method.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

Syntax

[Visual Basic]

Public Function ItemVolumeFadingSet (

nUniqueId as Int32,

bFadeIn as Boolean,

nFadeLengthMs as Int32,

nCurveType as enumVolumeCurves,

nDesignerUniqueId as Int32,

bAutoRefresh as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes ItemVolumeFadingSet (

Int32 nUniqueId,

bool bFadeIn,

Int32 nFadeLengthMs,

enumVolumeCurves nCurveType,

Int32nDesignerUniqueId,

bool bAutoRefresh

);

[C++]

public: enumErrorCodes ItemVolumeFadingSet (

Int32 nUniqueId,

bool bFadeIn,

Int32 nFadeLengthMs,

enumVolumeCurves nCurveType,

Int32nDesignerUniqueId,

bool bAutoRefresh

);

Parameter

Description

nUniqueId

Unique identification number assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileRawAdd for sound files

•	TracksBoard.ItemClone when an existing sound file item has been cloned

bFadeIn

Boolean value specifying if the fading is a fade-in or a fade-out.

Supported values are the following:

Mnemonic Value	Meaning
BOOL_FALSE	This is a fade-out
BOOL_TRUE	This is a fade-in

nFadeLengthMs

Length of the fade expressed in milliseconds

nCurveType

Type of curve applied to perform the volume fading..

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 controlled by the CurveDesigner specified inside the nDesignerUniqueId parameter.

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.

bAutoRefresh

Boolean value indicating if the modification should be applied immediately.

Supported values are the following:

Value	Meaning
BOOL_FALSE	The modification is not applied immediately and waits for the call to the TracksBoard.ItemCompose method
BOOL_TRUE	The modification is applied immediately

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.