Copyright © 2001-2018 MultiMedia Soft

VolumeAutomation.PointSetParams method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies parameters for the given existing volume point.

Modifications won't be immediately applied if loaded sound should be already playing and will take effect only after completing/stopping and restarting the playback session.

 

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

 

 

Syntax

 

[Visual Basic]

control.VolumeAutomation.PointSetParams (

nPlayer as Integer,

strVolumePointName as String,

fPosition as Single,

fVolumeLevel as Single,

nCurveType as enumVolumeCurves,

nDesignerUniqueId as Long

) as enumErrorCodes


 

[C++]

short control.VolumeAutomation.PointSetParams (

short nPlayer,

LPCTSTR strVolumePointName,

float fPosition,

float fVolumeLevel,

short nCurveType,

long nDesignerUniqueId

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

strVolumePointName

String representing the friendly name of the volume point to remove: this name must be identical to the corresponding one used for adding the volume point through the VolumeAutomation.PointAdd method.

fPosition

Position of the volume point expressed in the same unit set into the VolumeAutomation.PositionUnit property.

fVolumeLevel

Volume level expressed in the same unit set into the VolumeAutomation.ScaleType property

nCurveType

Type of curve applied to reach the next volume point.

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.

amp3dj_i00008f

VOLUME_CURVE_LINEAR

1

Linear curve

amp3dj_i000090

VOLUME_CURVE_EXPONENTIAL

2

Exponential curve

amp3dj_i000091

VOLUME_CURVE_COSINE

3

Cosine curve

amp3dj_i000092

VOLUME_CURVE_SMOOTH

4

Smooth curve

amp3dj_i000093

VOLUME_CURVE_CUSTOM

5

Custom Bézier curve.

amp3dj_i000094

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.

 

amp3dj_i00009a

 

This parameter is ignored if the nScaleType parameter above has been set to a value different from VOLUME_CURVE_CUSTOM.

 

 

Return value

 

Value

Meaning

 

 

enumErrorCodes.NOERROR (0)

The method call was successful

Negative value

An error occurred: see the LastError property for further error details or for a list of the possible error values.