Package com.twilio.video

Class VideoBandwidthProfileOptions

java.lang.Object

com.twilio.video.VideoBandwidthProfileOptions

public class VideoBandwidthProfileOptions
extends Object

VideoBandwidthProfileOptions enables you to configure how available bandwidth is shared among the RemoteVideoTrack(s) in a Group Room.

See Also:

• Using Bandwidth Profile API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VideoBandwidthProfileOptions.Builder	Builder class for VideoBandwidthProfileOptions.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ClientTrackSwitchOffControl	getClientTrackSwitchOffControl()	Get the client track switch off mode specified by VideoBandwidthProfileOptions.Builder.clientTrackSwitchOffControl(ClientTrackSwitchOffControl).
TrackPriority	getDominantSpeakerPriority()	Get the dominant speaker priority specified by VideoBandwidthProfileOptions.Builder.dominantSpeakerPriority(TrackPriority).
Long	getMaxSubscriptionBitrate()	Get the max subscription bitrate in Kilobits per second (Kbps) specified by VideoBandwidthProfileOptions.Builder.maxSubscriptionBitrate(Long).
Long	getMaxTracks()	Get the max tracks specified by VideoBandwidthProfileOptions.Builder.maxTracks(Long) (long)}.
BandwidthProfileMode	getMode()	Get the bandwidth profile mode specified by VideoBandwidthProfileOptions.Builder.trackSwitchOffMode(TrackSwitchOffMode).
Map<TrackPriority,VideoDimensions>	getRenderDimensions()	Get the render dimensions specified by VideoBandwidthProfileOptions.Builder.renderDimensions(Map).
TrackSwitchOffMode	getTrackSwitchOffMode()	Get the track switch off mode specified by VideoBandwidthProfileOptions.Builder.trackSwitchOffMode(TrackSwitchOffMode).
VideoContentPreferencesMode	getVideoContentPreferencesMode()	Get the video content preferences mode specified by VideoBandwidthProfileOptions.Builder.videoContentPreferencesMode(VideoContentPreferencesMode).
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Details

getDominantSpeakerPriority

@Nullable
public TrackPriority getDominantSpeakerPriority()

Get the dominant speaker priority specified by VideoBandwidthProfileOptions.Builder.dominantSpeakerPriority(TrackPriority). This property is null by default and can be set to null via VideoBandwidthProfileOptions.Builder.dominantSpeakerPriority(TrackPriority). A null value results in the Twilio Media Server selecting the Dominant Speaker's priority. This property will only be enabled if the Dominant Speaker feature is enabled via ConnectOptions.Builder.enableDominantSpeaker(boolean).

getMaxSubscriptionBitrate

@Nullable
public Long getMaxSubscriptionBitrate()

Get the max subscription bitrate in Kilobits per second (Kbps) specified by VideoBandwidthProfileOptions.Builder.maxSubscriptionBitrate(Long).

This property is 2400 Kbps by default. This property is allowed to be null if specified in VideoBandwidthProfileOptions.Builder.maxSubscriptionBitrate(Long). Providing null allows the maximum downlink video bandwidth for a Room.

getMaxTracks

@Nullable
public Long getMaxTracks()

Get the max tracks specified by VideoBandwidthProfileOptions.Builder.maxTracks(Long) (long)}. This property is null by default and can be set to null via VideoBandwidthProfileOptions.Builder.maxTracks(Long). A null value results in no limits on the number of visible RemoteVideoTracks.

getMode

@Nullable
public BandwidthProfileMode getMode()

Get the bandwidth profile mode specified by VideoBandwidthProfileOptions.Builder.trackSwitchOffMode(TrackSwitchOffMode). This property is null by default and can be set to null via VideoBandwidthProfileOptions.Builder.mode(BandwidthProfileMode). A null value results in the Twilio Media Server selecting the mode.

getRenderDimensions

@NonNull
public Map<TrackPriority,VideoDimensions> getRenderDimensions()

Get the render dimensions specified by VideoBandwidthProfileOptions.Builder.renderDimensions(Map). This property is an empty Map by default.

getTrackSwitchOffMode

@Nullable
public TrackSwitchOffMode getTrackSwitchOffMode()

Get the track switch off mode specified by VideoBandwidthProfileOptions.Builder.trackSwitchOffMode(TrackSwitchOffMode). This property is null by default and can be set to null via VideoBandwidthProfileOptions.Builder.trackSwitchOffMode(TrackSwitchOffMode). A null value results in the Twilio Media Server selecting the track switch off mode.

getClientTrackSwitchOffControl

@Nullable
public ClientTrackSwitchOffControl getClientTrackSwitchOffControl()

Get the client track switch off mode specified by VideoBandwidthProfileOptions.Builder.clientTrackSwitchOffControl(ClientTrackSwitchOffControl). This property is null by default and can be set to null via VideoBandwidthProfileOptions.Builder.clientTrackSwitchOffControl(ClientTrackSwitchOffControl). A null value results in automatically selecting ClientTrackSwitchOffControl.AUTO.

getVideoContentPreferencesMode

@Nullable
public VideoContentPreferencesMode getVideoContentPreferencesMode()

Get the video content preferences mode specified by VideoBandwidthProfileOptions.Builder.videoContentPreferencesMode(VideoContentPreferencesMode). This property is null by default and can be set to null via VideoBandwidthProfileOptions.Builder.videoContentPreferencesMode(VideoContentPreferencesMode). A null value results in automatically selecting VideoContentPreferencesMode.AUTO.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object