API reference

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

I

interfaceSoundAssetOptions

@codexo/exojs / assets / stable

Options accepted by an asset of the built-in `sound` type.

3
props
0
methods
0
events
Import
import { SoundAssetOptions } from '@codexo/exojs'

Options accepted by an asset of the built-in `sound` type.

Properties3
playbackOptions?: Partial<PlaybackOptionsCommon playback configuration for Sound and AudioStream.>
Initial playback settings forwarded to the Sound instance.
poolSize?: number
Concurrent voices the Sound pre-allocates; Sound's own default when omitted.
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…>> | string
Named sub-regions of the decoded buffer, for use as an audio sprite sheet. A string is the source of a sidecar JSON document holding the same map (see SoundSpriteSheet). It is loaded through the sound's own dependency scope, so the sidecar is released with the sound, and it is resolved against the loader's base path like any other asset source - not relative to the audio file.
Source
src/assets/factories/SoundFactory.ts