Class OmpGainEffect

Gain effect

Implements

OmpAudioEffect

Index

Constructors

Properties

attrs effectType id onReady$

Methods

destroy getInputNodes getNodes getOutputNode getParams setParam toDef createDef

Constructors

constructor

new OmpGainEffect(
audioContext: AudioContext,
def: OmpAudioEffectDef,
): OmpGainEffect
Parameters
- audioContext: AudioContext
- def: OmpAudioEffectDef
Returns OmpGainEffect
- Defined in project/src/audio/audio-effects.ts:348

Properties

attrs

attrs: Map<string, any> = ...

Arbitrary values used to describe the effect

`Readonly`effectType

effectType: string

Effect's effect type. Used for dynamic effect instantiation.

`Readonly`id

id: string

Effect's id. Unique at OmpAudioEffectsGraph level.

onReady$

onReady$: ReplaySubject<void> = ...

Signals when effect is fully initialized.

Methods

destroy

destroy(): void
Destroys all effect's nodes and sets up the effect to be garbage collected

Returns void
Implementation of OmpAudioEffect.destroy
- Defined in project/src/audio/audio-effects.ts:418

getInputNodes

getInputNodes(): AudioNode[]
Returns input audio nodes

Returns AudioNode[]
Implementation of OmpAudioEffect.getInputNodes
- Defined in project/src/audio/audio-effects.ts:367

getNodes

getNodes(): AudioNode[]
Returns all audio nodes

Returns AudioNode[]
Implementation of OmpAudioEffect.getNodes
- Defined in project/src/audio/audio-effects.ts:375

getOutputNode

getOutputNode(): AudioNode
Returns output audio nodes

Returns AudioNode
Implementation of OmpAudioEffect.getOutputNode
- Defined in project/src/audio/audio-effects.ts:371

getParams

getParams(): OmpAudioEffectParamType[] | undefined
Returns all effect parameters

Returns OmpAudioEffectParamType[] | undefined
Implementation of OmpAudioEffect.getParams
- Defined in project/src/audio/audio-effects.ts:379

setParam

setParam(param: OmpAudioEffectParam): void
Sets effect parameter.
Parameters
- param: OmpAudioEffectParam
Returns void
Implementation of OmpAudioEffect.setParam
- Defined in project/src/audio/audio-effects.ts:389

toDef

toDef(): OmpAudioEffectDef
Converts effect to effect definition

Returns OmpAudioEffectDef
Implementation of OmpAudioEffect.toDef
- Defined in project/src/audio/audio-effects.ts:383

`Static`createDef

createDef(id: string, gain: number): DefaultOmpAudioEffectDef
Parameters
- id: string
- gain: number
Returns DefaultOmpAudioEffectDef
- Defined in project/src/audio/audio-effects.ts:422