senza-sdk 4.5.3 → 4.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.5.3",
+    "version": "4.5.4",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",

package/src/implementation/overlay.js

@@ -22,6 +22,8 @@ const OVERLAY_CAPTURE_PRESETS = {
 
 const DEFAULT_CAPTURE_PRESET = "default";
 const VALID_QUALITIES = new Set(["low", "mid", "high"]);
+const DEFAULT_AUTO_HIDE_DURATION_SEC = 600;
+const OVERLAY_DURATION_SEC_MAX = 65535;
 
 class Overlay extends OverlayInterface {
     constructor() {
@@ -31,7 +33,8 @@ class Overlay extends OverlayInterface {
         this._configuration = {
             useTransparency: true,
             overlayCapturePreset: DEFAULT_CAPTURE_PRESET,
-            overlayCapturePlan: null
+            overlayCapturePlan: null,
+            autoHideDurationSec: DEFAULT_AUTO_HIDE_DURATION_SEC
         };
         this._activeCapturePlan = OVERLAY_CAPTURE_PRESETS[DEFAULT_CAPTURE_PRESET];
         this._retryGeneration = 0;
@@ -138,6 +141,7 @@ class Overlay extends OverlayInterface {
                     quality,
                     conditional
                 };
+                message.overlayDurationSec = this._configuration.autoHideDurationSec;
                 sdkLogger.log(`Overlay: rendering frame x=${x} y=${y} width=${width} height=${height} fcid=${FCID} (batchId=${batchId}, quality=${quality}, conditional=${conditional})`);
                 const request = { target: "UI-Streamer", waitForResponse: false, message: JSON.stringify(message) };
                 window.cefQuery({
@@ -226,6 +230,16 @@ class Overlay extends OverlayInterface {
             }
         }
 
+        if (Object.prototype.hasOwnProperty.call(normalizedConfiguration, "autoHideDurationSec")) {
+            const duration = normalizedConfiguration.autoHideDurationSec;
+            if (Number.isInteger(duration) && duration >= 0 && duration <= OVERLAY_DURATION_SEC_MAX) {
+                normalizedConfiguration.autoHideDurationSec = duration;
+            } else {
+                sdkLogger.warn(`Overlay: invalid autoHideDurationSec "${duration}", keeping previous value`);
+                delete normalizedConfiguration.autoHideDurationSec;
+            }
+        }
+
         this._configuration = { ...this._configuration, ...normalizedConfiguration };
         this._activeCapturePlan = this._resolveCapturePlan();
     }

package/src/interface/overlay.js

@@ -59,8 +59,8 @@ class Overlay extends EventTarget {
     }
 
     /**
-     * Removes all registered elements, sends a zero-dimension frame to the UI-Streamer,
-     * and deactivates the overlay. After calling removeAllElements(), a new element can be registered.
+     * Removes all registered elements and deactivates the overlay.
+     * After calling removeAllElements(), a new element can be registered.
      *
      * @returns {Promise<boolean>} Resolves to true if successful, rejects with error if failed.
      */
@@ -82,7 +82,7 @@ class Overlay extends EventTarget {
      *
      * @param {Object} configuration - The new configuration to apply.
      * @param {boolean} [configuration.useTransparency=true] - Controls whether the overlay should be rendered with transparency.
-     * When set to `true`, the value is forwarded to UI-Streamer in `displayOverlay` requests.
+     * When set to `true`, the overlay is rendered with transparency.
      * @param {string} [configuration.overlayCapturePreset="default"] - Named capture plan preset:
      * `default` (progressive low→high captures) or `once` (one immediate high-quality conditional step).
      * @param {Array<{quality: "low"|"mid"|"high", conditional: boolean, delay: number}>} [configuration.overlayCapturePlan]
@@ -90,6 +90,9 @@ class Overlay extends EventTarget {
      * the previous step in the batch. Set `conditional` per step (the SDK does not derive it):
      * when `true`, capture only if overlay content changed since the last required (non-conditional)
      * capture in this batch; when `false`, always capture on that step.
+     * @param {number} [configuration.autoHideDurationSec=600] - Client auto-hide duration in seconds.
+     * Defaults to `600` (10 minutes) until configured. Omit the key to keep the current value.
+     * `0` means never auto-hide. Valid range: `0`–`65535`.
      */
     configure(configuration) {
         noop(configuration);

package/src/interface/version.js

@@ -1 +1 @@
-export const version = "4.5.3";
+export const version = "4.5.4";