bry-biometric-collector 3.3.0-RC06 → 3.3.0-RC08

package/README.md

@@ -112,7 +112,7 @@ Currently supported tag parameters:
   Example: `video_dimensions="800x500"`
 
 - **collector_select**: The collectors that should be rendered. Possible values are `"BOTH", "FINGERS",
-"FACE", "DOCUMENT"`. When using only one, the tabs are hidden.
+"FACE", "DOCUMENT", "STREAM"`. When using only one, the tabs are hidden.
 
   Default: `"BOTH"`
 
@@ -626,6 +626,42 @@ The web component listens to and emits a few events. The events emitted are:
   {detail: {stream: MediaStream}
 ```
 
+- **brycc-face-initialized**: When the IDRnd widget is initialized and ready for face capture operations.
+
+- **stream-ready**: When the face capture stream is ready for biometric capture. This event is fired when the camera opens successfully. The event payload has the structure:
+
+```ts
+  {detail: {message: string}}
+```
+
+- **stream-error**: When an error occurs in the face capture stream. This event is fired when camera fails to open or other stream errors occur. The event payload has the structure:
+
+```ts
+  {detail: {message: string, error: Event}}
+```
+
+- **stream-lost-focus**: When the stream is closed due to window losing focus. This event is fired when the browser window or tab loses focus and the camera stream is automatically closed. The event payload has the structure:
+
+```ts
+  {detail: {message: string}}
+```
+
+- **stream-auto-reopened**: When the camera stream is automatically reopened after regaining focus. This event is fired when the window regains focus and the camera stream is automatically restarted. The event payload has the structure:
+
+```ts
+  {detail: {message: string}}
+```
+
+- **stream-capture**: When a face capture is completed in the stream collector. This event can be fired with either success or error status. The event payload has the structure:
+
+```ts
+  // On success:
+  {detail: {image: string, blob: string, status: 'success'}}
+  
+  // On error:
+  {detail: {errorCode: string, translatedError: string, status: 'error'}}
+```
+
 - **face-scrapped**: When the user scraps their face (by clicking capture again after having saved their picture) this event gets emitted without any data.
 
 - **face-unconformities-validated**: When the photo is captured and after evaluating it, an event of this kind is emitted with their picture like so: