Skip to content

EZ Web Audio / createGainEffect

Function: createGainEffect()

Call Signature

createGainEffect(initialValue?): GainEffect

Defined in: effects/gain-effect.ts:120

Factory function to create a GainEffect.

AudioContext is optional. If omitted, uses the shared library AudioContext (created lazily on first use).

Parameters

initialValue?

number

Initial gain value (default: 1.0). Pass AudioContext as first arg for backwards compatibility.

Returns

GainEffect

A new GainEffect instance

Example

typescript
// Without AudioContext (recommended)
const gain = createGainEffect(0.5)

// With explicit AudioContext (backwards compatible)
const gain = createGainEffect(audioContext, 0.5)

Call Signature

createGainEffect(audioContext, initialValue?): GainEffect

Defined in: effects/gain-effect.ts:121

Factory function to create a GainEffect.

AudioContext is optional. If omitted, uses the shared library AudioContext (created lazily on first use).

Parameters

audioContext

AudioContext

initialValue?

number

Initial gain value (default: 1.0). Pass AudioContext as first arg for backwards compatibility.

Returns

GainEffect

A new GainEffect instance

Example

typescript
// Without AudioContext (recommended)
const gain = createGainEffect(0.5)

// With explicit AudioContext (backwards compatible)
const gain = createGainEffect(audioContext, 0.5)