Interface IRemoteAudioTrack

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

Properties

isPlaying

isPlaying: boolean

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

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

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

processorDestination

processorDestination: IAudioProcessor

自从

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

trackMediaType

trackMediaType: "audio" | "video"

媒体轨道的类型：

• "audio": 音频轨道。

• "video": 视频轨道。

Methods

getListeners

getListeners(event: string): Function[]

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

参数

参数名	描述
event: string	事件名称。

返回值

Function[]

getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

获取浏览器原生的 MediaStreamTrack 对象。

返回值

MediaStreamTrack

一个 MediaStreamTrack 对象。

getRTCRtpTransceiver

getRTCRtpTransceiver(type?: StreamType): RTCRtpTransceiver | undefined

获取当前轨道的 RTCRtpTransceiver 实例。

该方法目前主要用于视频流的端到端加密（Beta）。

注意

如果 SDK 发生断线重连，当前轨道对应的 RTCRtpTransceiver 实例可能会发生变化。你可以通过以下回调来获取新的 RTCRtpTransceiver 实例：

• 本地轨道：ILocalTrack.transceiver-updated
• 远端轨道：IRemoteTrack.transceiver-updated

参数

参数名	描述
type: StreamType	视频流的类型。详见 StreamType。

返回值

RTCRtpTransceiver | undefined

当前轨道的 RTCRtpTransceiver 实例。

getStats

getStats(): RemoteAudioTrackStats

获取远端音频轨道相关信息。

不推荐使用 请使用 AgoraRTCClient.getRemoteAudioStats 获取远端音频轨道相关信息。

返回值

RemoteAudioTrackStats

一个 RemoteAudioTrackStats 对象。

getTrackId

getTrackId(): string

获取由 SDK 生成的对于媒体轨道来说的唯一 ID。

返回值

string

媒体轨道 ID。

getUserId

getUserId(): UID

获取发布远端轨道的远端用户 ID。

返回值

UID

远端轨道对应的 uid。

getVolumeLevel

getVolumeLevel(): number

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

返回值

number

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

off

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

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

参数

参数名	描述
event: string	指定事件的名称。
listener: Function	监听事件时传入的回调函数。

返回值

void

on

on(event: "track-updated", listener: typeof event_track_updated): void

on(event: "track-updated", listener: typeof event_track_updated): void

参数

参数名	描述
event: "track-updated"	事件名称。
listener: typeof event_track_updated	详见 track-updated。

返回值

void

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

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

参数

参数名	描述
event: "first-frame-decoded"	事件名称。
listener: typeof event_first_frame_decoded	详见 first-frame-decoded。

返回值

void

on(event: "transceiver-updated", listener: typeof event_transceiver_updated_2): void

on(event: "transceiver-updated", listener: typeof event_transceiver_updated_2): void

添加事件监听器。

参数

参数名	描述
event: "transceiver-updated"	事件名称。
listener: typeof event_transceiver_updated_2	详见 IRemoteTrack.transceiver-updated。

返回值

void

once

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

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

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

参数

参数名	描述
event: string	指定事件的名称。
listener: Function	传入的回调函数。

返回值

void

pipe

pipe(processor: IAudioProcessor): IAudioProcessor

自从

4.13.0

将 Processor 注入远端音频轨道。

参数

参数名	描述
processor: IAudioProcessor	Processor 实例。每个插件均有对应类型的 Processor。

返回值

IAudioProcessor

Processor 实例。

play

play(): void

播放远端音频轨道。

注意

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

返回值

void

removeAllListeners

removeAllListeners(event?: string): void

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

参数

参数名	描述
event: string	指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。

返回值

void

setAudioFrameCallback

setAudioFrameCallback(audioFrameCallback: null | function, frameSize?: 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);

参数

参数名	描述
audioFrameCallback: null | function	用于接收 AudioBuffer 的回调函数。设为 null 后，SDK 就会停止获取音频原始数据。
frameSize: number	每次回调的 AudioBuffer 中每个声道包含的采样数据个数，只能设为下列值：256, 512, 1024, 2048, 4096, 8192, 16384。默认为 4096。

返回值

void

setPlaybackDevice

setPlaybackDevice(deviceId: string): Promise<void>

自从

4.1.0

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

注意

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

参数

参数名	描述
deviceId: string	设备 ID，可以通过 getPlaybackDevices 方法获取。

返回值

Promise<void>

setVolume

setVolume(volume: number): void

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

参数

参数名	描述
volume: number	音量值，范围 [0, 100]，0 代表静音，100 代表原始音量。

返回值

void

stop

stop(): void

停止播放。

返回值

void

unpipe

unpipe(): void

自从

4.13.0

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

返回值

void