Remarks
Adds a cue point to the given player: when the cue point is reached, the container application is notified through the CallbackForPlayersEvents delegate which is invoked with the nEvent parameter set to EV_CUE_POINT_REACHED.
Cue points positioning is always referred to the original sound duration, meaning that it won't keep count of eventual tempo and/or playback rate changes and will always refer to the position of the song as it should be played at its original speed.
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
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes CuePointsAdd (
Int16 nPlayerIndex,
string strCuePointName,
Int32 nCuePointPos
);
|
|
[C++]
public: enumErrorCodes CuePointsAdd (
Int16 nPlayerIndex,
string strCuePointName,
Int32 nCuePointPos
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
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.
|
|
