|
Functions provided By S2L Frequency Flash
The following table provides an overview over all functions the effect provides:
Function
|
Description
|
void SetFade(int fade)
|
Sets the "fade" value. Valid values range from 1 to 3000.
|
int GetFade()
|
Returns the current "fade" value.
|
void SetColor(color col)
|
Sets the color of the effect. 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 SetSens(int sens)
|
Set the "Sensitivity" value for the effect. Valid values range from 0 to 100.
|
int GetSens()
|
Returns the current "Sensitivity" value of the effect.
|
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.
|
This Effect uses the Color Picker. Learn more about Using Colors.
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
|
8
|
1
|
42
|
2
|
57
|
3
|
77
|
4
|
102
|
5
|
135
|
6
|
180
|
7
|
242
|
8
|
322
|
9
|
430
|
10
|
570
|
11
|
767
|
12
|
1020
|
13
|
1360
|
14
|
1830
|
15
|
2450
|
16
|
3270
|
17
|
4310
|
18
|
5780
|
19
|
7760
|
20
|
10.300
|
21
|
13.000
|
Example:
The source code below would select 77Hz as minimum band and 570Hz as maximum band:
SetMinBand(3);
SetMaxBand(10);
|