DebugViewEffect


@UnstableApi
class DebugViewEffect : GlEffect


GlEffect that renders to a SurfaceView provided by DebugViewProvider.

Summary

Public constructors

DebugViewEffect(
    debugViewProvider: DebugViewProvider!,
    outputColorInfo: ColorInfo!
)

Creates a new instance.

Public functions

GlShaderProgram!
toGlShaderProgram(context: Context!, useHdr: Boolean)

Returns a GlShaderProgram that applies the effect.

Inherited functions

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(inputWidth: Int, inputHeight: Int)

Returns whether a GlEffect applies no change at every timestamp.

Public constructors

DebugViewEffect

DebugViewEffect(
    debugViewProvider: DebugViewProvider!,
    outputColorInfo: ColorInfo!
)

Creates a new instance.

Parameters
debugViewProvider: DebugViewProvider!

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

outputColorInfo: ColorInfo!

The ColorInfo of the output preview.

Public functions

toGlShaderProgram

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

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 .