CuePointsAdd method

CuePointsAdd method

Remarks

Adds a cue point to the given player: when the cue point is reached, the CuePointReached event is fired.

See the How to add Triggers and Cue Points to a player section for further details about cue points.

Syntax

[Visual Basic]

Public Function CuePointsAdd (

nPlayerIndex as Int16,

strCuePointName as string,

nCuePointPos as Int32

[C#]

public enumErrorCodes CuePointsAdd (

Int16 nPlayerIndex,

string strCuePointName,

Int32 nCuePointPos

);

[C++]

public: enumErrorCodes CuePointsAdd (

Int16 nPlayerIndex,

string strCuePointName,

Int32 nCuePointPos

);

Parameter	Description

nPlayer	Number representing the zero-based index of the involved player
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.
nCuePointPos	Number representing the cue point position expressed in milliseconds

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.