Copyright © 2005-2019 MultiMedia Soft

CuePointsSetPos method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the current position for the given cue point.

 

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

nPlayerIndex as Int16,

strCuePointName as string,

nCuePointPos as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes CuePointsSetPos (

Int16 nPlayerIndex,

string strCuePointName,

Int32 nCuePointPos

);


 

[C++]

public: enumErrorCodes CuePointsSetPos (

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 of the cue point as defined when the cue point was added through the CuePointsAdd method.

nCuePointPos

Number representing the new 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.