Repository navigation
AudioEffect
eduardgushchin edited this page Oct 2, 2026
·
2 revisions
Home | API by Category | Complete API Index | API Status
| Field | Value |
|---|---|
| Full name | Electron2D.AudioEffect |
| Namespace | Electron2D |
| Kind | class |
| Category | API Audio |
Describes an audio bus effect and creates independent stereo processing state.
public abstract class Electron2D.AudioEffectBuses borrow resources and own one instance per output stereo pair. Factories and graph edits are preparation operations; repeated processing must use prepared storage and synchronize custom mutable state.
Inherits: Resource
| Member | Kind | Summary |
|---|---|---|
protected AudioEffect() |
constructor | Initializes an effect resource. |
public Electron2D.AudioEffectInstance Instantiate() |
method | Creates a caller-owned stereo effect instance borrowing this resource. |
protected abstract Electron2D.AudioEffectInstance OnInstantiate() |
method | Creates independent stereo processing state. |
Kind: constructor
protected AudioEffect()Initializes an effect resource.
Kind: method
public Electron2D.AudioEffectInstance Instantiate()Creates a caller-owned stereo effect instance borrowing this resource.
A live, independent instance.
-
T:System.ObjectDisposedException: The resource is disposed. -
T:System.InvalidOperationException: The factory returns null, disposed or bus-owned state.
Kind: method
protected abstract Electron2D.AudioEffectInstance OnInstantiate()Creates independent stereo processing state.
A new caller-owned instance; factories must not reenter audio configuration.