Classes > TracksBoard class > Methods > TracksBoard.ItemVolumePointCurveGet method

Remarks

Obtains the volume curve applied on exit from the given volume point to reach the volume of the next volume point. The volume curve can be modified through the TracksBoard.ItemVolumePointCurveSet or the TracksBoard.ItemVolumePointCurveSetEx methods.

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 ItemVolumePointCurveGet (

nUniqueId as Int32,

nIndex 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 ItemVolumePointCurveGet (

Int32 nUniqueId,

Int32 nIndex,

ref enumVolumeCurves nCurveType,

ref Int32 nLeftX,

ref Int32 nLeftY,

ref Int32 nRightX,

ref Int32 nRightY

);

[C++]

public: enumErrorCodes ItemVolumePointCurveGet (

Int32 nUniqueId,

Int32 nIndex,

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

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 whose control points are returned 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

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.