Class BaseTrackSelection
- java.lang.Object
-
- com.google.android.exoplayer2.trackselection.BaseTrackSelection
-
- All Implemented Interfaces:
ExoTrackSelection
,TrackSelection
- Direct Known Subclasses:
AdaptiveTrackSelection
,FixedTrackSelection
,RandomTrackSelection
public abstract class BaseTrackSelection extends Object implements ExoTrackSelection
An abstract base class suitable for mostExoTrackSelection
implementations.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.trackselection.ExoTrackSelection
ExoTrackSelection.Definition, ExoTrackSelection.Factory
-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.trackselection.TrackSelection
TrackSelection.Type
-
-
Field Summary
Fields Modifier and Type Field Description protected TrackGroup
group
The selectedTrackGroup
.protected int
length
The number of selected tracks within theTrackGroup
.protected int[]
tracks
The indices of the selected tracks ingroup
, in order of decreasing bandwidth.-
Fields inherited from interface com.google.android.exoplayer2.trackselection.TrackSelection
TYPE_CUSTOM_BASE, TYPE_UNSET
-
-
Constructor Summary
Constructors Constructor Description BaseTrackSelection(TrackGroup group, int... tracks)
BaseTrackSelection(TrackGroup group, int[] tracks, @com.google.android.exoplayer2.trackselection.TrackSelection.Type int type)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
blacklist(int index, long exclusionDurationMs)
Attempts to exclude the track at the specified index in the selection, making it ineligible for selection by calls toExoTrackSelection.updateSelectedTrack(long, long, long, List, MediaChunkIterator[])
for the specified period of time.void
disable()
Disables this track selection.void
enable()
Enables the track selection.boolean
equals(Object obj)
int
evaluateQueueSize(long playbackPositionUs, List<? extends MediaChunk> queue)
Returns the number of chunks that should be retained in the queue.Format
getFormat(int index)
Returns the format of the track at a given index in the selection.int
getIndexInTrackGroup(int index)
Returns the index in the track group of the track at a given index in the selection.Format
getSelectedFormat()
Returns theFormat
of the individual selected track.int
getSelectedIndexInTrackGroup()
Returns the index in the track group of the individual selected track.TrackGroup
getTrackGroup()
Returns theTrackGroup
to which the selected tracks belong.int
getType()
Returns an integer specifying the type of the selection, orTrackSelection.TYPE_UNSET
if not specified.int
hashCode()
int
indexOf(int indexInTrackGroup)
Returns the index in the selection of the track with the specified index in the track group.int
indexOf(Format format)
Returns the index in the selection of the track with the specified format.boolean
isBlacklisted(int index, long nowMs)
Returns whether the track at the specified index in the selection is excluded.int
length()
Returns the number of tracks in the selection.void
onPlaybackSpeed(float playbackSpeed)
Called to notify the selection of the current playback speed.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.google.android.exoplayer2.trackselection.ExoTrackSelection
getSelectedIndex, getSelectionData, getSelectionReason, onDiscontinuity, onPlayWhenReadyChanged, onRebuffer, shouldCancelChunkLoad, updateSelectedTrack
-
-
-
-
Field Detail
-
group
protected final TrackGroup group
The selectedTrackGroup
.
-
length
protected final int length
The number of selected tracks within theTrackGroup
. Always greater than zero.
-
tracks
protected final int[] tracks
The indices of the selected tracks ingroup
, in order of decreasing bandwidth.
-
-
Constructor Detail
-
BaseTrackSelection
public BaseTrackSelection(TrackGroup group, int... tracks)
- Parameters:
group
- TheTrackGroup
. Must not be null.tracks
- The indices of the selected tracks within theTrackGroup
. Must not be null or empty. May be in any order.
-
BaseTrackSelection
public BaseTrackSelection(TrackGroup group, int[] tracks, @com.google.android.exoplayer2.trackselection.TrackSelection.Type int type)
- Parameters:
group
- TheTrackGroup
. Must not be null.tracks
- The indices of the selected tracks within theTrackGroup
. Must not be null or empty. May be in any order.type
- The type that will be returned fromTrackSelection.getType()
.
-
-
Method Detail
-
getType
public final int getType()
Description copied from interface:TrackSelection
Returns an integer specifying the type of the selection, orTrackSelection.TYPE_UNSET
if not specified.Track selection types are specific to individual applications, but should be defined starting from
TrackSelection.TYPE_CUSTOM_BASE
to ensure they don't conflict with any types that may be added to the library in the future.- Specified by:
getType
in interfaceTrackSelection
-
getTrackGroup
public final TrackGroup getTrackGroup()
Description copied from interface:TrackSelection
Returns theTrackGroup
to which the selected tracks belong.- Specified by:
getTrackGroup
in interfaceTrackSelection
-
length
public final int length()
Description copied from interface:TrackSelection
Returns the number of tracks in the selection.- Specified by:
length
in interfaceTrackSelection
-
getFormat
public final Format getFormat(int index)
Description copied from interface:TrackSelection
Returns the format of the track at a given index in the selection.- Specified by:
getFormat
in interfaceTrackSelection
- Parameters:
index
- The index in the selection.- Returns:
- The format of the selected track.
-
getIndexInTrackGroup
public final int getIndexInTrackGroup(int index)
Description copied from interface:TrackSelection
Returns the index in the track group of the track at a given index in the selection.- Specified by:
getIndexInTrackGroup
in interfaceTrackSelection
- Parameters:
index
- The index in the selection.- Returns:
- The index of the selected track.
-
indexOf
public final int indexOf(Format format)
Description copied from interface:TrackSelection
Returns the index in the selection of the track with the specified format. The format is located by identity so, for example,selection.indexOf(selection.getFormat(index)) == index
even if multiple selected tracks have formats that contain the same values.- Specified by:
indexOf
in interfaceTrackSelection
- Parameters:
format
- The format.- Returns:
- The index in the selection, or
C.INDEX_UNSET
if the track with the specified format is not part of the selection.
-
indexOf
public final int indexOf(int indexInTrackGroup)
Description copied from interface:TrackSelection
Returns the index in the selection of the track with the specified index in the track group.- Specified by:
indexOf
in interfaceTrackSelection
- Parameters:
indexInTrackGroup
- The index in the track group.- Returns:
- The index in the selection, or
C.INDEX_UNSET
if the track with the specified index is not part of the selection.
-
getSelectedFormat
public final Format getSelectedFormat()
Description copied from interface:ExoTrackSelection
Returns theFormat
of the individual selected track.- Specified by:
getSelectedFormat
in interfaceExoTrackSelection
-
getSelectedIndexInTrackGroup
public final int getSelectedIndexInTrackGroup()
Description copied from interface:ExoTrackSelection
Returns the index in the track group of the individual selected track.- Specified by:
getSelectedIndexInTrackGroup
in interfaceExoTrackSelection
-
enable
public void enable()
Description copied from interface:ExoTrackSelection
Enables the track selection. Dynamic changes viaExoTrackSelection.updateSelectedTrack(long, long, long, List, MediaChunkIterator[])
,ExoTrackSelection.evaluateQueueSize(long, List)
orExoTrackSelection.shouldCancelChunkLoad(long, Chunk, List)
will only happen after this call.This method may not be called when the track selection is already enabled.
- Specified by:
enable
in interfaceExoTrackSelection
-
disable
public void disable()
Description copied from interface:ExoTrackSelection
Disables this track selection. No further dynamic changes viaExoTrackSelection.updateSelectedTrack(long, long, long, List, MediaChunkIterator[])
,ExoTrackSelection.evaluateQueueSize(long, List)
orExoTrackSelection.shouldCancelChunkLoad(long, Chunk, List)
will happen after this call.This method may only be called when the track selection is already enabled.
- Specified by:
disable
in interfaceExoTrackSelection
-
onPlaybackSpeed
public void onPlaybackSpeed(float playbackSpeed)
Description copied from interface:ExoTrackSelection
Called to notify the selection of the current playback speed. The playback speed may affect adaptive track selection.- Specified by:
onPlaybackSpeed
in interfaceExoTrackSelection
- Parameters:
playbackSpeed
- The factor by which playback is sped up.
-
evaluateQueueSize
public int evaluateQueueSize(long playbackPositionUs, List<? extends MediaChunk> queue)
Description copied from interface:ExoTrackSelection
Returns the number of chunks that should be retained in the queue.May be called by sources that load media in discrete
MediaChunks
and support discarding of buffered chunks.To avoid excessive re-buffering, implementations should normally return the size of the queue. An example of a case where a smaller value may be returned is if network conditions have improved dramatically, allowing chunks to be discarded and re-buffered in a track of significantly higher quality. Discarding chunks may allow faster switching to a higher quality track in this case.
Note that even if the source supports discarding of buffered chunks, the actual number of discarded chunks is not guaranteed. The source will call
ExoTrackSelection.updateSelectedTrack(long, long, long, List, MediaChunkIterator[])
with the updated queue of chunks before loading a new chunk to allow switching to another quality.This method will only be called when the selection is enabled and none of the
MediaChunks
in the queue are currently loading.- Specified by:
evaluateQueueSize
in interfaceExoTrackSelection
- Parameters:
playbackPositionUs
- The current playback position in microseconds. If playback of the period to which this track selection belongs has not yet started, the value will be the starting position in the period minus the duration of any media in previous periods still to be played.queue
- The queue of bufferedMediaChunks
. Must not be modified.- Returns:
- The number of chunks to retain in the queue.
-
blacklist
public boolean blacklist(int index, long exclusionDurationMs)
Description copied from interface:ExoTrackSelection
Attempts to exclude the track at the specified index in the selection, making it ineligible for selection by calls toExoTrackSelection.updateSelectedTrack(long, long, long, List, MediaChunkIterator[])
for the specified period of time.Exclusion will fail if all other tracks are currently excluded. If excluding the currently selected track, note that it will remain selected until the next call to
ExoTrackSelection.updateSelectedTrack(long, long, long, List, MediaChunkIterator[])
.This method will only be called when the selection is enabled.
- Specified by:
blacklist
in interfaceExoTrackSelection
- Parameters:
index
- The index of the track in the selection.exclusionDurationMs
- The duration of time for which the track should be excluded, in milliseconds.- Returns:
- Whether exclusion was successful.
-
isBlacklisted
public boolean isBlacklisted(int index, long nowMs)
Description copied from interface:ExoTrackSelection
Returns whether the track at the specified index in the selection is excluded.- Specified by:
isBlacklisted
in interfaceExoTrackSelection
- Parameters:
index
- The index of the track in the selection.nowMs
- The current time in the timebase ofSystemClock.elapsedRealtime()
.
-
-