idmission-web-sdk 2.0.0 → 2.0.1

package/README.md

@@ -799,6 +799,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>idCaptureRotateLoadingOverlayImageWhenPortrait</code> (optional)</td><td>boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true.</td></tr>
 <tr><td><code>faceLivenessLoadingOverlayMode</code> (optional)</td><td>string indicating which face liveness loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
 <tr><td><code>sendBase64DocumentsInSwaggerProxy</code> (optional)</td><td>boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false.</td></tr>
+<tr><td><code>mergeAVStreams</code> (optional)</td><td>boolean flag to indicate whether recorded audio should be merged onto the recorded video stream before submission. Defaults to false.</td></tr>
 <tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</td></tr>
 <tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Assets table below.</td></tr>
 <tr><td><code>colors</code> (optional)</td><td>object containing any asset overrides, for available options consult the Colors table below.</td></tr>

package/dist/components/customer_flows/VideoIdValidation.d.ts

@@ -150,6 +150,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     disableFaceDetectionWhileAudioCaptureMsDelay?: number;
     /** Flag for suppressing fallback messaging - used when models fail to load */
     silentFallback?: boolean;
+    /** Boolean flag to indicate whether recorded audio should be merged onto the recorded video stream before submission. Defaults to false. */
+    mergeAVStreams?: boolean;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;
     /** Object containing any asset overrides. */

package/dist/components/video_id/IdVideoCapture.d.ts

@@ -52,10 +52,11 @@ export type IdVideoCaptureProps = {
     readTextMinReadingMs?: number;
     disableFaceDetectionWhileAudioCapture: boolean;
     disableFaceDetectionWhileAudioCaptureMsDelay: number;
+    mergeAVStreams?: boolean;
     assets?: IdVideoCaptureAssets;
     classNames?: IdVideoCaptureClassNames;
     colors?: IdVideoCaptureColors;
     verbiage?: IdVideoCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, onRecordingFailed, idCaptureModelsEnabled, idCardFrontDelay, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, idCardBackDetectionThreshold, idCardBackFocusThreshold, goodIdCardBackFramesThreshold, skipShowIdCardBack, captureCountdownSeconds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;
+export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, onRecordingFailed, idCaptureModelsEnabled, idCardFrontDelay, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, idCardBackDetectionThreshold, idCardBackFocusThreshold, goodIdCardBackFramesThreshold, skipShowIdCardBack, captureCountdownSeconds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, mergeAVStreams, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;

package/dist/components/video_id/IdVideoCaptureWizard.d.ts

@@ -65,10 +65,11 @@ export type VideoIdWizardProps = {
     disableFaceDetectionWhileAudioCapture?: boolean;
     disableFaceDetectionWhileAudioCaptureMsDelay?: number;
     silentFallback?: boolean;
+    mergeAVStreams?: boolean;
     assets?: VideoIdWizardAssets;
     classNames?: VideoIdWizardClassNames;
     colors?: VideoIdWizardColors;
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, onIdCaptureModelError, onCameraAccessDenied, onMicrophoneAccessDenied, idCaptureProps, faceLivenessProps, idCaptureModelsEnabled, idCardFrontDetectionThreshold, idCardBackDetectionThreshold, idCardFrontFocusThreshold, idCardBackFocusThreshold, goodIdCardFrontFramesThreshold, goodIdCardBackFramesThreshold, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureLoadingOverlayMode, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, idCaptureModelLoadTimeoutMs, faceLivenessLoadingOverlayMode, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, silentFallback, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, onIdCaptureModelError, onCameraAccessDenied, onMicrophoneAccessDenied, idCaptureProps, faceLivenessProps, idCaptureModelsEnabled, idCardFrontDetectionThreshold, idCardBackDetectionThreshold, idCardFrontFocusThreshold, idCardBackFocusThreshold, goodIdCardFrontFramesThreshold, goodIdCardBackFramesThreshold, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureLoadingOverlayMode, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, idCaptureModelLoadTimeoutMs, faceLivenessLoadingOverlayMode, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, silentFallback, mergeAVStreams, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;

package/dist/components/video_signature_capture/VideoSignatureWizard.d.ts

@@ -39,4 +39,4 @@ export type VideoSignatureWizardProps = {
     verbiage?: VideoSignatureVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoSignatureWizard: ({ onComplete, onVideoCaptured, onRetryClicked, onExitCapture, onUserCancel, onModelError, loadingOverlayMode, modelLoadTimeoutMs, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: VideoSignatureWizardProps) => ReactElement;
+export declare const VideoSignatureWizard: ({ onComplete, onVideoCaptured, onRetryClicked, onExitCapture, onUserCancel, loadingOverlayMode, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: VideoSignatureWizardProps) => ReactElement;

package/dist/lib/camera/useVideoRecorder.d.ts

@@ -1,5 +1,5 @@
 import { Camera } from './Camera';
-export declare const useVideoRecorder: (camera: Camera | null, audioStream?: MediaStream | null) => {
+export declare const useVideoRecorder: (camera: Camera | null, audioStream?: MediaStream | null, mergeAVStreams?: boolean) => {
     isRecordingVideo: boolean;
     isRecordingAudio: boolean;
     startRecordingVideo: () => void;