Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Notice
This set of functions is available when the FMOD plugin is loaded.
The Digital Signal Processor transforms input audio signals to an output stream.
DSP Class
Members
void setParameterBool ( int index, bool value ) #
Sets a boolean parameter by index.Arguments
- int index - The parameter index in range from 0 to getNumParameters().
- bool value - The parameter value.
void setParameterInt ( int index, int value ) #
Sets an integer value for the parameter by its index.
A DSP can have several parameters that can be controlled individually. For example, ECHO DSP's parameters are: DELAY, FEEDBACK, DRYLEVEL, WETLEVEL. See the list of available parameters for various DSP types.
Arguments
- int index - Parameter index. The parameters are numbered starting from 0 to getNumParameters().
- int value - Parameter value.
void setParameterFloat ( int index, float value ) #
Sets a floating point value for the parameter by its index.
A DSP can have several parameters that can be controlled individually. For example, ECHO DSP's parameters are: DELAY, FEEDBACK, DRYLEVEL, WETLEVEL. See the list of available parameters for various DSP types.
Arguments
- int index - Parameter index. The parameters are numbered starting from 0 to getNumParameters().
- float value - Parameter value.
void setActive ( int active ) #
Sets the processing active state. If active state is disabled, processing of this unit and its inputs are stopped. When created, a DSP is inactive. If addDSP is used it will automatically be activated, otherwise it must be set to active manually.Arguments
- int active - 1 to enable the active state, 0 to disable it.
int isActive ( ) #
Returns the processing active state. If active state is disabled, processing of this unit and its inputs are stopped. When created, a DSP is inactive. If addDSP is used it will automatically be activated, otherwise it must be set to active manually.Return value
1 if the active state is enabled, otherwise 0.void setBypass ( int bypass ) #
Sets the processing bypass state. If bypass is set, processing of this unit is skipped but it continues to process its inputs.Arguments
- int bypass - 1 to enable bypass, 0 to disable it.
int isBypass ( ) #
Returns the processing bypass state.Return value
1 if bypass is enabled, otherwise 0.int isIdle ( ) #
Returns the idle state. A DSP is considered idle when it stops receiving input signal and all internal processing of stored input has been exhausted. Each DSP type has the potential to have differing idle behaviour based on the type of effect. A reverb or echo may take a longer time to go idle after it stops receiving a valid signal, compared to an effect with a shorter tail length like an EQ filter.Return value
1 if idle state is enabled, otherwise 0.int getType ( ) #
Returns the DSP type value, one of the TYPE values.Return value
The DSP type value, one of the TYPE values.int getNumParameters ( ) #
Returns the number of parameters exposed by this unit. Use this to enumerate all parameters of a DSP unit with getParameterInfo().Return value
The number of parameters exposed by this unit.void release ( ) #
Frees a DSP object.void releaseFromChannel ( ) #
Auxiliary function, should not be used.Last update:
2023-03-15
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)