TestPlayerRunHelper.ExoPlayerRunResult

Artifact: androidx.media3:media3-test-utils-robolectric

Kotlin |Java

class TestPlayerRunHelper.ExoPlayerRunResult : TestPlayerRunHelper.PlayerRunResult

kotlin.Any
↳	androidx.media3.test.utils.robolectric.TestPlayerRunHelper.PlayerRunResult
	↳	androidx.media3.test.utils.robolectric.TestPlayerRunHelper.ExoPlayerRunResult

An ExoPlayer specific subclass of PlayerRunResult, giving access to conditions that only make sense for the ExoPlayer interface.

Summary

Public functions
`TestPlayerRunHelper.ExoPlayerRunResult!`	`ignoringNonFatalErrors()` Returns a new instance where the `untilXXX(...)` methods ignore non-fatal errors.
`Unit`	`untilPendingCommandsAreFullyHandled()` Runs tasks of the main `Looper` until the player completely handled all previously issued commands on the internal playback thread.
`ExoPlaybackException!`	`untilPlayerError()` Runs tasks of the main `Looper` until a player error occurs.
`Unit`	`untilPosition(mediaItemIndex: Int, positionMs: Long)` Runs tasks of the main `Looper` until playback reaches the specified position or an error occurs.
`Unit`	`untilSleepingForOffloadBecomes(expectedSleepingForOffload: Boolean)` Runs tasks of the main `Looper` until `isSleepingForOffload` matches the expected value, or an error occurs.
`Unit`	`untilStartOfMediaItem(mediaItemIndex: Int)` Runs tasks of the main `Looper` until playback reaches the specified media item or a playback error occurs.

Inherited functions

From androidx.media3.test.utils.robolectric.TestPlayerRunHelper.PlayerRunResult

`Unit`	`runUntil(predicate: Supplier<Boolean!>!)` Runs the main `Looper` until `predicate` returns true or an error occurs.
`Unit`	`untilFirstFrameIsRendered()` Runs tasks of the main `Looper` until `onRenderedFirstFrame` is called or an error occurs.
`Unit`	`untilLoadingIs(expectedIsLoading: Boolean)` Runs tasks of the main `Looper` until `isLoading` matches the expected value or an error occurs.
`Unit`	`untilPlayWhenReadyIs(expectedPlayWhenReady: Boolean)` Runs tasks of the main `Looper` until `getPlayWhenReady` matches the expected value or an error occurs.
`Unit`	`untilPositionDiscontinuityWithReason( @Player.DiscontinuityReason expectedReason: Int )` Runs tasks of the main `Looper` until `onPositionDiscontinuity` is called with the specified `Player.DiscontinuityReason` or an error occurs.
`Unit`	`untilState(@Player.State expectedState: Int)` Runs tasks of the main `Looper` until `getPlaybackState` matches the expected state or an error occurs.
`Timeline!`	`untilTimelineChanges()` Runs tasks of the main `Looper` until a timeline change or an error occurs.
`Unit`	`untilTimelineChangesTo(expectedTimeline: Timeline!)` Runs tasks of the main `Looper` until `getCurrentTimeline` matches the expected timeline or an error occurs.

Inherited properties

From androidx.media3.test.utils.robolectric.TestPlayerRunHelper.PlayerRunResult

`Boolean`	`hasBeenUsed`
`Boolean`	`playBeforeWaiting`

Public functions

ignoringNonFatalErrors

fun ignoringNonFatalErrors(): TestPlayerRunHelper.ExoPlayerRunResult!

Returns a new instance where the untilXXX(...) methods ignore non-fatal errors.

A fatal error is defined as an error that is passed to onPlayerError and results in the player transitioning to STATE_IDLE. A non-fatal error is defined as an error that is passed to any other callback (e.g. onLoadError).

untilPendingCommandsAreFullyHandled

fun untilPendingCommandsAreFullyHandled(): Unit

Runs tasks of the main Looper until the player completely handled all previously issued commands on the internal playback thread.

Both fatal and non-fatal errors are always ignored.

Throws
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.
`java.lang.Exception`

untilPlayerError

fun untilPlayerError(): ExoPlaybackException!

Runs tasks of the main Looper until a player error occurs.

Non-fatal errors are always ignored.

Returns
`ExoPlaybackException!`	The raised `PlaybackException`.

Throws
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilPosition

fun untilPosition(mediaItemIndex: Int, positionMs: Long): Unit

Runs tasks of the main Looper until playback reaches the specified position or an error occurs.

The playback thread is automatically blocked from making further progress after reaching this position and will only be unblocked by other run()/play().untilXXX(...) method chains, custom runMainLooperUntil conditions, or an explicit unblockThreadsWaitingForProgressOnCurrentLooper on the main thread.

Throws
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.
`java.lang.Exception`

untilSleepingForOffloadBecomes

fun untilSleepingForOffloadBecomes(expectedSleepingForOffload: Boolean): Unit

Runs tasks of the main Looper until isSleepingForOffload matches the expected value, or an error occurs.

Throws
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.
`java.lang.Exception`

untilStartOfMediaItem

fun untilStartOfMediaItem(mediaItemIndex: Int): Unit

Runs tasks of the main Looper until playback reaches the specified media item or a playback error occurs.

The playback thread is automatically blocked from making further progress after reaching the media item and will only be unblocked by other run()/play().untilXXX(...) method chains, custom runMainLooperUntil conditions, or an explicit unblockThreadsWaitingForProgressOnCurrentLooper on the main thread.

Parameters
`mediaItemIndex: Int`	The index of the media item.

Throws
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.
`java.lang.Exception`