sfml.js
    Preparing search index...

    Class Music

    按块解码和播放长音频,无需一次将全部样本加载到内存。

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    "[audioHandle]": AudioHandle<"source">
    ready: Promise<boolean>

    Worker 初始化和首批数据准备的结果;播放前应等待。

    times: BigInt64Array
    values: Float32Array
    Cone: typeof Cone = Cone

    方向锥配置类型。

    Status: typeof SoundStatus = SoundStatus

    播放状态枚举。

    TimeSpan: typeof TimeSpan = TimeSpan

    循环区间的时间段类型。

    Methods

    • 停止播放并异步关闭解码数据源。 在自身音频回调内调用时只请求关闭;实际清理于该回调结束后完成。

      Returns Promise<void>

    • 在对象所属 JS 线程填充交错 16 位 PCM;await super 可读取当前文件。 samples 指向原生可复用槽,仅在回调结束前有效;false 表示末块。

      Parameters

      Returns boolean | Promise<boolean>

    • 在对象所属 JS 线程准备末块时调用,返回下一轮交错样本偏移。 super 返回文件循环区间或 EOF 的位置;undefined 表示不循环。 实际定位由音频消费线程发起,再异步交给 onSeek。

      Returns undefined | bigint | Promise<undefined | bigint>

    • 在对象所属 JS 线程定位;await super 执行当前文件的默认定位。

      Parameters

      Returns void | Promise<void>

    • 异步打开音频文件用于流式播放,返回是否成功;不会自动 play。

      Parameters

      • filename: string

      Returns Promise<boolean>

    • 异步打开编码音频字节用于流式播放,返回是否成功。

      Parameters

      • data: Uint8Array

      Returns Promise<boolean>