Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RegistrationSessionSettings

Settings for registration sessions

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

bearingsToRegister

bearingsToRegister: Bearing[] = [Bearing.STRAIGHT, Bearing.LEFT, Bearing.RIGHT]

Bearings to register in this session

note

The number of faces to register is determined by the VerIDSessionSettings.numberOfResultsToCollect parameter. If the number of results to collect exceeds the number of bearings to register the session will start take the next bearing from the beginning of the bearings array.

For example, a session with bearings to register set to [Bearing.STRAIGHT, Bearing.LEFT, Bearing.RIGHT] and numberOfResultsToCollect set to 2 will register faces with bearings: [Bearing.STRAIGHT, Bearing.LEFT].

A session with bearings to register set to `[Bearing.STRAIGHT, Bearing.LEFT, Bearing.RIGHT]andnumberOfResultsToCollectset to2will register faces with bearings:[Bearing.STRAIGHT, Bearing.LEFT, Bearing.RIGHT, Bearing.STRAIGHT]`.

expiryTime

expiryTime: number = 30

Time it will take for the session to expire (in seconds)

numberOfResultsToCollect

numberOfResultsToCollect: number = 2

The number of detected faces and images the session must collect before finishing

showResult

showResult: boolean = false

Set to true to display the result of the session to the user

userId

userId: string

ID of the user to register

Generated using TypeDoc