Skip to content

Main classes#

LunaID#

LunaID is the main LUNA ID object, providing all the core methods and properties.

Main properties#

Property Description
engineInitStatus: StateFlow<EngineInitStatus> Tracks LUNA ID initialization status.
bestShot: MutableStateFlow<Event.BestShotFound?> Emits the best shot when it becomes available during a capture session.
bestShots: MutableStateFlow<Event.BestShotsFound?> Emits a list of found best shots (if multiple are requested) when they become available.
videoRecordingResult: MutableStateFlow<Event.VideoRecordingResult?> Provides a video recording file.
eventChannel: Channel<Event> Captures LUNA ID events.
faceDetectionChannel: Channel<Effect.FaceDetected> Emits face detection events.
errorFlow: Flow<Effect.Error?> Aggregates errors.
apiHuman: ApiHuman? API for working with the Human API.

BestShot#

The BestShot class describes the best face shot.

data class BestShot(
    val ags: Float, // Image quality rating (0.0 - 1.0)
    al detection: Rect, // Face region in the image
    val image: Bitmap, // Image
    val warp: Bitmap // Normalized face image
)

InteractionFrame#

The InteractionFrame class represents a user interaction frame, including an interaction type and the associated visual frame.

data class InteractionFrame(
    val interactionType: Int, // Interaction type
    val image: Bitmap // Frame image
)