com.google.android.exoplayer2.trackselection

Class BaseTrackSelection

java.lang.Object

com.google.android.exoplayer2.trackselection.BaseTrackSelection

All Implemented Interfaces:

TrackSelection

Direct Known Subclasses:

AdaptiveTrackSelection, FixedTrackSelection, RandomTrackSelection

public abstract class BaseTrackSelection
extends java.lang.Object
implements TrackSelection

An abstract base class suitable for most TrackSelection implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.trackselection.TrackSelection

TrackSelection.Factory

Field Summary

Fields

Modifier and Type	Field and Description
protected TrackGroup	group The selected TrackGroup.
protected int	length The number of selected tracks within the TrackGroup.
protected int[]	tracks The indices of the selected tracks in group, in order of decreasing bandwidth.

Constructor Summary

Constructors

Constructor and Description
BaseTrackSelection(TrackGroup group, int... tracks)

Method Summary

Modifier and Type	Method and Description
boolean	blacklist(int index, long blacklistDurationMs) Attempts to blacklist the track at the specified index in the selection, making it ineligible for selection by calls to TrackSelection.updateSelectedTrack(long, long, long) for the specified period of time.
void	disable() Disables this track selection.
void	enable() Enables the track selection.
boolean	equals(java.lang.Object obj)
int	evaluateQueueSize(long playbackPositionUs, java.util.List<? extends MediaChunk> queue) May be called periodically by sources that load media in discrete MediaChunks and support discarding of buffered chunks in order to re-buffer using a different selected track.
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 the Format of the individual selected track.
int	getSelectedIndexInTrackGroup() Returns the index in the track group of the individual selected track.
TrackGroup	getTrackGroup() Returns the TrackGroup to which the selected tracks belong.
int	hashCode()
int	indexOf(Format format) Returns the index in the selection of the track with the specified format.
int	indexOf(int indexInTrackGroup) Returns the index in the selection of the track with the specified index in the track group.
protected boolean	isBlacklisted(int index, long nowMs) Returns whether the track at the specified index in the selection is blacklisted.
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.TrackSelection

getSelectedIndex, getSelectionData, getSelectionReason, updateSelectedTrack

Field Detail

group

protected final TrackGroup group

The selected TrackGroup.

length

protected final int length

The number of selected tracks within the TrackGroup. Always greater than zero.

tracks

protected final int[] tracks

The indices of the selected tracks in group, in order of decreasing bandwidth.

Constructor Detail

BaseTrackSelection

public BaseTrackSelection(TrackGroup group,
                          int... tracks)

Parameters:

group - The TrackGroup. Must not be null.

tracks - The indices of the selected tracks within the TrackGroup. Must not be null or empty. May be in any order.

Method Detail

enable

public void enable()

Description copied from interface: TrackSelection

Enables the track selection.

This method may not be called when the track selection is already enabled.

Specified by:

enable in interface TrackSelection

disable

public void disable()

Description copied from interface: TrackSelection

Disables this track selection.

This method may only be called when the track selection is already enabled.

Specified by:

disable in interface TrackSelection

getTrackGroup

public final TrackGroup getTrackGroup()

Description copied from interface: TrackSelection

Returns the TrackGroup to which the selected tracks belong.

Specified by:

getTrackGroup in interface TrackSelection

length

public final int length()

Description copied from interface: TrackSelection

Returns the number of tracks in the selection.

Specified by:

length in interface TrackSelection

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 interface TrackSelection

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 interface TrackSelection

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.

Specified by:

indexOf in interface TrackSelection

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 interface TrackSelection

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: TrackSelection

Returns the Format of the individual selected track.

Specified by:

getSelectedFormat in interface TrackSelection

getSelectedIndexInTrackGroup

public final int getSelectedIndexInTrackGroup()

Description copied from interface: TrackSelection

Returns the index in the track group of the individual selected track.

Specified by:

getSelectedIndexInTrackGroup in interface TrackSelection

onPlaybackSpeed

public void onPlaybackSpeed(float playbackSpeed)

Description copied from interface: TrackSelection

Called to notify the selection of the current playback speed. The playback speed may affect adaptive track selection.

Specified by:

onPlaybackSpeed in interface TrackSelection

Parameters:

playbackSpeed - The playback speed.

evaluateQueueSize

public int evaluateQueueSize(long playbackPositionUs,
                             java.util.List<? extends MediaChunk> queue)

Description copied from interface: TrackSelection

May be called periodically by sources that load media in discrete MediaChunks and support discarding of buffered chunks in order to re-buffer using a different selected track. Returns the number of chunks that should be retained in the queue.

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. This method may only be called when the selection is enabled.

Specified by:

evaluateQueueSize in interface TrackSelection

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 buffered MediaChunks. Must not be modified.

Returns:

The number of chunks to retain in the queue.

blacklist

public final boolean blacklist(int index,
                               long blacklistDurationMs)

Description copied from interface: TrackSelection

Attempts to blacklist the track at the specified index in the selection, making it ineligible for selection by calls to TrackSelection.updateSelectedTrack(long, long, long) for the specified period of time. Blacklisting will fail if all other tracks are currently blacklisted. If blacklisting the currently selected track, note that it will remain selected until the next call to TrackSelection.updateSelectedTrack(long, long, long).

This method may only be called when the selection is enabled.

Specified by:

blacklist in interface TrackSelection

Parameters:

index - The index of the track in the selection.

blacklistDurationMs - The duration of time for which the track should be blacklisted, in milliseconds.

Returns:

Whether blacklisting was successful.

isBlacklisted

protected final boolean isBlacklisted(int index,
                                      long nowMs)

Returns whether the track at the specified index in the selection is blacklisted.

Parameters:

index - The index of the track in the selection.

nowMs - The current time in the timebase of SystemClock.elapsedRealtime().

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object