Class Audio

音频解码播放

Hierarchy

Audio

Implements

IEventSource<{
    ended: [];
    pause: [];
    play: [];
}>

Index

Constructors

Properties

Methods

emit end off on once output pause play setDefaultOutput

Constructors

constructor

new Audio(url: String, options?: {
    cacheSize?: number;
    chunkQueueLength?: number;
    chunkSize?: number;
}): Audio
构建实例
Parameters
- url: String
  
  音频文件url
- Optional options: {
      cacheSize?: number;
      chunkQueueLength?: number;
      chunkSize?: number;
  }
  - Optional cacheSize?: number
    
    音频播放缓存大小，默认 600KB (600*1024)
  - Optional chunkQueueLength?: number
    
    分块数，默认5
  - Optional chunkSize?: number
    
    url数据分块获取大小，默认8192
Returns Audio

Properties

`Readonly` ended

ended: boolean

是否播放完成?

Methods

emit

emit(type: "ended" | "play" | "pause", ...args: never): Audio
触发事件
Parameters
- type: "ended" | "play" | "pause"
  
  事件类型
- Rest ...args: never
  
  事件参数
Returns Audio

Implementation of IEventSource.emit

end

end(): Audio
终止播放

Returns Audio

off

off(type: "ended" | "play" | "pause", handler: (() => void)): Audio
取消监听
Parameters
- type: "ended" | "play" | "pause"
- handler: (() => void)
  - - (): void
    - Returns void
Returns Audio

Implementation of IEventSource.off

on

on(type: "ended" | "play" | "pause", handler: (() => void)): Audio
添加监听
Parameters
- type: "ended" | "play" | "pause"
  
  Event type
- handler: (() => void)
  
  A callback function to process the incomming event
  - - (): void
    - Returns void
Returns Audio

Implementation of IEventSource.on

once

once(type: "ended" | "play" | "pause", handler: (() => void)): Audio
添加一次性监听
Parameters
- type: "ended" | "play" | "pause"
  
  Event type
- handler: (() => void)
  
  A callback function to process the incomming event
  - - (): void
    - Returns void
Returns Audio

Implementation of IEventSource.once

output

output(channel: null | I2sWriter): Audio
设置输出通道，用于播放
Parameters
- channel: null | I2sWriter
Returns Audio
output(): null | I2sWriter
返回当前输出通道

Returns null | I2sWriter

pause

pause(): Audio
暂停播放

Returns Audio

play

play(): Audio
开始播放

Returns Audio

`Static` setDefaultOutput

setDefaultOutput(output: null | I2sWriter): void
设置默认播放输出通道
Parameters
- output: null | I2sWriter
  
  I2S输出通道，null表示无默认
Returns void