|
|
Functions Provided By S2L Wavegraph
The following table provides an overview over all functions the effect provides:
Function
|
Description
|
void SetColor(color col)
|
Sets the color for the effect.
|
color GetColor()
|
Returns the current effect color.
|
void SetDirection(int dir)
|
Sets the direction for the effect. Valid values are DIR_UP, DIR_DOWN, DIR_LEFT, and DIR_RIGHT.
|
int GetDirection()
|
Returns the current direction.
|
void SetTimeSlot(float timeSlot)
|
Sets the time slot value. Valid values range from 0.01 to 9999.
|
float GetTimeSlot()
|
Returns the currently set time slot.
|
void SetChannelView(int view)
|
Sets the channels that should be displayed by the effect. See below for further details.
|
int GetChannelView()
|
Returns the currently set channel to be displayed by the effect. See below for further details.
|
void SetShiftOutwards(int enable)
|
Sets the direction to outwards if enable is set to true. Otherwise, it is disabled. See below for further details.
|
int GetShiftOutwards()
|
Returns true if "Shift Outwards" is currently enabled, otherwise false. See below for further details.
|
void SetShiftInwards(int enable)
|
Sets the direction to inwards if enable is set to true, otherwise it is disabled. See below for further details.
|
int GetShiftInwards()
|
Returns true if "Shift Inwards" is currently enabled, otherwise false. See below for further details.
|
This Effect uses the Color Picker. Learn more about Using Colors.
Selecting The Sound Channels
The wavegraph effect is able to show the wave graph of the two stereo sound channels. It is possible to select the wavegraph of the left or right channel. In addition, it is possible to show both channels at the same time (stereo). Selecting mono is also an option. The function SetChannelView enables a macro to set these settings. The following values may be used as parameters:
Value
|
Description
|
CHM_MONO
|
Selects mono mode.
|
CHM_STEREO
|
Selects stereo mode, which displays both channels at the same time.
|
CHM_LEFT
|
Selects the left channel.
|
CHM_RIGHT
|
Selects the right channel.
|
Shifting The Direction
In addition to the directions DIR_UP, DIR_DOWN, DIR_LEFT, and DIR_RIGHT, the wavegraph can move inwards or outwards. With the two functions SetShiftOutwards and SetShiftInwards, it is possible to control these directions. They both use true or false as parameters to disable or to enable the according movement.
Example:
| • | SetShiftInwards(true); //activates inwards movement |
| • | SetShiftInwards(false); //disables inwards movement |
| • | SetShiftOutwards(true); //activates outwards movement |
| • | SetShiftOutwards(false); //disables outwards movement |
|