TestPlayerRunHelper.CompositionPlayerRunResult

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

Kotlin |Java

class TestPlayerRunHelper.CompositionPlayerRunResult : TestPlayerRunHelper.PlayerRunResult

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

A CompositionPlayer specific subclass of PlayerRunResult, giving access to conditions that only make sense for CompositionPlayer.

Summary

Public functions
`TestPlayerRunHelper.CompositionPlayerRunResult!`	`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.

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`	`untilPendingCommandsAreFullyHandled(clock: Clock!, targetLooper: Looper!)` Runs tasks of the `main looper` until all pending tasks in `targetLooper` have been handled and have propagated any updates to the main looper.
`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`	`untilPlayingAdIs(expectedIsPlayingAd: Boolean)` Runs tasks of the main `Looper` until `isPlayingAd` ()} 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.CompositionPlayerRunResult!

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.