AdaptiveTrackSelection.Factory

Artifact: androidx.media3:media3-exoplayer

View Source

---

Kotlin |Java

public class AdaptiveTrackSelection.Factory implements ExoTrackSelection.Factory

---

Factory for AdaptiveTrackSelection instances.

Summary

Public constructors
Factory() Creates an adaptive track selection factory with default parameters.
Factory(     int minDurationForQualityIncreaseMs,     int maxDurationForQualityDecreaseMs,     int minDurationToRetainAfterDiscardMs,     float bandwidthFraction ) Creates an adaptive track selection factory.
Factory(     int minDurationForQualityIncreaseMs,     int maxDurationForQualityDecreaseMs,     int minDurationToRetainAfterDiscardMs,     float bandwidthFraction,     float bufferedFractionToLiveEdgeForQualityIncrease,     Clock clock ) Creates an adaptive track selection factory.
Factory(     int minDurationForQualityIncreaseMs,     int maxDurationForQualityDecreaseMs,     int minDurationToRetainAfterDiscardMs,     int maxWidthToDiscard,     int maxHeightToDiscard,     float bandwidthFraction ) Creates an adaptive track selection factory.
Factory(     int minDurationForQualityIncreaseMs,     int maxDurationForQualityDecreaseMs,     int minDurationToRetainAfterDiscardMs,     int maxWidthToDiscard,     int maxHeightToDiscard,     float bandwidthFraction,     float bufferedFractionToLiveEdgeForQualityIncrease,     Clock clock ) Creates an adaptive track selection factory.

Public methods
final ExoTrackSelection[]	@NullableType createTrackSelections(     @NullableType ExoTrackSelection.Definition[] definitions,     BandwidthMeter bandwidthMeter,     MediaSource.MediaPeriodId mediaPeriodId,     Timeline timeline ) Creates track selections for the provided Definitions.

Protected methods
AdaptiveTrackSelection	createAdaptiveTrackSelection(     TrackGroup group,     int[] tracks,     int type,     BandwidthMeter bandwidthMeter,     ImmutableList<AdaptiveTrackSelection.AdaptationCheckpoint> adaptationCheckpoints ) Creates a single adaptive selection for the given group, bandwidth meter and tracks.

Public constructors

Factory

public Factory()

Creates an adaptive track selection factory with default parameters.

Factory

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

Creates an adaptive track selection factory.

Parameters
int minDurationForQualityIncreaseMs	The minimum duration of buffered data required for the selected track to switch to one of higher quality.
int maxDurationForQualityDecreaseMs	The maximum duration of buffered data required for the selected track to switch to one of lower quality.
int 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.
float 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.

Factory

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

Creates an adaptive track selection factory.

Parameters
int minDurationForQualityIncreaseMs	The minimum duration of buffered data required for the selected track to switch to one of higher quality.
int maxDurationForQualityDecreaseMs	The maximum duration of buffered data required for the selected track to switch to one of lower quality.
int 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.
float 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.
float 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 clock	A Clock.

Factory

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

Creates an adaptive track selection factory.

Parameters
int minDurationForQualityIncreaseMs	The minimum duration of buffered data required for the selected track to switch to one of higher quality.
int maxDurationForQualityDecreaseMs	The maximum duration of buffered data required for the selected track to switch to one of lower quality.
int 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.
int maxWidthToDiscard	The maximum video width that the selector may discard from the buffer to speed up switching to a higher quality.
int maxHeightToDiscard	The maximum video height that the selector may discard from the buffer to speed up switching to a higher quality.
float 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.

Factory

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
int minDurationForQualityIncreaseMs	The minimum duration of buffered data required for the selected track to switch to one of higher quality.
int maxDurationForQualityDecreaseMs	The maximum duration of buffered data required for the selected track to switch to one of lower quality.
int 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.
int maxWidthToDiscard	The maximum video width that the selector may discard from the buffer to speed up switching to a higher quality.
int maxHeightToDiscard	The maximum video height that the selector may discard from the buffer to speed up switching to a higher quality.
float 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.
float 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 clock	A Clock.

Public methods

createTrackSelections

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

Creates track selections for the provided Definitions.

Implementations that create at most one adaptive track selection may use createTrackSelectionsForDefinitions.

Parameters
@NullableType ExoTrackSelection.Definition[] definitions	A Definition array. May include null values.
BandwidthMeter bandwidthMeter	A BandwidthMeter which can be used to select tracks.
MediaSource.MediaPeriodId mediaPeriodId	The MediaPeriodId of the period for which tracks are to be selected.
Timeline timeline	The Timeline holding the period for which tracks are to be selected.

Returns
ExoTrackSelection[]	The created selections. Must have the same length as definitions and may include null values.

Protected methods

createAdaptiveTrackSelection

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

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

Parameters
TrackGroup group	The TrackGroup.
int[] tracks	The indices of the selected tracks in the track group.
int type	The type that will be returned from getType.
BandwidthMeter bandwidthMeter	A BandwidthMeter which can be used to select tracks.
ImmutableList<AdaptiveTrackSelection.AdaptationCheckpoint> adaptationCheckpoints	The checkpoints that can be used to calculate available bandwidth for this selection.

Returns
AdaptiveTrackSelection	An AdaptiveTrackSelection for the specified tracks.