RemoteTrack

更新时间: 2024-02-28 13:56:01

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

属性列表

属性

类型

描述

支持的最低版本

isPlaying

boolean

媒体轨道是否正在播放

3.0.0

trackMediaType

TrackMediaType

媒体轨道类型

3.0.0

userId

string

远端用户uid

3.0.0

接口列表

接口名称

描述

支持的最低版本

getMediaStreamTrack()

获取媒体轨道

3.0.0

getTrackId()

获取流轨道 id

3.0.0

play()

在页面上播放媒体轨道

3.0.0

replaceTrack()

替换音视频轨道

3.0.0

stop()

停止播放

3.0.0

off()

取消一个指定事件的监听回调函数

3.0.0

on()

监听一个指定事件并设置回调函数

3.0.0

once()

监听一个指定事件一次,回调函数触发后移除

3.0.0

removeAllListeners()

取消该对象指定事件或所有事件上的监听回调

3.0.0

事件列表

事件

事件参数

描述

支持的最低版本

"first-frame-decoded"

() => void

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

3.0.0

接口详情

getMediaStreamTrack()

获取媒体轨道

类型签名

getMediaStreamTrack(): MediaStreamTrack;

返回

MediaStreamTrack

媒体轨道

getTrackId()

获取流轨道 id

类型签名

getTrackId(): string;

返回

string

流轨道 id

play()

在页面上播放媒体轨道

类型签名

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

参数

参数

类型

描述

element

string | HTMLElement

(Optional)指定一个 DOM 元素,SDK 将在这个元素下创建video元素播放视频轨道,支持 2 种类型

- string: 指定该 DOM 元素的 ID 值。

- HTMLElement: 直接传入一个 DOM 元素对象。

config

VideoPlayerConfig

(Optional)视频媒体播放参数

返回

void

replaceTrack()

替换音视频轨道

类型签名

replaceTrack(track: MediaStreamTrack, stopOldTrack?: boolean): void;

参数

类型

描述

track

MediaStreamTrack

音视频轨道

stopOldTrack

boolean

(Optional)是否停止上一个轨道

返回

void

stop()

停止播放

类型签名

stop(): void;

返回

void

on()

监听一个指定事件并设置回调函数

类型签名

on(event: string, fn: Function): void;

参数

参数

类型

描述

event

string

监听的指定事件

fn

Function

监听事件触发时的回调函数

返回

void

off()

取消一个指定事件的监听回调函数

类型签名

off(event: string, fn: Function): void;

参数

参数

类型

描述

event

string

监听的指定事件

fn

Function

监听事件触发时的回调函数

返回

void

once()

监听一个指定事件一次,回调函数触发后移除

类型签名

once(event: string, fn: Function): void;

参数

参数

类型

描述

event

string

监听的指定事件

fn

Function

监听事件触发时的回调函数

返回

void

removeAllListeners()

取消该对象指定事件或所有事件上的监听回调

类型签名

removeAllListeners(event?: string): void;

参数

参数

类型

描述

event

string

(Optional)设置了指定事件时,对应监听回调函数将会清空。当参数未填写时,对象的所有事件的监听函数都将清空

返回

void

事件列表

"first-frame-decoded"

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

类型签名:

'first-frame-decoded': () => void

上一篇: MicrophoneAudioTrack 下一篇: RemoteVideoTrack
阿里云首页 音视频通信 相关技术圈