Class SoundRecorder

constructor

• new SoundRecorder(options: AudioWorkerOptions): SoundRecorder

  使用 Worker 模块创建录音器；调用 start 后开始采集。

  Parameters

  • options: AudioWorkerOptions

  Returns SoundRecorder

Readonly[audioHandle]

getChannelCount

• getChannelCount(): number

  返回采集声道数。

  Returns number

getChannelMap

• getChannelMap(): Readonly

  返回采集声道的扬声器位置映射。

  Returns Readonly

getDevice

• getDevice(): string

  返回当前录音设备名称。

  Returns string

getSampleRate

• getSampleRate(): number

  返回当前采样率，单位为 Hz。

  Returns number

getWorkerError

• getWorkerError(): undefined | Error

  返回 Worker 或子类回调的首次错误；没有错误时为 undefined。

  Returns undefined | Error

getWorkerStats

• getWorkerStats(): undefined | AudioWorkerStats

  返回当前 Worker 或子类回调队列统计；Native 快路径为 undefined。

  Returns undefined | AudioWorkerStats

setChannelCount

• setChannelCount(count: number): void

  设置采集声道数；必须等待当前异步录音操作结束后调用。

  Parameters

  • count: number

  Returns void

setDevice

• setDevice(name: string): Promise<boolean>

  异步切换录音设备并返回是否成功；按调用顺序执行，子类回调内不可调用。

  Parameters

  • name: string

  Returns Promise<boolean>

start

• start(sampleRate?: number): Promise<boolean>

  异步初始化采集会话，默认 44100 Hz；已采集、拒绝或启动失败返回 false。 不可在子类回调内部重新启动；应在外部等待 stop() 后再开启下一会话。

  Parameters

  • sampleRate: number = 44100

  Returns Promise<boolean>

stop

• stop(): Promise<void>

  异步停止采集并等待剩余样本及 onStop 完成。 子类回调内 await stop() 只等待设备停止，避免等待自身； 回调退出后继续排空，外部再次 await stop() 可等待完整结束。

  Returns Promise<void>

StaticgetAvailableDevices

• getAvailableDevices(): string[]

  返回当前可用录音设备的名称。

  Returns string[]

StaticgetDefaultDevice

• getDefaultDevice(): string

  返回默认录音设备名称。

  Returns string

StaticisAvailable

• isAvailable(): boolean

  返回系统是否支持音频采集。

  Returns boolean