Class DefaultOmpAudioEffectDef

Definition of an audio effect.

Implements

OmpAudioEffectDef

Index

Constructors

Properties

attrs? audioParams? connections? effectType id

Methods

addParam outputTo withAttrs

Constructors

constructor

new DefaultOmpAudioEffectDef(
id: string,
effectType: string,
): DefaultOmpAudioEffectDef
Parameters
- id: string
- effectType: string
Returns DefaultOmpAudioEffectDef
- Defined in project/src/audio/audio-effects.ts:92

Properties

`Optional`attrs

attrs?: Record<string, any>

Arbitrary attributes which can be used to describe audio effect.

`Optional`audioParams

audioParams?: OmpAudioEffectParamType[]

Audio effect params

`Optional`connections

connections?: OmpAudioEffectConnectionDef[]

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: OmpAudioEffectParamType): DefaultOmpAudioEffectDef
Parameters
- audioParam: OmpAudioEffectParamType
Returns DefaultOmpAudioEffectDef
- Defined in project/src/audio/audio-effects.ts:114

outputTo

outputTo(
...effectConnections: (string | OmpAudioEffectConnectionDef)[],
): DefaultOmpAudioEffectDef
Parameters
- ...effectConnections: (string | OmpAudioEffectConnectionDef)[]
Returns DefaultOmpAudioEffectDef
- Defined in project/src/audio/audio-effects.ts:102

withAttrs

withAttrs(attrs: Record<string, any>): DefaultOmpAudioEffectDef
Parameters
- attrs: Record<string, any>
Returns DefaultOmpAudioEffectDef
- Defined in project/src/audio/audio-effects.ts:97