DebugViewEffect

Kotlin |Java

@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

getDurationAfterEffectApplied(durationUs: 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 `GlShaderProgram`.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2025-08-28 UTC.

X
Follow @AndroidDev on X
YouTube
Check out Android Developers on YouTube
LinkedIn
Connect with the Android Developers community on LinkedIn