RemoteVideoTrack

继承

• RemoteTrack
  • RemoteVideoTrack

属性

isPlaying

isPlaying: boolean

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

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

trackMediaType

trackMediaType: "audio" | "video"

媒体轨道的类型：

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

方法

getCurrentFrameData

getCurrentFrameData(event: string): ImageData

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

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

返回值 ImageData

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

示例

const frameData = videoTrack.getCurrentFrameData();
// 创建canvas
const canvas = document.createElement("canvas");
canvas.width = frameData.width;
canvas.height = frameData.height;
const ctx = canvas.getContext('2d');
// 将截图显示在canvas上面
ctx.putImageData(frameData, 0,0);
// 获取 dataUrl 作为图片的 src 属性
const dataUrl = canvas.toDataURL();
// 自动保存图片
const a = document.createElement("a"); // 生成一个a元素
const event = new MouseEvent("click"); // 创建一个单击事件
a.download = "photo"; // 设置图片名称
a.href = dataUrl; // 将生成的URL设置为a.href属性
a.dispatchEvent(event); // 触发a的单击事件

getListeners

getListeners(event: string): Function[]

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

参数

• event: string

  事件名称。

返回值 Function[]

getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

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

返回值 MediaStreamTrack

一个 MediaStreamTrack 对象。

getTrackId

getTrackId(): string

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

返回值 string

媒体轨道 ID。

off

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

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

参数

• event: string

  指定事件的名称。

• listener: Function

  监听事件时传入的回调函数。

返回值 void

on

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

参数

• event: "first-frame-decoded"

• listener: event_first_frame_decoded

返回值 void

once

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

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

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

参数

• event: string

  指定事件的名称。

• listener: Function

  传入的回调函数。

返回值 void

play

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

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

参数

• element: string | HTMLElement

  指定一个 DOM 元素，SDK 将在这个元素下创建 <video> 元素播放视频轨道，支持 2 种类型：

  • string: 指定该 DOM 元素的 ID 值。
  • HTMLElement: 直接传入一个 DOM 元素对象。

• Optional config: VideoPlayerConfig

  设置播放参数（镜像/显示模式）。详见 VideoPlayerConfig。对于本地视频轨道，镜像模式默认开启。

返回值 void

removeAllListeners

removeAllListeners(event?: undefined | string): void

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

参数

• Optional event: undefined | string

  指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。

返回值 void

stop

stop(): void

停止播放。

返回值 void