ContextQMD
Back to Exoplayer

OverlayEffect (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/effect/OverlayEffect.html

latest4.3 KB
Original Source

Package com.google.android.exoplayer2.effect

Class OverlayEffect

  • java.lang.Object

    • com.google.android.exoplayer2.effect.OverlayEffect

  • All Implemented Interfaces:GlEffect, Effect

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classOverlayEffectextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")implements[GlEffect](GlEffect.html "interface in com.google.android.exoplayer2.effect")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

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

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | OverlayEffect​(ImmutableList<TextureOverlay> textureOverlays) | Deprecated.

Creates a new instance for the given list of TextureOverlays. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | SingleFrameGlShaderProgram | toGlShaderProgram​(Context context, boolean useHdr) | Deprecated.

Returns a GlShaderProgram that applies the effect. |

-

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

-

Methods inherited from interface com.google.android.exoplayer2.effect.GlEffect

isNoOp

Constructor Detail

-

OverlayEffect

public OverlayEffect​([ImmutableList](https://guava.dev/releases/31.1-android/api/docs/com/google/common/collect/ImmutableList.html?is-external=true "class or interface in com.google.common.collect")<[TextureOverlay](TextureOverlay.html "class in com.google.android.exoplayer2.effect")> textureOverlays)

Deprecated.

Creates a new instance for the given list of TextureOverlays. Parameters:textureOverlays - The TextureOverlays to be blended into the frame.

Method Detail

-

toGlShaderProgram

public[SingleFrameGlShaderProgram](SingleFrameGlShaderProgram.html "class in com.google.android.exoplayer2.effect")toGlShaderProgram​([Context](https://developer.android.com/reference/android/content/Context.html "class or interface in android.content")context,
                                                    boolean useHdr)
                                             throws[VideoFrameProcessingException](../util/VideoFrameProcessingException.html "class in com.google.android.exoplayer2.util")

Deprecated.

Description copied from interface: GlEffect

Returns a GlShaderProgram that applies the effect. Specified by:toGlShaderProgram in interface GlEffectParameters:context - A Context.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:VideoFrameProcessingException - If an error occurs while creating the GlShaderProgram.