Package-level declarations

Types

Link copied to clipboard
class CameraFrame(val width: Int, val height: Int, val rotationDegrees: Int, val platformHandle: Any? = null)

A camera video frame captured during user interaction.

Link copied to clipboard
@ObjCName(name = "FaceMatcherColor")
data class Color(val red: Float, val green: Float, val blue: Float, val alpha: Float = 1.0f)

RGBA color representation used by face matching and liveness sessions to control UI background illumination.

Link copied to clipboard
interface FaceMatcher

Interface for verifying user identity via face matching.

Link copied to clipboard
data class FaceMatcherLivenessPromptState(val message: String? = null, val status: FaceMatcherLivenessPromptState.Status = Status.IN_PROGRESS, val overlay: OverlayFrame? = null, val capturedImages: Map<FacePose, ByteString> = emptyMap(), val backgroundColor: Color? = null)

State of the face matcher liveness prompt dialog observed by the UI layer.

Link copied to clipboard
abstract class FaceMatcherLivenessSession(val poses: List<FacePose> = listOf(FacePose.FRONT))

Session driving the interactive face liveness verification and photo capture UI.

Link copied to clipboard
data class FaceMatcherPromptState(val message: String? = null, val status: FaceMatcherPromptState.Status = Status.IN_PROGRESS, val overlay: OverlayFrame? = null, val backgroundColor: Color? = null)

State of the face matcher prompt dialog observed by the UI layer during verification.

Link copied to clipboard

A repository of FaceMatcher implementations.

Link copied to clipboard
abstract class FaceMatcherSession(val referencePortrait: ByteString)

Session driving the interactive face matching verification UI against a reference portrait.

Link copied to clipboard

Head poses that can be requested and captured during a FaceMatcherLivenessSession.

Link copied to clipboard
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.