Interface IRemoteAudioTrack

PropertiesCopy Anchor Link

isPlayingCopy Anchor Link

isPlaying: boolean

Inherited from IBufferSourceAudioTrack.isPlaying

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

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

processorDestinationCopy Anchor Link

processorDestination: IAudioProcessor

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

trackMediaTypeCopy Anchor Link

trackMediaType: "audio"|"video"

Inherited from IBufferSourceAudioTrack.trackMediaType

媒体轨道的类型：

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

MethodsCopy Anchor Link

getListenersCopy Anchor Link

getListeners(event: string): Function[]

Inherited from EventEmitter.getListeners

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

getMediaStreamTrackCopy Anchor Link

getMediaStreamTrack(): MediaStreamTrack

Inherited from IBufferSourceAudioTrack.getMediaStreamTrack

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

getRTCRtpTransceiverCopy Anchor Link

getRTCRtpTransceiver(type?: StreamType): RTCRtpTransceiver | undefined

Inherited from IBufferSourceAudioTrack.getRTCRtpTransceiver

获取当前轨道的 RTCRtpTransceiver 实例。

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

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

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

getStatsCopy Anchor Link

getStats(): RemoteAudioTrackStats

Overrides IRemoteTrack.getStats

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

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

getTrackIdCopy Anchor Link

getTrackId(): string

Inherited from IBufferSourceAudioTrack.getTrackId

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

getUserIdCopy Anchor Link

getUserId(): UID

Inherited from IRemoteAudioTrack.getUserId

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

getVolumeCopy Anchor Link

getVolume(): number

getVolumeLevelCopy Anchor Link

getVolumeLevel(): number

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

offCopy Anchor Link

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

Inherited from EventEmitter.off

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

onCopy Anchor Link

on [1/3]Copy Anchor Link

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

Inherited from IRemoteAudioTrack.on

Overrides EventEmitter.on

on [2/3]Copy Anchor Link

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

Inherited from IRemoteAudioTrack.on

Overrides EventEmitter.on

on [3/3]Copy Anchor Link

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

Inherited from IRemoteAudioTrack.on

Overrides EventEmitter.on

添加事件监听器。

onceCopy Anchor Link

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

Inherited from EventEmitter.once

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

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

pipeCopy Anchor Link

pipe(processor: IAudioProcessor): IAudioProcessor

将 Processor 注入远端音频轨道。

playCopy Anchor Link

play(): void

Overrides ILocalTrack.play

播放远端音频轨道。

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

removeAllListenersCopy Anchor Link

removeAllListeners(event?: string): void

Inherited from EventEmitter.removeAllListeners

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

setAmplifiedVolumeCopy Anchor Link

setAmplifiedVolume(volume: number): void

setAudioFrameCallbackCopy Anchor Link

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);

setPlaybackDeviceCopy Anchor Link

setPlaybackDevice(deviceId: string): Promise<void>

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

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

setVolumeCopy Anchor Link

setVolume(volume: number): void

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

stopCopy Anchor Link

stop(): void

Inherited from IBufferSourceAudioTrack.stop

停止播放。

unpipeCopy Anchor Link

unpipe(): void

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