Function
|
Description
|
void SetDirection(int dir)
|
Set the direction of the effect. Valid values are DIR_UP, DIR_DOWN, DIR_LEFT and DIR_RIGHT.
|
int GetDirection()
|
Returns the current direction.
|
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 SetLength(int len)
|
Sets the length of the drops. Valid values range from 1 to 100.
|
int GetLength()
|
Returns the current length of drops.
|
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 instead of the "Sensitivity" value, the "Amplify" value will be used.
|
int GetSens()
|
Returns the current sensitivity value of the effect. If "Use Level (db)" is enabled, this function returns 0 because not the "Sensitivity" value is used by the effect, but the amplify value.
|
void SetAmplify(int amp)
|
Sets the amplification value of the effect. Valid values range from 0 to 100. This function has no effect if "Use Level (db)" is disabled. In that case the "Sensitivity" value is used by the effect.
|
int GetAmplify()
|
Returns the currently set "Amplify" value. This function returns 0 if "Use Level (db)" is disabled. In that case 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 current 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" mode if enable is 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.
|