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 却看不到图像时，你可通过此事件来进行问题排查。

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

Returns
返回类型	描述
void

Properties

isPlaying

isPlaying: boolean

Inherited from IBufferSourceAudioTrack.isPlaying

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

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

processorDestination

processorDestination: IBaseProcessor

自从

4.13.0

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

trackMediaType

trackMediaType: "audio"|"video"

Inherited from IBufferSourceAudioTrack.trackMediaType

媒体轨道的类型：

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

Methods

getCurrentFrameData

getCurrentFrameData(): ImageData

自从

4.1.0

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

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

Returns
返回类型	描述
ImageData	存储了 RGBA 数据的 `ImageData` 对象。该对象为浏览器原生对象，详见 ImageData。

getListeners

getListeners(event: string): Function[]

Inherited from EventEmitter.getListeners

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

Parameters
参数名	描述
`event`string required	事件名称。

Returns
返回类型	描述
Function[]

getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

Inherited from IBufferSourceAudioTrack.getMediaStreamTrack

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

Returns
返回类型	描述
MediaStreamTrack	一个 MediaStreamTrack 对象。

getRTCRtpTransceiver

getRTCRtpTransceiver(type?: StreamType): RTCRtpTransceiver | undefined

Inherited from IBufferSourceAudioTrack.getRTCRtpTransceiver

获取当前轨道的 RTCRtpTransceiver 实例。

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

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

本地轨道：ILocalTrack.transceiver-updated

远端轨道：IRemoteTrack.transceiver-updated

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

Returns
返回类型	描述
RTCRtpTransceiver \| undefined	当前轨道的 `RTCRtpTransceiver` 实例。

getStats

getStats(): RemoteVideoTrackStats

Overrides IRemoteTrack.getStats

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

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

Returns
返回类型	描述
RemoteVideoTrackStats	一个 RemoteVideoTrackStats 对象。

getTrackId

getTrackId(): string

Inherited from IBufferSourceAudioTrack.getTrackId

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

Returns
返回类型	描述
string	媒体轨道 ID。

getUserId

getUserId(): UID

Inherited from IRemoteAudioTrack.getUserId

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

Returns
返回类型	描述
UID	远端轨道对应的 `uid`。

getVideoElementVisibleStatus

getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined

自从

4.8.0

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

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

Returns
返回类型	描述
CheckVideoVisibleResult \| undefined	CheckVideoVisibleResult 对象。如果该方法返回 `undefined`，可能为以下原因： `remoteVideoTrack.isPlaying` 为 `false`。 `<video>` 标签不存在。 `<video>` 标签不是通过 `play` 方法调用产生的。

off

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

Inherited from EventEmitter.off

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

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

Returns
返回类型	描述
void

on

on [1/6]

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

Overrides IRemoteAudioTrack.on

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

Returns
返回类型	描述
void

on [2/6]

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

Overrides IRemoteAudioTrack.on

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

Returns
返回类型	描述
void

on [3/6]

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

Overrides IRemoteAudioTrack.on

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

Returns
返回类型	描述
void

on [4/6]

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

Overrides IRemoteAudioTrack.on

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

Returns
返回类型	描述
void

on [5/6]

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

Overrides IRemoteAudioTrack.on

添加事件监听器。

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

Returns
返回类型	描述
void

on [6/6]

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

Overrides IRemoteAudioTrack.on

添加事件监听器。

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

Returns
返回类型	描述
void

once

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

Inherited from EventEmitter.once

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

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

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

Returns
返回类型	描述
void

pipe

pipe(processor: IBaseProcessor): IBaseProcessor

自从

4.13.0

将 Processor 注入远端视频轨道。

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

Returns
返回类型	描述
IBaseProcessor	`Processor` 实例。

play

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

Overrides ILocalTrack.play

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

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

Returns
返回类型	描述
void

removeAllListeners

removeAllListeners(event?: string): void

Inherited from EventEmitter.removeAllListeners

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

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

Returns
返回类型	描述
void

stop

stop(): void

Inherited from IBufferSourceAudioTrack.stop

停止播放。

Returns
返回类型	描述
void

unpipe

unpipe(): void

自从

4.13.0

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

Returns
返回类型	描述
void

Events

video-element-visible-status

Properties

isPlaying

processorDestination

trackMediaType

Methods

getCurrentFrameData

getListeners

getMediaStreamTrack

getRTCRtpTransceiver

getStats

getTrackId

getUserId

getVideoElementVisibleStatus

off

on

on [1/6]

on [2/6]

on [3/6]

on [4/6]

on [5/6]

on [6/6]

once

pipe

play

removeAllListeners

stop

unpipe

咨询电话

咨询电话

EventsCopy Anchor Link

video-element-visible-statusCopy Anchor Link

PropertiesCopy Anchor Link

isPlayingCopy Anchor Link

processorDestinationCopy Anchor Link

trackMediaTypeCopy Anchor Link

MethodsCopy Anchor Link

getCurrentFrameDataCopy Anchor Link

getListenersCopy Anchor Link

getMediaStreamTrackCopy Anchor Link

getRTCRtpTransceiverCopy Anchor Link

getStatsCopy Anchor Link

getTrackIdCopy Anchor Link

getUserIdCopy Anchor Link

getVideoElementVisibleStatusCopy Anchor Link

offCopy Anchor Link

onCopy Anchor Link

on [1/6]Copy Anchor Link

on [2/6]Copy Anchor Link

on [3/6]Copy Anchor Link

on [4/6]Copy Anchor Link

on [5/6]Copy Anchor Link

on [6/6]Copy Anchor Link

onceCopy Anchor Link

pipeCopy Anchor Link

playCopy Anchor Link

removeAllListenersCopy Anchor Link

stopCopy Anchor Link

unpipeCopy Anchor Link

咨询电话

咨询电话

Events

video-element-visible-status

Properties

isPlaying

processorDestination

trackMediaType

Methods

getCurrentFrameData

getListeners

getMediaStreamTrack

getRTCRtpTransceiver

getStats

getTrackId

getUserId

getVideoElementVisibleStatus

off

on

on [1/6]

on [2/6]

on [3/6]

on [4/6]

on [5/6]

on [6/6]

once

pipe

play

removeAllListeners

stop

unpipe