androidx.media3.test.utils

Kotlin |Java

Interfaces

`ActionSchedule.Callback`	Callback to notify listener that the action schedule has finished.
`ActionSchedule.PlayerTarget.Callback`	Callback to be called when message arrives.
`DecodeOneFrameUtil.Listener`	Listener for decoding events.
`DummyMainThread.TestRunnable`	`Runnable` variant which can throw a checked exception.
`Dumper.Dumpable`	Provides custom dump method.
`ExtractorAsserts.ExtractorFactory`	A factory for `Extractor` instances.
`FakeFrameProcessor.Event`	Marker interface for ordering frames and EOS signals.
`FakeMediaPeriod.TrackDataFactory`	A factory to create the test data for a particular track.
`FakeTrackOutput.Factory`	Factory for `FakeTrackOutput` instances.
`HostActivity.HostedTest`	Interface for tests that run inside of a `HostActivity`.
`MediaPeriodAsserts.FilterableManifestMediaPeriodFactory`	Interface to create media periods for testing based on a `FilterableManifest`.
`VideoFrameProcessorTestRunner.BitmapReader`	Reads a `Bitmap` from `VideoFrameProcessor` output.
`VideoFrameProcessorTestRunner.OnOutputFrameAvailableForRenderingListener`
`VideoFrameProcessorTestRunner.OnVideoFrameProcessingEndedListener`

Classes

