TextOverlay

Kotlin |Java

@UnstableApi
abstract class TextOverlay : BitmapOverlay

kotlin.Any
↳	androidx.media3.effect.TextureOverlay
	↳	androidx.media3.effect.BitmapOverlay
		↳	androidx.media3.effect.TextOverlay

Creates a TextureOverlay from text.

Uses a SpannableString to store the text and support advanced per-character text styling.

Summary

Constants
`const Int`	`TEXT_SIZE_PIXELS = 100`

Public constructors
`TextOverlay()`

Public functions
`java-static TextOverlay!`	`createStaticTextOverlay(overlayText: SpannableString!)` Creates a `TextOverlay` that shows the `overlayText` with the same default settings in `StaticOverlaySettings` throughout the whole video.
`java-static TextOverlay!`	`createStaticTextOverlay( overlayText: SpannableString!, overlaySettings: StaticOverlaySettings! )` Creates a `TextOverlay` that shows the `overlayText` with the same `StaticOverlaySettings` throughout the whole video.
`Bitmap!`	`getBitmap(presentationTimeUs: Long)` Returns the overlay bitmap displayed at the specified timestamp.
`abstract SpannableString!`	`getText(presentationTimeUs: Long)` Returns the overlay text displayed at the specified timestamp.

`java-static BitmapOverlay!`	`createStaticBitmapOverlay(overlayBitmap: Bitmap!)` Creates a `BitmapOverlay` that shows the `overlayBitmap` in the same position and size throughout the whole video.
`java-static BitmapOverlay!`	`createStaticBitmapOverlay( overlayBitmap: Bitmap!, overlaySettings: StaticOverlaySettings! )` Creates a `BitmapOverlay` that shows the `overlayBitmap` in the same `OverlaySettings` throughout the whole video.
`java-static BitmapOverlay!`	`createStaticBitmapOverlay( context: Context!, overlayBitmapUri: Uri!, overlaySettings: StaticOverlaySettings! )` Creates a `BitmapOverlay` that shows the input at `overlayBitmapUri` with the same `StaticOverlaySettings` throughout the whole video.
`Int`	`getTextureId(presentationTimeUs: Long)` Returns the overlay texture identifier displayed at the specified timestamp.
`Size!`	`getTextureSize(presentationTimeUs: Long)` Returns the pixel width and height of the overlay texture displayed at the specified timestamp.
`FloatArray<Float>!`	`getVertexTransformation(presentationTimeUs: Long)` Returns a 4x4 OpenGL matrix, controlling how the vertices of the overlay are displayed at the specified timestamp.
`Unit`	`release()` Releases all resources.

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

const val TEXT_SIZE_PIXELS = 100: Int

TextOverlay()

java-static fun createStaticTextOverlay(overlayText: SpannableString!): TextOverlay!

Creates a TextOverlay that shows the overlayText with the same default settings in StaticOverlaySettings throughout the whole video.

java-static fun createStaticTextOverlay(
    overlayText: SpannableString!,
    overlaySettings: StaticOverlaySettings!
): TextOverlay!

Creates a TextOverlay that shows the overlayText with the same StaticOverlaySettings throughout the whole video.

Parameters
`overlayText: SpannableString!`	The text to overlay on the video.
`overlaySettings: StaticOverlaySettings!`	The `StaticOverlaySettings` configuring how the overlay is displayed on the frames.

fun getBitmap(presentationTimeUs: Long): Bitmap!

Returns the overlay bitmap displayed at the specified timestamp.

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

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

abstract fun getText(presentationTimeUs: Long): SpannableString!

Returns the overlay text displayed at the specified timestamp.

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