FakeTrackSelection

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@UnstableApi
public class FakeTrackSelection extends BaseTrackSelection

java.lang.Object
↳	androidx.media3.exoplayer.trackselection.BaseTrackSelection
	↳	androidx.media3.test.utils.FakeTrackSelection

A fake ExoTrackSelection that only returns 1 fixed track, and allows querying the number of calls to its methods.

Summary

Public fields
`int`	`enableCount`
`boolean`	`isEnabled`
`int`	`releaseCount`
`final int`	`selectedIndex`

Public constructors
`FakeTrackSelection(TrackGroup rendererTrackGroup)`
`FakeTrackSelection(TrackGroup rendererTrackGroup, int selectedIndex)`

Public methods
`void`	`disable()` Disables this track selection.
`void`	`enable()` Enables the track selection.
`boolean`	`equals(@Nullable Object o)`
`int`	`evaluateQueueSize(long playbackPositionUs, List<MediaChunk> queue)` Returns the number of chunks that should be retained in the queue.
`boolean`	`excludeTrack(int index, long exclusionDurationMs)` Attempts to exclude the track at the specified index in the selection, making it ineligible for selection by calls to `updateSelectedTrack` for the specified period of time.
`int`	`getSelectedIndex()` Returns the index of the selected track.
`@Nullable Object`	`getSelectionData()` Returns optional data associated with the current track selection.
`int`	`@C.SelectionReason getSelectionReason()` Returns the reason for the current track selection.
`int`	`hashCode()`
`boolean`	`isTrackExcluded(int index, long nowMs)` Returns whether the track at the specified index in the selection is excluded.
`void`	`updateSelectedTrack( long playbackPositionUs, long bufferedDurationUs, long availableDurationUs, List<MediaChunk> queue, MediaChunkIterator[] mediaChunkIterators )` Updates the selected track for sources that load media in discrete `MediaChunk`s.

Inherited Constants

From androidx.media3.exoplayer.trackselection.TrackSelection

`static final int`	`TYPE_CUSTOM_BASE = 10000` The first value that can be used for application specific track selection types.
`static final int`	`TYPE_UNSET = 0` An unspecified track selection type.

Inherited fields

From androidx.media3.exoplayer.trackselection.BaseTrackSelection

`final TrackGroup`	`group` The selected `TrackGroup`.
`final int`	`length` The number of selected tracks within the `TrackGroup`.
`boolean`	`playWhenReady` The current value of whether playback will proceed when ready.
`final int[]`	`tracks` The indices of the selected tracks in `group`, in order of decreasing bandwidth.
`final int`	`@TrackSelection.Type type` The type of the selection.

Inherited methods

From androidx.media3.exoplayer.trackselection.BaseTrackSelection

`final Format`	`getFormat(int index)` Returns the format of the track at a given index in the selection.
`final int`	`getIndexInTrackGroup(int index)` Returns the index in the track group of the track at a given index in the selection.
`final boolean`	`getPlayWhenReady()` Returns whether the playback using this track selection will proceed when ready.
`final Format`	`getSelectedFormat()` Returns the `Format` of the individual selected track.
`final int`	`getSelectedIndexInTrackGroup()` Returns the index in the track group of the individual selected track.
`final TrackGroup`	`getTrackGroup()` Returns the `TrackGroup` to which the selected tracks belong.
`final int`	`getType()` Returns an integer specifying the type of the selection, or `TYPE_UNSET` if not specified.
`final int`	`indexOf(Format format)` Returns the index in the selection of the track with the specified format.
`final int`	`indexOf(int indexInTrackGroup)` Returns the index in the selection of the track with the specified index in the track group.
`final int`	`length()` Returns the number of tracks in the selection.
`void`	`@CallSuper onPlayWhenReadyChanged(boolean playWhenReady)` Called to notify when the playback is paused or resumed.
`void`	`onPlaybackSpeed(float playbackSpeed)` Called to notify the selection of the current playback speed.