`Action`	Base class for actions to perform during playback tests.
`Action.AddMediaItems`	Calls `addMediaSources`.
`Action.ClearMediaItems`	Calls `clearMediaItems`}.
`Action.ClearVideoSurface`	Calls `clearVideoSurface`.
`Action.ExecuteRunnable`	Calls `Runnable.run()`.
`Action.MoveMediaItem`	Calls `moveMediaItem`.
`Action.PlayUntilPosition`	Schedules a play action to be executed, waits until the player reaches the specified position, and pauses the player again.
`Action.Prepare`	Calls `prepare`.
`Action.RemoveMediaItem`	Calls `removeMediaItem`.
`Action.RemoveMediaItems`	Calls `removeMediaItems`.
`Action.Seek`	Calls `seekTo` or `seekTo`.
`Action.SendMessages`	Calls `createMessage` and `send`.
`Action.SetAudioAttributes`	Calls `setAudioAttributes`.
`Action.SetMediaItems`	Calls `setMediaSources`.
`Action.SetMediaItemsResetPosition`	Calls `setMediaSources`.
`Action.SetPlayWhenReady`	Calls `setPlayWhenReady`.
`Action.SetPlaybackParameters`	Calls `setPlaybackParameters`.
`Action.SetRendererDisabled`	Updates the `Parameters` of a `DefaultTrackSelector` to specify whether the renderer at a given index should be disabled.
`Action.SetRepeatMode`	Calls `setRepeatMode`.
`Action.SetShuffleModeEnabled`	Calls `setShuffleModeEnabled`.
`Action.SetShuffleOrder`	Calls `setShuffleOrder` .
`Action.SetVideoSurface`	Calls `setVideoSurface`.
`Action.Stop`	Calls `stop`.
`Action.ThrowPlaybackException`	Throws a playback exception on the playback thread.
`Action.WaitForIsLoading`	Waits for a specified loading state, returning either immediately or after a call to `onIsLoadingChanged`.
`Action.WaitForMessage`	Waits for a player message to arrive.
`Action.WaitForPendingPlayerCommands`	Waits until the player acknowledged all pending player commands.
`Action.WaitForPlayWhenReady`	Waits for a specified playWhenReady value, returning either immediately or after a call to `onPlayWhenReadyChanged`.
`Action.WaitForPlaybackState`	Waits for a specified playback state, returning either immediately or after a call to `onPlaybackStateChanged`.
`Action.WaitForPositionDiscontinuity`	Waits for `onPositionDiscontinuity`.
`Action.WaitForTimelineChanged`	Waits for `onTimelineChanged`.
`ActionSchedule`	Schedules a sequence of `Action`s for execution during a test.
`ActionSchedule.Builder`	A builder for `ActionSchedule` instances.
`ActionSchedule.PlayerRunnable`	Provides a wrapper for a `Runnable` which has access to the player.
`ActionSchedule.PlayerTarget`	Provides a wrapper for a `Target` which has access to the player when handling messages.
`AdditionalFailureInfo`	A JUnit `Rule` that attaches additional info to any errors/exceptions thrown by the test.
`AssetContentProvider`	A `ContentProvider` for reading asset data.
`AssetInfo`	Information about a test asset.
`BinderStressCreator`	A utility for creating artificial stress on the system process binder.
`BitmapPixelTestUtil`	Utilities for pixel tests.
`BitmapPixelTestUtil.ImageBuffer`	Represents a `ByteBuffer` read from an `Image`.
`CacheAsserts`	Assertion methods for `Cache`.
`CacheAsserts.RequestSet`	Defines a set of data requests.
`CapturingAudioSink`	An `AudioSink` forwarding to `DefaultAudioSink` that captures configuration, discontinuity and buffer events.
`CapturingAudioSink.InterceptingBufferSink`
`CapturingAudioSink.SampleInterceptingBufferSink`
`CapturingImageOutput`	A `ImageOutput` that captures image availability events.
`CompositionAssetInfo`	Test assets that describe various `Composition` configurations.
`DataSourceContractTest`	A collection of contract tests for `DataSource` implementations.
`DataSourceContractTest.FakeTransferListener`	A `TransferListener` that only keeps track of the transferred bytes.
`DataSourceContractTest.TestResource`	Information about a resource that can be used to test the `DataSource` instance.
`DataSourceContractTest.TestResource.Builder`	Builder for `TestResource` instances.
`DecodeOneFrameUtil`	Utilities for decoding a video frame for tests.
`DecoderCountersUtil`	Assertions for `DecoderCounters`.
`DefaultRenderersFactoryAsserts`	Assertions for `DefaultRenderersFactory`.
`DownloadBuilder`	Builder for `Download`.
`DummyMainThread`	Helper class to simulate main/UI thread in tests.
`DumpFileAsserts`	Helper class to enable assertions based on golden-data dump files.
`DumpableFormat`	Wraps a `Format` to allow dumping it.
`DumpableMp4Box`	Wraps an Mp4 box to allow dumping it.
`Dumper`	Helper utility to dump field values.
`EditedMediaItemAssetInfo`	Information about an `EditedMediaItem` and its associated `AssetInfo`.
`EmptyMediaSource`	MediaSource producing an empty `Timeline`.
`ExoHostedTest`	A `HostedTest` for `ExoPlayer` playback tests.
`ExoPlayerTestRunner`	Helper class to run an ExoPlayer test.
`ExoPlayerTestRunner.Builder`	Builder to set-up an `ExoPlayerTestRunner`.
`ExtractorAsserts`	Assertion methods for `Extractor`.
`ExtractorAsserts.AssertionConfig`	A config for the assertions made (e.g. dump file location).
`ExtractorAsserts.AssertionConfig.Builder`	Builder for `AssertionConfig` instances.
`ExtractorAsserts.ConfigProvider`	A `TestParameterValuesProvider` that provides `SimulationConfig` objects from `configs` to exercise different extractor paths.
`ExtractorAsserts.SimulationConfig`	A config of different environments to simulate and extractor behaviours to test.
`FailOnCloseDataSink`	A `DataSink` that can simulate caching the bytes being written to it, and then failing to persist them when `close` is called.
`FailOnCloseDataSink.Factory`	Factory to create a `FailOnCloseDataSink`.
`FakeAdaptiveDataSet`	Fake data set emulating the data of an adaptive media source.
`FakeAdaptiveDataSet.Factory`	Factory for `FakeAdaptiveDataSet`s.
`FakeAdaptiveDataSet.Iterator`	`MediaChunkIterator` for the chunks defined by a fake adaptive data set.
`FakeAdaptiveMediaPeriod`	Fake `MediaPeriod` that provides tracks from the given `TrackGroupArray`.
`FakeAdaptiveMediaSource`	Fake `MediaSource` that provides a given timeline.
`FakeAdsLoader`	A fake implementation of `AdsLoader`.
`FakeAudioRenderer`	A `FakeRenderer` that supports `TRACK_TYPE_AUDIO`.
`FakeChunkSource`	Fake `ChunkSource` with adaptive media chunks of a given duration.
`FakeChunkSource.Factory`	Factory for a `FakeChunkSource`.
`FakeClock`	Fake `Clock` implementation that allows to `advance the time` manually to trigger pending timed messages.
`FakeClock.Builder`	A builder for `FakeClock` instances.
`FakeClock.HandlerMessage`	Message data saved to send messages or execute runnables at a later time on a Handler.
`FakeCryptoConfig`	Fake `CryptoConfig`.
`FakeDataSet`	Collection of `FakeData` to be served by a `FakeDataSource`.
`FakeDataSet.FakeData`	Container of fake data to be served by a `FakeDataSource`.
`FakeDataSet.FakeData.Segment`	A segment of `FakeData`.
`FakeDataSource`	A fake `DataSource` capable of simulating various scenarios.
`FakeDataSource.Factory`	Factory to create a `FakeDataSource`.
`FakeExoMediaDrm`	A fake implementation of `ExoMediaDrm` for use in tests.
`FakeExoMediaDrm.Builder`	Builder for `FakeExoMediaDrm` instances.
`FakeExoMediaDrm.LicenseServer`	An license server implementation to interact with `FakeExoMediaDrm`.
`FakeExoMediaDrm.LicenseServer.Builder`	Builder for `LicenseServer` instances.
`FakeExtractorInput`	A fake `ExtractorInput` capable of simulating various scenarios.
`FakeExtractorInput.Builder`	Builder of `FakeExtractorInput` instances.
`FakeExtractorOutput`	A fake `ExtractorOutput`.
`FakeFrameProcessor`	A no-op `FrameProcessor` that holds a reference to all queued frames for testing.
`FakeFrameProcessor.EosEvent`	Marker class representing a `signalEndOfStream` call.
`FakeFrameProcessor.Factory`	A factory for `FakeFrameProcessor` implementations.
`FakeFrameProcessor.FramesEvent`	Holds the frames queued in a `queue` call.
`FakeHardwareBufferNativeHelpers`	Fake class to simulate `HardwareBufferNativeHelpers`.
`FakeMediaChunk`	Fake `MediaChunk`.
`FakeMediaChunkIterator`	Fake `MediaChunkIterator`.
`FakeMediaClockRenderer`	Fake abstract `Renderer` which is also a `MediaClock`.
`FakeMediaPeriod`	Fake `MediaPeriod` that provides tracks from the given `TrackGroupArray`.
`FakeMediaSource`	Fake `MediaSource` that provides a given timeline.
`FakeMediaSource.Builder`	A builder for `FakeMediaSource` instances.
`FakeMediaSource.InitialTimeline`	A forwarding timeline to provide an initial timeline for fake multi window sources.
`FakeMediaSourceFactory`	Fake `MediaSourceFactory` that creates a `FakeMediaSource`.
`FakeMetadataEntry`	A fake `Metadata.Entry`.
`FakeMultiPeriodLiveTimeline`	A fake `Timeline` that produces a live window with periods according to the available time range.
`FakePlayer`	A fake `Player` that uses `SimpleBasePlayer`'s minimal number of default methods implementations to build upon to simulate realistic playback scenarios for testing.
`FakeRenderer`	Fake `Renderer` that supports any format with the matching track type.
`FakeSampleStream`	Fake `SampleStream` that outputs a given `Format` and any amount of `items`.
`FakeSampleStream.FakeSampleStreamItem`	Item to customize a return value of `readData`.
`FakeShuffleOrder`	Fake `ShuffleOrder` which returns a reverse order.
`FakeTimeline`	Fake `Timeline` which can be setup to return custom `TimelineWindowDefinition`s.
`FakeTimeline.TimelineWindowDefinition`	Definition used to define a `FakeTimeline`.
`FakeTimeline.TimelineWindowDefinition.Builder`	A builder to build instances of `FakeTimeline.TimelineWindowDefinition`.
`FakeTrackOutput`	A fake `TrackOutput`.
`FakeTrackSelection`	A fake `ExoTrackSelection` that supports selecting a subset of tracks within a `TrackGroup`, returns 1 fixed track, and tracks the number of calls to its methods.
`FakeTrackSelector`	A fake `MappingTrackSelector` that returns `FakeTrackSelection`s.
`FakeTrackSelector.FakeTrackSelectionFactory`	A factory for the `androidx.media3.test.utils.FakeTrackSelection` instances requested by the `FakeTrackSelector`.
`FakeVideoRenderer`	A `FakeRenderer` that supports `TRACK_TYPE_VIDEO`.
`FormatSupportAssumptions`	Utility methods for checking and assuming format support in instrumentation tests.
`HdrCapabilitiesUtil`	Utility class for checking HDR capabilities.
`HostActivity`	A host activity for performing playback tests.
`HttpDataSourceTestEnv`	A JUnit `Rule` that creates test resources for `HttpDataSource` contract tests.
`ImageReaderSurfaceHolder`	An implementation of `SurfaceHolder` which is backed by an `ImageReader`.
`ImmutableByteArray`	`byte` version of `com.google.common.primitives.ImmutableIntArray`.
`ImmutableByteArray.Builder`	Builder for `ImmutableByteArray` instances.
`InMemoryDatabaseRule`	A JUnit `Rule` that creates (and cleans up) in-memory databases and `SimpleCache` instances.
`MalformedParcelable`	A `Parcelable` that throws a `RuntimeException` during deserialization.
`MediaPeriodAsserts`	Assertion methods for `MediaPeriod`.
`MediaSourceTestRunner`	A runner for `MediaSource` tests.
`MediaSourceTestRunner.MediaSourceListener`
`MssimCalculator`	Image comparison tool that calculates the Mean Structural Similarity (MSSIM) of two images, developed by Wang, Bovik, Sheikh, and Simoncelli.
`OggFileAudioBufferSink`	A sink for audio buffers that writes output audio as .ogg files with a given path prefix.
`PassthroughAudioProcessor`	A `BaseAudioProcessor` implementation that accepts all input formats and copies all input buffers onto the output without modifications.
`PlayerFence`	A Java-compatible fluent API for waiting for certain `Player` conditions.
`RecordingHardwareBufferEffectsPipeline`	Wraps a `DefaultHardwareBufferEffectsPipeline` and triggers a callback on every `queuePacket` call.
`RecordingPacketConsumer`	A `PacketConsumer` implementation that holds a reference to all queued packets, and optionally releases the underlying frames.
`ReleaseListener`	A shared `AnalyticsListener` implementation for waiting until `onPlayerReleased` is called and all background events have been delivered.
`SequenceAssetInfo`	Test assets that describe various `EditedMediaItemSequence` configurations.
`SsimHelper`	A helper for calculating SSIM score for transcoded videos.
`StubExoPlayer`	An abstract `ExoPlayer` implementation that throws `UnsupportedOperationException` from every method.
`StubPlayer`	An abstract `Player` implementation that throws `UnsupportedOperationException` from every method.
`TestExoPlayerBuilder`	A builder of `ExoPlayer` instances for testing.
`TestSpeedProvider`	`SpeedProvider` for tests
`TestSummaryLogger`	Utilities for logging test summaries in instrumentation tests.
`TestTransformerBuilder`	A builder of `Transformer` instances for testing with Robolectric.
`TestUtil`	Utility methods for tests.
`TextureBitmapReader`	Reads from an OpenGL texture.
`ThreadTestUtil`	Static utility to coordinate threads in testing environments.
`ThrowingSubtitleParserFactory`	A `SubtitleParser.Factory` for `SubtitleParser` instances that throw an exception on every call to `parse`.
`TimelineAsserts`	Assertion methods for `Timeline`.
`VideoDecodingWrapper`	A wrapper for decoding a video using `MediaCodec`.
`VideoFrameProcessorTestRunner`	A test runner for `VideoFrameProcessor` tests.
`VideoFrameProcessorTestRunner.Builder`	A builder for `VideoFrameProcessorTestRunner` instances.
`VideoFrameProcessorTestRunner.SurfaceBitmapReader`	Reads from a `Surface`.
`WebServerDispatcher`	A Dispatcher for okhttp3.mockwebserver.MockWebServer that allows per-path customisation of the static data served.
`WebServerDispatcher.Resource`	A resource served by `WebServerDispatcher`.
`WebServerDispatcher.Resource.Builder`	Builder for `Resource`.

