Events > CuePointReached event

Remarks

Occurs when an existing cue point is reached during playback.

During playback this event is not generated if the current playback position should be moved, through a call to the SeekSound or ForwardSound methods, to a position exceeding the one of the cue point itself.

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

For further details about synchronization through Events see the How to synchronize the container application through events tutorial.

Syntax

[Visual Basic]

Public Event CuePointReached As CuePointReachedEventHandler

[C#]

public event CuePointReachedEventHandler CuePointReached;

[C++]

public: __event CuePointReachedEventHandler* CuePointReached;

Event Data

The event handler receives an argument of type CuePointReachedEventArgs having the following parameters:

Parameters	Description

nPlayerIndex	Number representing the zero-based index of the player that fired the event
strCuePointName	String containing the unique name of the cue point as defined when the cue point was added through the CuePointsAdd method.
nPosition	Number representing the position, expressed in milliseconds, of the cue point