FrameExtractor.Builder

Artifact: androidx.media3:media3-inspector-frame

Kotlin |Java

class FrameExtractor.Builder

A builder for FrameExtractor instances.

Summary

Public constructors
`Builder(context: Context!, mediaItem: MediaItem!)` Creates a new instance.

Public functions
`FrameExtractor!`	`build()` Builds a new `FrameExtractor` instance.
`FrameExtractor.Builder!`	`@CanIgnoreReturnValue setEffects(effects: (Mutable)List<Effect!>!)` Sets the `Effects` to apply to the extracted video frames.
`FrameExtractor.Builder!`	`@CanIgnoreReturnValue @RequiresApi(value = 34) @ExperimentalApi setEnableUltraHdr(enableUltraHdr: Boolean)` Sets whether to enable UltraHDR extraction.
`FrameExtractor.Builder!`	`@CanIgnoreReturnValue @RequiresApi(value = 34) setExtractHdrFrames(extractHdrFrames: Boolean)` Sets whether to extract HDR video frames as HLG Bitmaps.
`FrameExtractor.Builder!`	`@CanIgnoreReturnValue setGlObjectsProvider(glObjectsProvider: GlObjectsProvider!)` Sets the `GlObjectsProvider` to be used by the effect processing pipeline.
`FrameExtractor.Builder!`	`@CanIgnoreReturnValue setMediaCodecSelector(mediaCodecSelector: MediaCodecSelector!)` Sets the `selector` of `MediaCodec` instances.
`FrameExtractor.Builder!`	`@CanIgnoreReturnValue setMediaSourceFactory(mediaSourceFactory: MediaSource.Factory!)` Sets the `MediaSource.Factory` to be used to create the `MediaSource` for the given `MediaItem`.
`FrameExtractor.Builder!`	`@CanIgnoreReturnValue setSeekParameters(seekParameters: SeekParameters!)` Sets the parameters that control how seek operations are performed.

Public constructors

Builder

Builder(context: Context!, mediaItem: MediaItem!)

Creates a new instance.

Parameters
`context: Context!`	The `Context`.
`mediaItem: MediaItem!`	The `MediaItem` from which to extract frames.

Public functions

build

fun build(): FrameExtractor!

Builds a new FrameExtractor instance.

setEffects

@CanIgnoreReturnValue
fun setEffects(effects: (Mutable)List<Effect!>!): FrameExtractor.Builder!

Sets the Effects to apply to the extracted video frames.

Parameters
`effects: (Mutable)List<Effect!>!`	The `List` of `video effects`.

Returns
`FrameExtractor.Builder!`	This builder.

setEnableUltraHdr

@CanIgnoreReturnValue
@RequiresApi(value = 34)
@ExperimentalApi
fun setEnableUltraHdr(enableUltraHdr: Boolean): FrameExtractor.Builder!

Sets whether to enable UltraHDR extraction.

When set to true and setExtractHdrFrames is false, extracting from an HDR source on API 34+ will produce an UltraHDR image (SDR base + Gainmap).

When set to false, extracting from an HDR source will always produce a tone-mapped SDR image, even on API 34+.

Defaults to false.

Parameters
`enableUltraHdr: Boolean`	Whether to enable UltraHDR extraction.

Returns
`FrameExtractor.Builder!`	This builder.

setExtractHdrFrames

@CanIgnoreReturnValue
@RequiresApi(value = 34)
fun setExtractHdrFrames(extractHdrFrames: Boolean): FrameExtractor.Builder!

Sets whether to extract HDR video frames as HLG Bitmaps.

When set to true, extracted HDR frames will have a high bit depth Bitmap.Config and BT2020_HLG. Extracting HDR frames is only supported on API 34+.

When set to false, extracted HDR frames will be tone-mapped to SDR (BT.709).

setEnableUltraHdr controls whether to generate a getGainmap.

Defaults to false.

Parameters
`extractHdrFrames: Boolean`	Whether to extract HDR frames as HLG.

Returns
`FrameExtractor.Builder!`	This builder.

setGlObjectsProvider

@CanIgnoreReturnValue
fun setGlObjectsProvider(glObjectsProvider: GlObjectsProvider!): FrameExtractor.Builder!

Sets the GlObjectsProvider to be used by the effect processing pipeline.

By default, a DefaultGlObjectsProvider is used.

Parameters
`glObjectsProvider: GlObjectsProvider!`	The `GlObjectsProvider`.

Returns
`FrameExtractor.Builder!`	This builder.

setMediaCodecSelector

@CanIgnoreReturnValue
fun setMediaCodecSelector(mediaCodecSelector: MediaCodecSelector!): FrameExtractor.Builder!

Sets the selector of MediaCodec instances. Defaults to PREFER_SOFTWARE.

Parameters
`mediaCodecSelector: MediaCodecSelector!`	The `MediaCodecSelector`.

Returns
`FrameExtractor.Builder!`	This builder.

setMediaSourceFactory

@CanIgnoreReturnValue
fun setMediaSourceFactory(mediaSourceFactory: MediaSource.Factory!): FrameExtractor.Builder!

Sets the MediaSource.Factory to be used to create the MediaSource for the given MediaItem. If not set, a DefaultMediaSourceFactory will be used.

Parameters
`mediaSourceFactory: MediaSource.Factory!`	The `MediaSource.Factory`.

Returns
`FrameExtractor.Builder!`	This builder.

setSeekParameters

@CanIgnoreReturnValue
fun setSeekParameters(seekParameters: SeekParameters!): FrameExtractor.Builder!

Sets the parameters that control how seek operations are performed. Defaults to DEFAULT.

Parameters
`seekParameters: SeekParameters!`	The `SeekParameters`.

Returns
`FrameExtractor.Builder!`	This builder.