Optional _cacophony: CacophonyPrivate Optional _cacophonyPrivate _playbackOptional bufferPrivate eventPrivate globalRetrieves the duration of the sound in seconds. If the sound is based on an AudioBuffer, it returns the duration of the buffer. Otherwise, if the sound has not been played and is a MediaElementSource, it returns NaN, indicating that the duration is unknown or not applicable.
The duration of the sound in seconds.
Returns a boolean indicating whether the object is currently playing. an object is playing if any of its playbacks are currently playing.
True if the object is playing, false otherwise.
Retrieves the current 3D spatial position of the sound in the audio context. The position is returned as an array of three values[x, y, z].
The current position of the sound.
Sets the 3D spatial position of the sound in the audio context. The position is an array of three values[x, y, z]. This method updates the position of all active playbacks of the sound.
The new position of the sound.
Adds a BiquadFilterNode to the container's filter chain. Filters are cloned when creating new playbacks - existing playbacks are not affected. Each playback gets independent filter instances for isolated processing.
The filter to add to the chain.
Clones the current Sound instance, creating a deep copy with the option to override specific properties.
This method allows for the creation of a new, independent Sound instance based on the current one, with the
flexibility to modify certain attributes through the overrides parameter. This is particularly useful for
creating variations of a sound without affecting the original instance. The cloned instance includes all properties,
playback settings, and filters of the original, unless explicitly overridden.
An object specifying properties to override in the cloned instance. This can include audio settings like volume, playback rate, and spatial positioning, as well as more complex configurations like 3D audio options and filter adjustments.
A new Sound instance that is a clone of the current sound.
Protected emitProtected emitFades in all playbacks from silence to their current volume.
The fade duration in milliseconds.
Optional type: FadeTypeThe fade curve type. Defaults to "linear".
Resolves when all fades complete.
Fades out all playbacks from their current volume to silence.
The fade duration in milliseconds.
Optional type: FadeTypeThe fade curve type. Defaults to "linear".
Resolves when all fades complete.
Fades the volume of all playbacks to a target value over a duration.
The target volume (0 to 1).
The fade duration in milliseconds.
Optional type: FadeTypeThe fade curve type. Defaults to "linear".
Resolves when all fades complete.
Sets or retrieves the loop behavior for the sound. If loopCount is provided, the sound will loop the specified number of times. If loopCount is 'infinite', the sound will loop indefinitely until stopped. If no argument is provided, the method returns the current loop count setting.
Optional loopCount: LoopCountThe number of times to loop or 'infinite' for indefinite looping.
The current loop count setting if no argument is provided.
Remove event listener.
Register event listener.
Cleanup function
Optional options: PlayOptionsRemoves a BiquadFilterNode from the container's filter chain. Only affects future playbacks - existing playbacks retain their cloned filters.
The filter to remove from the chain.
If the filter was never added to this container.
Fades out all playbacks then stops them.
The fade-out duration in milliseconds.
Optional type: FadeTypeThe fade curve type. Defaults to "linear".
Resolves when the fade completes and all playbacks are stopped.
The base interface for any sound-producing entity, including individual sounds, groups, and playbacks. BaseSound