ReadonlyreadyResult of Worker initialization and initial data preparation; await before playback.
Protected ReadonlytimesProtected ReadonlyvaluesStatic ReadonlyConeDirectional cone configuration type.
Static ReadonlyStatusPlayback status enumeration.
Static ReadonlyTimeTime span type for the loop region.
Copy source attributes, retaining this source's content and playback.
sourceStop playback and asynchronously close the decoding data source. Inside this object's own audio callback, only request closure; actual cleanup completes after that callback ends.
ProtectedcommandcommandProtectedfieldfieldwriteProtectedgetfieldReturn the distance attenuation factor.
Return the number of channels.
Return the speaker positions of the interleaved channels.
Return the directional attenuation factor.
Return the Doppler effect multiplier.
Return a copy of the loop region, including its starting offset and length.
Return the maximum distance.
Return the maximum gain.
Return the minimum reference distance.
Return the minimum gain.
Return the stereo pan.
Return the pitch multiplier.
Return the sample rate per channel, in Hz.
Return the volume percentage.
Return the latest streaming decoder pump error, or undefined if no pump is used or no error exists.
Return streaming decoder queue statistics, or undefined if no pump is used.
Return whether playback loops.
Return whether listener-relative coordinates are used.
Return whether spatialization is enabled.
ProtectedonFill interleaved 16-bit PCM on the object's owning JS thread; await super to read the current file. samples references a reusable native slot, valid only until the callback ends; false denotes the final block.
chunkProtectedonCalled on the object's owning JS thread while preparing the final block; return the next loop's interleaved sample offset. super returns the file's loop region or EOF position; undefined means no loop. The audio consumer thread initiates the actual seek, then asynchronously delegates to onSeek.
ProtectedonSeek on the object's owning JS thread; await super performs the current file's default seek.
offsetAsynchronously open an audio file for streaming and return whether it succeeded; does not call play automatically.
filenameAsynchronously open encoded audio bytes for streaming, returning whether it succeeded.
dataAsynchronously open a seekable stream, retaining the data source needed for decoding until close.
streamPause and retain the playback position.
Start or resume playback; if already playing, restart per SFML semantics.
ProtectedrefreshSet the distance attenuation factor; 0 disables distance attenuation.
valueSet the inner and outer cone angles and outer gain, updating the native audio engine.
valueSet the sound source's emission direction.
valueSet the factor controlling the source direction's effect on attenuation.
valueSet the Doppler effect multiplier; 0 disables it.
valueBind and retain an effect processor reference; undefined removes it.
processorOptionalSet whether playback loops after reaching the end.
valueSet the loop region; call setLooping(true) separately to enable looping.
valueSet the maximum distance used for distance attenuation.
valueSet the maximum gain after distance attenuation.
valueSet the minimum reference distance at which maximum volume is maintained.
valueSet the minimum gain after distance attenuation.
valueSet stereo pan: -1 is left, 0 is center, and 1 is right.
valueSet the pitch and playback rate multiplier; 1 is the original rate.
valueSet the playback time relative to the beginning of the sound.
valueSet the 3D position using the same units as the listener and distances.
valueSet whether the position is relative to the listener; false uses world coordinates.
valueEnable or disable spatial effects from position, distance, and direction.
valueSet the 3D velocity for the Doppler effect, in position units per second.
valueSet volume as a percentage; 0 is silent and 100 is the original volume.
valueStop and reset the playback position to zero.
Decode and play long audio in blocks without loading all samples into memory at once.