Copyright © 2005-2018 MultiMedia Soft

TriggersSetPos method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the current position for the given trigger.

 

Triggers 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 triggers.

 

 

Syntax

 

[Visual Basic]

Public Function TriggersSetPos (

nPlayerIndex as Int16,

nTriggerID as Int16,

nTriggerPos as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes TriggersSetPos (

Int16 nPlayerIndex,

Int16 nTriggerID,

Int32 nTriggerPos

);


 

[C++]

public: enumErrorCodes TriggersSetPos (

Int16 nPlayerIndex,

Int16 nTriggerID,

Int32 nTriggerPos

);


 

 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

nTriggerID

Number representing the identifier of the new trigger

nTriggerPos

Number representing the trigger position; it's effective value depends upon the value of the ScaleUnits property.

If this position should be already assigned to another trigger, the existing trigger would be removed from the list of existing triggers and replaced by the new one.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.WARNING_TRIGGER_REMOVED (1)

An existing trigger having the same position has been removed from the list of existing triggers

enumErrorCodes.NOERROR (0)

The method call was successful.