Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RtcAudioMixingManager

Hierarchy

  • EventEmitter
    • RtcAudioMixingManager

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

createAudioMixingTask

  • createAudioMixingTask(taskId: number, fileName: string): number

  • 创建混音任务。

    note:

    在Windows平台请使用UTF-8传输文件名。

    Parameters

    • taskId: number

      任务标识。

    • fileName: string

    Returns number

    • OK: 成功
    • 其他: 失败

destroyAudioMixingTask

  • destroyAudioMixingTask(taskId: number): number

  • 销毁混音任务。

    Parameters

    • taskId: number

      任务标识。

    Returns number

    • OK: 成功
    • 其他: 失败

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getCurrentTimestamp

  • getCurrentTimestamp(taskId: number): number

  • 获取当前时间戳。

    Parameters

    • taskId: number

      任务标识。

    Returns number

    • 时间戳(单位毫秒)

getDuration

  • getDuration(taskId: number): number

  • 获取音频文件的总时长。

    note

    总时长是根据文件平均码率估算出来的。对于某些非恒定码率的音频文件，可能与实际总时长相比存在一定偏差。

    Parameters

    • taskId: number

      任务标识。

    Returns number

    • 时长 (单位毫秒)

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

pause

  • pause(taskId: number): number

  • 暂停混音任务。

    Parameters

    • taskId: number

      任务标识。

    Returns number

    • OK: 成功
    • 其他: 失败

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resume

  • resume(taskId: number): number

  • 恢复被暂停的混音任务。

    Parameters

    • taskId: number

      任务标识。

    Returns number

    • OK: 成功
    • 其他: 失败

seek

  • seek(taskId: number, timestampMs: number): number

  • 跳转至指定时间戳。

    Parameters

    • taskId: number

      任务标识。

    • timestampMs: number

      时间戳。

    Returns number

    • OK: 成功
    • 其他: 失败

setMaxListeners

  • setMaxListeners(n: number): this

start

  • start(taskId: number, cfg: Object): number

  • 启动混音任务。

    note

    实际的混音操作仅在加入房间后进行。

    Parameters

    • taskId: number

      任务标识。

    • cfg: Object

    Returns number

    • OK: 成功
    • 其他: 失败

stop

  • stop(taskId: number): number

  • 结束混音任务。

    Parameters

    • taskId: number

      任务标识。

    Returns number

    • OK: 成功
    • 其他: 失败

update

  • update(taskId: number, cfg: Object): number

  • 更新混音任务。

    Parameters

    • taskId: number

      任务标识。

    • cfg: Object

    Returns number

    • OK: 成功
    • 其他: 失败

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc