Methods > Playlists > PlayListItemVolAutomGetMixPos method

Remarks

Obtains volume automation mixing positions from an item of the playlist. Current mixing positions can be modified through the PlayListItemVolAutomSetMixPos method.

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 PlayListItemVolAutomGetMixPos (

nPlayerIndex as Int16,

nItemIndex as Int16,

nPositionUnit as enumVolumeAutomationPositionUnits,

ByRef fStartPos as Single,

ByRef fMixPos as Single,

ByRef fEndPos as Single

) as enumErrorCodes

[C#]

public enumErrorCodes PlayListItemVolAutomGetMixPos (

Int16 nPlayerIndex,

Int16 nItemIndex,

enumVolumeAutomationPositionUnits nPositionUnit,

ref float fStartPos,

ref float fMixPos,

ref float fEndPos

);

[C++]

public: enumErrorCodes PlayListItemVolAutomGetMixPos (

Int16 nPlayerIndex,

Int16 nItemIndex,

enumVolumeAutomationPositionUnits nPositionUnit,

float __gc *fStartPos,

float __gc *fMixPos,

float __gc *fEndPos

);

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.

nPositionUnit

The unit used to define the position parameters fStartPos,fMixPos and fEndPos below.

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

fStartPos

Reference that, on return from the method call, will contain the start position expressed in nPositionUnit. This parameter is the equivalent of the StartPosSec/StartPosMs/StartPosPerc attributes of the Item sub-key of the PDJ format.

fMixPos

Reference that, on return from the method call, will contain the mixing position expressed in nPositionUnit. This parameter is the equivalent of the MixPosSec/MixPosMs/MixPosPerc attributes of the Item sub-key of the PDJ format.

fEndPos

Reference that, on return from the method call, will contain the end position expressed in nPositionUnit. This parameter is the equivalent of the EndPosSec/EndPosMs/EndPosPerc attributes of the Item sub-key of the PDJ format.

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.