From androidx.media3.exoplayer.trackselection.ExoTrackSelection

`long`	`getLatestBitrateEstimate()` Returns the most recent bitrate estimate utilised for track selection.
`void`	`onDiscontinuity()` Called to notify the selection of a position discontinuity.
`void`	`onRebuffer()` Called to notify when a rebuffer occurred.
`boolean`	`shouldCancelChunkLoad( long playbackPositionUs, Chunk loadingChunk, List<MediaChunk> queue )` Returns whether an ongoing load of a chunk should be canceled.

Public fields

enableCount

public int enableCount

isEnabled

public boolean isEnabled

releaseCount

public int releaseCount

selectedIndex

public final int selectedIndex

Public constructors

FakeTrackSelection

public FakeTrackSelection(TrackGroup rendererTrackGroup)

FakeTrackSelection

public FakeTrackSelection(TrackGroup rendererTrackGroup, int selectedIndex)

Public methods

disable

public void disable()

Disables this track selection. No further dynamic changes via updateSelectedTrack, evaluateQueueSize or shouldCancelChunkLoad will happen after this call.

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

enable

public void enable()

Enables the track selection. Dynamic changes via updateSelectedTrack, evaluateQueueSize or shouldCancelChunkLoad will only happen after this call.

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

equals

public boolean equals(@Nullable Object o)

evaluateQueueSize

public int evaluateQueueSize(long playbackPositionUs, List<MediaChunk> queue)

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 updateSelectedTrack 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.

Parameters
`long 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.
`List<MediaChunk> queue`	The queue of buffered `MediaChunks`. Must not be modified.

Returns
`int`	The number of chunks to retain in the queue.

excludeTrack

public boolean excludeTrack(int index, long exclusionDurationMs)

Attempts to exclude the track at the specified index in the selection, making it ineligible for selection by calls to updateSelectedTrack 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 updateSelectedTrack.

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

Parameters
`int index`	The index of the track in the selection.
`long exclusionDurationMs`	The duration of time for which the track should be excluded, in milliseconds.

Returns
`boolean`	Whether exclusion was successful.

getSelectedIndex

public int getSelectedIndex()

Returns the index of the selected track.

getSelectionData

public @Nullable Object getSelectionData()

Returns optional data associated with the current track selection.

getSelectionReason

@C.SelectionReason
public int getSelectionReason()

Returns the reason for the current track selection.

hashCode

public int hashCode()

isTrackExcluded

public boolean isTrackExcluded(int index, long nowMs)

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

Parameters
`int index`	The index of the track in the selection.
`long nowMs`	The current time in the timebase of `elapsedRealtime`.

updateSelectedTrack

public void updateSelectedTrack(
    long playbackPositionUs,
    long bufferedDurationUs,
    long availableDurationUs,
    List<MediaChunk> queue,
    MediaChunkIterator[] mediaChunkIterators
)

Updates the selected track for sources that load media in discrete MediaChunks.

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

Parameters
`long 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.
`long bufferedDurationUs`	The duration of media currently buffered from the current playback position, in microseconds. Note that the next load position can be calculated as `(playbackPositionUs + bufferedDurationUs)`.
`long availableDurationUs`	The duration of media available for buffering from the current playback position, in microseconds, or `TIME_UNSET` if media can be buffered to the end of the current period. Note that if not set to `TIME_UNSET`, the position up to which media is available for buffering can be calculated as `(playbackPositionUs + availableDurationUs)`.
`List<MediaChunk> queue`	The queue of already buffered `MediaChunk`s. Must not be modified.
`MediaChunkIterator[] mediaChunkIterators`	An array of `MediaChunkIterator`s providing information about the sequence of upcoming media chunks for each track in the selection. All iterators start from the media chunk which will be loaded next if the respective track is selected. Note that this information may not be available for all tracks, and so some iterators may be empty.