Capture sessions

`FaceCaptureSession`


sdk.createFaceSession(video: HTMLVideoElement, opts?: FaceCaptureConfig)

`FaceCaptureConfig`

Field	Type	Default
`cameraDeviceId`	`string`	`''`
`antispoofThreshold`	`number`	`0.7`
`requireLiveness`	`boolean`	`true`
`activeChallenges`	`ChallengeType[]`	`[]`
`captureTimeoutMs`	`number`	`30000`
`guidanceFrameRate`	`number`	`30`
`autoCapture`	`boolean`	`true`
`imageMime`	`'image/jpeg' \| 'image/png'`	`'image/jpeg'`
`maxAntispoofRetries`	`number`	`3`
`holdSteadyMs`	`number`	`3000`
`faceQuality`	`FaceQualityConfig`	`{}`
`faceQualityGate`	`'off' \| 'guidance' \| 'strict'`	`'strict'`
`maxFaceQualityRetries`	`number`	`5`

A non-empty activeChallenges array throws CaptureError with code NOT_IMPLEMENTED_V0.

Methods

start() — open the camera and begin the guidance loop.
stop() — tear down the session.
captureFrame() — manual capture when autoCapture: false.

Events

See Capture session lifecycle for the full event table.

`FingerprintCaptureSession`


sdk.createFingerprintSession(video: HTMLVideoElement, opts?: FingerprintCaptureConfig)

`FingerprintCaptureConfig`

Field	Type	Default
`qualityThreshold`	`number`	`40`
`qualityPolicy`	`'all' \| 'any'`	`'all'`
`captureSteps`	`FingerprintCaptureStep[]`	one step per `requiredFingers`
`requiredFingers`	`number[]`	`[1, 2, 3, 6, 7, 8]`
`holdSteadySeconds`	`number`	`3`
`retryPauseMs`	`number`	`1500`
`facingMode`	`'user' \| 'environment' \| 'auto'`	`'auto'`
`cameraDeviceId`	`string`	`''`
`centeringTolerance`	`number`	`0.25`
`proximityJitterFrames`	`number`	`8`
`proximityRange`	`{ slapMin?, slapMax?, singleMin?, singleMax? }`	slap `0.75–1.35`, single `0.41–2.03`
`forceQualityFallback`	`boolean`	`false`

Step presets


import { FingerprintSteps, FINGER_POSITIONS } from '@sladeid/slade-id-sdk';
 
FingerprintSteps.rightHand();      // slap 2–5, thumb 1
FingerprintSteps.leftHand();       // slap 7–10, thumb 6
FingerprintSteps.bothHands();      // right then left
FingerprintSteps.singleFinger(2);  // right index
 
FINGER_POSITIONS.rightIndex;       // 2

Position numbering: right hand 1 (thumb), 2 (index), 3 (middle), 4 (ring), 5 (little). Left hand 6–10 in the same order.