S2L EQ Tubes

   Print  Previous  Next

Functions Provided By S2L EQ Tubes

The following table provides an overview over all functions the effect provides:

Function

Description

void SetBpm(int bpm)

Sets the speed of the effect in BPM. Valid values range from 0 to 9999 BPM.

int GetBpm()

Returns the current effect speed in BPM.

void SetColor(color col)

Sets the effect color. Please note that the alpha channel is not used by this effect.

color GetColor()

Returns the currently set color. Please note that the alpha channel is not used and should be ignored.

void SetFade(int fade)

Set the "fade" value. Valid values range from 1 to 3000.

int GetFade()

Returns the current "fade" value.

void SetSens(int sens)

Sets the "Sensitivity" value for the effect. Valid values range from 0 to 100. If "Use Level (db)" is enabled, this function has no effect because  the "Amplify" value is used instead.

int GetSens()

Returns the current "Sensitivity" value of the effect. If "Use Level (db)" is enabled, this function returns 0. Because in that case the "Amplify" value is used.

void SetAmplify(int amp)

Sets the "Amplify" value for the effect. Valid values range from 0 to 100. This function has no effect if "Use Level (db)" is disabled because then the "Sensitivity" value is used by the effect.

int GetAmplify()

Returns the current "Amplify" value of the effect. This function returns 0 if "Use Level (db)" is disabled because then the "Sensitivity" value is used by the effect.

void SetBandCount(int cnt)

Sets the number of "bands" to be displayed. Valid values range from 1 to 511.

int GetBandCount()

Returns the currently used number of "bands".

void SetInvert(int enable)

Disables "Invert" if enable is set to false. Otherwise, it will be enabled.

int GetInvert()

Returns true if "Invert" is enabled, otherwise false.

void SetMirror(int enable)

Disables "Mirror" if enable is set to false. Otherwise, it will be enabled.

int GetMirror()

Returns true if "Mirror" is enabled, otherwise false.

void SetUseLevel(int enable)

Disables "Use Level (db)" if enable is set to false. Otherwise, it will be enabled.

int GetUseLevel()

Returns true if "Use Level (db)" is enabled, otherwise false.

void SetDirection(int dir)

Sets the direction of the lines to horizontal or vertical. See below for details.

int GetDirection()

Returns current direction of the lines. See below for details.

 

This Effect uses the Color Picker. Learn more about Using Colors.

 

Deprecated Functions
Deprecated functions are outdated functions and should not be used anymore.

Function

Description

void SetSpeed(int speed)

Sets the speed of the effect in FPS. Valid values range from 0 to 166. Please note: This function is deprecated and may be removed in one of the next releases. Use SetBpm instead.

float GetSpeed()

Returns the current effect speed in FPS. Please note: This function is deprecated and may be removed in one of the next releases. Use GetBpm instead.

 

Setting The Direction

This effect supports two directions, vertical lines and horizontal lines. Using the SetDirection function, it is possible to set any of them with one of the following parameters:

Value

Description

DIR_HORIZONTAL

Sets horizontal lines to be used by the effect.

DIR_VERTICAL

Sets vertical lines to be used by the effect.

DIR_HV

Sets vertical and horizontal lines to be used by the effect.