Exceptions

FakeExtractorInput.SimulatedIOException

Thrown when simulating an IOException.

Top-level functions summary

Unit

@UnstableApi
doBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> Unit)

Runs the given block using runBlocking on the current thread for side effect.

Extension functions summary

`suspend Unit`	`@UnstableApi Player.awaitContentPositionAtLeast( targetPositionMs: Long, failOnNonFatalErrors: Boolean, timeout: Duration? )` Suspends until the content position reaches (or passes) `targetPositionMs` in the current media item.
`suspend Unit`	`@UnstableApi Player.awaitFirstFrameRendered( failOnNonFatalErrors: Boolean, timeout: Duration? )` Suspends until `Player.Listener.onRenderedFirstFrame` is invoked.
`suspend Unit`	`@UnstableApi Player.awaitIsPlaying( targetIsPlaying: Boolean, failOnNonFatalErrors: Boolean, timeout: Duration? )` Suspends until the player's `Player.isPlaying` value matches `targetIsPlaying`.
`suspend Unit`	`@UnstableApi Player.awaitPlaybackState( targetState: @Player.State Int, failOnNonFatalErrors: Boolean, timeout: Duration? )` Suspends until the player enters the provided `targetState`.

Top-level functions

doBlocking

Artifact: androidx.media3:media3-test-utils

