EZ Web Audio

Appearance

EZ Web Audio / createGainEffect

Function: createGainEffect() ​

Call Signature ​

createGainEffect(initialValue?): GainEffect

Defined in: packages/core/src/effects/gain-effect.ts:142

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: packages/core/src/effects/gain-effect.ts:143

Factory function to create a GainEffect.

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

Parameters ​

audioContext ​

BaseAudioContext

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)