2021-11-02 22:41:02 +00:00
# Effect Chains
2021-11-02 21:49:51 +00:00
## `~_EffectChain_Create()`
2021-11-02 21:25:52 +00:00
**Returns:** Number, an **effect chain ID**
|Argument|Datatype|Description |
|--------|--------|------------------------------------------------------|
2021-11-02 21:30:04 +00:00
|None | | |
2021-11-02 21:25:52 +00:00
2021-11-02 22:14:12 +00:00
Creates a new effect chain that can be modified and applied to sound instances (or the master buss).
2021-11-02 21:25:52 +00:00
2021-11-02 21:49:51 +00:00
## `~_EffectChain_Destroy(effectChainID)`
2021-11-02 21:25:52 +00:00
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------|
2021-11-02 22:14:12 +00:00
|`effectChainID`|number |Effect chain to target |
Destroys an effect chain, freeing memory associated with it.
2021-11-02 21:25:52 +00:00
2021-11-02 21:49:51 +00:00
## `~_EffectChain_AddDefaultReverb(effectChainID)`
2021-11-02 21:25:52 +00:00
**Returns:** N/A (`undefined`)
2021-11-02 21:37:46 +00:00
|Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------|
2021-11-02 22:14:12 +00:00
|`effectChainID`|number |Effect chain to target |
Adds a pleasant-sounding default reverb to the effect chain.
2021-11-02 21:25:52 +00:00
2021-11-02 21:49:51 +00:00
## `~_EffectChain_AddReverb(...)`
2021-11-02 21:25:52 +00:00
**Returns:** N/A (`undefined`)
2021-11-02 21:37:46 +00:00
|Argument |Datatype|Description |
|------------------|--------|------------------------------------------------------|
2021-11-02 22:14:12 +00:00
|`effectChainID` |number |Effect chain to target |
2021-11-02 21:37:46 +00:00
|`wetDryMix` |number | |
|`reflectionsDelay`|number | |
|`reverbDelay` |number | |
|`earlyDiffusion` |number | |
|`lateDiffusion` |number | |
|`lowEQGain` |number | |
|`lowEQCutoff` |number | |
|`highEQGain` |number | |
|`highEQCutoff` |number | |
|`reflectionsGain` |number | |
|`reverbGain` |number | |
|`decayTime` |number | |
|`density` |number | |
|`roomSize` |number | |
2021-11-02 22:14:12 +00:00
Adds a reverb effect with many (many...) parameters to the effect chain.
2021-11-02 21:25:52 +00:00
2021-11-02 21:49:51 +00:00
## `~_SoundInstance_SetEffectChain(soundInstanceID, effectChainID, effectGain)`
2021-11-02 21:25:52 +00:00
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|-----------------|--------|------------------------------------------------------|
2021-11-02 22:14:12 +00:00
|`soundInstanceID`|number |Sound instance to target |
|`effectChainID` |number |Effect chain to apply |
|`effectGain` |number |Gain of the effect. `1` is 100% volume |
Applies an effect chain to the given sound instance.
2021-11-02 21:25:52 +00:00
2021-11-02 21:49:51 +00:00
## `~_SoundInstance_SetEffectGain(soundInstanceID, effectGain)`
2021-11-02 21:25:52 +00:00
**Returns:** N/A (`undefined`)
2021-11-02 22:14:12 +00:00
|Argument |Datatype|Description |
|-----------------|--------|----------------------------------------------------------------------------|
|`soundInstanceID`|number |Sound instance to target |
|`effectGain` |number |Gain of the effect already applied to the sound instance. `1` is 100% volume|
Modifies the effect chain gain for the given sound instance. This function will do nothing if no effect chain has been applied.
2021-11-02 21:25:52 +00:00
2021-11-02 21:49:51 +00:00
## `~_SetMasteringEffectChain(effectChainID, effectGain)`
2021-11-02 21:25:52 +00:00
**Returns:** N/A (`undefined`)
2021-11-02 22:14:12 +00:00
|Argument |Datatype|Description |
|---------------|--------|--------------------------------------|
|`effectChainID`|number |Effect chain to apply |
|`effectGain` |number |Gain of the effect. `1` is 100% volume|
Applies an effect chain to the master buss, changing how every piece of audio sounds. This function does **not** apply an effect to each individual sound instance, simply the whole output audio.
2021-11-02 21:25:52 +00:00
2021-11-02 21:49:51 +00:00
## `~_SetMasteringEffectGain(effectGain)`
2021-11-02 21:25:52 +00:00
**Returns:** N/A (`undefined`)
2021-11-02 22:14:12 +00:00
|Argument |Datatype|Description |
|------------|--------|-------------------------------------------------------------------------|
|`effectGain`|number |Gain of the effect already applied to the master buss. `1` is 100% volume|
Modifies the effect chain gain for the master buss. This function will do nothing if no effect chain has been applied.
