RemoteVideoTrack
Summary
RemoteVideoTrack represents a video track from a RemoteParticipantRemarks
It provides methods to attach and detach the track to and from HTMLVideoElements.Properties
sid
optional
Server assigned id.
Server assigned id.
Remarks
The value set after the track is published to the server, or if it's a remote track.Type
string
streamState
Indicates the current state of stream.
Remarks
It'll indicate paused
if the track has been paused by the congestion controller.Type
StreamState
Accessors
isAdaptiveStream
Returns true if adaptive streaming is enabled.
Type
boolean
mediaStreamTrack
Returns the media stream track.
Type
MediaStreamTrack
Methods
attach
Attaches the video track to an HTML video element.
Signature
attach(element?: HTMLVideoElement)
Name | Type | Description |
---|---|---|
element optional | HTMLVideoElement | The video element to attach to (optional). |
Returns
HTMLVideoElement
The HTMLVideoElement the video track is attached to.Remarks
If no element is provided, a new video element will be created and returned.detach
Detaches the track from an HTML video element.
Signature
detach(element?: HTMLMediaElement)
Name | Type | Description |
---|---|---|
element optional | HTMLMediaElement | The video element to detach from (optional). |
Returns
HTMLMediaElement
| HTMLMediaElement[]
The detached video element(s).Remarks
If no element is provided, the track will be detached from all previously attached elements.