Classes > TracksBoard class > Methods > TracksBoard.ItemVolumePointCurveSet method

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]

Public Function ItemVolumePointCurveSet (

nUniqueId as Int32,

nIndex as Int32,

nCurveType as enumVolumeCurves,

nDesignerUniqueId as Int32,

bAutoRefresh as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes ItemVolumePointCurveSet (

Int32 nUniqueId,

Int32 nIndex,

enumVolumeCurves nCurveType,

Int32 nDesignerUniqueId,

bool bAutoRefresh

);

[C++]

public: enumErrorCodes ItemVolumePointCurveSet (

Int32 nUniqueId,

Int32 nIndex,

enumVolumeCurves nCurveType,

Int32 nDesignerUniqueId,

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.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	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

Type of curve applied to perform the volume fading to the next volume point.

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

•	TracksBoard.ItemVolumePointsApply

•	TracksBoard.ItemVolumePointAmplitudeSet with its bAutoRefresh parameter set to "true"

•	TracksBoard.ItemVolumePointPositionSet with its bAutoRefresh parameter set to "true"

•	TracksBoard.ItemVolumePointCurveSet with its bAutoRefresh parameter set to "true"

•	TracksBoard.ItemVolumePointCurveSetEx with its bAutoRefresh parameter set to "true"

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.