Agora Web API Reference
Hierarchy
-
IRemoteTrack
- IRemoteVideoTrack
Index
Properties
isPlaying
媒体轨道是否正在页面上播放。
true: 媒体轨道正在页面上播放。false: 媒体轨道没有在页面上播放。
trackMediaType
媒体轨道的类型：
"audio": 音频轨道。"video": 视频轨道。
Methods
getCurrentFrameData
-
Returns ImageData
存储了 RGBA 数据的
ImageData对象。该对象为浏览器原生对象，详见 ImageData。
getListeners
-
指定一个事件名，获取当前所有监听这个事件的回调函数。
Parameters
-
event: string
事件名称。
Returns Function[]
-
getMediaStreamTrack
-
获取浏览器原生的 MediaStreamTrack 对象。
Returns MediaStreamTrack
一个 MediaStreamTrack 对象。
getStats
-
获取远端视频轨道相关信息。
不推荐使用 请使用 AgoraRTCClient.getRemoteVideoStats 获取远端视频轨道相关信息。
Returns RemoteVideoTrackStats
一个 RemoteVideoTrackStats 对象。
getTrackId
-
获取由 SDK 生成的对于媒体轨道来说的唯一 ID。
Returns string
媒体轨道 ID。
getUserId
-
获取发布远端轨道的远端用户 ID。
Returns UID
远端轨道对应的
uid。
off
-
取消一个指定事件的监听。
Parameters
-
event: string
指定事件的名称。
-
listener: Function
监听事件时传入的回调函数。
Returns void
-
on
-
Parameters
-
event: "first-frame-decoded"
-
listener: event_first_frame_decoded
Returns void
-
once
-
监听一个指定的事件，当事件触发时会调用传入的回调函数。
当监听后事件第一次触发时，该监听和回调函数就会被立刻移除，也就是只监听一次指定事件。
Parameters
-
event: string
指定事件的名称。
-
listener: Function
传入的回调函数。
Returns void
-
play
-
在页面上播放本地视频轨道。
Parameters
-
element: string | HTMLElement
指定一个 DOM 元素，SDK 将在这个元素下创建
<video>元素播放视频轨道，支持 2 种类型：string: 指定该 DOM 元素的 ID 值。HTMLElement: 直接传入一个 DOM 元素对象。
-
Optional config: VideoPlayerConfig
设置播放参数（镜像/显示模式）。详见 VideoPlayerConfig。对于本地视频轨道，镜像模式默认开启。
Returns void
-
removeAllListeners
-
指定一个事件，取消其所有的监听。
Parameters
-
Optional event: undefined | string
指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。
Returns void
-
stop
-
停止播放。
Returns void
远端视频轨道。
调用 subscribe 后通过 AgoraRTCRemoteUser.videoTrack 对象获取。