Whether a media track is playing on the webpage:
true
: The media track is playing on the webpage.false
: The media track is not playing on the webpage.Since
4.13.0
The destination of the current processing pipeline on the remote video track.
The type of a media track:
"audio"
: Audio track."video"
: Video track.Since
4.1.0
Gets the data of the video frame being rendered.
You should call this method after calling [[play]]. Otherwise, the method call returns null.
An ImageData
object that stores RGBA data. ImageData
is a web API supported by the browser. For details, see ImageData.
Gets an MediaStreamTrack object.
An MediaStreamTrack object.
Gets the RTCRtpTransceiver instance of the current track.
This method is currently mainly used for end-to-end encryption of video streams (Beta).
If the SDK experiences a reconnection, the
RTCRtpTransceiver
instance corresponding to the current track might change. You can obtain the newRTCRtpTransceiver
instance through the following callbacks:
- For a local track: ["transceiver-updated"]ILocalTrack.event_transceiver_updated
- For a remote track: ["transceiver-updated-2"]IRemoteTrack.event_transceiver_updated_2
Optional
type: StreamTypeThe type of the video stream. See StreamType.
The RTCRtpTransceiver instance of the current track.
Gets the statistics of a remote video track.
An [[RemoteVideoTrackStats]] object。
Since
4.8.0
Gets the visibility of the <video>
HTML tag.
After you call remoteVideoTrack.play
, the SDK creates an <video>
tag for playing video tracks. When remoteVideoTrack.isPlaying
is true
but you cannot see any video, call this method to check whether the <video>
tag is visible or not and learn the reason when the <video>
tag is invisible.
The [[CheckVideoVisibleResult]] object. If this method returns undefined
, it may be due to the following reasons:
localRemoteTrack.isPlaying
is false
.<video>
tag does not exist.<video>
tag is not created by calling the play
method.The event name.
See [first-frame-decoded]__type.
Occurs when the first remote audio or video frame is decoded.
IRemoteTrack
Events
The event name.
See [video-element-visible-status]__type.
Since
4.8.0
Indicates the visibility of the <video>
HTML tag.
The SDK triggers this event every 30 seconds.
After you call remoteVideoTrack.play
, the SDK creates an <video>
tag for playing video tracks. When remoteVideoTrack.isPlaying
is true
but you cannot see any video, this event helps you check whether the <video>
tag is visible or not and learn the reason when the <video>
tag is invisible.
Optional
data: CheckVisibleResultThe visibility of the <video>
tag.
IRemoteVideoTrack
Events
Adds an event listener.
The event name.
See [transceiver-updated-2]__type.
Occurs when the RTCRtpTransceiver
instance of the current track is updated.
The new RTCRtpTransceiver
instance.
IRemoteTrack
Events
Plays a remote video track on the web page.
Specifies a DOM element. The SDK will create a <video>
element under the specified DOM element to play the video track. You can specify a DOM element in either of following ways:
string
: Specify the ID of the DOM element.HTMLElement
: Pass a DOM object.Optional
config: VideoPlayerConfigSets the playback configurations, such as display mode and mirror mode. See [[VideoPlayerConfig]]. By default, the SDK enables mirror mode for a local video track.
RemoteVideoTrack
is the basic interface for the remote video track.You can get create a remote video track by the [AgoraRTCRemoteUser.videoTrack]videoTrack object after calling [subscribe]subscribe.