AssetLoader

Artifact: androidx.media3:media3-transformer

Kotlin |Java

@UnstableApi
interface AssetLoader

Known direct subclasses

ExoPlayerAssetLoader, ImageAssetLoader, MediaProjectionAssetLoader, RawAssetLoader, SurfaceAssetLoader, TextureAssetLoader

`ExoPlayerAssetLoader`	An `AssetLoader` implementation that uses an `ExoPlayer` to load samples.
`ImageAssetLoader`	An `AssetLoader` implementation that loads images into `Bitmap` instances.
`MediaProjectionAssetLoader`	Asset loader that provides video from `MediaProjection`.
`RawAssetLoader`	An `AssetLoader` implementation that loads raw audio and/or video data.
`SurfaceAssetLoader`	Asset loader that outputs video data passed to its input `Surface`.
`TextureAssetLoader`	This class is deprecated. Use `RawAssetLoader`.

Provides media data to a Transformer.

The output samples can be encoded or decoded.

Only audio and video samples are supported. Both audio and video tracks can be provided by a single asset loader, but outputting multiple tracks of the same type is not supported.

An asset loader is responsible for removing audio or video if requested.

If slow motion flattening is requested, the asset loader should flatten the video track for media containing slow motion markers. This is usually done prior to decoding. The audio samples are flattened after they are output by the AssetLoader, because this is done on decoded samples.

Summary

Nested types
`class AssetLoader.CompositionSettings` Customizations set on the `composition-level` that are needed when `loading` each of the `individual assets` in the `Composition`.
`interface AssetLoader.Factory` A factory for `AssetLoader` instances.
`interface AssetLoader.Listener` A listener of `AssetLoader` events.
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ElementType.TYPE_USE) @IntDef(flag = true, value = ) annotation AssetLoader.SupportedOutputTypes` Supported output types of an asset loader.

Constants
`const Int`	`SUPPORTED_OUTPUT_TYPE_DECODED = 2` Indicates that the asset loader can output decoded samples.
`const Int`	`SUPPORTED_OUTPUT_TYPE_ENCODED = 1` Indicates that the asset loader can output encoded samples.

Public functions
`ImmutableMap<Int!, String!>!`	`getDecoderNames()` Return the used decoders' names.
`Int`	`@Transformer.ProgressState getProgress(progressHolder: ProgressHolder!)` Returns the current `Transformer.ProgressState` and updates `progressHolder` with the current progress if it is `available`.
`Unit`	`release()` Stops loading data and releases all resources associated with the asset loader.
`Unit`	`start()` Starts the asset loader.

Constants

SUPPORTED_OUTPUT_TYPE_DECODED

const val SUPPORTED_OUTPUT_TYPE_DECODED = 2: Int

Indicates that the asset loader can output decoded samples.

SUPPORTED_OUTPUT_TYPE_ENCODED

const val SUPPORTED_OUTPUT_TYPE_ENCODED = 1: Int

Indicates that the asset loader can output encoded samples.

Public functions

getDecoderNames

fun getDecoderNames(): ImmutableMap<Int!, String!>!

Return the used decoders' names.

Returns
`ImmutableMap<Int!, String!>!`	The decoders' names keyed by `track type`.

getProgress

@Transformer.ProgressState
fun getProgress(progressHolder: ProgressHolder!): Int

Returns the current Transformer.ProgressState and updates progressHolder with the current progress if it is available.

Parameters
`progressHolder: ProgressHolder!`	A `ProgressHolder`, updated to hold the percentage progress if `available`.

Returns
`Int`	The `Transformer.ProgressState`.

release

fun release(): Unit

Stops loading data and releases all resources associated with the asset loader.

start

fun start(): Unit

Starts the asset loader.

AssetLoader

Summary

Nested types

Constants

Public functions

Constants

SUPPORTED_OUTPUT_TYPE_DECODED

SUPPORTED_OUTPUT_TYPE_ENCODED

Public functions

getDecoderNames

getProgress

release

start