Package com.twilio.video

Class RemoteVideoTrack

java.lang.Object

com.twilio.video.VideoTrack

com.twilio.video.RemoteVideoTrack

All Implemented Interfaces:

Track

public class RemoteVideoTrack
extends VideoTrack

A remote video track represents a remote video source.

Method Summary

Modifier and Type	Method	Description
void	addSink(VideoSink videoSink)	Add a video sink to receive frames from the video track.
TrackPriority	getPriority()	Get the subscriber's TrackPriority for this RemoteVideoTrack.
java.lang.String	getSid()	Returns the remote video track's server identifier.
boolean	isSwitchedOff()	Return whether the track is switched off.
void	removeSink(VideoSink videoSink)	Remove a video sink to stop receiving video from the video track.
void	setContentPreferences(VideoContentPreferences videoContentPreferences)	Sets the VideoContentPreferences for the RemoteVideoTrack.
void	setPriority(TrackPriority priority)	Set the subscriber's TrackPriority for this RemoteVideoTrack.
void	switchOff()	Request to switch off a RemoteVideoTrack, if it is currently switched on.
void	switchOn()	Request to switch on a RemoteVideoTrack, if it is currently switched off.

Methods inherited from class com.twilio.video.VideoTrack

getName, getSinks, isEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSid

@NonNull
public java.lang.String getSid()

Returns the remote video track's server identifier. This value uniquely identifies the remote video track within the scope of a Room.

addSink

public void addSink(@NonNull
                    VideoSink videoSink)

Description copied from class: VideoTrack

Add a video sink to receive frames from the video track.

Overrides:

addSink in class VideoTrack

Parameters:

videoSink - video sink that receives video.

removeSink

public void removeSink(@NonNull
                       VideoSink videoSink)

Description copied from class: VideoTrack

Remove a video sink to stop receiving video from the video track.

Overrides:

removeSink in class VideoTrack

Parameters:

videoSink - the video sink that should no longer receive video.

switchOn

public void switchOn()

Request to switch on a RemoteVideoTrack, if it is currently switched off. This method must be called only if the ClientTrackSwitchOffControl is set to ClientTrackSwitchOffControl.MANUAL in video bandwidth profile options. Tracks may still remain switched off when available bandwidth is limited.

Throws:

java.lang.IllegalStateException - if the following preconditions exist:

1. BandwidthProfileOptions has not been set.
2. ClientTrackSwitchOffControl.AUTO is set.
3. VideoBandwidthProfileOptions.Builder.maxTracks(Long) is set.

switchOff

public void switchOff()

Request to switch off a RemoteVideoTrack, if it is currently switched on. This method must be called only if the ClientTrackSwitchOffControl is set to ClientTrackSwitchOffControl.MANUAL in video bandwidth profile options.

Throws:

java.lang.IllegalStateException - if the following preconditions exist:

1. BandwidthProfileOptions has not been set.
2. ClientTrackSwitchOffControl.AUTO is set.
3. VideoBandwidthProfileOptions.Builder.maxTracks(Long) is set.

setContentPreferences

public void setContentPreferences(VideoContentPreferences videoContentPreferences)

Sets the VideoContentPreferences for the RemoteVideoTrack. This method must be called only if the VideoContentPreferencesMode is set to VideoContentPreferencesMode.MANUAL in video bandwidth profile options.

Parameters:

videoContentPreferences - The VideoContentPreferences for this RemoteVideoTrack.

Throws:

java.lang.IllegalStateException - if the following preconditions exist:

1. BandwidthProfileOptions has not been set.
2. VideoContentPreferencesMode.AUTO is set.
3. VideoBandwidthProfileOptions.Builder.renderDimensions(Map) is set.

isSwitchedOff

public boolean isSwitchedOff()

Return whether the track is switched off.

getPriority

@Nullable
public TrackPriority getPriority()

Get the subscriber's TrackPriority for this RemoteVideoTrack. The default subscriber priority is null, which indicates that the subscriber has not set a priority for this RemoteVideoTrack.

setPriority

public void setPriority(@Nullable
                        TrackPriority priority)

Set the subscriber's TrackPriority for this RemoteVideoTrack. Providing null clears the subscriber's TrackPriority for this RemoteVideoTrack. This method is a no-op if the RemoteVideoTrack has been unsubscribed from.

Parameters:

priority - The priority to be set.