com.twilio.video

Enum BandwidthProfileMode

java.lang.Object

java.lang.Enum<BandwidthProfileMode>

com.twilio.video.BandwidthProfileMode

All Implemented Interfaces:

Serializable, Comparable<BandwidthProfileMode>

public enum BandwidthProfileMode
extends Enum<BandwidthProfileMode>

BandwidthProfileMode specifies how RemoteVideoTrack(s) TrackPriority values are mapped to bandwidth allocation in Group Rooms.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLLABORATION This mode is for use cases where some RemoteVideoTrack(s) are more prioritized over others.
GRID This mode is for use cases where all the subscribed RemoteVideoTrack(s) are equally important.
PRESENTATION This mode is for use cases where some RemoteVideoTrack(s) are deemed critical and must be preserved at any cost over the other RemoteVideoTrack(s).

Method Summary

Modifier and Type	Method and Description
static BandwidthProfileMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BandwidthProfileMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COLLABORATION

public static final BandwidthProfileMode COLLABORATION

This mode is for use cases where some RemoteVideoTrack(s) are more prioritized over others. However, the lower priority RemoteVideoTrack(s) still need to be visible. The bandwidth allocation algorithm will distribute the available downlink bandwidth proportional to the requested render VideoDimensions. In case of low downlink bandwidth, the quality of higher priority RemoteVideoTrack(s) may be degraded to avoid switching off lower priority RemoteVideoTrack(s).

GRID

public static final BandwidthProfileMode GRID

This mode is for use cases where all the subscribed RemoteVideoTrack(s) are equally important. The bandwidth allocation algorithm will share the available downlink bandwidth equally among the subscribed RemoteVideoTrack(s).

PRESENTATION

public static final BandwidthProfileMode PRESENTATION

This mode is for use cases where some RemoteVideoTrack(s) are deemed critical and must be preserved at any cost over the other RemoteVideoTrack(s). The bandwidth allocation algorithm will allocate as big a share of the available downlink bandwidth as it possibly can to the higher priority RemoteVideoTrack(s), and only then consider the lower priority RemoteVideoTrack(s). In case of low downlink bandwidth, the lower priority RemoteVideoTrack(s) are switched off in order to preserve the quality of the higher priority RemoteVideoTrack(s).

Method Detail

values

public static BandwidthProfileMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BandwidthProfileMode c : BandwidthProfileMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BandwidthProfileMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null