Interface IRemoteVideoTrack

远端视频轨道。
调用 subscribe 后通过 AgoraRTCRemoteUser.videoTrack 对象获取。

Events

video-element-visible-status

video-element-visible-status(data?: CheckVideoVisibleResult): void

自从

4.8.0

提示 HTML <video> 标签的可见状态和不可见原因。SDK 每 30 秒触发一次该事件。

调用 remoteVideoTrack.play 后 SDK 会创建 HTML <video> 标签用于播放视频轨道。当 remoteVideoTrack.isPlaying 为 true 却看不到图像时，你可通过此事件来进行问题排查。

参数

参数名	描述
data: CheckVideoVisibleResult	`<video>` 标签的可见状态信息。

返回值

void

Properties

isPlaying

isPlaying: boolean

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

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

processorDestination

processorDestination: IBaseProcessor

自从

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

trackMediaType

trackMediaType: "audio" | "video"

媒体轨道的类型：

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

Methods

getCurrentFrameData

getCurrentFrameData(): ImageData

自从

4.1.0

获取当前渲染的视频帧数据。

注意

只有在播放后才能调用此方法，如果没有调用 play 则返回空数据。

返回值

ImageData

存储了 RGBA 数据的 ImageData 对象。该对象为浏览器原生对象，详见 ImageData。

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(): RemoteVideoTrackStats

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

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

返回值

RemoteVideoTrackStats

一个 RemoteVideoTrackStats 对象。

getTrackId

getTrackId(): string

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

返回值

string

媒体轨道 ID。

getUserId

getUserId(): UID

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

返回值

UID

远端轨道对应的 uid。

getVideoElementVisibleStatus

getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined

@自从
4.8.0

获取 HTML <video> 标签的可见状态和不可见原因。

调用 remoteVideoTrack.play 后 SDK 会创建 HTML <video> 标签用于播放视频轨道。当 remoteVideoTrack.isPlaying 为 true 却看不到图像时，你可调用该方法进行问题排查。

返回值

CheckVideoVisibleResult | undefined

CheckVideoVisibleResult 对象。如果该方法返回 undefined，可能为以下原因：

remoteVideoTrack.isPlaying 为 false。
<video> 标签不存在。
<video> 标签不是通过 play 方法调用产生的。

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: "video-state-changed", listener: typeof event_video_state_changed): void

on(event: "video-state-changed", listener: typeof event_video_state_changed): void

参数

参数名	描述
event: "video-state-changed"	事件名称。
listener: typeof event_video_state_changed	详见 video-state-changed。

返回值

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: "video-element-visible-status", listener: typeof event_video_element_visible_status_2): void

on(event: "video-element-visible-status", listener: typeof event_video_element_visible_status_2): void

参数

参数名	描述
event: "video-element-visible-status"	事件名称。
listener: typeof event_video_element_visible_status_2	详见 video-element-visible-status。

返回值

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

on(event: "sei-received", listener: typeof event_sei_received): void

on(event: "sei-received", listener: typeof event_sei_received): void

添加事件监听器。

参数

参数名	描述
event: "sei-received"	事件名称。
listener: typeof event_sei_received	详见 ILocalTrack.sei-received。

返回值

void

once

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

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

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

参数

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

返回值

void

pipe

pipe(processor: IBaseProcessor): IBaseProcessor

自从

4.13.0

将 Processor 注入远端视频轨道。

参数

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

返回值

IBaseProcessor

Processor 实例。

play

play(element: string | HTMLElement, config?: VideoPlayerConfig): void

在页面上播放本地视频轨道。

参数

参数名	描述
element: string \| HTMLElement	指定一个 DOM 元素，SDK 将在这个元素下创建 `<video>` 元素播放视频轨道，支持 2 种类型： `string`: 指定该 DOM 元素的 ID 值。 `HTMLElement`: 直接传入一个 DOM 元素对象。
config: VideoPlayerConfig	设置播放参数（镜像/显示模式）。详见 VideoPlayerConfig。对于本地视频轨道，镜像模式默认开启。

返回值

void

removeAllListeners

removeAllListeners(event?: string): void

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

参数

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

返回值

void

stop

stop(): void

停止播放。

返回值

void

unpipe

unpipe(): void

自从

4.13.0

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

返回值

void

Events​

video-element-visible-status

参数​

返回值​

Properties​

isPlaying

processorDestination

trackMediaType

Methods​

getCurrentFrameData

返回值​

getListeners

参数​

返回值​

getMediaStreamTrack

返回值​

getRTCRtpTransceiver

参数​

返回值​

getStats

返回值​

getTrackId

返回值​

getUserId

返回值​

getVideoElementVisibleStatus

返回值​

off

参数​

返回值​

on

参数​

返回值​

参数​

返回值​

参数​

返回值​

参数​

返回值​

参数​

返回值​

参数​

返回值​

once

参数​

返回值​

pipe

参数​

返回值​

play

参数​

返回值​

removeAllListeners

参数​

返回值​

stop

返回值​

unpipe

返回值​

Events

参数

返回值

Properties

Methods

返回值

参数

返回值

返回值

参数

返回值

返回值

返回值

返回值

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

返回值

返回值