|
Functions provided By S2L Frequency Flash
This effect uses the following functions:
Function
|
Description
|
void SetFadeIn(int fade)
|
Sets the Fade In value. This value represents Beats Per Minute (BPM).
|
int GetFadeIn()
|
Returns the current Fade In value.
|
void SetFadeOut(int fade)
|
Sets the Fade Out value. This value represents Beats Per Minute (BPM).
|
int GetFadeOut()
|
Returns the current Fade Out value.
|
void SetSensitivity(int value)
|
Set the Sensitivity value.
|
int GetSensitivity()
|
Returns the Sensitivity value.
|
void SetMinBand(int index)
|
Sets the Minimum Band that should be included in the effect calculation. The given value is an index, which describes the band that should be used. The table below provides an overview over available values and the appropriate band.
|
int GetMinBand()
|
Returns the specifier of the current Minimum Band. See below for further details.
|
void SetMaxBand(int index)
|
Set the Maximum Band that should be included in the effect calculation. The given value is an index which describes the band that should be used. The table below provides an overview over available values and the appropriate band.
|
int GetMaxBand()
|
Returns the specifier of the current Maximum Band. See below for further details.
|
Frequency Bands
This effect allows to select the frequency bands which should be used to calculate the flash. The functions SetMinBand and SetMaxBand may be used to set the minimum band and the maximum band. Both use an identifier value between 0 and 21 which describes one of the following frequency bands:
Value
|
Frequency Band in Hz
|
0
|
5
|
1
|
40
|
2
|
57
|
3
|
75
|
4
|
99
|
5
|
133
|
6
|
175
|
7
|
239
|
8
|
318
|
9
|
425
|
10
|
567
|
11
|
766
|
12
|
1013
|
13
|
1352
|
14
|
1832
|
15
|
2441
|
16
|
3269
|
17
|
4315
|
18
|
5769
|
19
|
7749
|
20
|
10.299
|
21
|
13.007
|
Example
The source code below would select 57 Hz as minimum band and 567 Hz as maximum band. Furthermore the color red is set with a fade in value of 3000 BPM and a fade out value of 120 BPM.
@scriptname="";
@author="";
@version="";
@description="";
void InitEffect()
{
SetColor(RED);
SetFadeIn(3000);
SetFadeOut(120);
SetMinBand(2);
SetMaxBand(10);
}
void PreRenderEffect()
{
}
void PostRenderEffect()
{
}
void MatrixSizeChanged()
{
InitEffect();
}
MADRIX 2.X To MADRIX 3.X Migration Hints
The following functions and constants are not supported anymore. Please follow the hints to migrate your macros.
Function/Constant
|
Description
|
void SetFade(int value)
|
Use SetFadeIn(int value) and SetFadeOut(int value) instead.
|
int GetFade()
|
Use GetFadeIn() and GetFadeOut() instead.
|
void SetSens(int sens)
|
Use SetSensitivity(int value) instead.
|
int GetSens()
|
Use GetSensitivity() instead.
|
|