← API
Interface
PlayOptions
Members
- bus Override the default bus for this voice.
- duration If set, voice auto-stops after this many seconds. Used by Sprite.
- fadeIn Fade-in duration (seconds) applied to the voice's gain at start. Default 0 (instant). Convenience for "drop in smoothly" — the dual of the click-free stop fade. Equivalent to playing at
- loop Loop the voice. Default false.
- loopCrossfade Equal-power crossfade duration (seconds) at the loop boundary. When
- loopEnd When loop=true, end of the loop region (seconds).
- loopStart When loop=true, start of the loop region (seconds).
- offset Offset into the buffer (seconds) to start at. Default 0. Used by Sprite.
- pitch Playback rate. 1 = source speed. Random jitter optional.
- priority Voice priority — higher = more likely to survive stealing. Default 0.
- signal AbortSignal — voice stops when aborted.
- spatializer 2D pan or 3D position. Inserts a Spatializer between the voice and its bus.
- volume Initial volume (0..1). Default 1.