通知
本站点除 Legacy 产品与方案外，已迁移至 声网新文档中心 ，当前页面不再维护
文档中心
全部产品
Console 官网 社区 技术支持
简体中文
search-icon

Agora Web API Reference

概览 AgoraRTC AgoraRTCClient LocalTrack RemoteTrack 错误码

远端音频轨道，调用 subscribe 后通过 AgoraRTCRemoteUser.audioTrack 对象获取

Hierarchy

Index

Properties

Methods

Properties

isPlaying

isPlaying: boolean

媒体轨道是否正在页面上播放。

  • true: 媒体轨道正在页面上播放。
  • false: 媒体轨道没有在页面上播放。

processorDestination

processorDestination: IAudioProcessor

自从
   4.13.0

远端音频轨道上当前媒体处理链路的最终节点。

trackMediaType

trackMediaType: "audio" | "video"

媒体轨道的类型：

  • "audio": 音频轨道。
  • "video": 视频轨道。

Methods

getListeners

  • getListeners(event: string): Function[]

  • 指定一个事件名，获取当前所有监听这个事件的回调函数。

    Parameters

    • event: string

      事件名称。

    Returns Function[]

getMediaStreamTrack

  • getMediaStreamTrack(): MediaStreamTrack

getStats

getTrackId

  • getTrackId(): string

getUserId

  • getUserId(): UID

getVolumeLevel

  • getVolumeLevel(): number

  • 获取远端音频轨道的音量等级。

    Returns number

    音量等级值，范围 [0, 1]，1 代表理论最大音量。通常该值大于 0.6 代表用户在持续说话。

off

  • off(event: string, listener: Function): void

  • 取消一个指定事件的监听。

    Parameters

    • event: string

      指定事件的名称。

    • listener: Function

      监听事件时传入的回调函数。

    Returns void

on

  • on(event: "first-frame-decoded", listener: typeof event_first_frame_decoded): void

once

  • once(event: string, listener: Function): void

  • 监听一个指定的事件，当事件触发时会调用传入的回调函数。

    当监听后事件第一次触发时，该监听和回调函数就会被立刻移除，也就是只监听一次指定事件。

    Parameters

    • event: string

      指定事件的名称。

    • listener: Function

      传入的回调函数。

    Returns void

pipe

  • pipe(processor: IAudioProcessor): IAudioProcessor

  • 自从
       4.13.0

    将 Processor 注入远端音频轨道。

    Parameters

    • processor: IAudioProcessor

      Processor 实例。每个插件均有对应类型的 Processor。

    Returns IAudioProcessor

    Processor 实例。

play

  • play(): void

  • 播放远端音频轨道。

    播放音频时 SDK 不会创建任何 DOM 元素，所以无需像视频一样提供 DOM 元素。

    Returns void

removeAllListeners

  • removeAllListeners(event?: undefined | string): void

  • 指定一个事件，取消其所有的监听。

    Parameters

    • Optional event: undefined | string

      指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。

    Returns void

setAudioFrameCallback

  • setAudioFrameCallback(audioFrameCallback: null | function, frameSize?: undefined | number): void

  • 设置原始音频数据（PCM）回调。

    设置成功后，SDK 会不断地将远端音频轨道的音频帧以 AudioBuffer 的形式通过回调返回。

    你可以通过 frameSize 来设置每次回调中音频帧的大小。该设置也会影响回调的间隔，frameSize 越大，每次回调的音频数据越多，回调间隔越长。

    track.setAudioFrameCallback((buffer) => {
  for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
    // Float32Array with PCM data
    const currentChannelData = buffer.getChannelData(channel);
    console.log("PCM data in channel", channel, currentChannelData);
  }
}, 2048);

// ....
// Stop getting the raw audio data
track.setAudioFrameCallback(null);

    Parameters

    • audioFrameCallback: null | function

      用于接收 AudioBuffer 的回调函数。设为 null 后，SDK 就会停止获取音频原始数据。

    • Optional frameSize: undefined | number

      每次回调的 AudioBuffer 中每个声道包含的采样数据个数，只能设为下列值：256, 512, 1024, 2048, 4096, 8192, 16384。默认为 4096。

    Returns void

setPlaybackDevice

  • setPlaybackDevice(deviceId: string): Promise<void>

  • 自从
       4.1.0

    设置音频播放设备，比如扬声器。

    该方法只支持桌面端的 Chrome 浏览器，其他浏览器调用将会抛出 NOT_SUPPORTED 错误。

    Parameters

    Returns Promise<void>

setVolume

  • setVolume(volume: number): void

  • 设置远端音频轨道的播放音量

    Parameters

    • volume: number

      音量值，范围 [0, 100]，0 代表静音，100 代表原始音量。

    Returns void

stop

  • stop(): void

unpipe

  • unpipe(): void

  • 自从
       4.13.0

    取消远端音频轨道上注入的 Processor。

    Returns void