Methods > Playlists > PlayListItemCuePointGet method

Remarks

Obtains information about a specific cue point from an item of the playlist.

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.

For further details about cue points see the How to add Triggers and Cue Points to a player tutorial.

Syntax

[Visual Basic]

Public Function PlayListItemCuePointGet (

nPlayerIndex as Int16,

nItemIndex as Int16,

nCuePointIndex as Int16,

nPositionUnit as enumVolumeAutomationPositionUnits,

ByRef fPosition as Single

) as String

[C#]

public string PlayListItemCuePointGet (

Int16 nPlayerIndex,

Int16 nItemIndex,

Int16 nCuePointIndex,

enumVolumeAutomationPositionUnits nPositionUnit,

ref float fPosition

);

[C++]

public: string PlayListItemCuePointGet (

Int16 nPlayerIndex,

Int16 nItemIndex,

Int16 nCuePointIndex,

enumVolumeAutomationPositionUnits nPositionUnit,

float __gc *fPosition

);

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.

nCuePointIndex

Number representing the zero-based index of the cue point. The number of available cue points can be obtained using the PlayListItemCuePointCountGet method.

nPositionUnit

The unit used to define the position of the cue point through the fPosition parameter below.

Supported values are the following:

Mnemonic constant	Value	Meaning
VA_POS_UNIT_SECONDS	0	Position is expressed in seconds
VA_POS_UNIT_PERCENTAGE	1	Position is expressed in percentage
VA_POS_UNIT_MILLISECONDS	2	Position is 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.

Return value

Value	Meaning

Empty string	The information was not available or an error occurred (see the LastError property for further error details)
Valid string	The name of the cue point