View Source

@UnstableApi
fun doBlocking(
    context: CoroutineContext = EmptyCoroutineContext,
    block: suspend CoroutineScope.() -> Unit
): Unit

Runs the given block using runBlocking on the current thread for side effect.

Using this function is like runBlocking with default context (which runs the given block on the calling thread) but forces the return type to be Unit, which is helpful when implementing suspending tests as expression functions:

@Test
fun myTest() = doBlocking {...}

Extension functions

Player.awaitContentPositionAtLeast

Artifact: androidx.media3:media3-test-utils

View Source

@UnstableApi
suspend fun Player.awaitContentPositionAtLeast(
    targetPositionMs: Long,
    failOnNonFatalErrors: Boolean = true,
    timeout: Duration? = null
): Unit

Suspends until the content position reaches (or passes) targetPositionMs in the current media item.

This makes some assumptions:

The condition completes immediately if Player.getContentPosition is already at least targetPositionMs.
Seeking past the target position satisfies the condition.
If playback ends, or the media item changes, before the target position is reached, an exception is thrown.

Must be called on the player's application looper thread.

Parameters
`targetPositionMs: Long`	The `Player.getContentPosition` to wait for.
`failOnNonFatalErrors: Boolean = true`	Whether non-fatal errors (such as those from `AnalyticsListener.onAudioCodecError`) cause an exception to be thrown immediately.
`timeout: Duration? = null`	The max time to wait for, or `null` to use a default timeout of 10 seconds.

