Class AudioEffectDef

Definition of an audio effect.

Implements

AudioEffectState

Index

Constructors

Properties

attrs? audioParams? connections? effectType id

Methods

addParam outputTo withAttrs

Constructors

constructor

new AudioEffectDef(id: string, effectType: string): AudioEffectDef
Parameters
- id: string
- effectType: string
Returns AudioEffectDef
- Defined in src/audio/audio-effects/audio-effect.ts:29

Properties

`Optional`attrs

attrs?: Record<string, any>

Arbitrary attributes which can be used to describe audio effect.

`Optional`audioParams

audioParams?: AudioEffectParamType[]

Audio effect params

`Optional`connections

connections?: AudioEffectConnectionDef[]

Connections to other OmpAudioNodeDef's

effectType

effectType: string

Effect type as used in EffectsRegistry. There are no limitations to effect types but they need to be dynamically added to EffectsRegistry.

id

id: string

Methods

addParam

addParam(audioParam: AudioEffectParamType): AudioEffectDef
Parameters
- audioParam: AudioEffectParamType
Returns AudioEffectDef
- Defined in src/audio/audio-effects/audio-effect.ts:51

outputTo

outputTo(
...effectConnections: (string | AudioEffectConnectionDef)[],
): AudioEffectDef
Parameters
- ...effectConnections: (string | AudioEffectConnectionDef)[]
Returns AudioEffectDef
- Defined in src/audio/audio-effects/audio-effect.ts:39

withAttrs

withAttrs(attrs: Record<string, any>): AudioEffectDef
Parameters
- attrs: Record<string, any>
Returns AudioEffectDef
- Defined in src/audio/audio-effects/audio-effect.ts:34