visageSDK
Instance Methods | Properties | List of all members
VisageLivenessSmile Class Reference

Objective-C wrapper of the VisageSDK::VisageLivenessSmile class. More...

#import <objc_VisageLivenessSmile.h>

Inheritance diagram for VisageLivenessSmile:
VisageLivenessAction

Instance Methods

(int) - update:withVsImage:
 Method that should be called for each frame until the action is verified. More...
 
(void) - reset
 Resets action. More...
 

Properties

NSInteger STATE_WAIT_FOR_FRONTAL
 Describes action's state where face in the frame is not frontal (head rotations larger than 0.3 rad, ~17 degrees). More...
 
NSInteger STATE_ACTION_INITIALIZING
 Describes action's state while the action is initializing, i.e. More...
 
NSInteger STATE_WAIT_FOR_STABLE
 Describes action's state when user is not keeping his head still.
 
NSInteger STATE_WAIT_FOR_ACTION
 Describes action's state when blink is trying to be verified.
 

Detailed Description

Objective-C wrapper of the VisageSDK::VisageLivenessSmile class.

Definition at line 21 of file objc_VisageLivenessSmile.h.

Method Documentation

◆ reset()

- (void) reset

Resets action.

Clears face data sequence.

Implements VisageLivenessAction.

◆ update:withVsImage:()

- (int) update: (const FaceData *)  faceData
withVsImage: (VisageImage *)  frame 

Method that should be called for each frame until the action is verified.

It should only be called when tracking status is TRACK_STAT_OK. Returns action's current state so appropriate message and/or image can be displayed if user interaction is required (e.g. warning for user or instruction on how to perform smile).

Parameters
faceDataface data obtained from the tracker
frameoptional image to display
Returns
action's current state. State can be one of the following:
  • STATE_WAIT_FOR_FRONTAL, STATE_ACTION_INITIALIZING, STATE_WAIT_FOR_STABLE, STATE_WAIT_FOR_ACTION, STATE_ACTION_VERIFIED.

Implements VisageLivenessAction.

Property Documentation

◆ STATE_ACTION_INITIALIZING

- (NSInteger) STATE_ACTION_INITIALIZING
readatomicassign

Describes action's state while the action is initializing, i.e.

storing initial face data sequence. After each reset, action needs to reinitialize.

Definition at line 39 of file objc_VisageLivenessSmile.h.

◆ STATE_WAIT_FOR_FRONTAL

- (NSInteger) STATE_WAIT_FOR_FRONTAL
readatomicassign

Describes action's state where face in the frame is not frontal (head rotations larger than 0.3 rad, ~17 degrees).

If this state is detected, the action will be reset.

Definition at line 33 of file objc_VisageLivenessSmile.h.


The documentation for this class was generated from the following file: