Classes > TracksBoard class > Methods > TracksBoard.ItemVolumeFadingGet method

Remarks

Obtains parameters of the requested volume fading applied to the given item. The volume fading can be added or modified through the TracksBoard.ItemVolumeFadingSet or TracksBoard.ItemVolumeFadingSetEx 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 ItemVolumeFadingGet (

nUniqueId as Int32,

bFadeIn as Boolean,

ByRef nFadeLengthMs as Int32,

ByRef nCurveType as enumVolumeCurves,

ByRef nLeftX as Int32,

ByRef nLeftY as Int32,

ByRef nRightX as Int32,

ByRef nRightY as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemVolumeFadingGet (

Int32 nUniqueId,

bool bFadeIn,

ref Int32 nFadeLengthMs,

ref enumVolumeCurves nCurveType,

ref Int32 nLeftX,

ref Int32 nLeftY,

ref Int32 nRightX,

ref Int32 nRightY

);

[C++]

public: enumErrorCodes ItemVolumeFadingGet (

Int32 nUniqueId,

bool bFadeIn,

Int32 __gc *nFadeLengthMs,

enumVolumeCurves __gc *nCurveType,

Int32 __gc *nLeftX,

Int32 __gc *nLeftY,

Int32 __gc *nRightX,

Int32 __gc *nRightY

);

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

Reference that, on return from the method call, will contain the length of the fade expressed in milliseconds

nCurveType

Reference that, on return from the method call, will contain the 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. 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 class refer to the tutorial How to create custom volume curves.

nLeftX

Reference that, on return from the method call, will contain the horizontal position, expressed in percentage, of the left control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

nLeftY

Reference that, on return from the method call, will contain the vertical position, expressed in percentage, of the left control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

nRightX

Reference that, on return from the method call, will contain the horizontal position, expressed in percentage, of the right control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

nRightY

Reference that, on return from the method call, will contain the vertical position, expressed in percentage, of the right control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

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.