API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceSoundOptions

@codexo/exojs / audio / stable

Construction options for Sound.

8
props
0
methods
0
events
Import
import { SoundOptions } from '@codexo/exojs'

Construction options for Sound.

Properties8
loop?: boolean
Default loop setting. Default: false.
muted?: boolean
Default muted state. Default: false.
playbackRate?: number
Default playback rate. Default: 1.
poolSize?: number
poolStrategy?: SoundPoolStrategyEviction strategy used when the pool is full and a new play is requested. At the per-Sound level all pooled instances share the same priority, so `LowestPriori…
priority?: number
sprites?: Readonly<Record<string, AudioSpriteClipNamed sub-region of an AudioBuffer used as an audio sprite sheet. `start` / `end` are seconds into the buffer; `loop` makes the clip loop indefinitely when pla…>>
volume?: number
Default volume for voices created from this sound. Range [0, 1]. Default: 1.
Source
src/audio/Sound.ts