Copyright © 2005-2016 MultiMedia Soft

PlayListItemVolAutomPointParamsGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains parameters of an existing volume point of a playlist's item. The volume point can have been previously added through the PlayListItemVolAutomPointAdd method or as a result of a playlist loading through the PlayListLoad method.

 

For further details about playlists management see the How to create and manage a playlist tutorial.

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

 

 

Syntax

 

[Visual Basic]

Public Function PlayListItemVolAutomPointParamsGet (

nPlayerIndex as Int16,

nItemIndex as Int16,

strVolumePointName as String,

nPositionUnit as enumVolumeAutomationPosUnits,

ByRef fPosition as Single,

nVolumeScaleType as enumVolumeScales,

ByRef fVolumeLevel as Single,

ByRef nCurveType as enumVolumeCurves,

ByRef nLeftX as Int16,

ByRef nLeftY as Int16,

ByRef nRightX as Int16,

ByRef nRightY as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlayListItemVolAutomPointParamsGet (

Int16 nPlayerIndex,

Int16 nItemIndex,

string strVolumePointName,

enumVolumeAutomationPosUnits nPositionUnit,

float fPosition,

enumVolumeScales nVolumeScaleType,

float fVolumeLevel,

enumVolumeCurves nCurveType,

ref Int16 nLeftX,

ref Int16 nLeftY,

ref Int16 nRightX,

ref Int16 nRightY

);


 

[C++]

public: enumErrorCodes PlayListItemVolAutomPointParamsGet (

Int16 nPlayerIndex,

Int16 nItemIndex,

string strVolumePointName,

enumVolumeAutomationPosUnits nPositionUnit,

float fPosition,

enumVolumeScales nVolumeScaleType,

float fVolumeLevel,

enumVolumeCurves nCurveType,

Int16 __gc *nLeftX,

Int16 __gc *nLeftY,

Int16 __gc *nRightX,

Int16 __gc *nRightY

);


 

 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nItemIndex

Number representing the zero-based index of the item inside the playlist. The number of available items can be obtained using the PlayListGetCount method.

strVolumePointName

String representing the friendly name of the volume point to modify

nPositionUnit

The unit used to define positions of volume points.

Supported values are the following:

Mnemonic constant

Value

Meaning

VA_POS_UNIT_SECONDS

0

Positions are expressed in seconds

VA_POS_UNIT_PERCENTAGE

1

Positions are expressed in percentage

VA_POS_UNIT_MILLISECONDS

2

Positions are expressed in milliseconds

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 nPositionUnit parameter.

nVolumeScaleType

The volume scaling type.

Supported values are the following:

Mnemonic constant

Value

Meaning

SCALE_LINEAR

0

The returned volume is based upon a linear scale and can be in the range from 0.0 (silence) to 100.0 (max volume)

SCALE_LOG

1

The returned volume, expressed in dB, is based upon a logarithmic scale and can be in the range from -100  (silence) to 0 (max volume)

The actual applied formula for converting a linear volume into a logarithmic volume is the following:

VolumeInDB = 20 * log10 (VolumeLinear/100)

The C syntax for converting a logarithmic volume into a linear volume is the following:

VolumeLinear = 100 * pow (10, VolumeInDB/20);

fVolumeLevel

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

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

 

 

 

 

-1

Ignore this setting and leave the current curve type unchanged.

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

 

When this values is obtained, positions of Bézier curve's control points are returned inside the nLeftX, nLeftY, nRightX and nRightY parameters below.

nLeftX

Reference that, on return from the method call, will contain the horizontal position, expressed in percentage of the designer's area, of the left control point. This parameter can be ignored when the nCurveType parameter above is set to a value different from VOLUME_CURVE_CUSTOM.

nLeftY

Reference that, on return from the method call, will contain the vertical position, expressed in percentage of the designer's area, of the left control point. This parameter can be ignored when the nCurveType parameter above is set to a value different from VOLUME_CURVE_CUSTOM.

nRightX

Reference that, on return from the method call, will contain the horizontal position, expressed in percentage  of the designer's area, of the right control point. This parameter can be ignored when the nCurveType parameter above is set to a value different from VOLUME_CURVE_CUSTOM.

nRightY

Reference that, on return from the method call, will contain the vertical position, expressed in percentage of the designer's area, of the right control point This parameter can be ignored when the nCurveType parameter above is 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.