OverlayFrame

class OverlayFrame(val width: Int, val height: Int, val platformHandle: Any? = null, val data: ByteString? = null)

A bitmap overlay rendered on top of the camera video stream during face matching.

Constructors

Link copied to clipboard
constructor(width: Int, height: Int, platformHandle: Any? = null, data: ByteString? = null)
constructor(width: Int, height: Int, platformHandle: Any?)

Properties

Link copied to clipboard
val data: ByteString?

optional raw image bytes (e.g. for testing or headless pipelines).

Link copied to clipboard
val height: Int

height of the overlay in pixels.

Link copied to clipboard

optional platform-specific handle (e.g. Android Bitmap, iOS UIImage, or JVM BufferedImage) for zero-copy rendering.

Link copied to clipboard
val width: Int

width of the overlay in pixels.