@3dsource/angular-unreal-module 0.0.101-dev.4 → 0.0.101-dev.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3dsource/angular-unreal-module",
-  "version": "0.0.101-dev.4",
+  "version": "0.0.101-dev.5",
   "description": "Angular Unreal module for connect with unreal engine stream",
   "keywords": [
     "3dsource",

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

@@ -923,6 +923,129 @@ declare class WebRtcPlayerService extends SubService {
     static ɵprov: i0.ɵɵInjectableDeclaration<WebRtcPlayerService>;
 }
 
+declare class WebRtcPlayerService2 extends SubService {
+    onDataChannelMessage$: Subject<ArrayBuffer>;
+    private pcClient;
+    private signallingSrv;
+    private videoService;
+    private commandTelemetryService;
+    private cfg;
+    private useMic;
+    private forceTURN;
+    private forceMonoAudio;
+    private dcClient;
+    /** Whether the remote SDP has been applied to the current peer connection */
+    private remoteDescriptionSet;
+    /** ICE candidates received before the remote description was set */
+    private iceCandidateBuffer;
+    private isReconnecting;
+    constructor();
+    protected init(): void;
+    /**
+     * Handles an SDP offer received from the server.
+     * Creates a new peer connection, applies the remote offer,
+     * then responds with an SDP answer.
+     *
+     * The DataChannel is NOT created here — the server creates it
+     * and we receive it via the `datachannel` event on the peer connection.
+     */
+    private handleServerOffer;
+    /**
+     * Handles an SDP answer received from the server in response to our offer.
+     * Applies the remote description and flushes any buffered ICE candidates.
+     */
+    private handleServerAnswer;
+    /** Drains buffered ICE candidates after the remote description has been set */
+    private flushIceCandidateBuffer;
+    /**
+     * Creates a client-initiated WebRTC offer and sends it to the server.
+     * When the client offers, it also creates the DataChannel.
+     * Used for peer reconnection through the existing signaling connection.
+     */
+    private createWebRtcOffer;
+    /**
+     * Initializes a new RTCPeerConnection with event handlers.
+     * Transceivers are NOT added here — the caller is responsible for adding
+     * them at the correct point depending on the negotiation flow.
+     */
+    private setupPeerConnection;
+    private createDataChannel;
+    private handleCandidateFromServer;
+    /**
+     * Reorders the `m=video` line in the SDP so that payload types matching
+     * the given H.264 `profile-level-id` appear first, making the browser
+     * prefer that profile during codec negotiation.
+     *
+     * A `profile-level-id` is a 3-byte hex string (`XXYYZZ`) defined in
+     * RFC 6184 that encodes three H.264 parameters:
+     * - **Profile IDC** (`XX`) — the H.264 profile.
+     * - **Profile IOP** (`YY`) — constraint flags that further narrow the profile.
+     * - **Level IDC** (`ZZ`) — the level, which caps resolution/framerate/bitrate.
+     *
+     * ### H.264 profiles relevant to Unreal Engine Pixel Streaming
+     *
+     * | profile-level-id | Profile                    | Level | Notes                                        |
+     * |------------------|----------------------------|-------|----------------------------------------------|
+     * | `42001f`         | Baseline                   | 3.1   | No B-frames, low latency; legacy devices     |
+     * | `42e01f`         | Constrained Baseline       | 3.1   | Widest HW decode support; **recommended**    |
+     * | `4d001f`         | Main                       | 3.1   | B-frames + CABAC; better compression          |
+     * | `4d4028`         | Main                       | 4.0   | Up to 1080p60; common desktop target          |
+     * | `640028`         | High                       | 4.0   | Best quality/compression; most GPUs support   |
+     * | `64002a`         | High                       | 4.2   | Up to 1080p120 or 4K30                        |
+     * | `640033`         | High                       | 5.1   | Up to 4K60; requires modern HW                |
+     * | `640034`         | High                       | 5.2   | Up to 4K120; high-end HW only                 |
+     * | `6e001f`         | High 10                    | 3.1   | 10-bit color; limited browser support          |
+     * | `f4001f`         | High 4:4:4 Predictive      | 3.1   | Lossless capable; rare in browsers             |
+     *
+     * UE Pixel Streaming defaults to Constrained Baseline (`42e01f`) or High (`6400xx`)
+     * depending on engine version and `WebRTC.H264Profile` CVar.
+     *
+     * We prioritize `42e01f` because it guarantees hardware decoding on
+     * virtually all client devices (desktop, mobile, embedded), avoiding
+     * fallback to software decoding or negotiation of a higher profile
+     * that the client GPU may not accelerate.
+     */
+    private prioritizeH264Profile;
+    private mungeSDP;
+    /**
+     * Closes existing PeerConnection and DataChannel, resets negotiation state.
+     */
+    closePC(): void;
+    canSend(): boolean | null;
+    send(data: ArrayBuffer): void;
+    /**
+     * Attempts to reconnect the peer when send fails due to DataChannel not being open.
+     * This handles cases where the DC connection is broken but no error events are fired.
+     */
+    private tryReconnectOnSendFailure;
+    /**
+     * Reconnects only the WebRTC peer connection without re-establishing signaling.
+     * Closes the current PeerConnection and creates a new client-initiated offer
+     * through the existing WebSocket connection.
+     * @returns true if reconnection was initiated, false if signaling is not connected
+     */
+    reconnectPeer(): boolean;
+    private setConfig;
+    private handlePeerConnectionEvents;
+    private setupTransceiversAsync;
+    private setupDataChannelCallbacks;
+    private onDataChannelConnected;
+    /**
+     * Creates an SDP offer, applies SDP munging, sets it as local description,
+     * and sends it to the server via signaling.
+     * Transceivers already configure media directions, so deprecated
+     * offerToReceive* options are not used.
+     */
+    private createOffer;
+    /**
+     * Creates an SDP answer, applies SDP munging, sets it as local description,
+     * and sends it to the server via signaling.
+     */
+    private createAnswer;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WebRtcPlayerService2, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WebRtcPlayerService2>;
+}
+
 declare class AfkPlaywrightService extends AFKService {
     init(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AfkPlaywrightService, never>;
@@ -1016,30 +1139,6 @@ declare class FileReceiverPlaywrightService extends FileReceiverService {
     init(): void;
 }
 
-declare class InputPlaywrightService extends InputService {
-    init(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<InputPlaywrightService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<InputPlaywrightService>;
-}
-
-declare class FileHandlerService {
-    private fileService;
-    private fileHandlers;
-    private handleJsonFile;
-    observeFileResponse<K extends keyof MetaBoxCommandList, T extends MetaBoxCommandList[K] = MetaBoxCommandList[K]>(mimetype: ReceivedMimeType, data: T, sender: (data: T) => void, timeOut?: number): Observable<unknown>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FileHandlerService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<FileHandlerService>;
-}
-
-declare class AnalyticsService {
-    #private;
-    sendEventToMixPanel(name: string, params?: Record<string, unknown>): void;
-    constructor();
-    private monitorMouse;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AnalyticsService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AnalyticsService>;
-}
-
 /**
  * Adaptive FPS controller that monitors the incoming WebRTC video stream
  * quality and dynamically adjusts Unreal Engine's `t.MaxFPS` console variable.
@@ -1216,6 +1315,36 @@ declare class FpsMonitorService {
     static ɵprov: i0.ɵɵInjectableDeclaration<FpsMonitorService>;
 }
 
+declare class FpsMonitorPlaywrightService extends FpsMonitorService {
+    init(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FpsMonitorPlaywrightService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FpsMonitorPlaywrightService>;
+}
+
+declare class InputPlaywrightService extends InputService {
+    init(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<InputPlaywrightService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<InputPlaywrightService>;
+}
+
+declare class FileHandlerService {
+    private fileService;
+    private fileHandlers;
+    private handleJsonFile;
+    observeFileResponse<K extends keyof MetaBoxCommandList, T extends MetaBoxCommandList[K] = MetaBoxCommandList[K]>(mimetype: ReceivedMimeType, data: T, sender: (data: T) => void, timeOut?: number): Observable<unknown>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FileHandlerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FileHandlerService>;
+}
+
+declare class AnalyticsService {
+    #private;
+    sendEventToMixPanel(name: string, params?: Record<string, unknown>): void;
+    constructor();
+    private monitorMouse;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AnalyticsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AnalyticsService>;
+}
+
 /**
  * Custom Unreal callback events that are not part of MetaBoxCommandList.
  * These events are pushed from Unreal to the frontend via the data channel.
@@ -1812,6 +1941,7 @@ declare class SafePipe implements PipeTransform {
 declare function provideAngularUnrealModule(config?: {
     playwright?: boolean;
     newWebRtcConnector?: boolean;
+    fpsMonitor?: boolean;
 }): i0.EnvironmentProviders;
 
 /**
@@ -2405,5 +2535,5 @@ declare const selectClientAndViewIds: _ngrx_store.MemoizedSelector<Record<string
 }>;
 declare const selectIsLoaderScreenVisible: _ngrx_store.MemoizedSelector<Record<string, any>, boolean, (s1: boolean, s2: boolean, s3: boolean) => boolean>;
 
-export { AFKService, AfkPlaywrightService, AfkTimeoutModalComponent, AggregatorPlaywrightService, AggregatorService, AnalyticsService, AnswerHandler, CONSOLE_COMMAND_DISABLE_MESSAGES, CONSOLE_COMMAND_ENABLE_MESSAGES, CONSOLE_COMMAND_PIXEL_QUALITY, CommandTelemetryPlaywrightService, CommandTelemetryService, CommandsEffects, ConfigHandler, ConsoleExtensionsPlaywrightService, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DEFAULT_RECONNECT_DELAY_MS, DEFAULT_RECONNECT_ENABLED, DEFAULT_RECONNECT_MAX_ATTEMPTS, DEFAULT_RECONNECT_ON_DATACHANNEL_CLOSE, DEFAULT_RECONNECT_ON_ICE_FAILURE, DataFlowMonitor, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverPlaywrightService, FileReceiverService, FilterSettingsComponent, FpsMonitorService, FreezeFrameComponent, FreezeFramePlaywrightService, FreezeFrameService, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputPlaywrightService, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, KalmanFilter1D, LatencyTimings, LowBandwidthDetectorComponent, LowBandwidthModalComponent, MINIMAL_FPS, MessageType, MouseButton, MouseButtonsMask, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PingHandler, PlayerCountHandler, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_VIDEO_ID, SafePipe, SignallingPlaywrightService, SignallingService, SpecialKeyCodes, StatGraphComponent, StreamStatusTelemetryPlaywrightService, StreamStatusTelemetryService, SubService, ToClientMessage, UNREAL_CONFIG, UnrealCallbackService, UnrealCommunicatorPlaywrightService, UnrealCommunicatorService, UnrealEffects, UnrealSceneComponent, UnrealStatusMessage, 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_TIMEOUT, WebRtcPlayerService, WebrtcErrorModalComponent, abortEstablishingConnection, changeLowBandwidth, changeStatusMainVideoOnScene, changeStreamResolutionAction, changeStreamResolutionSuccessAction, commandCompleted, commandStarted, commandsFeature, commandsReducer, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getRtcErrorMessage, iceConnectionFailed, initSignalling, keepMaxUntilReset, provideAngularUnrealModule, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetWarnTimeout, saveAnalyticsEvent, selectClientAndViewIds, selectCommandProgress, selectCommandsInProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsLoaderScreenVisible, selectIsShowPopupWithoutAutoStart, selectIsVideoPlayingAndDataChannelConnected, selectLastCommandInProgress, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setDataChannelConnected, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setKalmanSettings, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setViewportNotReady, setViewportReady, showUnrealErrorMessage, smoothTransition, startStream, trackMixpanelEvent, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
+export { AFKService, AfkPlaywrightService, AfkTimeoutModalComponent, AggregatorPlaywrightService, AggregatorService, AnalyticsService, AnswerHandler, CONSOLE_COMMAND_DISABLE_MESSAGES, CONSOLE_COMMAND_ENABLE_MESSAGES, CONSOLE_COMMAND_PIXEL_QUALITY, CommandTelemetryPlaywrightService, CommandTelemetryService, CommandsEffects, ConfigHandler, ConsoleExtensionsPlaywrightService, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DEFAULT_RECONNECT_DELAY_MS, DEFAULT_RECONNECT_ENABLED, DEFAULT_RECONNECT_MAX_ATTEMPTS, DEFAULT_RECONNECT_ON_DATACHANNEL_CLOSE, DEFAULT_RECONNECT_ON_ICE_FAILURE, DataFlowMonitor, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverPlaywrightService, FileReceiverService, FilterSettingsComponent, FpsMonitorPlaywrightService, FpsMonitorService, FreezeFrameComponent, FreezeFramePlaywrightService, FreezeFrameService, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputPlaywrightService, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, KalmanFilter1D, LatencyTimings, LowBandwidthDetectorComponent, LowBandwidthModalComponent, MINIMAL_FPS, MessageType, MouseButton, MouseButtonsMask, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PingHandler, PlayerCountHandler, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_VIDEO_ID, SafePipe, SignallingPlaywrightService, SignallingService, SpecialKeyCodes, StatGraphComponent, StreamStatusTelemetryPlaywrightService, StreamStatusTelemetryService, SubService, ToClientMessage, UNREAL_CONFIG, UnrealCallbackService, UnrealCommunicatorPlaywrightService, UnrealCommunicatorService, UnrealEffects, UnrealSceneComponent, UnrealStatusMessage, 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_TIMEOUT, WebRtcPlayerService, WebRtcPlayerService2, WebrtcErrorModalComponent, abortEstablishingConnection, changeLowBandwidth, changeStatusMainVideoOnScene, changeStreamResolutionAction, changeStreamResolutionSuccessAction, commandCompleted, commandStarted, commandsFeature, commandsReducer, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getRtcErrorMessage, iceConnectionFailed, initSignalling, keepMaxUntilReset, provideAngularUnrealModule, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetWarnTimeout, saveAnalyticsEvent, selectClientAndViewIds, selectCommandProgress, selectCommandsInProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsLoaderScreenVisible, selectIsShowPopupWithoutAutoStart, selectIsVideoPlayingAndDataChannelConnected, selectLastCommandInProgress, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setDataChannelConnected, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setKalmanSettings, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setViewportNotReady, setViewportReady, showUnrealErrorMessage, smoothTransition, startStream, trackMixpanelEvent, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
 export type { AggregatedStat, AnySignalingMessage, AwsInstance, CandidateMessage, CloseReason, ConfigMessage, ConnectionError, ControlSchemeValues, DataFlowCheckResult, DisconnectReasonType, ForceClientDisconnect, FreezeFrameMessage, InboundVideoStats, InputProps, InstanceReady, InstanceReserved, InterruptClientStream, LBMStats, ListStreamersMessage, MessageBase, MessageTypeValues, NormalizeAndQuantizeSignedValue, NormalizeAndQuantizeUnsignedValue, OrchestrationErrorMessage, OrchestrationMessageType, P2PEstablishedMessage, PingMessage, PlayerCountMessage, PollingOrchestrationMessage, Quality, ReceivedFile, ReconnectConfig, RequestStream, SSInfo, SignalingData, SignalingMessageHandler, SignalingMessageMap, StreamConfig, StreamRequestContext, StreamResolutionProps, StreamerListMessage, TelemetryType, UnknownFields, UnquantizeAndDenormalizeUnsignedValue, UnrealCallbackDescriptor, UnrealCallbackEventMap, UnrealCallbackJson, UnrealCallbackJsonWrapped, UnrealCommandsState, UnrealInitialConfig, UnrealState, WSCloseCodesValues, streamPreparedForUserInteractionMessage };