Interface IRemoteTrack

远端轨道对象的基础类，为远端音频轨道 RemoteAudioTrack 和远端视频轨道 RemoteVideoTrack 提供一些公共的方法。

Events

first-frame-decoded

first-frame-decoded(): void

首帧音频或视频解码时触发。

返回值

void

transceiver-updated

transceiver-updated(transceiver: RTCRtpTransceiver): void

当前轨道的 RTCRtpTransceiver 实例更新回调。

参数

参数名	描述
transceiver: RTCRtpTransceiver	新的 RTCRtpTransceiver 实例。

返回值

void

video-state-changed

video-state-changed(videoState: VideoState): void

视频状态发生变化时触发。

参数

参数名	描述
videoState: VideoState

返回值

void

Properties

isPlaying

isPlaying: boolean

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

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

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

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 | RemoteVideoTrackStats

获取远端轨道相关信息。

deprecated

自 v4.1.0 起废弃，请使用 AgoraRTCClient.getRemoteVideoStats 和 AgoraRTCClient.getRemoteAudioStats。

返回值

RemoteAudioTrackStats | RemoteVideoTrackStats

RemoteAudioTrackStats 或 RemoteVideoTrackStats 对象。

getTrackId

getTrackId(): string

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

返回值

string

媒体轨道 ID。

getUserId

getUserId(): UID

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

返回值

UID

远端轨道对应的 uid。

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

play

play(element?: string | HTMLElement): void

在页面上播放媒体轨道。

参数

参数名	描述
element: string | HTMLElement	指定一个 DOM 元素，SDK 将在这个元素下创建 <video> 元素播放视频轨道，支持 2 种类型： string: 指定该 DOM 元素的 ID 值。 HTMLElement: 直接传入一个 DOM 元素对象。

返回值

void

removeAllListeners

removeAllListeners(event?: string): void

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

参数

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

返回值

void

stop

stop(): void

停止播放。

返回值

void