TestPlayerRunHelper.ExoPlayerRunResult

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

Kotlin |Java

public final class TestPlayerRunHelper.ExoPlayerRunResult extends TestPlayerRunHelper.PlayerRunResult

java.lang.Object
↳	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 methods
`TestPlayerRunHelper.ExoPlayerRunResult`	`ignoringNonFatalErrors()` Returns a new instance where the `untilXXX(...)` methods ignore non-fatal errors.
`void`	`untilBackgroundThreadCondition( Supplier<Boolean> backgroundThreadCondition )` Runs tasks of the main `Looper` until the specified condition becomes true independent of a message on the main `Looper`.
`void`	`untilFullyBuffered()` Runs tasks of the main `Looper` until the player has fully buffered its entire playlist and stopped reporting `isLoading`.
`void`	`untilMediaItemIndex(int mediaItemIndex)` Runs tasks of the main `Looper` until `getCurrentMediaItemIndex` equals the specified index or an error occurs.
`void`	`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.
`void`	`untilPosition(int mediaItemIndex, long positionMs)` Runs tasks of the main `Looper` until the internal playback thread reaches the specified position or an error occurs.
`void`	`untilPositionAtLeast(long positionMs)` Runs tasks of the main `Looper` until `getContentPosition` reaches at least the specified position in the current media item, or an error occurs.
`void`	`untilPositionAtLeast(int mediaItemIndex, long positionMs)` Runs tasks of the main `Looper` until `getCurrentMediaItemIndex` equals the specified index and `getContentPosition` reaches at least the specified position, or an error occurs.
`void`	`untilSleepingForOffloadBecomes(boolean expectedSleepingForOffload)` Runs tasks of the main `Looper` until `isSleepingForOffload` matches the expected value, or an error occurs.
`void`	`untilStartOfMediaItem(int mediaItemIndex)` Runs tasks of the main `Looper` until the internal playback thread reaches the start of the specified media item or a playback error occurs.

Inherited fields

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

`boolean`	`hasBeenUsed`
`final boolean`	`playBeforeWaiting`

Inherited methods

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

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

Public methods

ignoringNonFatalErrors

public TestPlayerRunHelper.ExoPlayerRunResult ignoringNonFatalErrors()

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

untilBackgroundThreadCondition

public void untilBackgroundThreadCondition(
    Supplier<Boolean> backgroundThreadCondition
)

Runs tasks of the main Looper until the specified condition becomes true independent of a message on the main Looper.

This method is useful for cases where the condition may change outside of a main message, for example because it's checking a volatile variable or shared synchronized state that is updated on a background thread, or because checking the condition itself may cause it to become true.

This method ensures the condition is checked within artificially created main messages. When using a androidx.media3.test.utils.FakeClock, this guarantees the remainder of the test method is not executed in parallel with other background thread messages.

Parameters
`Supplier<Boolean> backgroundThreadCondition`	The condition to wait for.

Throws
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.lang.IllegalStateException`	If non-fatal playback errors occur, and aren't `ignored` (the non-fatal exceptions will be attached with `addSuppressed`).
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilFullyBuffered

public void untilFullyBuffered()

Runs tasks of the main Looper until the player has fully buffered its entire playlist and stopped reporting isLoading.

Note that this method won't succeed if the player is configured with a that prevents loading the playlist fully before playback resumes.

If a Player.RepeatMode setting results in an endless playlist, this method only waits until all items have been buffered at least once.

Throws
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilMediaItemIndex

public void untilMediaItemIndex(int mediaItemIndex)

Runs tasks of the main Looper until getCurrentMediaItemIndex equals the specified index or an error occurs.

Use untilStartOfMediaItem instead if the test needs to advance the player until the internal playback thread reaches the start of the media item exactly.

Throws
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.lang.IllegalStateException`	If non-fatal playback errors occur, and aren't `ignored` (the non-fatal exceptions will be attached with `addSuppressed`).
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilPendingCommandsAreFullyHandled

public void untilPendingCommandsAreFullyHandled()

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.

untilPlayerError

public ExoPlaybackException untilPlayerError()

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

public void untilPosition(int mediaItemIndex, long positionMs)

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

Use untilPositionAtLeast instead if the test needs to advance the player until the publicly visible position reaches a specified value.

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
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.lang.IllegalStateException`	If non-fatal playback errors occur, and aren't `ignored` (the non-fatal exceptions will be attached with `addSuppressed`).
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilPositionAtLeast

public void untilPositionAtLeast(long positionMs)

Runs tasks of the main Looper until getContentPosition reaches at least the specified position in the current media item, or an error occurs.

Use untilPosition instead if the test needs to advance the player until the internal playback thread reaches a specific position exactly.

Throws
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.lang.IllegalStateException`	If non-fatal playback errors occur, and aren't `ignored` (the non-fatal exceptions will be attached with `addSuppressed`).
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilPositionAtLeast

public void untilPositionAtLeast(int mediaItemIndex, long positionMs)

Runs tasks of the main Looper until getCurrentMediaItemIndex equals the specified index and getContentPosition reaches at least the specified position, or an error occurs.

Use untilPosition instead if the test needs to advance the player until the internal playback thread reaches a specific position exactly.

Throws
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.lang.IllegalStateException`	If non-fatal playback errors occur, and aren't `ignored` (the non-fatal exceptions will be attached with `addSuppressed`).
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilSleepingForOffloadBecomes

public void untilSleepingForOffloadBecomes(boolean expectedSleepingForOffload)

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

Throws
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.lang.IllegalStateException`	If non-fatal playback errors occur, and aren't `ignored` (the non-fatal exceptions will be attached with `addSuppressed`).
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.

untilStartOfMediaItem

public void untilStartOfMediaItem(int mediaItemIndex)

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

Use untilMediaItemIndex instead if the test needs to advance the player until the publicly visible media item index reaches a specified value.

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
`int mediaItemIndex`	The index of the media item.

Throws
`androidx.media3.common.PlaybackException`	If a playback error occurs.
`java.lang.IllegalStateException`	If non-fatal playback errors occur, and aren't `ignored` (the non-fatal exceptions will be attached with `addSuppressed`).
`java.util.concurrent.TimeoutException`	If the `default timeout` is exceeded.