Classes > VolumeAutomationMan class > Classes > CurveDesignerMan class > Methods > VolumeAutomation.CurveDesigner.GetDisplayCurveType method

Remarks

Obtains the current type of predefined curve on the designer window. The type of predefined curve on the designer window can be modified through the VolumeAutomation.CurveDesigner.SetDisplayCurveType method.

For details about using the Curve Designer refer to the How to create custom volume curves tutorial.

For details about using Volume Automation refer to the How to manage Volume Automation tutorial.

Syntax

[Visual Basic]

Public Function GetDisplayCurveType (

nDesignerUniqueId as Int32,

ByRef nCurveType as enumVolumeCurves,

ByRef bPointsModified as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes GetDisplayCurveType (

Int32 nDesignerUniqueId,

ref enumVolumeCurves nCurveType,

ref bool bPointsModified

);

[C++]

public: enumErrorCodes GetDisplayCurveType (

Int32 nDesignerUniqueId,

enumVolumeCurves __gc *nCurveType,

bool __gc *bPointsModified

);

Parameter

Description

nDesignerUniqueId

Unique identifier of the curve designer returned by a previous call to the VolumeAutomation.CurveDesigner.Create method

nCurveType

Reference that, on return from the method call, will contain the type of displayed curve.

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.

bPointsModified

Reference that, on return from the method call, will contain the boolean value that tells if control points for Bézier curve where modified by the user.

Supported values are the following:

Mnemonic constant	Meaning
false	Control points were not modified or a the VolumeAutomation.CurveDesigner.ResetPoints method was invoked
true	Control points were modified

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.