3.2 STSilentLivenessDetector

- (instancetype)initWithDetectionModelPath:(NSString *)detectionModelPath alignmentModelPath:(NSString *)alignmentModelPath frameSelectorModelPath:(NSString *)frameSelectorModelPath antiSpoofingModelPath:(NSString *)antiSpoofingModelPath licensePath:(NSString *)licensePath setDelegate:(id <STSilentLivenessDetectorDelegate>)delegate;

初期化メソッドです。

パラメーター	説明
detectionModelPath	DETECTIONモデルリソースのパス
alignmentModelPath	ALIGNMENTモデルリソースのパス
frameSelectorModelPath	FRAME_SELECTORモデルリソースのパス
antiSpoofingModelPath	ANTI_SPOOFINGモデルリソースのパス
faceQualityModelPath	FACE_QUALITYモデルリソースのパス。顔の品質検査を行う必要がない場合は、nilを渡すことが可能
licensePath	SenseID_Liveness_Silent.licライセンスファイルのパス
delegate	コールバックのデリゲート

戻り値	説明
生体検知インスタンス	なし

- (void)setImageProcessRule:(STSilentLivenessImageProcessRule *)rule;

画像トリミングの処理ルールを設定します。

パラメーター	説明
rule	画像トリミングの処理ルール、詳細はSTSilentLivenessImageProcessRuleを参照してください。

戻り値	説明
なし	なし

- (void)setBrowOcclusionEnable:(BOOL)enable;

生体検知中に眉の遮蔽の検知を実施するかを設定します。設定しない場合、デフォルトは NO です。

パラメーター	説明
enable	Yesは眉の検知がオンになっていることを示し、Noは眉の遮蔽の検知がオフになっていることを示します。

戻り値	説明
なし	なし

- (void)setBlurryFilterEnable:(BOOL)enable threshold:(float)threshold;

生体検知中にぼやけの検知を実施するかを設定します。設定しない場合、デフォルトは NO です。閾値の既定値は1.4です。

パラメーター	説明
enable	Yesはぼやけの検知がオンになっていることを示し、Noはぼやけの検知がオフになっていることを示します。
threshold	ぼやけを判断するために使用される値です。範囲は[0,5]です。検出結果スコアは閾値よりも大きい場合、ぼやけと判定されます。既定の閾値は1.4です。5に設定する場合、ぼやけ検知はオフになります。

戻り値	説明
なし	なし

- (void)setIlluminationFilterEnable:(BOOL)enable darkLightThreshold:(float)darkLightThreshold strongLightThreshold:(float)strongLightThreshold;

生体検知中に照明条件の検知を実施するかを設定します。設定しない場合、デフォルトは NO です。darkLightThresholdの既定値は1.899です。strongLightThresholdの既定値は4.997です。

パラメーター	説明
enable	Yesは照明条件（明るい、暗い）の検知がオンになっていることを示し、Noは照明条件の検知がオフになっていることを示します。
darkLightThreshold	暗い照明条件を判断するために使用される値です。範囲は[0,6]です。検出結果スコアは閾値よりも小さい場合、暗すぎると判定されます。既定の閾値は1.899です。0に設定する場合、暗い照明条件検知はオフになります。
strongLightThreshold	明るい照明条件を判断するために使用される値です。範囲は[0,6]です。検出結果スコアは閾値よりも大きい場合、暗すぎると判定されます。既定の閾値は4.997です。6に設定する場合、明るい照明条件検知はオフになります。

戻り値	説明
なし	なし

- (void)setEyeOpenFilterEnable:(BOOL)enable threshold:(float)threshold;

生体検知中に目の開きの検知を実施するかを設定します。設定しない場合、デフォルトは NO です。閾値の既定値は0.47です。

パラメーター	説明
enable	Yesは目の開きの検知がオンになっていることを示し、Noは目の開きの検知がオフになっていることを示します。
threshold	目の開きを判断するために使用される値です。範囲は[0,1]です。検出結果スコアは閾値よりも大きい場合、目が開いていると判定されます。既定の閾値は0.47です。0に設定する場合、目の開き検知はオフになります。

戻り値	説明
なし	なし

- (void)setOcclusionEnable:(BOOL)enable;

生体検知中に顔パーツの遮蔽の検知を実施するかを設定します。設定しない場合、デフォルトは NO です。

パラメーター	説明
enable	Yesは顔パーツの遮蔽の検知がオンになっていることを示し、Noは顔パーツの遮蔽の検知がオフになっていることを示します。

戻り値	説明
なし	なし

- (void)setHackThreshold:(float)threshold;

生体検知の閾値を設定します。有効にするには、startの前に呼び出す必要があります。閾値の既定値は0.88です。

パラメーター	説明
threshold	なりすまし防止為の閾値です。範囲は[0.0,1.0]です。

戻り値	説明
なし	なし

- (void)setDetectTimeout:(NSInteger)duration;

各モジュールに許可されている最大検知時間です。デフォルト値は10秒で、単位は秒です。

パラメーター	説明
duration	各モジュールに許可されている最大検知時間です。0に設定されている場合、タイムアウト時間は設定されません。デフォルト値は10秒で、単位は秒です。

戻り値	説明
なし	なし