Throws
`IllegalStateException`	if not called on the player's application looper thread.

Player.awaitFirstFrameRendered

Artifact: androidx.media3:media3-test-utils

View Source

@UnstableApi
suspend fun Player.awaitFirstFrameRendered(
    failOnNonFatalErrors: Boolean = true,
    timeout: Duration? = null
): Unit

Suspends until Player.Listener.onRenderedFirstFrame is invoked.

This should be called before the callback has been invoked (e.g. before calling Player.prepare), otherwise it risks awaiting forever.

Must be called on the player's application looper thread.

Parameters
`failOnNonFatalErrors: Boolean = true`	Whether non-fatal errors (such as those from `AnalyticsListener.onAudioCodecError`) cause an exception to be thrown immediately.
`timeout: Duration? = null`	The max time to wait for, or `null` to use a default timeout of 10 seconds.

Throws
`IllegalStateException`	if not called on the player's application looper thread.

Player.awaitIsPlaying

Artifact: androidx.media3:media3-test-utils

View Source

@UnstableApi
suspend fun Player.awaitIsPlaying(
    targetIsPlaying: Boolean,
    failOnNonFatalErrors: Boolean = true,
    timeout: Duration? = null
): Unit

Suspends until the player's Player.isPlaying value matches targetIsPlaying.

If the player's Player.isPlaying value is already targetIsPlaying this returns immediately.

Must be called on the player's application looper thread.

Parameters
`targetIsPlaying: Boolean`	The value of `Player.isPlaying` to wait for.
`failOnNonFatalErrors: Boolean = true`	Whether non-fatal errors (such as those from `AnalyticsListener.onAudioCodecError`) cause an exception to be thrown immediately.
`timeout: Duration? = null`	The max time to wait for, or `null` to use a default timeout of 10 seconds.

Throws
`IllegalStateException`	if not called on the player's application looper thread.

Player.awaitPlaybackState

Artifact: androidx.media3:media3-test-utils

View Source

@UnstableApi
suspend fun Player.awaitPlaybackState(
    targetState: @Player.State Int,
    failOnNonFatalErrors: Boolean = true,
    timeout: Duration? = null
): Unit

Suspends until the player enters the provided targetState.

If the player is already in the provided targetState this returns immediately.

Must be called on the player's application looper thread.

Parameters
`targetState: @Player.State Int`	The playback `Player.State` to await.
`failOnNonFatalErrors: Boolean = true`	Whether non-fatal errors (such as those from `AnalyticsListener.onAudioCodecError`) cause an exception to be thrown immediately.
`timeout: Duration? = null`	The max time to wait for, or `null` to use a default timeout of 10 seconds.

Throws
`IllegalStateException`	if not called on the player's application looper thread.