@3dsource/angular-unreal-module 0.0.191 → 0.0.193-dev.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3dsource/angular-unreal-module",
-  "version": "0.0.191",
+  "version": "0.0.193-dev.0",
   "description": "Angular integration for Unreal Engine Pixel Streaming",
   "keywords": [
     "3dsource",

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

@@ -11,7 +11,6 @@ interface UnrealInitialConfig {
   mode?: UnrealMode;
   playwright?: boolean;
   customErrorsEndpoint?: string;
-  commandTelemetryReceiver?: string;
   regionsPingUrl?: string;
   screenLockerContainerId?: string;
   dataChannelConnectionTimeout?: number;

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

@@ -608,7 +608,7 @@ type Quality = 'lime' | 'red' | 'orange';
  * (`253.StreamTelemetry/src/app/telemetry/models/telemetry.types.ts`) — any
  * change here needs a paired edit there.
  *
- * Event taxonomy (8 names, 6 payload shapes):
+ * Event taxonomy (9 names, 7 payload shapes):
  *  | event                      | payload                            |
  *  |----------------------------|------------------------------------|
  *  | `stream.session_started`   | {@link SessionStartedData}         |
@@ -619,6 +619,7 @@ type Quality = 'lime' | 'red' | 'orange';
  *  | `stream.quality_recovered` | {@link QualityAnomalyData}         |
  *  | `stream.fps_low`           | {@link FpsLowData}                 |
  *  | `stream.signaling_retry`   | {@link SignalingRetryData}         |
+ *  | `stream.pak_timing`        | {@link PakTimingData}              |
  */
 /**
  * Every stable id the service can put on the wire — phases, milestones,
@@ -626,7 +627,7 @@ type Quality = 'lime' | 'red' | 'orange';
  * every id added here needs a paired vocabulary row in the viewer
  * (`telemetry-vocabulary.ts`).
  */
-type EventId = 'region-resolving' | 'signaling-connection' | 'webrtc-negotiation' | 'unreal-communication' | 'region-ping-fetch-start' | 'region-ping-fetch-end' | 'region-resolved' | 'polling-started' | 'polling-ended' | 'aws-instance-resolved' | 'signaling-ws-connected' | 'instance-reserved' | 'instance-ready' | 'config-received' | 'ssinfo-received' | 'offer-received' | 'answer-sent' | 'answer-received' | 'first-ice-candidate' | 'last-ice-candidate' | 'datachannel-connected' | 'first-command-started' | 'loopback-sent' | 'loopback-received' | 'viewport-ready' | 'polling-to-instance' | 'signaling-handshake' | 'stabilization-warmup';
+type EventId = 'region-resolving' | 'signaling-connection' | 'webrtc-negotiation' | 'unreal-communication' | 'region-ping-fetch-start' | 'region-ping-fetch-end' | 'region-resolved' | 'polling-started' | 'polling-ended' | 'aws-instance-resolved' | 'signaling-ws-connected' | 'instance-reserved' | 'instance-ready' | 'config-received' | 'ssinfo-received' | 'offer-received' | 'answer-sent' | 'answer-received' | 'first-ice-candidate' | 'last-ice-candidate' | 'ice-checking' | 'ice-gathering-complete' | 'ice-connected' | 'ice-failed' | 'datachannel-connected' | 'first-command-started' | 'loopback-sent' | 'loopback-received' | 'viewport-ready' | 'polling-to-instance' | 'signaling-handshake' | 'ice-connectivity-checks' | 'stabilization-warmup';
 /**
  * High-level cause of `stream.session_ended`.
  *  - `disconnected` — Cirrus/WebRTC dropped us mid-stream (granular cause
@@ -941,6 +942,29 @@ interface SignalingRetryData extends TelemetryEventEnvelope {
   readonly reason: string;
   readonly kind: SignalingRetryKind;
 }
+/** A command with ≥ 1 pak, send → `commandCallback` (by `correlationId`).
+ *  Browser and Unreal clocks are never mixed. */
+interface PakTimingItem {
+  /** Every `pakFilePath` of the command, comma-joined. */
+  readonly pak: string;
+  readonly command: string;
+  /** Anchor-relative ms. */
+  readonly sentMs: number;
+  /** Send → callback, browser clock. Absent when {@link lost}. */
+  readonly totalMs?: number;
+  /** `onRequestCommand` → `onStartCommand`, Unreal clock. */
+  readonly queueMs?: number;
+  /** `onStartCommand` → `onCompleteCommand`, Unreal clock. */
+  readonly execMs?: number;
+  /** No callback within 60 s, or the session ended first. */
+  readonly lost?: true;
+}
+/** `stream.pak_timing` — pak commands done during one 5 s window, all
+ *  session long. Empty windows are not sent. */
+interface PakTimingData extends TelemetryEventEnvelope {
+  readonly seq: number;
+  readonly items: readonly PakTimingItem[];
+}
 /** Event name → payload. The authoritative index of the wire taxonomy. */
 interface StreamTelemetryEventMap {
   'stream.session_started': SessionStartedData;
@@ -951,6 +975,7 @@ interface StreamTelemetryEventMap {
   'stream.quality_recovered': QualityAnomalyData;
   'stream.fps_low': FpsLowData;
   'stream.signaling_retry': SignalingRetryData;
+  'stream.pak_timing': PakTimingData;
 }
 type StreamTelemetryEventName = keyof StreamTelemetryEventMap;
 /** Names emitted via `emitLifecycle` — the three `duration`-carrying events. */
@@ -1302,7 +1327,6 @@ interface StreamResolutionProps {
  */
 type UnrealUiPart = 'resumeCard' | 'resumeText' | 'resumeButton' | 'afkScrim' | 'afkCard' | 'afkButton' | 'statusCard' | 'statusMessage';
 type UnrealUiClasses = Partial<Record<UnrealUiPart, string | string[]>>;
-type TelemetryType = 'commandSent' | 'commandStop';
 export declare const InputOptions: InputProps;
 /** Disconnect reasons that should trigger remote connection cleanup. */
 export declare const DESTROY_DISCONNECT_REASONS: DisconnectReasonType[];
@@ -1427,94 +1451,6 @@ export declare class AggregatorService extends SubService {
   static ɵfac: i0.ɵɵFactoryDeclaration<AggregatorService, never>;
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
-export declare class CommandTelemetryService extends SubService {
-  private readonly appId;
-  private commandsSent;
-  private exileTimeout;
-  private pollingTime;
-  private commandSequenceNumber;
-  /**
-   * The time the telemetry service was started.
-   * Initialized at a moment when connectToSignaling() was called.
-   * @private
-   */
-  private startTime;
-  private lastTime;
-  private uuid;
-  private viewId;
-  private sessionId;
-  private userId;
-  private payloads;
-  private readonly httpClient;
-  private readonly unrealConfig;
-  constructor();
-  protected init(): void;
-  private get timeNow();
-  private get sessionTime();
-  private get canSkipSending();
-  decorate(funcToDecorate: ToBeDecorated): (data: MetaBoxCommandPacket) => void;
-  trackStartCommand(trackingId: string): void;
-  trackStopCommand(trackingId: string, multi?: boolean, response?: {
-    multi?: boolean;
-  } & Record<string, unknown>, timeStampsRaw?: TimeStampsRaw): void;
-  reset(): void;
-  private pushStatToBuffer;
-  private trackTime;
-  private send;
-  /**
-   * Listens for Unreal Engine callbacks.
-   * Subscribes to the Unreal Engine event loop back and filters out events that do not have a tracking ID.
-   * When a callback with a tracking ID is received,
-   * it stops tracking the time for that command and filters out commands
-   * that have exceeded the timeout limit.
-   */
-  protected listenCallbacks(): void;
-  private pushData;
-  /**
-   * Removes commands that have exceeded the timeout limit.
-   * Iterates over all the commands sent and checks if the difference between the current time
-   * and the time the command was sent is greater than the timeout limit.
-   * If it is, the command is marked for deletion.
-   * After checking all commands, those marked for deletion are removed from the commands sent.
-   * This method is used to ensure that commands that are not responded to within a certain time frame
-   * do not remain in the commandsSent object indefinitely, which could lead to memory leaks over time.
-   */
-  private removeExileCommands;
-  /**
-   * Wraps the provided function with telemetry tracking.
-   * Generates a unique tracking ID and adds it to the data object.
-   * Pushes the command sent to the payloads with the tracking ID.
-   * Starts tracking the time for the command.
-   * Finally, calls the provided function with the modified data object.
-   *
-   * @param {ToBeDecorated} funcToDecorate - The function to be decorated with telemetry tracking.
-   * @param {MetaBoxCommandPacket} data - The data object to be passed to the function. It will be augmented with a unique tracking ID.
-   */
-  private wrapper;
-  static ɵfac: i0.ɵɵFactoryDeclaration<CommandTelemetryService, never>;
-  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
-}
-type ToBeDecorated = (data: MetaBoxCommandPacket) => void;
-interface TimeStampsRaw {
-  timeStampPak: TimeStampPakCollection;
-  timeStampCommand: TimeStampCommandCollection;
-}
-interface TimeStampPakCollection {
-  onLoadPak: TimeStampMemory;
-  onRenderPak: TimeStampMemory;
-  onSequencePak: TimeStampMemory;
-  onSpawnPak: TimeStampMemory;
-}
-interface TimeStampMemory {
-  timestamp: number;
-  ram: number;
-  vRam: number;
-}
-interface TimeStampCommandCollection {
-  onRequestCommand: TimeStampMemory;
-  onStartCommand: TimeStampMemory;
-  onCompleteCommand: TimeStampMemory;
-}
 export declare class ConsoleExtensionsService extends SubService {
   #private;
   private readonly unrealConfig;
@@ -1579,6 +1515,9 @@ export declare class InputService extends SubService {
   private maxByteValue;
   private fingers;
   private readonly heldKeys;
+  private heldButtons;
+  private lastMousePosition;
+  private leavePending;
   private readonly mouseMoveView;
   private readonly mouseButtonView;
   private readonly mouseWheelView;
@@ -1621,8 +1560,15 @@ export declare class InputService extends SubService {
   emitMouseDown(button: number, x: number, y: number): void;
   emitMouseUp(button: number, x: number, y: number): void;
   emitMouseWheel(delta: number, x: number, y: number): void;
+  /**
+   * Releases the held ones among `buttons` at the last position over the
+   * video, then sends the MouseLeave a drag deferred once nothing is held.
+   */
   private releaseMouseButtons;
+  /** Presses the ones among `buttons` Unreal does not hold yet. */
   private pressMouseButtons;
+  private sendMouseEnter;
+  private sendMouseLeave;
   private registerHoveringMouseEvents;
   private registerMouseEnterAndLeaveEvents;
   /**
@@ -1724,7 +1670,6 @@ interface Region {
 export declare class SignallingService extends SubService {
   private readonly httpClient;
   private readonly regionsPingService;
-  private readonly commandTelemetryService;
   private readonly unrealConfig;
   readonly region: import("@angular/core").WritableSignal<string>;
   readonly selectClientAndViewIds: import("@angular/core").Signal<{
@@ -1793,8 +1738,7 @@ export declare class SignallingService extends SubService {
   private requestCirrusDirect;
   /**
    * HTTP-orchestration path. Brackets {@link pollLoop} with `pollingStarted`/
-   * `pollingEnded` and the `EXT-getSignaling` telemetry span (started in `defer`,
-   * stopped in `finalize` with the last response from the closure).
+   * `pollingEnded` (dispatched in `defer` and `finalize`).
    */
   private requestCirrusViaPolling;
   /**
@@ -1979,6 +1923,7 @@ export declare class StreamStatusTelemetryService2 {
   private readonly actions$;
   private readonly videoService;
   private readonly signallingService;
+  private readonly webRtcPlayer;
   private readonly unrealConfig;
   private readonly destroyRef;
   private readonly destroy$;
@@ -2042,6 +1987,8 @@ export declare class StreamStatusTelemetryService2 {
   private readonly awsInstanceResolvedEntry;
   private readonly loopbackReceivedEntry;
   private readonly signalingServerConnectedEntry;
+  private readonly iceCheckingEntry;
+  private readonly iceConnectedEntry;
   private readonly configReceivedEntry;
   /**
    * Unified phase catalog — the single source of truth for everything
@@ -2118,6 +2065,11 @@ export declare class StreamStatusTelemetryService2 {
   private adoptedSignalingParams;
   private handleWindow;
   private evaluateAnomalies;
+  /** Ship the pak commands finished this window as one `stream.pak_timing`;
+   *  `final` also gives up on the ones still waiting (session is ending). */
+  private flushPaks;
+  /** ICE connection state changes into any of `states`. */
+  private iceConnection$;
   private updateMaxFpsTarget;
   /**
    * Snapshot every milestone recorded in this session that belongs to
@@ -2163,7 +2115,6 @@ export declare class StreamStatusTelemetryService2 {
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
 export declare class UnrealCommunicatorService extends SubService {
-  private readonly commandTelemetryService;
   private readonly webRtcPlayerService;
   private readonly unrealConfig;
   private cirrusConnected;
@@ -2271,13 +2222,43 @@ export declare class VideoService extends SubService {
   static ɵfac: i0.ɵɵFactoryDeclaration<VideoService, never>;
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
+declare function finite(value: unknown): number | undefined;
+/** The `local-candidate` / `remote-candidate` fields read here — the DOM lib
+ *  in use does not declare RTCIceCandidateStats. */
+interface IceCandidateStats {
+  candidateType?: string;
+  protocol?: string;
+  address?: string | null;
+  port?: number;
+  url?: string;
+  relayProtocol?: string;
+}
+/**
+ * The route-relevant fields of one candidate. The address is uploaded for a
+ * relay candidate only — host / srflx addresses identify the user, a relay
+ * address identifies the TURN provider's region.
+ */
+declare function candidateInfo(candidate: IceCandidateStats | undefined, isLocal: boolean): IceCandidateInfo;
+/** Id of the selected candidate pair: the transport's pick, or Firefox's
+ *  pre-standard `selected` flag when there is no `transport` report. */
+declare function selectedPairId(stats: RTCStatsReport): string | undefined;
+/** Candidates per side by type, pairs by check state, and the selected pair. */
+interface IceSnapshot {
+  readonly local: Readonly<Record<string, number>>;
+  readonly remote: Readonly<Record<string, number>>;
+  readonly pairs: Readonly<Record<string, number>>;
+  readonly selected: IceRoute | null;
+  readonly selectedRttMs?: number;
+}
+declare function iceSnapshot(stats: RTCStatsReport): IceSnapshot;
 export declare class WebRtcPlayerService extends SubService {
   onDataChannelMessage$: Subject<ArrayBuffer>;
+  /** ICE connection / gathering state changes of the current peer connection. */
+  readonly iceState$: Subject<IceStateChange>;
   private pcClient;
   private dcClient;
   private readonly signallingSrv;
   private readonly videoService;
-  private readonly commandTelemetryService;
   private cfg;
   private useMic;
   private forceTURN;
@@ -2371,6 +2352,8 @@ export declare class WebRtcPlayerService extends SubService {
    */
   releaseRemoteConnections(reason: DisconnectReasonType): void;
   canSend(): boolean | null;
+  /** ICE of the current peer connection; `null` without one or on a failed read. */
+  readIceSnapshot(): Promise<IceSnapshot | null>;
   describeConnectionState(): string;
   send(data: ArrayBuffer): void;
   /**
@@ -2416,6 +2399,13 @@ export declare class WebRtcPlayerService extends SubService {
   static ɵfac: i0.ɵɵFactoryDeclaration<WebRtcPlayerService, never>;
   static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
+export type IceStateChange = {
+  readonly kind: 'connection';
+  readonly state: RTCIceConnectionState;
+} | {
+  readonly kind: 'gathering';
+  readonly state: RTCIceGatheringState;
+};
 declare const ReceivedMimeTypes: {
   readonly ApplicationJson: "application/json";
 };
@@ -2855,7 +2845,8 @@ export declare function provideUnrealModule(): import("@angular/core").Environme
  */
 export interface UnrealCallbackJsonWrapped {
   commandCallback: MetaBoxCommandPacket;
-  timeStamp?: unknown;
+  /** Unreal's own stamps; some builds send `timeStamp` — read via `callbackStamps`. */
+  timestamp?: unknown;
 }
 export type UnrealCallbackJson = UnrealCallbackJsonWrapped | MetaBoxCommandPacket;
 export declare const unrealCommandCallback: import("@ngrx/store").ActionCreator<string, (props: {
@@ -2867,10 +2858,12 @@ export declare const commandStarted: import("@ngrx/store").ActionCreator<string,
   id: string;
   command: string;
   timeStamp: number;
+  paks?: string;
 }) => {
   id: string;
   command: string;
   timeStamp: number;
+  paks?: string;
 } & import("@ngrx/store").Action<string>>;
 export declare const commandCompleted: import("@ngrx/store").ActionCreator<string, (props: {
   id: string;
@@ -3326,7 +3319,6 @@ export declare class UnrealEffects {
   private readonly unrealInitialConfig;
   private readonly webRtcPlayerService;
   private readonly commandsSender;
-  private readonly commandTelemetryService;
   private readonly regionsPingService;
   private readonly signallingService;
   private readonly streamAdoptionService;
@@ -3769,4 +3761,4 @@ export declare class Semaphore {
   release(): void;
 }
 export declare const tapLog: <T>(text: string, ...args: unknown[]) => ((source: Observable<T>) => Observable<T>);
-export { ALL_KEYBOARD_KEYS, type AggregatedStat, type Area, type AwsInstance, type BootstrapInfo, type CirrusRequestKind, type CloseReason, type Coords, type EmittedMilestone, type EventId, type FpsLowData, type FreezeFrameMessage, type IKeyCode, type IKeyCodeName, type IKeyName, IME_PROCESS_KEY, type IceCandidateInfo, type IceRoute, type ImageOutputValues, type InboundVideoStats, type InputProps, MODIFIER_KEY_CODES, type PhaseEndedData, type PhaseOverlay, type PhaseParam, type Quality, type QualityAnomalyData, type Rect, type RegionPick, type RegionProbes, type RegionSource, type ResourceBucket, type ResourceTotals, type RouteSegment, type SampleData, type SelectedIceCandidatePair, type SessionEndReason, type SessionEndedData, type SessionStartedData, type SignalingData, type SignalingRetryData, type SignalingRetryKind, type Size, type SlowResource, type StreamConfig, type StreamResolutionProps, type StreamTelemetryEvent, type StreamTelemetryEventMap, type StreamTelemetryEventName, type StreamTelemetryLifecycleData, type StreamTelemetryLifecycleEventName, type StreamTelemetryTrackData, type TelemetryEventEnvelope, type TelemetryLifecycleEnvelope, type TelemetryType, UNREAL_CONFIG, type UnrealAfkSlotContext, type UnrealInitialConfig, UnrealKeyCode, type UnrealMode, type UnrealResumeSlotContext, type UnrealSlotTemplateContext, type UnrealStatusSlotContext, type UnrealUiClasses, type UnrealUiPart, type WindowAggregate };
+export { ALL_KEYBOARD_KEYS, type AggregatedStat, type Area, type AwsInstance, type BootstrapInfo, type CirrusRequestKind, type CloseReason, type Coords, type EmittedMilestone, type EventId, type FpsLowData, type FreezeFrameMessage, type IKeyCode, type IKeyCodeName, type IKeyName, IME_PROCESS_KEY, type IceCandidateInfo, type IceRoute, type ImageOutputValues, type InboundVideoStats, type InputProps, MODIFIER_KEY_CODES, type PakTimingData, type PakTimingItem, type PhaseEndedData, type PhaseOverlay, type PhaseParam, type Quality, type QualityAnomalyData, type Rect, type RegionPick, type RegionProbes, type RegionSource, type ResourceBucket, type ResourceTotals, type RouteSegment, type SampleData, type SelectedIceCandidatePair, type SessionEndReason, type SessionEndedData, type SessionStartedData, type SignalingData, type SignalingRetryData, type SignalingRetryKind, type Size, type SlowResource, type StreamConfig, type StreamResolutionProps, type StreamTelemetryEvent, type StreamTelemetryEventMap, type StreamTelemetryEventName, type StreamTelemetryLifecycleData, type StreamTelemetryLifecycleEventName, type StreamTelemetryTrackData, type TelemetryEventEnvelope, type TelemetryLifecycleEnvelope, UNREAL_CONFIG, type UnrealAfkSlotContext, type UnrealInitialConfig, UnrealKeyCode, type UnrealMode, type UnrealResumeSlotContext, type UnrealSlotTemplateContext, type UnrealStatusSlotContext, type UnrealUiClasses, type UnrealUiPart, type WindowAggregate };