BitmapOverlay

Kotlin |Java

@UnstableApi
public abstract class BitmapOverlay extends TextureOverlay

java.lang.Object
↳	androidx.media3.effect.TextureOverlay
	↳	androidx.media3.effect.BitmapOverlay

Known direct subclasses

CanvasOverlay, DrawableOverlay, TextOverlay

`CanvasOverlay`	A `TextOverlay` that is backed by a `Canvas`.
`DrawableOverlay`	Creates a `TextureOverlay` from `Drawable`.
`TextOverlay`	Creates a `TextureOverlay` from text.

Known indirect subclasses

LottieOverlay

LottieOverlay

A CanvasOverlay that renders a Lottie animation.

Creates TextureOverlays from Bitmaps.

Useful for overlaying images and animated images (e.g. GIFs).

Summary

Public constructors
`BitmapOverlay()`

Public methods
`static BitmapOverlay`	`createStaticBitmapOverlay(Bitmap overlayBitmap)` Creates a `BitmapOverlay` that shows the `overlayBitmap` in the same position and size throughout the whole video.
`static BitmapOverlay`	`createStaticBitmapOverlay( Bitmap overlayBitmap, StaticOverlaySettings overlaySettings )` Creates a `BitmapOverlay` that shows the `overlayBitmap` in the same `OverlaySettings` throughout the whole video.
`static BitmapOverlay`	`createStaticBitmapOverlay( Context context, Uri overlayBitmapUri, StaticOverlaySettings overlaySettings )` Creates a `BitmapOverlay` that shows the input at `overlayBitmapUri` with the same `StaticOverlaySettings` throughout the whole video.
`abstract Bitmap`	`getBitmap(long presentationTimeUs)` Returns the overlay bitmap displayed at the specified timestamp.
`int`	`getTextureId(long presentationTimeUs)` Returns the overlay texture identifier displayed at the specified timestamp.
`Size`	`getTextureSize(long presentationTimeUs)` Returns the pixel width and height of the overlay texture displayed at the specified timestamp.
`float[]`	`getVertexTransformation(long presentationTimeUs)` Returns a 4x4 OpenGL matrix, controlling how the vertices of the overlay are displayed at the specified timestamp.
`void`	`release()` Releases all resources.

Inherited methods

From androidx.media3.effect.TextureOverlay

`void`	`configure(Size videoSize)` Set up resources for the overlay given the input video’s dimensions.
`OverlaySettings`	`getOverlaySettings(long presentationTimeUs)` Returns the `OverlaySettings` controlling how the overlay is displayed at the specified timestamp.

Public constructors

BitmapOverlay

public BitmapOverlay()

Public methods

createStaticBitmapOverlay

public static BitmapOverlay createStaticBitmapOverlay(Bitmap overlayBitmap)

Creates a BitmapOverlay that shows the overlayBitmap in the same position and size throughout the whole video.

Parameters
`Bitmap overlayBitmap`	The bitmap to overlay on the video.

createStaticBitmapOverlay

public static BitmapOverlay createStaticBitmapOverlay(
    Bitmap overlayBitmap,
    StaticOverlaySettings overlaySettings
)

Creates a BitmapOverlay that shows the overlayBitmap in the same OverlaySettings throughout the whole video.

Parameters
`Bitmap overlayBitmap`	The bitmap to overlay on the video.
`StaticOverlaySettings overlaySettings`	The `OverlaySettings` configuring how the overlay is displayed on the frames.

createStaticBitmapOverlay

public static BitmapOverlay createStaticBitmapOverlay(
    Context context,
    Uri overlayBitmapUri,
    StaticOverlaySettings overlaySettings
)

Creates a BitmapOverlay that shows the input at overlayBitmapUri with the same StaticOverlaySettings throughout the whole video.

Parameters
`Context context`	The `Context`.
`Uri overlayBitmapUri`	The `Uri` pointing to the resource to be converted into a bitmap.
`StaticOverlaySettings overlaySettings`	The `StaticOverlaySettings` configuring how the overlay is displayed on the frames.

getBitmap

public abstract Bitmap getBitmap(long presentationTimeUs)

Returns the overlay bitmap displayed at the specified timestamp.

Parameters
`long presentationTimeUs`	The presentation timestamp of the current frame, in microseconds.

Throws
`androidx.media3.common.VideoFrameProcessingException`	If an error occurs while processing or drawing the frame.

getTextureId

public int getTextureId(long presentationTimeUs)

Returns the overlay texture identifier displayed at the specified timestamp.

Parameters
`long presentationTimeUs`	The presentation timestamp of the current frame, in microseconds.

Throws
`androidx.media3.common.VideoFrameProcessingException`	If an error occurs while processing or drawing the frame.

getTextureSize

public Size getTextureSize(long presentationTimeUs)

Returns the pixel width and height of the overlay texture displayed at the specified timestamp.

This method must be called after #getTextureId(long).

Gets the width and height of the cached bitmap.

Parameters
`long presentationTimeUs`	The presentation timestamp of the current frame, in microseconds.

getVertexTransformation

public float[] getVertexTransformation(long presentationTimeUs)

Returns a 4x4 OpenGL matrix, controlling how the vertices of the overlay are displayed at the specified timestamp.

Applied before #getOverlaySettings overlay settings.

Flips the overlay vertically to convert between Android and OpenGL texture coordinate systems.

release

public void release()

Releases all resources.

Throws
`androidx.media3.common.VideoFrameProcessingException`	If an error occurs while releasing resources.