@nuralogix.ai/web-measurement-embedded-app 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -85,7 +85,7 @@ Need deeper integration details? Check the full docs at [docs.deepaffex.ai/wmea]
85
85
  // Optional configuration overrides (defaults shown)
86
86
  config: {
87
87
  checkConstraints: true,
88
- cameraFacingMode: 'user', // or 'environment' for back camera
88
+ // cameraFacingMode: 'environment', // omit to select by deviceId / browser default
89
89
  cameraAutoStart: false,
90
90
  measurementAutoStart: false,
91
91
  cancelWhenLowSNR: true,
@@ -123,12 +123,13 @@ Need deeper integration details? Check the full docs at [docs.deepaffex.ai/wmea]
123
123
  - Optional `apiUrl` enables region-specific processing; omitted values follow the backend token's region automatically. When set explicitly, frontend calls your URL (processing where that endpoint runs) while results continue to store in the token's region—verify the combination suits your deployment.
124
124
  - Config options:
125
125
  - `checkConstraints` (default: `true`) – enables constraint validation pre-measurement
126
- - `cameraFacingMode` (default: `'user'`) – use `'user'` for front camera or `'environment'` for back camera.
126
+ - `cameraFacingMode` (default: `undefined`) – use `'user'` (front) or `'environment'` (back). When set, it takes precedence over `defaultCameraId`; leave it unset to select by `defaultCameraId` or the browser default.
127
127
  - `cameraAutoStart` (default: `false`) – automatically starts the camera once permission is granted.
128
128
  - `measurementAutoStart` (default: `false`) – automatically starts the measurement once constraints are satisfied.
129
129
  - `cancelWhenLowSNR` (default: `true`) – cancels the measurement if signal-to-noise ratio falls below threshold.
130
130
  - `debugMode` (default: `false`) – enables verbose logging to the console for debugging purposes.
131
131
  - `downloadPayloads` (default: `false`) – when enabled, saves payload and metadata binary files for each chunk sent to DeepAffex Cloud so you can send them to NuraLogix for debugging. A 30-second measurement emits 6 chunks (every 5 seconds), generating 2 files per chunk. Ensure your browser allows multiple file downloads and does not block popups.
132
+ - `defaultCameraId` (default: `''`) – preferred camera `deviceId` to open on startup, used only when `cameraFacingMode` is not set. If the ID is not connected, the browser's default camera is used.
132
133
  - Language support: `en`, `ja`, `zh`, `es`, `pt`, `pt-BR`, `it`, `fr`, `de`.
133
134
  - Unsupported browser locales fall back to base language (e.g., `zh-TW` → `zh`), then to English.
134
135