Skip to content

EZ Web Audio / GrainPlayerOptions

Interface: GrainPlayerOptions

Defined in: packages/core/src/grain-player.ts:14

Configuration options for creating a GrainPlayer.

Properties

gain?

optional gain: number

Defined in: packages/core/src/grain-player.ts:28

Initial master gain, 0-1 (default: 1).


grainSize?

optional grainSize: number

Defined in: packages/core/src/grain-player.ts:16

Duration of each grain in seconds (default: 0.1, min: 0.01).


jitter?

optional jitter: number

Defined in: packages/core/src/grain-player.ts:24

Random scatter around the position for organic texture, 0-1 (default: 0).


loop?

optional loop: boolean

Defined in: packages/core/src/grain-player.ts:26

Whether to loop back to buffer start when reaching the end (default: true).


overlap?

optional overlap: number

Defined in: packages/core/src/grain-player.ts:18

Overlap between consecutive grains in seconds (default: 0.05).


pan?

optional pan: number

Defined in: packages/core/src/grain-player.ts:30

Initial master pan, -1 to 1 (default: 0).


pitch?

optional pitch: number

Defined in: packages/core/src/grain-player.ts:22

Pitch shift in semitones (default: 0). Converted to playbackRate via 2^(semitones/12).


position?

optional position: number

Defined in: packages/core/src/grain-player.ts:20

Initial playback position in the buffer, normalized 0-1 (default: 0).