Properties:
Name | Type | Description |
---|---|---|
isSubscribed |
boolean | Whether the RemoteVideoTrack is currently subscribed to |
sid |
Track.SID | The RemoteVideoTrack's SID |
Fires:
Extends
Members
Methods
-
attach()
-
Create an HTMLVideoElement and attach the VideoTrack to it.
The HTMLVideoElement's
srcObject
will be set to a new MediaStream containing the VideoTrack's MediaStreamTrack.- Inherited From:
- Overrides:
Returns:
videoElement
- Type
- HTMLVideoElement
Example
const Video = require('twilio-video'); Video.createLocalVideoTrack().then(function(videoTrack) { const videoElement = videoTrack.attach(); document.body.appendChild(videoElement); });
-
detach()
-
Detach the VideoTrack from all previously attached HTMLMediaElements.
- Inherited From:
- Overrides:
Returns:
mediaElements
- Type
- Array.<HTMLMediaElement>
Example
const mediaElements = videoTrack.detach(); mediaElements.forEach(mediaElement => mediaElement.remove());
Events
-
dimensionsChanged
-
The RemoteVideoTrack's dimensions changed.
Parameters:
Name Type Description track
RemoteVideoTrack The RemoteVideoTrack whose dimensions changed
- Overrides:
-
disabled
-
The RemoteVideoTrack was disabled, i.e. "paused".
Parameters:
Name Type Description track
RemoteVideoTrack The RemoteVideoTrack that was disabled
- Overrides:
-
enabled
-
The RemoteVideoTrack was enabled, i.e. "unpaused".
Parameters:
Name Type Description track
RemoteVideoTrack The RemoteVideoTrack that was enabled
- Overrides:
-
started
-
The VideoTrack started. This means there is enough video data to begin playback.
Parameters:
Name Type Description track
VideoTrack The VideoTrack that started
- Inherited From:
- Overrides:
-
unsubscribed
-
The RemoteVideoTrack was unsubscribed from.
Parameters:
Name Type Description track
RemoteVideoTrack The RemoteVideoTrack that was unsubscribed from
- Deprecated:
-
- Use the parent RemoteVideoTrackPublication's "unsubscribed" event instead