Copyright © 2001-2018 MultiMedia Soft

VolumeAutomation.PointGetParams method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains parameters for the given volume point.

 

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

 

 

Syntax

 

[Visual Basic]

control.VolumeAutomation.PointGetParams (

nPlayer as Integer,

strVolumePointName as String,

fPosition as Single,

fVolumeLevel as Single,

nCurveType as enumVolumeCurves

) as enumErrorCodes


 

[C++]

short control.VolumeAutomation.PointGetParams (

short nPlayer,

LPCTSTR strVolumePointName,

float *fPosition,

float *fVolumeLevel,

short *nCurveType

);


 

 

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

Reference that, on return from the method call, will contain the position of the volume point expressed in the same unit set into the VolumeAutomation.PositionUnit property

fVolumeLevel

Reference that, on return from the method call, will contain the volume level expressed in the same unit set into the VolumeAutomation.ScaleType property

nCurveType

Reference that, on return from the method call, will contain the 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

 

 

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.