Documentation

Class: RemoteVideoTrackPublication

RemoteVideoTrackPublication

A RemoteVideoTrackPublication represents a RemoteVideoTrack that has been published to a Room.

Properties:
Name Type Argument Description
kind Track.Kind

"video"
track RemoteVideoTrack <nullable>

unless you have subscribed to the RemoteVideoTrack, this property is null
Fires:

Events

subscribed

Your LocalParticipant subscribed to the RemoteVideoTrack.

Parameters:
Name Type Description
track RemoteVideoTrack

the RemoteVideoTrack that was subscribed to

subscriptionFailed

Your LocalParticipant failed to subscribe to the RemoteVideoTrack.

Parameters:
Name Type Description
error TwilioError

the reason the RemoteVideoTrack could not be subscribed to

trackDisabled

The RemoteVideoTrack was disabled. It is fired only if .isSubscribed is set to true (Deprecated only for large group Rooms).

Deprecated:
  • Use trackSwitchedOff (track.switchOffReason === "disabled-by-publisher") instead

trackEnabled

The RemoteVideoTrack was enabled. It is fired only if .isSubscribed is set to true (Deprecated only for large group Rooms).

Deprecated:

trackSwitchedOff

The RemoteVideoTrack was switched off. The media server stops sending media for the RemoteVideoTrack until it is switched back on. Just before the event is raised, isSwitchedOff is set to true and switchOffReason is set to a TrackSwitchOffReason in large group Rooms (switchOffReason is null non-large group Rooms). Also, if the RemoteVideoTrack receives audio media, the mediaStreamTrack property is set to null. (only in large group Rooms)

Parameters:
Name Type Argument Description
track RemoteVideoTrack

the RemoteVideoTrack that was switched off
switchOffReason TrackSwitchOffReason <nullable>

the reason the RemoteVideoTrack was switched off

trackSwitchedOn

The RemoteVideoTrack was switched on. The media server starts sending media for the RemoteVideoTrack until it is switched off. Just before the event is raised, isSwitchedOff is set to false and switchOffReason is set to null. Also, the mediaStreamTrack property is set to a MediaStreamTrack that is the source of the RemoteVideoTrack's media.

Parameters:
Name Type Description
track RemoteVideoTrack

the RemoteVideoTrack that was switched on

unsubscribed

Your LocalParticipant unsubscribed from the RemoteVideoTrack.

Parameters:
Name Type Description
track RemoteVideoTrack

the RemoteVideoTrack that was unsubscribed from