Effect Parameter Chaser

   Print  Previous  Next

Functions Provided For Using The Effect Parameter Chaser

Function

Description

int ChaserGetPlaybackState()

Returns the current playback state of the Effect Parameter Chaser. See below for a list of Playback State constants.

void ChaserPlay()

Starts Chaser playback.

void ChaserStop()

Stops Chaser playback.

void ChaserPause()

Pauses Chaser playback.

int ChaserGetCurrentStep()

Returns the index of the Step that is currently active. Indexing starts with 0.

void ChaserCallCurrentStep(int index)

Activates the Step specified with index. Indexing starts with 0.

void ChaserCallPreviousStep(int offset)

Returns to the Previous Step. Offset allows to define how many Steps are skipped. By default, Offset is set to 1 and does not need to be passed.

void ChaserCallNextStep(int offset)

Skips to the Next Step. Offset allows to define how many Steps are skipped. By default, Offset is set to 1 and does not need to be passed.

void ChaserGetStepCount(int count)

Returns the current number of Steps.

void ChaserSetLoopCount(int count)

Sets the Loop Count. Valid values range from 0 to s. A value of 0 means Endless.

int ChaserGetLoopCount()

Returns the currently set Loop Count. A value of 0 means Endless.

float ChaserGetStepProgress()

Returns the progression of the current Step in percent. Valid values range from 0.0 to 100.0.

float ChaserGetLoopProgress()

Returns the progression of the Loop in percent. Valid values range from 0.0 to 100.0.

float ChaserGetStepTime(int index)

Returns the total Step Time of the Step specified with index in seconds. Indexing starts with 0.

float ChaserGetLoopTime()

Returns the total Loop Time of the Chaser in seconds. Indexing starts with 0.

void ChaserSetStepDescription(int index, string description)

Sets the Description of the Step specified with index. Indexing starts with 0.

string ChaserGetStepDescription(int index)

Returns the Description of the Step specified with index. Indexing starts with 0.

void ChaserSetStepFadeType(int index, int type)

Sets the Fade Type of the Step specified with index. Indexing starts with 0. See below for a list of Interpolation Type constants for type.

int ChaserGetStepFadeType(int index)

Returns the Fade Type of the Step specified with index. Indexing starts with 0.

void ChaserSetStepFadeTime(int index, float time)

Sets the Fade Time of the Step specified with index, in seconds. Indexing starts with 0.

float ChaserGetStepFadeTime(int index)

Returns the Fade Time of the Step specified with index, in seconds. Indexing starts with 0.

void ChaserSetStepWaitTime(int index, float time)

Sets the Wait Time of the Step specified with index, in seconds. Indexing starts with 0.

float ChaserGetStepWaitTime(int index)

Returns the Wait Time of the Step specified with index, in seconds. Indexing starts with 0.

void ChaserInvert()

Inverts the Step list.

void ChaserSwapSteps(int index1, int index2)

Swaps the positions of the Steps specified with index1 and index2. Indexing starts with 0.

void ChaserMoveStepUp(int index)

Moves the Step specified with index one item up. Indexing starts with 0.

void ChaserMoveStepDown(int index)

Moves the Step specified with index one item down. Indexing starts with 0.

int ChaserGetCurrentLoop()

Returns in which loop the Chaser is currently in.

void ChaserSetPlaybackMode(int mode)

Sets the Playback Mode of the Chaser. See below for a list of Playback  Mode constants for mode.

int ChaserGetPlaybackMode()

Returns the currently set Playback Mode. See below for a list of constants.

void ChaserSetSpeedPitch(float value)

Sets the Pitch value of the Chaser. Valid values range from -10.00 to 10.00.

float ChaserGetSpeedPitch()

Returns the currently set Pitch.

 

Playback State Constants

Constant

Description

int PLAYBACK_PLAYING

Shows that the Effect Parameter Chaser is currently playing (index 0).

int PLAYBACK_STOPPED

Shows that the Effect Parameter Chaser is currently stopped (index 1).

int PLAYBACK_PAUSED

Shows that the Effect Parameter Chaser is currently paused (index 2).

int PLAYBACK_FADING

Shows that the Effect Parameter Chaser is currently transitioning from one Step to the next Step after having been triggered manually (index 3).

 

Interpolation Type Constants

Constant

Description

int INTERPOLATION_TYPE_LINEAR

Sets the Interpolation Type to Linear.

int INTERPOLATION_TYPE_EASE_BOUNCE_IN

Sets the Interpolation Type to Ease In Bounce.

int INTERPOLATION_TYPE_EASE_BOUNCE_OUT

Sets the Interpolation Type to Ease Out Bounce.

int INTERPOLATION_TYPE_EASE_BOUNCE_INOUT

Sets the Interpolation Type to Ease In Out Bounce.

int INTERPOLATION_TYPE_EASE_CIRC_IN

Sets the Interpolation Type to Ease In Circular.

int INTERPOLATION_TYPE_EASE_CIRC_OUT

Sets the Interpolation Type to Ease Out Circular.

int INTERPOLATION_TYPE_EASE_CIRC_INOUT

Sets the Interpolation Type to Ease In Out Circular.

int INTERPOLATION_TYPE_EASE_CUBIC_IN

Sets the Interpolation Type to Ease In Cubic.

int INTERPOLATION_TYPE_EASE_CUBIC_OUT

Sets the Interpolation Type to Ease Out Cubic.

int INTERPOLATION_TYPE_EASE_CUBIC_INOUT

Sets the Interpolation Type to Ease In Out Cubic.

int INTERPOLATION_TYPE_EASE_SINE_IN

Sets the Interpolation Type to Ease In Sinusoidal.

int INTERPOLATION_TYPE_EASE_SINE_OUT

Sets the Interpolation Type to Ease Out Sinusoidal.

int INTERPOLATION_TYPE_EASE_SINE_INOUT

Sets the Interpolation Type to Ease In Out Sinusoidal.

int INTERPOLATION_TYPE_EASE_EXPO_IN

Sets the Interpolation Type to Ease In Exponential.

int INTERPOLATION_TYPE_EASE_EXPO_OUT

Sets the Interpolation Type to Ease Out Exponential.

int INTERPOLATION_TYPE_EASE_EXPO_INOUT

Sets the Interpolation Type to Ease In Out Exponential.

 

Playback Mode Constants

Constant

Description

int PLAYBACK_MODE_FORWARD

Sets the playback mode to Forward.

int PLAYBACK_MODE_BACKWARD

Sets the playback mode to Backward.

int PLAYBACK_MODE_PING_PONG

Sets the playback mode to Ping Pong.

int PLAYBACK_MODE_SHUFFLE

Sets the playback mode to Shuffle.

 

MADRIX Version: 3.6f | Script Version: 2.19
[Ctrl & +/-] = Zoom In/Out | [Ctrl & 0] = 100%
Print   Previous   Next