Fader.FadeOutVolumeCurveSet method |
|
Remarks
Sets the volume curve for fade-out operations.
This setting is lost after invoking the Fader.Exit method so you should call again this method after a new eventual call to the Fader.Init method.
Syntax
[Visual Basic] Public Function FadeOutVolumeCurveSet ( nCurveType as enumVolumeCurves, nDesignerUniqueId as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes FadeOutVolumeCurveSet ( enumVolumeCurves nCurveType, Int32 nDesignerUniqueId ); |
[C++] public: enumErrorCodes FadeOutVolumeCurveSet ( enumVolumeCurves nCurveType, Int32 nDesignerUniqueId ); |
Parameter |
Description |
|||||||||||||||||||||
|
|
|||||||||||||||||||||
nCurveType |
Type of curve applied to the volume sliding. Supported values are the following:
|
|||||||||||||||||||||
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.
This parameter is ignored if the nScaleType parameter above has been set to a value different from VOLUME_CURVE_CUSTOM.
If you don't want to display the custom curve designer on your user interface but you know the exact position of the control points to set, you can use the Fader.FadeOutVolumeCurveSetEx method. |
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. |