- (void)setFaceDistanceRateWithFarRate:(CGFloat) farRate closeRate:(CGFloat) closeRate;

顔との距離の判定条件を設定します。

パラメーター	説明
farRate	画像の短辺に対する顔の高さ / 幅の比率です。[0.0～1.0] の範囲で設定できます。パラメーターが0に近いほど顔がスクリーンから離れていることを示します。デフォルト値は0.4です。0に設定されている場合、距離のプロンプトは表示されません。
closeRate	画像の短辺に対する顔の高さ / 幅の比率です。[0.0～1.0] の範囲で設定できます。パラメーターが1に近いほど顔がスクリーンに近づいていることを示します。デフォルト値は0.8です。0に設定されている場合、距離のプロンプトは表示されません。

戻り値	説明
なし	なし

- (void)setPassConditionMinDuration:(NSInteger)minDuration minFrames:(NSInteger)minFrames;

生体検知を通過するまでの条件を設定します。

パラメーター	説明
minDuration	生体検知がパスされるまでの [0～dDuration] の範囲の最短検知時間です。デフォルトは3秒です。最低でも1ミリ秒とすることを推奨します。0は最短時間制限が無いことを示します。負の数字に設定されている場合は0秒とみなされます。
minFrames	生体検知の最小検知フレーム数です。デフォルトは4です。0は最小フレーム数制限が無いことを示します。負の数字に設定されている場合は0にみなされます。

戻り値	説明
なし	なし

- (void)inputDataWithSampleBuffer:(CMSampleBufferRef)sampleBuffer faceOrientaion:(STIDSilentLivenessFaceOrientaion)faceOrientation imagePrepareRect:(CGRect)imagePrepareRect;

生体検知の構成です。検知待ちの画像を入力します。

パラメーター	説明
sampleBuffer	各フレームの画像データです。
faceOrientation	顔の向きです。
imagePrepareRect	アライメントフレームです。

戻り値	説明
なし	なし

- (void)start;

検知を開始します。

- (void)stop;

検知を停止します。

- (BOOL)isBrowOcclusionEnable;

眉の遮蔽検知スイッチの状態を取得します。

パラメーター	説明
なし	なし

戻り値	説明
BOOL	Yesは眉の検知がオンになっていることを示し、Noは眉の遮蔽の検知がオフになっていることを示します。

- (BOOL)isBlurryFilterEnable;

ぼやけ検知スイッチの状態を取得します。

パラメーター	説明
なし	なし

戻り値	説明
BOOL	Yesはぼやけの検知がオンになっていることを示し、Noはぼやけの検知がオフになっていることを示します。

- (BOOL)isIlluminationFilterEnable;

照明条件検知スイッチの状態を取得します。

パラメーター	説明
なし	なし

戻り値	説明
BOOL	Yesは照明条件の検知がオンになっていることを示し、Noは照明条件の検知がオフになっていることを示します。

- (BOOL)isEyeOpenFilterEnable;

目の開き検知スイッチの状態を取得します。

パラメーター	説明
なし	なし

戻り値	説明
BOOL	Yesは目の開きの検知がオンになっていることを示し、Noは目の開きの検知がオフになっていることを示します。

- (BOOL)isOcclusionEnable;

顔パーツの遮蔽検知スイッチの状態を取得します。

パラメーター	説明
なし	なし

戻り値	説明
BOOL	Yesは顔パーツの遮蔽検知がオンになっていることを示し、Noは顔パーツの遮蔽の検知がオフになっていることを示します。

- (CGFloat)hackThreshold;

生体検知の閾値をを取得します。閾値を超えた場合は、生体と判断し、閾値未満の場合は、検出が失敗したことを表示します。

パラメーター	説明
なし	なし

戻り値	説明
CGFloat	生体検知の閾値です。異常時と呼出失敗した場合の戻り値は-1です。

- (NSInteger)detectTimeout;

タイムアウト時間を取得します。

パラメーター	説明
なし	なし

戻り値	説明
NSInteger	タイムアウト時間です。

- (NSInteger)passMinDuration;

生体検知を通過するまでの最短時間を取得します。

パラメーター	説明
なし	なし

戻り値	説明
NSInteger	最短時間です。

- (NSInteger)passMinFrames;

生体検知を通過するまでの最小フレーム数を取得します。

パラメーター	説明
なし	なし

戻り値	説明
NSInteger	最小フレーム数です。

- (CGFloat)faceFarRate;

判定条件における最も遠い顔の距離のしきい値を取得します。

パラメーター	説明
なし	なし

戻り値	説明
CGFloat	最も遠い距離のしきい値です。

- (CGFloat)faceCloseRate;

判定条件における最も近い顔の距離のしきい値を取得します。

パラメーター	説明
なし	なし

戻り値	説明
CGFloat	最も近い距離のしきい値です。

+ (NSString*)sdkVersion;

SDK のバージョンを取得します。

パラメーター	説明
なし	なし

戻り値	説明
SDK version	SDK のバージョンです。

+ (NSString*)libraryVersion;

基礎となるライブラリのバージョンを取得します。

パラメーター	説明
なし	なし

戻り値	説明
Underlying library version	基礎となるライブラリのバージョンです。