@3dsource/angular-unreal-module 0.0.175 → 0.0.181

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3dsource/angular-unreal-module",
-  "version": "0.0.175",
+  "version": "0.0.181",
   "description": "Angular integration for Unreal Engine Pixel Streaming",
   "keywords": [
     "3dsource",
@@ -16,11 +16,11 @@
   "author": "3dsource",
   "sideEffects": false,
   "dependencies": {
-    "tslib": "^2.8.1"
+    "tslib": "^2.8.1",
+    "uuid": "^14.0.2"
   },
   "peerDependencies": {
-    "@3dsource/types-unreal": ">=0.0.7",
-    "@3dsource/utils": ">=1.0.21",
+    "@3dsource/types-unreal": ">=0.0.14 <0.1.0",
     "@angular/cdk": ">=19.0.0 <23.0.0",
     "@angular/common": ">=19.0.0 <23.0.0",
     "@angular/core": ">=19.0.0 <23.0.0",
@@ -41,6 +41,10 @@
     ".": {
       "types": "./types/3dsource-angular-unreal-module.d.ts",
       "default": "./fesm2022/3dsource-angular-unreal-module.mjs"
+    },
+    "./config": {
+      "types": "./types/3dsource-angular-unreal-module-config.d.ts",
+      "default": "./fesm2022/3dsource-angular-unreal-module-config.mjs"
     }
   },
   "type": "module"

package/types/3dsource-angular-unreal-module-config.d.ts

@@ -0,0 +1,27 @@
+import { InjectionToken } from '@angular/core';
+
+/**
+ * Which command protocol the module speaks.
+ *
+ * - `'metabox'` (default) — the full Metabox command protocol.
+ * - `'default'` — a stock Pixel Streaming application: the module sends none of
+ *   its own `MetaBoxCommand` packets.
+ */
+type UnrealMode = 'metabox' | 'default';
+interface UnrealInitialConfig {
+    mode?: UnrealMode;
+    playwright?: boolean;
+    customErrorsEndpoint?: string;
+    commandTelemetryReceiver?: string;
+    regionsPingUrl?: string;
+    screenLockerContainerId?: string;
+    dataChannelConnectionTimeout?: number;
+    streamTelemetryV2Url?: string;
+    fpsMonitor?: boolean;
+    autoHighResolution?: boolean;
+}
+
+declare const UNREAL_CONFIG: InjectionToken<UnrealInitialConfig>;
+
+export { UNREAL_CONFIG };
+export type { UnrealInitialConfig, UnrealMode };

package/types/3dsource-angular-unreal-module.d.ts

@@ -1,13 +1,14 @@
 import * as _3dsource_angular_unreal_module from '@3dsource/angular-unreal-module';
 import * as i0 from '@angular/core';
-import { Signal, TemplateRef, ElementRef, InjectionToken, DestroyRef, PipeTransform } from '@angular/core';
+import { Signal, TemplateRef, ElementRef, DestroyRef, PipeTransform } from '@angular/core';
+import { UnrealInitialConfig } from '@3dsource/angular-unreal-module/config';
+export { UNREAL_CONFIG, UnrealInitialConfig, UnrealMode } from '@3dsource/angular-unreal-module/config';
 import * as _ngrx_store from '@ngrx/store';
 import { Store } from '@ngrx/store';
 import * as rxjs from 'rxjs';
 import { Subject, Observable, Subscription, OperatorFunction } from 'rxjs';
 import * as _ngrx_effects from '@ngrx/effects';
 import { Actions } from '@ngrx/effects';
-import { IKeyCode, ImageOutputValues, Area } from '@3dsource/utils';
 import { SafeHtml, SafeStyle, SafeScript, SafeUrl, SafeResourceUrl } from '@angular/platform-browser';
 import { MetaBoxCommandPacket, MetaBoxCommandList, MetaBoxCallbackList, FOnSceneStateCallback, FOnFocusObjectCallback, FCameraChangedCallback, FOnObjectTransformChangedCallback, FOnChangeSequenceChangedCallback, FOnFinishSequenceChangedCallback } from '@3dsource/types-unreal';
 
@@ -258,6 +259,148 @@ declare const MouseButtonsMask: {
     FifthButton: number;
 };
 
+/**
+ * `KeyboardEvent.code` → the Windows virtual-key code Unreal expects.
+ *
+ * Only keys whose `event.keyCode` cannot be trusted belong here. The browser
+ * already resolves `keyCode` correctly for everything else, so the table exists
+ * for two cases: browsers that disagree on a value (Gecko reports the
+ * punctuation keys by ASCII — `;` as 59, `=` as 61, `-` as 173) and keys Unreal
+ * numbers differently from the DOM (the right-hand modifiers, the Cmd/Win keys).
+ *
+ * The numpad is deliberately absent. A numpad key reports the same `code` in
+ * both NumLock states but a different virtual key — `Numpad4` is 37/`VK_LEFT`
+ * with NumLock off and 100/`VK_NUMPAD4` with it on — so any entry here would
+ * have to commit to one state and be wrong in the other. Falling through to
+ * `event.keyCode` is right in both. `NumpadAdd`/`Subtract`/`Multiply`/`Divide`
+ * stay because they do not change with NumLock.
+ *
+ * `SpecialKeyCodes` in `./buttons-codes` repeats seven of these entries with
+ * the same values. The two are kept apart because both are public API; merging
+ * them would be a breaking change.
+ *
+ * Values must stay unique so `InvertedKeyMap` is lossless. The `OSLeft`/
+ * `MetaLeft` and `OSRight`/`MetaRight` pairs share a value on purpose: they are
+ * legacy and current names for the same physical key.
+ */
+declare const KeyboardNumericCode: {
+    readonly Backspace: 8;
+    readonly Tab: 9;
+    readonly Enter: 13;
+    readonly ShiftLeft: 16;
+    readonly ControlLeft: 17;
+    readonly AltLeft: 18;
+    readonly Escape: 27;
+    readonly Space: 32;
+    readonly ArrowLeft: 37;
+    readonly ArrowUp: 38;
+    readonly ArrowRight: 39;
+    readonly ArrowDown: 40;
+    readonly Digit0: 48;
+    readonly Digit1: 49;
+    readonly Digit2: 50;
+    readonly Digit3: 51;
+    readonly Digit4: 52;
+    readonly Digit5: 53;
+    readonly Digit6: 54;
+    readonly Digit7: 55;
+    readonly Digit8: 56;
+    readonly Digit9: 57;
+    readonly KeyA: 65;
+    readonly KeyB: 66;
+    readonly KeyC: 67;
+    readonly KeyD: 68;
+    readonly KeyE: 69;
+    readonly KeyF: 70;
+    readonly KeyG: 71;
+    readonly KeyH: 72;
+    readonly KeyI: 73;
+    readonly KeyJ: 74;
+    readonly KeyK: 75;
+    readonly KeyL: 76;
+    readonly KeyM: 77;
+    readonly KeyN: 78;
+    readonly KeyO: 79;
+    readonly KeyP: 80;
+    readonly KeyQ: 81;
+    readonly KeyR: 82;
+    readonly KeyS: 83;
+    readonly KeyT: 84;
+    readonly KeyU: 85;
+    readonly KeyV: 86;
+    readonly KeyW: 87;
+    readonly KeyX: 88;
+    readonly KeyY: 89;
+    readonly KeyZ: 90;
+    readonly OSLeft: 91;
+    readonly MetaLeft: 91;
+    readonly OSRight: 92;
+    readonly MetaRight: 92;
+    readonly ContextMenu: 93;
+    readonly NumpadMultiply: 106;
+    readonly NumpadAdd: 107;
+    readonly NumpadSubtract: 109;
+    readonly NumpadDivide: 111;
+    readonly F1: 112;
+    readonly F2: 113;
+    readonly F3: 114;
+    readonly F4: 115;
+    readonly F5: 116;
+    readonly F6: 117;
+    readonly F7: 118;
+    readonly F8: 119;
+    readonly F9: 120;
+    readonly F10: 121;
+    readonly F11: 122;
+    readonly F12: 123;
+    readonly NumLock: 144;
+    readonly ScrollLock: 145;
+    readonly Semicolon: 186;
+    readonly Equal: 187;
+    readonly Comma: 188;
+    readonly Minus: 189;
+    readonly Period: 190;
+    readonly Slash: 191;
+    readonly Backquote: 192;
+    readonly BracketLeft: 219;
+    readonly Backslash: 220;
+    readonly BracketRight: 221;
+    readonly Quote: 222;
+    readonly IntlBackslash: 226;
+    readonly ShiftRight: 253;
+    readonly ControlRight: 254;
+    readonly AltRight: 255;
+};
+/**
+ * The `keyCode` a browser reports while an IME is composing (`VK_PROCESSKEY`).
+ *
+ * `event.code` keeps naming the *physical* key during composition — `KeyW`,
+ * `KeyA` and friends — so a consumer that forwards keys has to drop these
+ * events explicitly or typing CJK text turns into keystrokes.
+ */
+declare const IME_PROCESS_KEY = 229;
+/**
+ * Codes of the keys that are themselves modifiers. A modifier's own `keydown`
+ * already reports `ctrlKey`/`metaKey` as pressed, so a "browser shortcut in
+ * flight" check has to exempt them or `ControlRight` would block itself.
+ */
+declare const MODIFIER_KEY_CODES: ReadonlySet<string>;
+type IKeyName = keyof typeof KeyboardNumericCode;
+type IKeyCode = (typeof KeyboardNumericCode)[IKeyName];
+/**
+ * A physical key name as reported by `KeyboardEvent.code`.
+ *
+ * The union lists the names this table knows a virtual-key code for, so editors
+ * complete them. The `string` branch keeps every other DOM code assignable —
+ * `'Numpad4'`, `'Delete'`, `'Home'` — since a key needs no entry here to be
+ * matched against `event.code`.
+ */
+type IKeyCodeName = IKeyName | (string & Record<never, never>);
+type InvertedKeyMapType = {
+    [K in IKeyName as (typeof KeyboardNumericCode)[K]]: K;
+};
+declare const InvertedKeyMap: InvertedKeyMapType;
+
 declare const ControlScheme: {
     readonly LockedMouse: 0;
     readonly HoveringMouse: 1;
@@ -355,26 +498,32 @@ interface FreezeFrameMessage {
 }
 
 /**
- * Which command protocol the module speaks.
+ * Geometry primitives used by the resize helpers.
  *
- * - `'metabox'` (default) — the full Metabox command protocol.
- * - `'default'` — a stock Pixel Streaming application: the module sends none of
- *   its own `MetaBoxCommand` packets.
+ * Collapsed into one file from the four these were split across, so the
+ * package no longer names another library in its public type surface.
  */
-type UnrealMode = 'metabox' | 'default';
-interface UnrealInitialConfig {
-    mode?: UnrealMode;
-    playwright?: boolean;
-    customErrorsEndpoint?: string;
-    commandTelemetryReceiver?: string;
-    regionsPingUrl?: string;
-    screenLockerContainerId?: string;
-    dataChannelConnectionTimeout?: number;
-    streamTelemetryV2Url?: string;
-    fpsMonitor?: boolean;
-    autoHighResolution?: boolean;
+interface Size {
+    w: number;
+    h: number;
+}
+interface Coords {
+    x: number;
+    y: number;
+}
+interface Rect extends Size, Coords {
+}
+interface Area extends Rect {
+    scale: number;
 }
 
+/**
+ * Output format accepted by {@link getImageFromVideoStream}.
+ *
+ * `'canvas'` returns the element itself; the MIME types return a data URL.
+ */
+type ImageOutputValues = 'canvas' | 'image/png' | 'image/webp' | 'image/jpeg';
+
 interface SignalingData {
     instanceType: string;
     branchInfo: string;
@@ -1020,8 +1169,6 @@ type UnrealUiClasses = Partial<Record<UnrealUiPart, string | string[]>>;
 
 type TelemetryType = 'commandSent' | 'commandStop';
 
-declare const UNREAL_CONFIG: InjectionToken<UnrealInitialConfig>;
-
 declare const InputOptions: InputProps;
 
 /** Disconnect reasons that should trigger remote connection cleanup. */
@@ -1282,10 +1429,10 @@ declare class FreezeFrameService extends SubService {
 
 declare class InputService extends SubService {
     private readonly commandsSender;
-    private readonly isDevMode;
+    private readonly devModeService;
     private readonly videoService;
     private readonly unrealConfig;
-    readonly defaultKeys: (17 | 37 | 38 | 39 | 40 | 46 | 65 | 68 | 83 | 87 | 107 | 109 | 187 | 189)[];
+    readonly defaultKeys: readonly IKeyCodeName[];
     private availableKeys;
     private options;
     private reInit$;
@@ -1296,6 +1443,7 @@ declare class InputService extends SubService {
     private fingerIds;
     private maxByteValue;
     private fingers;
+    private readonly heldKeys;
     private readonly mouseMoveView;
     private readonly mouseButtonView;
     private readonly mouseWheelView;
@@ -1307,7 +1455,16 @@ declare class InputService extends SubService {
     private offsetParams;
     constructor();
     protected init(): void;
-    useKeyboardKeys(keys: IKeyCode[]): void;
+    /**
+     * Replaces the forwarded-key allow-list. Takes physical key names
+     * (`KeyboardEvent.code`) such as `'KeyW'` or `'BracketLeft'`.
+     *
+     * Legacy numeric `keyCode` values are still accepted and converted, but they
+     * cannot express every key: `InvertedKeyMap` is many-to-one, so 37 resolves
+     * to `'ArrowLeft'` and 17 to `'ControlLeft'`, and `'Numpad4'`/`'ControlRight'`
+     * are unreachable through the numeric form. Pass names.
+     */
+    useKeyboardKeys(keys: readonly (IKeyCode | IKeyCodeName)[]): void;
     get video(): HTMLVideoElement | null;
     private setup;
     /**
@@ -1336,22 +1493,46 @@ declare class InputService extends SubService {
     private pressMouseButtons;
     private registerHoveringMouseEvents;
     private registerMouseEnterAndLeaveEvents;
-    private isKeyCodeBrowserKey;
     /**
-     * The key code Unreal expects, which is the Windows virtual-key code.
+     * Keys whose default browser action fights the stream: the function keys
+     * (F5 reloads mid-session), Tab (moves focus out of the player) and the
+     * arrows (scroll the page while they steer the camera).
+     *
+     * Takes the *resolved* virtual-key code rather than `event.code`, so a numpad
+     * key acting as an arrow with NumLock off is caught as well.
+     */
+    private isBrowserKey;
+    /**
+     * The key code Unreal expects — the Windows virtual-key code — or `null` when
+     * the event carries no key worth forwarding.
      *
-     * `e.keyCode` is not that on Gecko: Firefox reports the punctuation keys by
-     * their ASCII value — `=` as 61 and `-` as 173, where Chrome sends 187 and 189
-     * — so zoom-on-plus/minus reached the engine as codes it does not know.
-     * `KeyboardNumericCode` is keyed by `e.code` and holds the virtual-key value,
-     * so it resolves the same number on every browser; a no-op on Chrome.
+     * `KeyboardNumericCode` covers only the keys whose `event.keyCode` cannot be
+     * trusted; everything else, the numpad included, falls through to the value
+     * the browser resolved.
      *
-     * Checked after the right-hand modifiers, which need their own distinct codes
-     * that the map does not carry.
+     * Returns `null` for an IME composition — `event.code` still names the
+     * physical key there, so the keystrokes would otherwise reach the engine as
+     * camera movement — and for a `keyCode` of 0, which no engine key uses.
      */
     private getKeyCode;
+    /**
+     * True while a focused element owns the keyboard. Read off `composedPath()`
+     * rather than `event.target`: retargeting reports the host element for an
+     * `<input>` inside a shadow root, so a `target`-based check never fires in an
+     * app built from web components.
+     */
+    private isTextEntryTarget;
+    /** True when `event.code` is on the allow-list, or dev mode waives it. */
+    private isKeyAllowed;
+    private sendKeyUp;
+    /**
+     * Releases everything the engine still believes is held. Needed because a
+     * `keyup` is not guaranteed to arrive: the window can lose focus to a browser
+     * dialog or another tab first, and then the engine keeps moving the camera
+     * forever.
+     */
+    private releaseKeys;
     private registerKeyboardEvents;
-    private startListenKeys;
     static ɵfac: i0.ɵɵFactoryDeclaration<InputService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<InputService>;
 }
@@ -1804,11 +1985,10 @@ declare class StreamStatusTelemetryService2 {
     /**
      * Emit the region / signaling / webrtc phases for an ADOPTED connection.
      *
-     * The prefetch script established the connection in PARALLEL with page load,
-     * so the phases are positioned at their real (anchor-relative) spans — shifted
-     * LEFT to overlap the HTML-loading / route-idle rows — rather than sequentially
-     * after them. That's the whole point of the prefetch: the handshake already
-     * happened while the page was loading. Each phase ships:
+     * The prefetch script established the connection in parallel with page load,
+     * so phases sit at their real anchor-relative spans — shifted left to overlap
+     * the HTML-loading / route-idle rows instead of following them. Each phase
+     * ships:
      *  - `duration` — the real sub-step time the prefetch spent.
      *  - `spanStartMs` — anchor-relative start, so the viewer left-shifts the bar.
      *  - `adoptionAtMs` — where Angular took over (the next phase, Unreal
@@ -1855,22 +2035,15 @@ declare class StreamStatusTelemetryService2 {
      */
     private collectBootstrapInfo;
     /**
-     * Aggregate all resources the browser has loaded so far
-     * (`performance.getEntriesByType('resource')`), grouped by `initiatorType`,
-     * **split by `window.load`**:
-     *
-     *   - `resources` — fetched before `loadEventEnd` (= part of the actual
-     *     page weight). What you'd traditionally call "page load."
-     *   - `lazyResources` — fetched after `loadEventEnd` (= typically the
-     *     route's lazy-loaded chunks, JSON manifests etc. that download
-     *     when the user navigates to a sub-route the streamer lives on).
+     * Aggregates `performance.getEntriesByType('resource')` by `initiatorType`,
+     * split at `window.load`: `resources` for entries before `loadEventEnd` (the
+     * actual page weight) and `lazyResources` for those after it (typically the
+     * route's lazy chunks and manifests, downloaded when the user navigates to the
+     * sub-route the streamer lives on). If `loadEventEnd` is 0 or unknown,
+     * everything lands in `resources` and `lazyResources` is null.
      *
-     * When `loadEventEnd` is 0/unknown, everything goes into `resources`
-     * and `lazyResources` is null — old behavior.
-     *
-     * `transferSize === 0 && decodedBodySize > 0` means the resource came from
-     * the HTTP cache — counted separately so cached hits don't inflate
-     * the "bytes on the wire" metric.
+     * `transferSize === 0 && decodedBodySize > 0` means an HTTP-cache hit, counted
+     * separately so it does not inflate the bytes-on-the-wire metric.
      */
     private collectResourceTotals;
     private aggregate;
@@ -2197,77 +2370,22 @@ declare class AnalyticsService extends SubService {
 }
 
 /**
- * Adaptive FPS controller that monitors the incoming WebRTC video stream
- * quality and dynamically adjusts Unreal Engine's `t.MaxFPS` console variable.
- *
- * ## How it works
- *
- * The service subscribes to `VideoService.videoStats$` (emitted every 250 ms)
- * and collects samples of FPS, bitrate, and QP (Quantization Parameter).
- * Every {@link SAMPLE_WINDOW} ticks (~2 s) it averages the collected samples
- * and feeds them into a set of **fuzzy-logic membership functions** that
- * classify each metric into overlapping quality bands.
- *
- * ### Input signals
- *
- * **1. FPS ratio** = `actualFPS / currentTargetFPS` (0..1+)
- *
- * | Band | Range | Meaning |
- * |--------|---------------------|-----------------------------------------------|
- * | low | ratio < 0.7 → 1.0, linear ramp 0.7..0.9 → 0 | Stream cannot keep up with the target |
- * | okays | triangle 0.8..1.0, peak at 0.95 | Stream roughly matches the target |
- * | high | ratio 0.9..1.0 → ramp, >1.0 → 1.0 | Stream meets or exceeds the target |
- *
- * **2. Bitrate load** = `currentBitrate / MAX_BITRATE` (0..1+)
- *
- * `MAX_BITRATE` = 20 Mbit/s — the reference ceiling for the encoder.
- *
- * | Band | Range | Meaning |
- * |--------|-------------------------------------------------|-----------------------------------------------|
- * | high | load 0.5..0.8 → ramp, >0.8 → 1.0 | Encoder is using most of the available bandwidth |
- * | not high | load < 0.5 → 0.0 | Bandwidth headroom is available |
- *
- * **3. Quality** — mapped from QP via `mapQpToQuality()` (see {@link Quality}):
- *
- * | Quality | QP range | Meaning |
- * |----------|-----------|-------------------------------------------------|
- * | `lime` | QP <= 26 | Good — encoder has enough headroom |
- * | `orange` | QP 27..35 | Fair — encoder is under moderate pressure |
- * | `red` | QP > 35 | Poor — heavy compression, visible artifacts |
- *
- * ### Decision rules (evaluated in priority order, first match wins)
- *
- * | # | Condition                                                  | Decision     |
- * |---|------------------------------------------------------------|--------------|
- * | 1 | FPS ratio is **low** (membership > 0.5)                    | **decrease** |
- * | 2 | FPS ratio is **ok** AND quality is `red`                   | **decrease** |
- * | 3 | FPS ratio is **ok** AND bitrate **high** AND quality is `orange` | **hold** |
- * | 4 | FPS ratio is **high** AND quality is `lime` AND bitrate **not high** | **increase** |
- * | — | Everything else                                            | **hold**     |
- *
- * ## Cooldown-based throttling
+ * Adaptive FPS controller: watches the incoming WebRTC stream and steers Unreal's
+ * `t.MaxFPS` between the discrete {@link FPS_STEPS}.
  *
- * The service continuously evaluates fuzzy rules in every sample window.
- * After each FPS step change it enforces a cooldown before the next
- * change can be applied. The cooldown duration depends on the
- * (previous decision → next decision) pair:
+ * Every {@link SAMPLE_WINDOW} ticks of `VideoService.videoStats$` (250 ms each)
+ * it averages FPS, bitrate and QP, runs them through the fuzzy membership
+ * functions below, and picks a decision by first-match rules. Fuzzy bands rather
+ * than hard thresholds so a metric sitting on a boundary does not oscillate.
  *
- * | Previous | Next | Cooldown |
- * |-----------|-----------|-----------------------------------------------------|
- * | decrease | decrease | {@link COOLDOWN_DECREASE_AFTER_DECREASE_MS} (2 s) |
- * | decrease | increase | {@link COOLDOWN_INCREASE_AFTER_DECREASE_MS} (10 s) |
- * | increase | decrease | {@link COOLDOWN_AFTER_INCREASE_MS} (2 s) |
- * | increase | increase | {@link COOLDOWN_AFTER_INCREASE_MS} (2 s) |
+ * Cooldowns between steps are deliberately asymmetric: stepping *down* again is
+ * allowed after {@link COOLDOWN_DECREASE_AFTER_DECREASE_MS}, but stepping back
+ * *up* after a decrease waits {@link COOLDOWN_INCREASE_AFTER_DECREASE_MS} — a
+ * stream that just failed its target is likely to fail it again.
  *
- * This means the system reacts quickly after an increase (2 s in any
- * direction) but is cautious about stepping back up after a decrease
- * (10 s), while still allowing consecutive decreases at 2 s intervals.
- *
- * ## FPS dispatch
- *
- * FPS changes are dispatched via the NgRx `setMaxFps` action, which triggers
- * the existing `UnrealEffects.setMaxFps$` effect that sends the
- * `t.MaxFPS <value>` console command to Unreal Engine.
+ * Changes go out as the `setMaxFps` action, not a direct command: the existing
+ * `UnrealEffects.setMaxFps$` effect turns it into the `t.MaxFPS <value>` console
+ * command.
  */
 declare class FpsMonitorService extends SubService {
     private readonly videoService;
@@ -2320,52 +2438,15 @@ declare class FpsMonitorService extends SubService {
      */
     private processTick;
     private handleMonitoring;
-    /**
-     * Combines fuzzy membership values into a single discrete decision.
-     * Rules are evaluated in priority order — first match wins.
-     *
-     * Inputs:
-     * - `fpsRatio` = avgFPS / currentTargetFPS (e.g., 45/60 = 0.75)
-     * - `bitrateLoad` = avgBitrate / 20 Mbit/s (e.g., 12M/20M = 0.6)
-     * - `quality` = mapQpToQuality(avgQP) → 'lime' | 'orange' | 'red'
-     */
+    /** Rules are evaluated in priority order — first match wins. */
     private evaluateDecision;
-    /**
-     * FPS ratio membership "low".
-     * Input: a ratio = actualFPS / targetFPS (e.g., 42/60 = 0.70).
-     *
-     *   ratio < 0.7 → 1.0 (clearly failing, e.g., 40/60)
-     *   ratio 0.7..0.9 → linear ramp down (e.g., 0.8 → 0.5)
-     *   a ratio > 0.9 → 0.0 (keeping up)
-     */
+    /** "low" — the stream cannot keep up with its target. */
     private membershipFpsLow;
-    /**
-     * FPS ratio membership "ok" — triangle shape.
-     * Input: ratio = actualFPS / targetFPS.
-     *
-     *   ratio < 0.8 → 0.0
-     *   ratio 0.8..0.95 → ramp up, peak at 0.95 (e.g., 57/60)
-     *   ratio 0.95..1.0 → ramp down
-     *   a ratio > 1.0 → 0.0
-     */
+    /** "ok" — triangle peaking just under the target. */
     private membershipFpsOk;
-    /**
-     * FPS ratio membership "high".
-     * Input: ratio = actualFPS / targetFPS.
-     *
-     *   ratio < 0.9 → 0.0
-     *   ratio 0.9..1.0 → linear ramp up (e.g., 0.95 → 0.5)
-     *   a ratio >= 1.0 → 1.0 (meeting or exceeding target, e.g., 60/60)
-     */
+    /** "high" — the stream meets or exceeds its target. */
     private membershipFpsHigh;
-    /**
-     * Bitrate load membership "high".
-     * Input: a load = currentBitrate / MAX_BITRATE (20 Mbit/s).
-     *
-     *   load < 0.5 → 0.0 (below 10 Mbit/s — plenty of headroom)
-     *   load 0.5..0.8 → linear ramp (e.g., 13M/20M = 0.65 → 0.5)
-     *   load > 0.8 → 1.0 (above 16 Mbit/s — near capacity)
-     */
+    /** "high" — the encoder is using most of the available bandwidth. */
     private membershipBitrateHigh;
     private upgradeFps;
     /**
@@ -3502,5 +3583,5 @@ declare const selectUserInactivityDetected: _ngrx_store.MemoizedSelector<Record<
 /** Used by external consumers (e.g., metabox). Do not remove. */
 declare const selectIsVideoPlayingAndDataChannelConnected: _ngrx_store.MemoizedSelector<Record<string, any>, boolean, (s1: boolean, s2: boolean) => boolean>;
 
-export { AFKService, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DESTROY_DISCONNECT_REASONS, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, INNER_RETRY_LIMIT, INSTANCE_READY_TIMEOUT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, LatencyTimings, LoadingProgressService, MINIMAL_FPS, MIN_CONTAINER_SIZE, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PlayerCountHandler, RECONNECT_CONFIG, REGION_PING_ACCURATE_SAMPLES, REGION_PING_BACKGROUND_REFRESH_DELAY_MS, REGION_PING_CACHE_KEY, REGION_PING_CACHE_TTL_MS, REGION_PING_WARMUP_DEADLINE_MS, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_AUDIO_ID, STREAMING_VIDEO_ID, SafePipe, SignallingService, SpecialKeyCodes, StatGraphComponent, StreamAdoptionService, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UNREAL_CONFIG, UnrealAfkSlotDirective, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealResumeSlotDirective, UnrealSceneComponent, UnrealStatusMessage, UnrealStatusSlotDirective, VideoService, VideoStatsComponent, WSCloseCode_CIRRUS_ABNORMAL_CLOSURE, WSCloseCode_CIRRUS_MAX_PLAYERS_ERROR, WSCloseCode_CIRRUS_PLAYER_DISCONNECTED, WSCloseCode_CIRRUS_STREAMER_KIKED_PLAYER, WSCloseCode_FORCE_CIRRUS_CLOSE, WSCloseCode_NORMAL_AFK_TIMEOUT, WSCloseCode_NORMAL_CLOSURE, WSCloseCode_NORMAL_MANUAL_DISCONNECT, WSCloseCode_UNKNOWN, WSCloseCodes, WS_OPEN_STATE, WS_RETRY_PER_INSTANCE, WS_TIMEOUT, WebRtcPlayerService, WebrtcErrorModalComponent, abortEstablishingConnection, answerSent, changeStatusMainVideoOnScene, changeStreamResolutionAction, commandCompleted, commandStarted, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToPercents, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getResizeStudioValues, getResizeValuesUniversal, getRtcErrorMessage, iceConnectionFailed, initSignalling, instanceReady, isAppOwned, isMetaboxMode, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, resolveSkin, saveAnalyticsEvent, selectCirrusConnectionId, selectClientAndViewIds, selectCommandProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsFullyConnected, selectIsLoaderScreenVisible, selectIsVideoPlayingAndDataChannelConnected, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectUserInactivityDetected, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setUserInactivityTimeout, setViewportNotReady, setViewportReady, showLoadingProgress, showResumeStreamPopup, showUnrealErrorMessage, showUserInactivityTimeoutPopup, signalingRetryAttempted, startStream, streamAdopted, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
-export type { AggregatedStat, AnySignalingMessage, AppOwnedStream, AwsInstance, BootstrapInfo, CandidateMessage, CirrusRequestKind, CloseReason, CommandInProgress, ConfigMessage, ConnectionError, ControlSchemeValues, DisconnectReasonType, EmittedMilestone, EventId, FpsLowData, FreezeFrameMessage, InboundVideoStats, InputProps, InstanceReady, InstanceReserved, InterruptClientStream, ListStreamersMessage, MessageBase, MessageTypeValues, OrchestrationErrorMessage, OrchestrationMessageType, P2PEstablishedMessage, ParkedStream, PhaseEndedData, PhaseOverlay, PhaseParam, PlayerCountMessage, PollingOrchestrationMessage, Quality, QualityAnomalyData, ReceivedFile, RequestStream, ResourceBucket, ResourceTotals, SSInfo, SampleData, SelectedIceCandidatePair, SessionEndReason, SessionEndedData, SessionStartedData, SignalingData, SignalingMessageHandler, SignalingMessageMap, SignalingRetryData, SignalingRetryKind, SlowResource, StreamConfig, StreamRequestContext, StreamResolutionProps, StreamTelemetryEvent, StreamTelemetryEventMap, StreamTelemetryEventName, StreamTelemetryLifecycleData, StreamTelemetryLifecycleEventName, StreamTelemetryTrackData, StreamerListMessage, TelemetryEventEnvelope, TelemetryLifecycleEnvelope, TelemetryType, UnknownFields, UnrealAfkSlotContext, UnrealCallbackDescriptor, UnrealCallbackEventMap, UnrealCallbackJson, UnrealCallbackJsonWrapped, UnrealInitialConfig, UnrealMode, UnrealResumeSlotContext, UnrealSlotTemplateContext, UnrealState, UnrealStatusSlotContext, UnrealUiClasses, UnrealUiPart, WSCloseCodesValues, WindowAggregate };
+export { AFKService, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DESTROY_DISCONNECT_REASONS, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, IME_PROCESS_KEY, INNER_RETRY_LIMIT, INSTANCE_READY_TIMEOUT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, InvertedKeyMap, KeyboardNumericCode, LatencyTimings, LoadingProgressService, MINIMAL_FPS, MIN_CONTAINER_SIZE, MODIFIER_KEY_CODES, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PlayerCountHandler, RECONNECT_CONFIG, REGION_PING_ACCURATE_SAMPLES, REGION_PING_BACKGROUND_REFRESH_DELAY_MS, REGION_PING_CACHE_KEY, REGION_PING_CACHE_TTL_MS, REGION_PING_WARMUP_DEADLINE_MS, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_AUDIO_ID, STREAMING_VIDEO_ID, SafePipe, SignallingService, SpecialKeyCodes, StatGraphComponent, StreamAdoptionService, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UnrealAfkSlotDirective, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealResumeSlotDirective, UnrealSceneComponent, UnrealStatusMessage, UnrealStatusSlotDirective, VideoService, VideoStatsComponent, WSCloseCode_CIRRUS_ABNORMAL_CLOSURE, WSCloseCode_CIRRUS_MAX_PLAYERS_ERROR, WSCloseCode_CIRRUS_PLAYER_DISCONNECTED, WSCloseCode_CIRRUS_STREAMER_KIKED_PLAYER, WSCloseCode_FORCE_CIRRUS_CLOSE, WSCloseCode_NORMAL_AFK_TIMEOUT, WSCloseCode_NORMAL_CLOSURE, WSCloseCode_NORMAL_MANUAL_DISCONNECT, WSCloseCode_UNKNOWN, WSCloseCodes, WS_OPEN_STATE, WS_RETRY_PER_INSTANCE, WS_TIMEOUT, WebRtcPlayerService, WebrtcErrorModalComponent, abortEstablishingConnection, answerSent, changeStatusMainVideoOnScene, changeStreamResolutionAction, commandCompleted, commandStarted, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToPercents, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getResizeStudioValues, getResizeValuesUniversal, getRtcErrorMessage, iceConnectionFailed, initSignalling, instanceReady, isAppOwned, isMetaboxMode, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, resolveSkin, saveAnalyticsEvent, selectCirrusConnectionId, selectClientAndViewIds, selectCommandProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsFullyConnected, selectIsLoaderScreenVisible, selectIsVideoPlayingAndDataChannelConnected, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectUserInactivityDetected, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setUserInactivityTimeout, setViewportNotReady, setViewportReady, showLoadingProgress, showResumeStreamPopup, showUnrealErrorMessage, showUserInactivityTimeoutPopup, signalingRetryAttempted, startStream, streamAdopted, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
+export type { AggregatedStat, AnySignalingMessage, AppOwnedStream, Area, AwsInstance, BootstrapInfo, CandidateMessage, CirrusRequestKind, CloseReason, CommandInProgress, ConfigMessage, ConnectionError, ControlSchemeValues, Coords, DisconnectReasonType, EmittedMilestone, EventId, FpsLowData, FreezeFrameMessage, IKeyCode, IKeyCodeName, IKeyName, ImageOutputValues, InboundVideoStats, InputProps, InstanceReady, InstanceReserved, InterruptClientStream, ListStreamersMessage, MessageBase, MessageTypeValues, OrchestrationErrorMessage, OrchestrationMessageType, P2PEstablishedMessage, ParkedStream, PhaseEndedData, PhaseOverlay, PhaseParam, PlayerCountMessage, PollingOrchestrationMessage, Quality, QualityAnomalyData, ReceivedFile, Rect, RequestStream, ResourceBucket, ResourceTotals, SSInfo, SampleData, SelectedIceCandidatePair, SessionEndReason, SessionEndedData, SessionStartedData, SignalingData, SignalingMessageHandler, SignalingMessageMap, SignalingRetryData, SignalingRetryKind, Size, SlowResource, StreamConfig, StreamRequestContext, StreamResolutionProps, StreamTelemetryEvent, StreamTelemetryEventMap, StreamTelemetryEventName, StreamTelemetryLifecycleData, StreamTelemetryLifecycleEventName, StreamTelemetryTrackData, StreamerListMessage, TelemetryEventEnvelope, TelemetryLifecycleEnvelope, TelemetryType, UnknownFields, UnrealAfkSlotContext, UnrealCallbackDescriptor, UnrealCallbackEventMap, UnrealCallbackJson, UnrealCallbackJsonWrapped, UnrealResumeSlotContext, UnrealSlotTemplateContext, UnrealState, UnrealStatusSlotContext, UnrealUiClasses, UnrealUiPart, WSCloseCodesValues, WindowAggregate };