Copyright © 2005-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]

Public Function PointGetParams (

nPlayerIndex as Int16,

strVolumePointName as String,

Byref fPosition as Single,

Byref fVolumeLevel as Single,

Byref nCurveType as enumVolumeCurves

) as enumErrorCodes


 

[C#]

public enumErrorCodes PointGetParams (

Int16 nPlayerIndex,

string strVolumePointName,

ref float fPosition,

ref float fVolumeLevel,

ref enumVolumeCurves nCurveType

);


 

[C++]

public: enumErrorCodes PointGetParams (

Int16 nPlayerIndex,

string strVolumePointName,

float __gc *fPosition,

float __gc *fVolumeLevel,

enumVolumeCurves __gc *nCurveType

);


 

 

 

Parameter

Description

 

 

nPlayerIndex

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.

adjstudnet_i000085

VOLUME_CURVE_LINEAR

1

Linear curve

adjstudnet_i000086

VOLUME_CURVE_EXPONENTIAL

2

Exponential curve

adjstudnet_i000087

VOLUME_CURVE_COSINE

3

Cosine curve

adjstudnet_i000088

VOLUME_CURVE_SMOOTH

4

Smooth curve

adjstudnet_i000089

VOLUME_CURVE_CUSTOM

5

Custom Bézier curve.

adjstudnet_i00008a

 

 

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.