|
| 1 | +export const FACE_LIVENESS_DETECTOR_PARAMETERS = [ |
| 2 | + { |
| 3 | + name: `sessionID`, |
| 4 | + description: 'The sessionID as returned by CreateFaceLivenessSession API.', |
| 5 | + type: `String`, |
| 6 | + }, |
| 7 | + { |
| 8 | + name: `region`, |
| 9 | + description: |
| 10 | + 'The AWS region to stream the video to, this should match the region you called the CreateFaceLivenessSession API in.', |
| 11 | + type: `String`, |
| 12 | + }, |
| 13 | + { |
| 14 | + name: `credentialsProvider`, |
| 15 | + description: 'An optional paramter that provides AWS Credentials', |
| 16 | + type: `AWSCredentialsProvider?`, |
| 17 | + }, |
| 18 | + { |
| 19 | + name: `disableStartView`, |
| 20 | + description: |
| 21 | + 'Optional parameter for the disabling the intial view with instructions, default = false.', |
| 22 | + type: `Boolean`, |
| 23 | + }, |
| 24 | + { |
| 25 | + name: `onComplete`, |
| 26 | + description: |
| 27 | + 'Callback that signals when the liveness session has completed.', |
| 28 | + type: 'Action; equivalent to () -> Void', |
| 29 | + }, |
| 30 | + { |
| 31 | + name: `onError`, |
| 32 | + description: |
| 33 | + 'Callback that signals when the liveness session has returned an error.', |
| 34 | + type: 'Consumer<FaceLivenessDetectionException>; equivalent to (Exception) -> Void', |
| 35 | + }, |
| 36 | +]; |
| 37 | + |
| 38 | +export const FACE_LIVENESS_DETECTOR_ERROR_STATES = [ |
| 39 | + { |
| 40 | + name: `FaceLivenessDetectionException`, |
| 41 | + description: 'An unknown error occurred, retry the face liveness check.', |
| 42 | + type: `Error`, |
| 43 | + }, |
| 44 | + { |
| 45 | + name: `FaceLivenessDetectionException.SessionNotFoundException`, |
| 46 | + description: 'Session not found.', |
| 47 | + type: `Error`, |
| 48 | + }, |
| 49 | + { |
| 50 | + name: `FaceLivenessDetectionException.AccessDeniedException`, |
| 51 | + description: 'Not authorized to perform a face liveness check.', |
| 52 | + type: `Error`, |
| 53 | + }, |
| 54 | + { |
| 55 | + name: `FaceLivenessDetectionException.CameraPermissionDeniedException`, |
| 56 | + description: 'The camera permission has not been granted.', |
| 57 | + type: `Error`, |
| 58 | + }, |
| 59 | + { |
| 60 | + name: `FaceLivenessDetectionException.SessionTimedOutException`, |
| 61 | + description: |
| 62 | + 'The session timed out and did not receive response from server within the time limit.', |
| 63 | + type: `Error`, |
| 64 | + }, |
| 65 | + { |
| 66 | + name: `FaceLivenessDetectionException.UserCancelledException`, |
| 67 | + description: 'The user cancelled the face liveness check.', |
| 68 | + type: `Error`, |
| 69 | + }, |
| 70 | +]; |
0 commit comments