TestPlayerRunHelper.PlayerRunResult

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

Kotlin |Java

class TestPlayerRunHelper.PlayerRunResult

Known direct subclasses

TestPlayerRunHelper.ExoPlayerRunResult

TestPlayerRunHelper.ExoPlayerRunResult

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

Intermediate type that allows callers to run the main Looper until certain conditions are met.

If an error occurs while a untilXXX(...) method is waiting for the condition to become true, most methods will throw that error (exceptions to this are documented on specific methods below). Use ignoringNonFatalErrors to ignore non-fatal errors and only fail on fatal playback errors.

Instances of this class should only be used for a single untilXXX() invocation and not be re-used.

Summary

Public functions
`TestPlayerRunHelper.PlayerRunResult!`	`ignoringNonFatalErrors()` Returns a new instance where the `untilXXX(...)` methods ignore non-fatal errors.
`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.
`PlaybackException!`	`untilPlayerError()` Runs tasks of the main `Looper` until a player 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.

Protected functions
`Unit`	`runUntil(predicate: Supplier<Boolean!>!)` Runs the main `Looper` until `predicate` returns true or an error occurs.

Protected properties
`Boolean`	`hasBeenUsed`
`Boolean`	`playBeforeWaiting`

Public functions

ignoringNonFatalErrors

fun ignoringNonFatalErrors(): TestPlayerRunHelper.PlayerRunResult!

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

untilFirstFrameIsRendered

fun untilFirstFrameIsRendered(): Unit

Runs tasks of the main Looper until onRenderedFirstFrame is called 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.

untilLoadingIs

fun untilLoadingIs(expectedIsLoading: Boolean): Unit

Runs tasks of the main Looper until isLoading 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.

untilPlayWhenReadyIs

fun untilPlayWhenReadyIs(expectedPlayWhenReady: Boolean): Unit

Runs tasks of the main Looper until getPlayWhenReady 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.

untilPlayerError

fun untilPlayerError(): PlaybackException!

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

Non-fatal errors are always ignored.

Returns
`PlaybackException!`	The raised `PlaybackException`.

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

untilPositionDiscontinuityWithReason

fun untilPositionDiscontinuityWithReason(
    @Player.DiscontinuityReason expectedReason: Int
): Unit

Runs tasks of the main Looper until onPositionDiscontinuity is called with the specified Player.DiscontinuityReason 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.

untilState

fun untilState(@Player.State expectedState: Int): Unit

Runs tasks of the main Looper until getPlaybackState matches the expected state or an error occurs.

Throws
`androidx.media3.common.PlaybackException`	If a fatal 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.

untilTimelineChanges

fun untilTimelineChanges(): Timeline!

Runs tasks of the main Looper until a timeline change 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.

untilTimelineChangesTo

fun untilTimelineChangesTo(expectedTimeline: Timeline!): Unit

Runs tasks of the main Looper until getCurrentTimeline matches the expected timeline 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.

Protected functions

runUntil

protected fun runUntil(predicate: Supplier<Boolean!>!): Unit

Runs the main Looper until predicate returns true or an error occurs.

Throws
`androidx.media3.common.PlaybackException`
`java.util.concurrent.TimeoutException`

Protected properties

hasBeenUsed

protected val hasBeenUsed: Boolean

playBeforeWaiting

protected val playBeforeWaiting: Boolean