API reference
Preparing search index…

SoundStream

Buffered SFML stream. The supplied module produces PCM in a Node Worker.

Type hierarchy

Hierarchy (View Summary)

Source & inheritance
Member directory59

Constructors

Properties

Methods

Constructors

Properties

ready: Promise<boolean>

Result of Worker initialization and initial data preparation; await before playback.

Source & inheritance
times: BigInt64Array
Source & inheritance
values: Float32Array
Source & inheritance
Cone: typeof Cone = Cone

Directional cone configuration type.

Source & inheritance
Status: typeof SoundStatus = SoundStatus

Playback status enumeration.

Source & inheritance

Methods

  • Stop playback and asynchronously close the Worker session.

    Returns

    Promise<void>
    Source & inheritance
  • Return the speaker positions of the interleaved channels.

    Returns

    Readonly
    Source & inheritance
  • Return the Worker error, or undefined if no error has occurred.

    Returns

    undefined | Error
    Source & inheritance

Symbol members

"[audioHandle]": AudioHandle<"source">
Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0