OverlayEffect

Kotlin |Java

@UnstableApi
public final class OverlayEffect implements 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(List<TextureOverlay> textureOverlays)` Creates a new instance for the given list of `TextureOverlay`s.

Public methods
`BaseGlShaderProgram`	`toGlShaderProgram(Context context, boolean useHdr)` Returns a `GlShaderProgram` that applies the effect.

long

getDurationAfterEffectApplied(long durationUs)

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

boolean

isNoOp(int inputWidth, int inputHeight)

Returns whether a GlEffect applies no change at every timestamp.

public OverlayEffect(List<TextureOverlay> textureOverlays)

Creates a new instance for the given list of TextureOverlays.

Parameters
`List<TextureOverlay> textureOverlays`	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.

public BaseGlShaderProgram toGlShaderProgram(Context context, boolean useHdr)

Returns a GlShaderProgram that applies the effect.

Parameters
`Context context`	A `Context`.
`boolean useHdr`	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`.