jcv-face-core/mobile.japancv.jcvfacesdk

Package-level declarations

Types

class AndroidPlatform(val context: Any?) : Platform

actual class Core

SDK Core. This is the entry point of JCV Face SDK. It holds common configuration and the state of SDK APIs. Most applications don't need to interact with this class.

expect class Core

SDK Core. This is the entry point of JCV Face SDK. It holds common configuration and the state of SDK APIs. Most applications don't need to interact with this class.

actual class Core

DualImageAgent

data class DualImageAgent(val firstImageAgent: ImageAgent, val secondImageAgent: ImageAgent)

The DualImageAgent is represented for two ImageAgents may be used for the scenario of binocular Face Liveness detection

ImageAgent

interface ImageAgent

The ImageAgent interface serves as a versatile and comprehensive abstraction for interacting with images within the SDK. It defines a set of properties that an implementing class must support, providing a unified interface for various image-related operations.

InternalFaceSdkApi

annotation class InternalFaceSdkApi

The InternalFaceSdkApi annotation class is designed to annotate classes or functions within the Face SDK that are intended for internal use only. This annotation serves as a marker to indicate that certain elements of the SDK are not intended for public consumption and may not provide the same level of stability or backward compatibility as the officially documented API.

IOSPlatform

class IOSPlatform : Platform

Platform

interface Platform

Platform context

Scope

@Target(allowedTargets = [AnnotationTarget.CLASS])

actual annotation class Scope(val scope: Int)

@Target(allowedTargets = [AnnotationTarget.CLASS])

expect annotation class Scope(val scope: Int)

Identifies scope annotations.

actual annotation class Scope(val scope: Int)

SdkComponent

actual abstract class SdkComponent

expect abstract class SdkComponent

actual abstract class SdkComponent

SdkModels

data class SdkModels(val faceDetection: String, val faceDetectionPriors: String, val faceQuality: String? = null, val faceLiveness: String? = null, val faceBinocularLiveness: String? = null, val facePose: String? = null, val faceAge: String? = null, val faceGender: String? = null, val gesture: String? = null)

SdkOptions

data class SdkOptions(val projectId: String, val packageName: String, val apiKey: String, val key: String, val sdkModels: SdkModels)

SdkScope

data class SdkScope(val scope: Int = 0)

Functions

toImageAgent

fun Bitmap.toImageAgent(): ImageAgent

The util for converting Bitmap to ImageAgent

fun ByteArray.toImageAgent(format: ImageFormat): ImageAgent

The util for converting ByteArray to ImageAgent