DebugViewEffect


@UnstableApi
public final class DebugViewEffect implements GlEffect


GlEffect that renders to a SurfaceView provided by DebugViewProvider.

Summary

Public constructors

DebugViewEffect(
    DebugViewProvider debugViewProvider,
    ColorInfo outputColorInfo
)

Creates a new instance.

Public methods

GlShaderProgram
toGlShaderProgram(Context context, boolean useHdr)

Returns a GlShaderProgram that applies the effect.

Inherited methods

From androidx.media3.common.Effect
long

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

From androidx.media3.effect.GlEffect
boolean
isNoOp(int inputWidth, int inputHeight)

Returns whether a GlEffect applies no change at every timestamp.

Public constructors

DebugViewEffect

public DebugViewEffect(
    DebugViewProvider debugViewProvider,
    ColorInfo outputColorInfo
)

Creates a new instance.

Parameters
DebugViewProvider debugViewProvider

The class that provides the SurfaceView that the debug preview will be rendered to.

ColorInfo outputColorInfo

The ColorInfo of the output preview.

Public methods

toGlShaderProgram

public GlShaderProgram 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 .