FakeTrackSelection

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@UnstableApi
class FakeTrackSelection : BaseTrackSelection

kotlin.Any
↳	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 constructors
`FakeTrackSelection(rendererTrackGroup: TrackGroup!)`
`FakeTrackSelection(rendererTrackGroup: TrackGroup!, selectedIndex: Int)`

Public functions
`Unit`	`disable()` Disables this track selection.
`Unit`	`enable()` Enables the track selection.
`Boolean`	`equals(o: Any?)`
`Int`	`evaluateQueueSize( playbackPositionUs: Long, queue: (Mutable)List<MediaChunk!>! )` Returns the number of chunks that should be retained in the queue.
`Boolean`	`excludeTrack(index: Int, exclusionDurationMs: Long)` 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.
`Any?`	`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(index: Int, nowMs: Long)` Returns whether the track at the specified index in the selection is excluded.
`Unit`	`updateSelectedTrack( playbackPositionUs: Long, bufferedDurationUs: Long, availableDurationUs: Long, queue: (Mutable)List<MediaChunk!>!, mediaChunkIterators: Array<MediaChunkIterator!>! )` Updates the selected track for sources that load media in discrete `MediaChunk`s.

Public properties
`Int`	`enableCount`
`Boolean`	`isEnabled`
`Int`	`releaseCount`
`Int`	`selectedIndex`

Inherited Constants

From androidx.media3.exoplayer.trackselection.TrackSelection

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

Inherited functions

From androidx.media3.exoplayer.trackselection.BaseTrackSelection

`Format!`	`getFormat(index: Int)` Returns the format of the track at a given index in the selection.
`Int`	`getIndexInTrackGroup(index: Int)` 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`	`indexOf(format: Format!)` Returns the index in the selection of the track with the specified format.
`Int`	`indexOf(indexInTrackGroup: Int)` Returns the index in the selection of the track with the specified index in the track group.
`Int`	`length()` Returns the number of tracks in the selection.
`Unit`	`@CallSuper onPlayWhenReadyChanged(playWhenReady: Boolean)` Called to notify when the playback is paused or resumed.
`Unit`	`onPlaybackSpeed(playbackSpeed: Float)` 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.
`Unit`	`onDiscontinuity()` Called to notify the selection of a position discontinuity.
`Unit`	`onRebuffer()` Called to notify when a rebuffer occurred.
`Boolean`	`shouldCancelChunkLoad( playbackPositionUs: Long, loadingChunk: Chunk!, queue: (Mutable)List<MediaChunk!>! )` Returns whether an ongoing load of a chunk should be canceled.

Inherited properties

From androidx.media3.exoplayer.trackselection.BaseTrackSelection

`TrackGroup!`	`group` The selected `TrackGroup`.
`Int`	`length` The number of selected tracks within the `TrackGroup`.
`Boolean`	`playWhenReady` The current value of whether playback will proceed when ready.
`IntArray<Int>!`	`tracks` The indices of the selected tracks in `group`, in order of decreasing bandwidth.
`Int`	`@TrackSelection.Type type` The type of the selection.

Public constructors

FakeTrackSelection

FakeTrackSelection(rendererTrackGroup: TrackGroup!)

FakeTrackSelection

FakeTrackSelection(rendererTrackGroup: TrackGroup!, selectedIndex: Int)

Public functions

disable

fun disable(): Unit

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

fun enable(): Unit

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

fun equals(o: Any?): Boolean

evaluateQueueSize

fun evaluateQueueSize(
    playbackPositionUs: Long,
    queue: (Mutable)List<MediaChunk!>!
): Int

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
`playbackPositionUs: Long`	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: (Mutable)List<MediaChunk!>!`	The queue of buffered `MediaChunks`. Must not be modified.

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

excludeTrack

fun excludeTrack(index: Int, exclusionDurationMs: Long): Boolean

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
`index: Int`	The index of the track in the selection.
`exclusionDurationMs: Long`	The duration of time for which the track should be excluded, in milliseconds.

Returns
`Boolean`	Whether exclusion was successful.

getSelectionData

fun getSelectionData(): Any?

Returns optional data associated with the current track selection.

getSelectionReason

@C.SelectionReason
fun getSelectionReason(): Int

Returns the reason for the current track selection.

hashCode

fun hashCode(): Int

isTrackExcluded

fun isTrackExcluded(index: Int, nowMs: Long): Boolean

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

Parameters
`index: Int`	The index of the track in the selection.
`nowMs: Long`	The current time in the timebase of `elapsedRealtime`.

updateSelectedTrack

fun updateSelectedTrack(
    playbackPositionUs: Long,
    bufferedDurationUs: Long,
    availableDurationUs: Long,
    queue: (Mutable)List<MediaChunk!>!,
    mediaChunkIterators: Array<MediaChunkIterator!>!
): Unit

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

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

Parameters
`playbackPositionUs: Long`	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.
`bufferedDurationUs: Long`	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)`.
`availableDurationUs: Long`	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)`.
`queue: (Mutable)List<MediaChunk!>!`	The queue of already buffered `MediaChunk`s. Must not be modified.
`mediaChunkIterators: Array<MediaChunkIterator!>!`	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.

Public properties

enableCount

val enableCount: Int

isEnabled

val isEnabled: Boolean

releaseCount

val releaseCount: Int

selectedIndex

val selectedIndex: Int