OverlayEffect

Kotlin |Java

@UnstableApi
class OverlayEffect : GlEffect

Applies a list of TextureOverlays to a frame in FIFO order (the last overlay in the list is displayed on top).

This effect assumes a non-linear working color space for SDR input and a linear working color space or HDR input.

Summary

Public constructors
`OverlayEffect(textureOverlays: (Mutable)List<TextureOverlay!>!)` Creates a new instance for the given list of `TextureOverlay`s.

Public functions
`BaseGlShaderProgram!`	`toGlShaderProgram(context: Context!, useHdr: Boolean)` Returns a `GlShaderProgram` that applies the effect.

Long

getDurationAfterEffectApplied(durationUs: Long)

Returns the expected duration of the output stream when the effect is applied given a input durationUs.

Boolean

isNoOp(inputWidth: Int, inputHeight: Int)

Returns whether a GlEffect applies no change at every timestamp.

OverlayEffect(textureOverlays: (Mutable)List<TextureOverlay!>!)

Creates a new instance for the given list of TextureOverlays.

Parameters
`textureOverlays: (Mutable)List<TextureOverlay!>!`	The `TextureOverlay`s to be blended into the frame. To modify the list of `TextureOverlays`, one must recreate a new `OverlayEffect` with the updated list.

fun toGlShaderProgram(context: Context!, useHdr: Boolean): BaseGlShaderProgram!

Returns a GlShaderProgram that applies the effect.

Parameters
`context: Context!`	A `Context`.
`useHdr: Boolean`	Whether input textures come from an HDR source. If `true`, colors will be in linear RGB BT.2020. If `false`, colors will be in linear RGB BT.709.

Throws
`androidx.media3.common.VideoFrameProcessingException`	If an error occurs while creating the `GlShaderProgram`.