public class

AdaptiveTrackSelection.Factory

extends java.lang.Object

implements ExoTrackSelection.Factory

 java.lang.Object

↳androidx.media3.exoplayer.trackselection.AdaptiveTrackSelection.Factory

Overview

Factory for AdaptiveTrackSelection instances.

Summary

Constructors
publicFactory()

Creates an adaptive track selection factory with default parameters.

publicFactory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, float bandwidthFraction)

Creates an adaptive track selection factory.

publicFactory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, float bandwidthFraction, float bufferedFractionToLiveEdgeForQualityIncrease, Clock clock)

Creates an adaptive track selection factory.

publicFactory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, int maxWidthToDiscard, int maxHeightToDiscard, float bandwidthFraction)

Creates an adaptive track selection factory.

publicFactory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, int maxWidthToDiscard, int maxHeightToDiscard, float bandwidthFraction, float bufferedFractionToLiveEdgeForQualityIncrease, Clock clock)

Creates an adaptive track selection factory.

Methods
protected AdaptiveTrackSelectioncreateAdaptiveTrackSelection(TrackGroup group, int[] tracks[], int type, BandwidthMeter bandwidthMeter, <any> adaptationCheckpoints)

Creates a single adaptive selection for the given group, bandwidth meter and tracks.

public final ExoTrackSelectioncreateTrackSelections(ExoTrackSelection.Definition definitions[], BandwidthMeter bandwidthMeter, MediaSource.MediaPeriodId mediaPeriodId, Timeline timeline)

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Factory()

Creates an adaptive track selection factory with default parameters.

public Factory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, float bandwidthFraction)

Creates an adaptive track selection factory.

Parameters:

minDurationForQualityIncreaseMs: The minimum duration of buffered data required for the selected track to switch to one of higher quality.
maxDurationForQualityDecreaseMs: The maximum duration of buffered data required for the selected track to switch to one of lower quality.
minDurationToRetainAfterDiscardMs: When switching to a video track of higher quality, the selection may indicate that media already buffered at the lower quality can be discarded to speed up the switch. This is the minimum duration of media that must be retained at the lower quality. It must be at least minDurationForQualityIncreaseMs.
bandwidthFraction: The fraction of the available bandwidth that the selection should consider available for use. Setting to a value less than 1 is recommended to account for inaccuracies in the bandwidth estimator.

public Factory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, int maxWidthToDiscard, int maxHeightToDiscard, float bandwidthFraction)

Creates an adaptive track selection factory.

Parameters:

minDurationForQualityIncreaseMs: The minimum duration of buffered data required for the selected track to switch to one of higher quality.
maxDurationForQualityDecreaseMs: The maximum duration of buffered data required for the selected track to switch to one of lower quality.
minDurationToRetainAfterDiscardMs: When switching to a video track of higher quality, the selection may indicate that media already buffered at the lower quality can be discarded to speed up the switch. This is the minimum duration of media that must be retained at the lower quality. It must be at least minDurationForQualityIncreaseMs.
maxWidthToDiscard: The maximum video width that the selector may discard from the buffer to speed up switching to a higher quality.
maxHeightToDiscard: The maximum video height that the selector may discard from the buffer to speed up switching to a higher quality.
bandwidthFraction: The fraction of the available bandwidth that the selection should consider available for use. Setting to a value less than 1 is recommended to account for inaccuracies in the bandwidth estimator.

public Factory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, float bandwidthFraction, float bufferedFractionToLiveEdgeForQualityIncrease, Clock clock)

Creates an adaptive track selection factory.

Parameters:

minDurationForQualityIncreaseMs: The minimum duration of buffered data required for the selected track to switch to one of higher quality.
maxDurationForQualityDecreaseMs: The maximum duration of buffered data required for the selected track to switch to one of lower quality.
minDurationToRetainAfterDiscardMs: When switching to a video track of higher quality, the selection may indicate that media already buffered at the lower quality can be discarded to speed up the switch. This is the minimum duration of media that must be retained at the lower quality. It must be at least minDurationForQualityIncreaseMs.
bandwidthFraction: The fraction of the available bandwidth that the selection should consider available for use. Setting to a value less than 1 is recommended to account for inaccuracies in the bandwidth estimator.
bufferedFractionToLiveEdgeForQualityIncrease: For live streaming, the fraction of the duration from current playback position to the live edge that has to be buffered before the selected track can be switched to one of higher quality. This parameter is only applied when the playback position is closer to the live edge than minDurationForQualityIncreaseMs, which would otherwise prevent switching to a higher quality from happening.
clock: A Clock.

public Factory(int minDurationForQualityIncreaseMs, int maxDurationForQualityDecreaseMs, int minDurationToRetainAfterDiscardMs, int maxWidthToDiscard, int maxHeightToDiscard, float bandwidthFraction, float bufferedFractionToLiveEdgeForQualityIncrease, Clock clock)

Creates an adaptive track selection factory.

Parameters:

minDurationForQualityIncreaseMs: The minimum duration of buffered data required for the selected track to switch to one of higher quality.
maxDurationForQualityDecreaseMs: The maximum duration of buffered data required for the selected track to switch to one of lower quality.
minDurationToRetainAfterDiscardMs: When switching to a video track of higher quality, the selection may indicate that media already buffered at the lower quality can be discarded to speed up the switch. This is the minimum duration of media that must be retained at the lower quality. It must be at least minDurationForQualityIncreaseMs.
maxWidthToDiscard: The maximum video width that the selector may discard from the buffer to speed up switching to a higher quality.
maxHeightToDiscard: The maximum video height that the selector may discard from the buffer to speed up switching to a higher quality.
bandwidthFraction: The fraction of the available bandwidth that the selection should consider available for use. Setting to a value less than 1 is recommended to account for inaccuracies in the bandwidth estimator.
bufferedFractionToLiveEdgeForQualityIncrease: For live streaming, the fraction of the duration from current playback position to the live edge that has to be buffered before the selected track can be switched to one of higher quality. This parameter is only applied when the playback position is closer to the live edge than minDurationForQualityIncreaseMs, which would otherwise prevent switching to a higher quality from happening.
clock: A Clock.

Methods

public final ExoTrackSelection createTrackSelections(ExoTrackSelection.Definition definitions[], BandwidthMeter bandwidthMeter, MediaSource.MediaPeriodId mediaPeriodId, Timeline timeline)

protected AdaptiveTrackSelection createAdaptiveTrackSelection(TrackGroup group, int[] tracks[], int type, BandwidthMeter bandwidthMeter, <any> adaptationCheckpoints)

Creates a single adaptive selection for the given group, bandwidth meter and tracks.

Parameters:

group: The TrackGroup.
tracks: The indices of the selected tracks in the track group.
type: The type that will be returned from TrackSelection.getType().
bandwidthMeter: A BandwidthMeter which can be used to select tracks.
adaptationCheckpoints: The checkpoints that can be used to calculate available bandwidth for this selection.

Returns:

An AdaptiveTrackSelection for the specified tracks.