3.1 SilentLivenessApi
public final class SilentLivenessApi
public static void init(@NonNull final Context context, @NonNull final String licenseFilePath, @NonNull final String detectionModelFilePath, @NonNull final String alignmentModelFilePath, @NonNull final String qualityModelFilePath, @NonNull final String frameSelectorModelFilePath, @NonNull final String antiSpoofingModelFilePath, @NonNull final OnLivenessListener listener)
初期化メソッドです。
パラメーター
型
説明
context
Context
licenseFilePath
String
デバイス上のライセンスファイルの格納パス
detectionModelFilePath
String
デバイス上の顔検知モデルファイルの格納パス
qualityModelFilePath
String
デバイス上の品質モデルファイルの格納パス
alignmentModelFilePath
String
デバイス上のアライメントモデルファイルの格納パス
frameSelectorModelFilePath
String
デバイス上のフレームセレクターモデルファイルの格納パス
antiSpoofingModelFilePath
String
デバイス上のなりすまし防止モデルファイルの格納パス
listener
OnLivenessListener
OnLivernessListener (生体検知のステータスリスナー。empty に設定されている場合、初期化できません。)
戻り値
説明
なし
なし
public static void setBrowOcclusionEnable(final boolean enable)
生体検知中に眉の遮蔽の検知を実施するかを設定します。設定しない場合、デフォルトはfalseです。
パラメーター
型
説明
enable
boolean
生体検知中に眉の遮蔽の検知を実施するかを設定します。設定しない場合、デフォルトは falseです。
戻り値
説明
なし
なし
public static void setBlurryFilterEnable(final boolean enable, final float threshold)
生体検知中にぼやけの検知を実施するかを設定します。設定しない場合、デフォルトはfalseです。閾値の既定値は1.4です。
パラメーター
型
説明
enable
boolean
生体検知中にぼやけの検知を実施するかを設定します。設定しない場合、デフォルトは falseです。
threshold
float
ぼやけを判断するために使用される値です。範囲は[0,5]です。検出結果スコアは閾値よりも大きい場合、ぼやけと判定されます。既定の閾値は1.4です。5に設定する場合、ぼやけ検知はオフになります。
戻り値
説明
なし
なし
public static void setIlluminationFilterEnable(final boolean enable, final float lowLightThreshold, final float brightThreshold)
生体検知中に照明条件の検知を実施するかを設定します。設定しない場合、デフォルトはfalseです。
パラメーター
型
説明
enable
boolean
生体検知中に照明条件の検知を実施するかを設定します。設定しない場合、デフォルトはfalseです。
lowLightThreshold
float
暗い照明条件を判断するために使用される値です。範囲は[0,6]です。検出結果スコアは閾値よりも小さい場合、暗すぎると判定されます。既定の閾値は1.899です。0に設定する場合、暗い照明条件検知はオフになります。
brightThreshold
float
明るい照明条件を判断するために使用される値です。範囲は[0,6]です。検出結果スコアは閾値よりも大きい場合、暗すぎると判定されます。既定の閾値は4.997です。6に設定する場合、明るい照明条件検知はオフになります。
戻り値
説明
なし
なし
public static void setEyeOpenThreshold(final float threshold)
生体検知中に目の開きの検知しきい値を設定します。既定値は0.47です。
パラメーター
型
説明
threshold
float
目の開きを判断するために使用される値です。範囲は[0,1]です。検出結果スコアは閾値よりも大きい場合、目が開いていると判定されます。既定の閾値は0.47です。
戻り値
説明
なし
なし
public static void setOcclusionEnable(final boolean enable)
生体検知中に顔パーツの遮蔽の検知を実施するかを設定します。デフォルトはtrueです。
パラメーター
型
説明
enable
boolean
生体検知中に顔パーツの遮蔽の検知を実施するかを設定します。デフォルトはtrueです。
戻り値
説明
なし
なし
public static void setThreshold(final float threshold)
生体検知の閾値を設定します。閾値の既定値は0.88です。
パラメーター
型
説明
threshold
float
生体検知（なりすまし防止為）の閾値です。範囲は[0.0,1.0]です。
戻り値
説明
なし
なし
public static void setDetectTimeout(int timeout)
各モジュールに許可されている最大検知時間です。デフォルト値は10秒で、単位は秒です。
パラメーター
型
説明
timeout
int
各モジュールに許可されている最大検知時間です。デフォルト値は10秒で、単位は秒です。値が0未満の場合、STID_E_INVALID_ARGUMENTSエラーが通知され、0の場合はタイムアウトせず、0よりも大きい値の場合、設定値がタイムアウト時間になります。
戻り値
説明
なし
なし
public static void setFaceDistanceRate(float farRate, float closeRate)
顔との距離の判定条件を設定します。パラメーター値が範囲外の場合、またはcloseRateが0以外かつfarRateがcloseRateよりも大きい場合、STID_E_FARCLOSE_INVALIDエラーが通知されます。
パラメーター
型
説明
farRate
float
画像の短辺に対する顔の高さ/幅の比率です。[0.0～1.0]の範囲で設定できます。パラメーターが0に近いほど顔がスクリーンから離れていることを示します。デフォルト値は0.4です。0に設定されている場合、距離のプロンプトは表示されません。
closeRate
float
画像の短辺に対する顔の高さ/幅の比率です。[0.0～1.0]の範囲で設定できます。パラメーターが1に近いほど顔がスクリーンに近づいていることを示します。デフォルト値は0.8です。0に設定されている場合、距離のプロンプトは表示されません。
戻り値
説明
なし
なし
public static void setPassCondition(final int minDuration, final int frames)
サイレント生体検知を通過するまでの条件を設定し、正確な結果を取得するためにinitメソッドの後にstart() メソッドを呼び出します。それ以外の場合は-1を返します。
パラメーター
型
説明
minDuration
int
生体検知がパスされるまでの [0～dDuration] の範囲の最短検知時間です。デフォルトは3秒です。最低でも1ミリ秒とすることを推奨します。0は最短時間制限が無いことを示します。負の数字に設定されている場合は0秒とみなされます。
frames
int
生体検知の最小検知フレーム数です。デフォルトは4です。0は最小フレーム数制限が無いことを示します。負の数字に設定されている場合は0にみなされます。
戻り値
説明
なし
なし
public static void inputData(byte[] image, PixelFormat format, Size previewSize, Rect containerRect, boolean frontCameraOrNot, int cameraOrientation)
生体検知の構成です。検知待ちの画像を入力します。
パラメーター
型
説明
image
byte[]
検知される画像フレームデータ
format
`PixelFormat
画像フレームデータのフォーマット
previewSize
Size
画像サイズ
containerRect
Rect
プレビュービューの区域のサイズ
frontCameraOrNot
boolean
フロントカメラを使用しているかを示すパラメーター 使用している状態ではtrue、使用していない状態ではfalseを示します。
cameraOrientation
int
カメラ画像の向き
戻り値
説明
なし
なし
public static void start()
検知の準備が完了しています。inputDataの前、およびinitの後に呼び出します。
パラメーター
説明
なし
なし
戻り値
説明
なし
なし
public static void stop()
現在の検知を停止し、検知ステータスをリセットします。失敗後のリトライの状況で使用され、stop を呼び出した後に（initの成功後、且つrelease無しで）呼び出し、検知はstartで直接再開することができます。
パラメーター
説明
なし
なし
戻り値
説明
なし
なし
public static void release()
initを呼び出した後にリソースを解放します。リソースはreleaseを介して解放する必要があります。
パラメーター
説明
なし
なし
戻り値
説明
なし
なし
public static boolean getBrowOcclusionEnable()
生体検知中に眉の遮蔽検知を実施するの設定を取得します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合はfalseが戻され、眉の遮蔽検知の正しい設定を取得できません。
パラメーター
説明
なし
なし
戻り値
説明
boolean
Trueは眉の遮蔽検知がオンになっていることを示し、falseは眉の遮蔽検知がオフになっていることを示します。
public static boolean getBlurryFilterEnable()
生体検知中にぼやけ検知を実施するかの設定を取得します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合はfalseが戻され、ぼやけ検知の正しい設定を取得できません。
パラメーター
説明
なし
なし
戻り値
説明
boolean
Trueはぼやけ検知がオンになっていることを示し、falseはぼやけ検知がオフになっていることを示します。
public static boolean getIlluminationFilterEnable()
生体検知中に照明条件の検知を実施するかの設定を取得します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合はfalseが戻され、照明条件の検知の正しい設定を取得できません。
パラメーター
説明
なし
なし
戻り値
説明
boolean
Trueは照明条件の検知がオンになっていることを示し、falseは照明条件の検知がオフになっていることを示します。
public static boolean getOcclusionEnable()
生体検知中に顔パーツの遮蔽の検知を実施するかを設定します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合はfalseが戻され、顔パーツの遮蔽の検知の正しい設定を取得できません。
パラメーター
説明
なし
なし
戻り値
説明
boolean
Trueは顔パーツの遮蔽検知がオンになっていることを示し、falseは顔パーツの遮蔽の検知がオフになっていることを示します。
public static float getThreshold()
生体検知の閾値をを取得します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合は-1.0が戻されます。閾値の既定値は0.88です。
パラメーター
説明
なし
なし
戻り値
説明
float
生体検知の閾値です。
public static int getDetectTimeout()
検知のタイムアウト時間を取得します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合は正確なタイムアウト設定を取得することができず-1を返します。
パラメーター
説明
なし
なし
戻り値
説明
int
秒単位の検知タイムアウト時間
public static int getPassMinDuration()
生体検知を通過するまでの最短検知時間を取得します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合は-1.0が戻されます。
パラメーター
説明
なし
なし
戻り値
説明
int
生体検知を通過するまでの最短時間 (秒単位)。
public static int getPassMinFrames()
生体検知を通過するまでの最小の検知フレーム数を取得。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合は-1.0が戻されます。
パラメーター
説明
なし
なし
戻り値
説明
int
生体検知を通過するまでの最小検知フレーム数
public static float getFaceFarRate()
顔との距離farRateの判定条件の値を設定します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合は-1.0が戻されます。
パラメーター
説明
なし
なし
戻り値
説明
float
顔との距離の判定条件のfarRateの値
public static float getFaceCloseRate()
顔との距離の判定条件のcloseRateの値を取得します。initの後に呼び出すことで、正確な結果を取得できます。それ以外の場合は-1.0が戻されます。
パラメーター
説明
なし
なし
戻り値
説明
float
顔との距離の判定条件の closeRate の値
public static String getSdkVersion()
現在のSDKのバージョン番号を取得します。
パラメーター
説明
なし
なし
戻り値
説明
String
現在の SDK のバージョン番号
public static String getLibraryVersion()
現在の内部ライブラリのバージョン番号を取得します。initの成功後に、このメソッドを呼び出すことで内部ライブラリの正確なバージョン番号を取得できます。
パラメーター
説明
なし
なし
戻り値
説明
String
現在の内部ライブラリのバージョンを取得
Last updated