Package com.twilio.video

Class VideoBandwidthProfileOptions.Builder

java.lang.Object

com.twilio.video.VideoBandwidthProfileOptions.Builder

Enclosing class:

VideoBandwidthProfileOptions

public static class VideoBandwidthProfileOptions.Builder
extends java.lang.Object

Builder class for VideoBandwidthProfileOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VideoBandwidthProfileOptions	build()
VideoBandwidthProfileOptions.Builder	clientTrackSwitchOffControl(ClientTrackSwitchOffControl control)	Configure how RemoteVideoTracks are switched on and off based on the provided ClientTrackSwitchOffControl.
VideoBandwidthProfileOptions.Builder	dominantSpeakerPriority(TrackPriority priority)	Set the minimum TrackPriority of the Dominant Speaker's RemoteVideoTracks.
VideoBandwidthProfileOptions.Builder	maxSubscriptionBitrate(java.lang.Long maxSubscriptionBitrate)	Set the maximum downlink video bandwidth in Kilobits per second (Kbps).
VideoBandwidthProfileOptions.Builder	maxTracks(java.lang.Long maxTracks)	Deprecated. This property is deprecated in favor of ClientTrackSwitchOffControl.
VideoBandwidthProfileOptions.Builder	mode(BandwidthProfileMode mode)	Set how RemoteVideoTracks TrackPriority values are mapped to bandwidth allocation in Group Rooms.
VideoBandwidthProfileOptions.Builder	renderDimensions(java.util.Map<TrackPriority,VideoDimensions> dimensions)	Deprecated. This property is deprecated in favor of videoContentPreferencesMode(VideoContentPreferencesMode).
VideoBandwidthProfileOptions.Builder	trackSwitchOffMode(TrackSwitchOffMode mode)	Configure how RemoteVideoTracks are switched off.
VideoBandwidthProfileOptions.Builder	videoContentPreferencesMode(VideoContentPreferencesMode mode)	Configure how the video content preferences are determined based on the VideoContentPreferencesMode.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

dominantSpeakerPriority

public VideoBandwidthProfileOptions.Builder dominantSpeakerPriority(@Nullable
                                                                    TrackPriority priority)

Set the minimum TrackPriority of the Dominant Speaker's RemoteVideoTracks. This property is null by default and can be set to null. 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).

Parameters:

priority - The track priority to use or null.

maxSubscriptionBitrate

public VideoBandwidthProfileOptions.Builder maxSubscriptionBitrate(@Nullable
                                                                   java.lang.Long maxSubscriptionBitrate)

Set the maximum downlink video bandwidth in Kilobits per second (Kbps). This property is 2,400 Kbps by default and can be set to null. A null value results in the maximum allowed bitrate for a Room.

Parameters:

maxSubscriptionBitrate - The maximum bitrate for subscribe RemoteVideoTracks or null.

maxTracks

@Deprecated
public VideoBandwidthProfileOptions.Builder maxTracks(@Nullable
                                                      java.lang.Long maxTracks)

Deprecated.

This property is deprecated in favor of ClientTrackSwitchOffControl. Attempting to set maxTracks when ClientTrackSwitchOffControl is already set will throw an exception.

Set the maximum number of visible RemoteVideoTracks selected first using TrackPriority and second using an N-Loudest policy. This property is null by default and can be set to null. A null value results in no limits on the number of visible RemoteVideoTracks.

Parameters:

maxTracks - The maximum number of video tracks or null.

mode

public VideoBandwidthProfileOptions.Builder mode(@Nullable
                                                 BandwidthProfileMode mode)

Set how RemoteVideoTracks TrackPriority values are mapped to bandwidth allocation in Group Rooms. This property is null by default and can be set to null. A null value results in the Twilio Media Server selecting the mode.

Parameters:

mode - The BandwidthProfileMode to use or null.

renderDimensions

@Deprecated
public VideoBandwidthProfileOptions.Builder renderDimensions(@NonNull
                                                             java.util.Map<TrackPriority,VideoDimensions> dimensions)

Deprecated.

This property is deprecated in favor of videoContentPreferencesMode(VideoContentPreferencesMode). Attempting to set renderDimensions when the content preferences mode is already set will throw an exception.

Set the desired render dimensions of RemoteVideoTracks based on TrackPriority and the RemoteVideoTracks of the Dominant Speaker. The bandwidth allocation algorithm will distribute the available downlink bandwidth proportional to the requested render dimensions.

Parameters:

dimensions - A map containing at most one entry for each TrackPriority.

trackSwitchOffMode

public VideoBandwidthProfileOptions.Builder trackSwitchOffMode(@Nullable
                                                               TrackSwitchOffMode mode)

Configure how RemoteVideoTracks are switched off. This property is null by default and can be set to null. A null value results in the Twilio Media Server selecting the track switch off mode.

Parameters:

mode - The TrackSwitchOffMode to use or null.

clientTrackSwitchOffControl

public VideoBandwidthProfileOptions.Builder clientTrackSwitchOffControl(@Nullable
                                                                        ClientTrackSwitchOffControl control)

Configure how RemoteVideoTracks are switched on and off based on the provided ClientTrackSwitchOffControl. This cannot be set along with maxTracks(Long), otherwise a IllegalArgumentException will be thrown when build() is invoked. This property is null by default and can be set to null. A null value results in automatically selecting ClientTrackSwitchOffControl.AUTO.

Parameters:

control - The ClientTrackSwitchOffControl to use or null.

videoContentPreferencesMode

public VideoBandwidthProfileOptions.Builder videoContentPreferencesMode(@Nullable
                                                                        VideoContentPreferencesMode mode)

Configure how the video content preferences are determined based on the VideoContentPreferencesMode. This cannot be set along with renderDimensions(Map), otherwise a IllegalArgumentException will be thrown when build() is invoked. This property is null by default and can be set to null. A null value results in automatically selecting VideoContentPreferencesMode.AUTO.

Parameters:

mode - The VideoContentPreferencesMode to use or null.

build

public VideoBandwidthProfileOptions build()