Copyright © 2008-2023 MultiMedia Soft

TracksBoard.ItemVolumePointCurveSetEx method

 Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the volume curve applied on exit from the given volume point to reach the volume of the next volume point. The current volume curve can be obtained through the TracksBoard.ItemVolumePointCurveGet 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]

control.TracksBoard.ItemVolumePointCurveSetEx (

nUniqueId as Long,

nIndex as Long,

nCurveType as enumVolumeCurves,

nLeftX as Integer,

nLeftY as Integer,

nRightX as Integer,

nRightY as Integer,

bAutoRefresh as enumBoolean

) as enumErrorCodes

 

[C++]

short control.TracksBoard.ItemVolumePointCurveSetEx (

long nUniqueId,

long nIndex,

short nCurveType,

short nLeftX,

short nLeftY,

short nRightX,

short nRightY,

short bAutoRefresh

);

 

Parameter

Description

 

 

nUniqueId

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

•TracksBoard.ItemClone when an existing item has been cloned

nIndex

Zero-based index of the volume point. The total number of available volume points can be obtained through the TracksBoard.ItemVolumePointCountGet method.

nCurveType

The type of curve applied to perform the volume fading.

Supported values are the following:

Mnemonic constant

Value

Meaning

 

 

 

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 whose control points are defined inside the nLeftX, nLeftY, nRightX and nRightY parameters.

 

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.

 

nLeftX

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

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

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

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.

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 will be applied through a later call to one between the following methods:

•TracksBoard.ItemVolumePointAmplitudeSet with its bAutoRefresh parameter set to BOOL_TRUE
•TracksBoard.ItemVolumePointPositionSet with its bAutoRefresh parameter set to BOOL_TRUE
•TracksBoard.ItemVolumePointCurveSet with its bAutoRefresh parameter set to BOOL_TRUE
•TracksBoard.ItemVolumePointCurveSetEx with its bAutoRefresh parameter set to BOOL_TRUE

BOOL_TRUE

The modification is applied immediately

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful