Methods > Playlists > PlayListItemCuePointAdd method

Remarks

Adds a new cue point to an item of the playlist: when the cue point is reached, the CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to EV_CUE_POINT_REACHED allowing to discriminate the specific cue point through contents of the pBufferUnicode parameter.

This method will return an error if the playlist has not been created with the PlayListCreateEx method or loaded with the PlayListLoad or PlayListLoadSync methods, all having the nMode parameter set to PLAYLIST_AUTOMATION_MODE.

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

nPlayerIndex as Int16,

nItemIndex as Int16,

strCuePointName as string,

nPositionUnit as enumVolumeAutomationPositionUnits,

fPosition as Single

) as enumErrorCodes

[C#]

public enumErrorCodes PlayListItemCuePointAdd (

Int16 nPlayerIndex,

Int16 nItemIndex,

string strCuePointName,

enumVolumeAutomationPositionUnits nPositionUnit,

float fPosition

);

[C++]

public: enumErrorCodes PlayListItemCuePointAdd (

Int16 nPlayerIndex,

Int16 nItemIndex,

string strCuePointName,

enumVolumeAutomationPositionUnits nPositionUnit,

float 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.

strCuePointName

String containing the unique name that will identify the cue point from now on.

If this name should be already assigned to an existing cue point, an error code would be returned

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

Number representing the cue point position expressed in nPositionUnit

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.