@arcware-cloud/pixelstreaming-websdk 0.1.7 → 0.1.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arcware-cloud/pixelstreaming-websdk",
   "description": "WebSDK for easy implementation of pixel streaming with Arcware CloudRT Services. Heavily based on the '@epicgames-ps' library.",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "type": "commonjs",
   "main": "./index.umd.js",
   "module": "./index.umd.js",
@@ -26,7 +26,7 @@
     "lodash": "4.17.21",
     "lottie-web": "5.10.2",
     "moment": "2.29.4",
-    "zod": "3.21.4"
+    "zod": "3.22.4"
   },
   "cjs": "./index.cjs.js"
 }

package/types/lib/ArcwareConfig.d.ts

@@ -27,7 +27,7 @@ export declare class ArcwareConfig extends Config {
     readonly session: Session;
     readonly settings: Settings;
     private _initialSettings;
-    readonly VERSION = "0.1.7";
+    readonly VERSION = "0.1.9";
     constructor(config: ArcwareConfigParams);
     /** Setup connection string. */
     get urlFlags(): string;

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -93,4 +93,7 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
     private createMicrophoneOverlay;
     toggleMic(enable: boolean, isDefault: boolean): void;
     private wrapWebSocketOnCloseHandler;
+    onStreamingStateChange(callback: (isStreaming: boolean) => void): void;
+    private removeXRIconIfDisabled;
+    private injectCustomUI;
 }

package/types/lib/styles/ArcwarePixelStreamingApplicationStyles.d.ts

@@ -20,6 +20,9 @@ export declare const ArcwareStyles: {
         "*": {
             fontFamily: string;
         };
+        "#shared-stream-container": {
+            boxSizing: string;
+        };
         "#shared-stream-container::-webkit-scrollbar": {
             width: string;
         };
@@ -51,11 +54,21 @@ export declare const ArcwareStyles: {
             position: string;
             width: string;
             height: string;
+            maxWidth: string;
+            maxHeight: string;
             top: number;
             right: number;
             bottom: number;
             left: number;
             margin: string;
+            boxSizing: string;
+            pointerEvents: string;
+        };
+        "#streamingVideo": {
+            maxWidth: string;
+            maxHeight: string;
+            boxSizing: string;
+            background: string;
         };
         "#uiFeatures #controls": {
             top: string;
@@ -100,6 +113,10 @@ export declare const ArcwareStyles: {
             width: string;
             height: string;
         };
+        "#stopIcon, #playIcon": {
+            width: string;
+            height: string;
+        };
         "#uiFeatures button .tooltiptext": {
             right: string;
             left: string;
@@ -115,6 +132,10 @@ export declare const ArcwareStyles: {
             padding: string;
             backgroundColor: string;
         };
+        "#uiFeatures #settingsIcon, #uiFeatures #statsIcon": {
+            width: string;
+            height: string;
+        };
         ".svgIcon": {
             fill: string;
         };
@@ -373,10 +394,20 @@ export declare const ArcwareStyles: {
             textTransform: string;
             textAlign: string;
         };
-        "#letters-block p": {
+        "#letters-wrapper": {
+            height: string;
+            overflow: string;
+            position: string;
+            display: string;
+            flexDirection: string;
+            alignItems: string;
+            justifyContent: string;
+            marginTop: string;
+            paddingBottom: string;
+        };
+        "#letters-wrapper p": {
             textAlign: string;
             lineHeight: number;
-            margin: string;
             fontSize: string;
         };
         ".letter-animation:nth-last-of-type(1)::after": {
@@ -388,6 +419,7 @@ export declare const ArcwareStyles: {
         ".letter-animation": {
             transition: string;
             transformOrigin: string;
+            margin: string;
         };
         ".letter-animation-enter": {
             animation: string;
@@ -396,6 +428,7 @@ export declare const ArcwareStyles: {
             opacity: number;
             scale: number;
             transition: string;
+            margin: number;
         };
         "@keyframes dotty": {
             "0%": {

package/types/lib/ui/PlayIcon/index.d.ts

@@ -0,0 +1,5 @@
+export declare class PlayIcon {
+    playIcon: SVGElement;
+    constructor();
+    private createPlayIcon;
+}

package/types/lib/ui/StopButton/index.d.ts

@@ -3,10 +3,14 @@ export declare class StopButton {
     private button;
     private stream;
     private stopIcon;
+    private playIcon;
     private tooltipText;
+    private isStreaming;
     constructor(stream: ArcwarePixelStreaming);
     private createButton;
     private createTooltipText;
-    private stop;
+    private toggleStreaming;
+    private updateButtonIcon;
     get element(): HTMLButtonElement;
+    private updateButtonState;
 }

package/types/shared/lib/Messages/StreamInfo.d.ts

@@ -23,19 +23,25 @@ export declare const ZStreamInfo: z.ZodObject<{
         }>>;
         meta: z.ZodOptional<z.ZodObject<{
             friendlyName: z.ZodOptional<z.ZodString>;
+            isTrial: z.ZodOptional<z.ZodBoolean>;
+            mouseLock: z.ZodOptional<z.ZodBoolean>;
+            poweredBy: z.ZodOptional<z.ZodBoolean>;
             ueVersion: z.ZodOptional<z.ZodString>;
             version: z.ZodOptional<z.ZodString>;
-            mouseLock: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
             friendlyName?: string | undefined;
+            isTrial?: boolean | undefined;
+            mouseLock?: boolean | undefined;
+            poweredBy?: boolean | undefined;
             ueVersion?: string | undefined;
             version?: string | undefined;
-            mouseLock?: boolean | undefined;
         }, {
             friendlyName?: string | undefined;
+            isTrial?: boolean | undefined;
+            mouseLock?: boolean | undefined;
+            poweredBy?: boolean | undefined;
             ueVersion?: string | undefined;
             version?: string | undefined;
-            mouseLock?: boolean | undefined;
         }>>;
         webSdkSettings: z.ZodOptional<z.ZodObject<{
             conf: z.ZodOptional<z.ZodObject<{
@@ -69,36 +75,27 @@ export declare const ZStreamInfo: z.ZodObject<{
                 GamepadInput: z.ZodOptional<z.ZodBoolean>;
                 TouchInput: z.ZodOptional<z.ZodBoolean>;
                 XRControllerInput: z.ZodOptional<z.ZodBoolean>;
-                UseMic: z.ZodOptional<z.ZodBoolean>;
                 FakeMouseWithTouches: z.ZodOptional<z.ZodBoolean>;
                 ForceMonoAudio: z.ZodOptional<z.ZodBoolean>;
                 HoveringMouse: z.ZodOptional<z.ZodBoolean>;
-                MatchViewportRes: z.ZodOptional<z.ZodBoolean>;
-                SuppressBrowserKeys: z.ZodOptional<z.ZodBoolean>;
             }, "strip", z.ZodTypeAny, {
                 KeyboardInput?: boolean | undefined;
                 MouseInput?: boolean | undefined;
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             }, {
                 KeyboardInput?: boolean | undefined;
                 MouseInput?: boolean | undefined;
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             }>>;
         }, "strict", z.ZodTypeAny, {
             conf?: {
@@ -116,12 +113,9 @@ export declare const ZStreamInfo: z.ZodObject<{
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             } | undefined;
         }, {
             conf?: {
@@ -139,12 +133,9 @@ export declare const ZStreamInfo: z.ZodObject<{
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             } | undefined;
         }>>;
         afk: z.ZodOptional<z.ZodObject<{
@@ -175,9 +166,11 @@ export declare const ZStreamInfo: z.ZodObject<{
         } | undefined;
         meta?: {
             friendlyName?: string | undefined;
+            isTrial?: boolean | undefined;
+            mouseLock?: boolean | undefined;
+            poweredBy?: boolean | undefined;
             ueVersion?: string | undefined;
             version?: string | undefined;
-            mouseLock?: boolean | undefined;
         } | undefined;
         webSdkSettings?: {
             conf?: {
@@ -195,12 +188,9 @@ export declare const ZStreamInfo: z.ZodObject<{
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             } | undefined;
         } | undefined;
         afk?: {
@@ -221,9 +211,11 @@ export declare const ZStreamInfo: z.ZodObject<{
         } | undefined;
         meta?: {
             friendlyName?: string | undefined;
+            isTrial?: boolean | undefined;
+            mouseLock?: boolean | undefined;
+            poweredBy?: boolean | undefined;
             ueVersion?: string | undefined;
             version?: string | undefined;
-            mouseLock?: boolean | undefined;
         } | undefined;
         webSdkSettings?: {
             conf?: {
@@ -241,12 +233,9 @@ export declare const ZStreamInfo: z.ZodObject<{
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             } | undefined;
         } | undefined;
         afk?: {
@@ -270,9 +259,11 @@ export declare const ZStreamInfo: z.ZodObject<{
         } | undefined;
         meta?: {
             friendlyName?: string | undefined;
+            isTrial?: boolean | undefined;
+            mouseLock?: boolean | undefined;
+            poweredBy?: boolean | undefined;
             ueVersion?: string | undefined;
             version?: string | undefined;
-            mouseLock?: boolean | undefined;
         } | undefined;
         webSdkSettings?: {
             conf?: {
@@ -290,12 +281,9 @@ export declare const ZStreamInfo: z.ZodObject<{
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             } | undefined;
         } | undefined;
         afk?: {
@@ -319,9 +307,11 @@ export declare const ZStreamInfo: z.ZodObject<{
         } | undefined;
         meta?: {
             friendlyName?: string | undefined;
+            isTrial?: boolean | undefined;
+            mouseLock?: boolean | undefined;
+            poweredBy?: boolean | undefined;
             ueVersion?: string | undefined;
             version?: string | undefined;
-            mouseLock?: boolean | undefined;
         } | undefined;
         webSdkSettings?: {
             conf?: {
@@ -339,12 +329,9 @@ export declare const ZStreamInfo: z.ZodObject<{
                 GamepadInput?: boolean | undefined;
                 TouchInput?: boolean | undefined;
                 XRControllerInput?: boolean | undefined;
-                UseMic?: boolean | undefined;
                 FakeMouseWithTouches?: boolean | undefined;
                 ForceMonoAudio?: boolean | undefined;
                 HoveringMouse?: boolean | undefined;
-                MatchViewportRes?: boolean | undefined;
-                SuppressBrowserKeys?: boolean | undefined;
             } | undefined;
         } | undefined;
         afk?: {

package/types/shared/lib/Messages/WebSdkSettings.d.ts

@@ -31,36 +31,27 @@ export declare const WebSdkSettings: z.ZodObject<{
         GamepadInput: z.ZodOptional<z.ZodBoolean>;
         TouchInput: z.ZodOptional<z.ZodBoolean>;
         XRControllerInput: z.ZodOptional<z.ZodBoolean>;
-        UseMic: z.ZodOptional<z.ZodBoolean>;
         FakeMouseWithTouches: z.ZodOptional<z.ZodBoolean>;
         ForceMonoAudio: z.ZodOptional<z.ZodBoolean>;
         HoveringMouse: z.ZodOptional<z.ZodBoolean>;
-        MatchViewportRes: z.ZodOptional<z.ZodBoolean>;
-        SuppressBrowserKeys: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         KeyboardInput?: boolean | undefined;
         MouseInput?: boolean | undefined;
         GamepadInput?: boolean | undefined;
         TouchInput?: boolean | undefined;
         XRControllerInput?: boolean | undefined;
-        UseMic?: boolean | undefined;
         FakeMouseWithTouches?: boolean | undefined;
         ForceMonoAudio?: boolean | undefined;
         HoveringMouse?: boolean | undefined;
-        MatchViewportRes?: boolean | undefined;
-        SuppressBrowserKeys?: boolean | undefined;
     }, {
         KeyboardInput?: boolean | undefined;
         MouseInput?: boolean | undefined;
         GamepadInput?: boolean | undefined;
         TouchInput?: boolean | undefined;
         XRControllerInput?: boolean | undefined;
-        UseMic?: boolean | undefined;
         FakeMouseWithTouches?: boolean | undefined;
         ForceMonoAudio?: boolean | undefined;
         HoveringMouse?: boolean | undefined;
-        MatchViewportRes?: boolean | undefined;
-        SuppressBrowserKeys?: boolean | undefined;
     }>>;
 }, "strict", z.ZodTypeAny, {
     conf?: {
@@ -78,12 +69,9 @@ export declare const WebSdkSettings: z.ZodObject<{
         GamepadInput?: boolean | undefined;
         TouchInput?: boolean | undefined;
         XRControllerInput?: boolean | undefined;
-        UseMic?: boolean | undefined;
         FakeMouseWithTouches?: boolean | undefined;
         ForceMonoAudio?: boolean | undefined;
         HoveringMouse?: boolean | undefined;
-        MatchViewportRes?: boolean | undefined;
-        SuppressBrowserKeys?: boolean | undefined;
     } | undefined;
 }, {
     conf?: {
@@ -101,11 +89,8 @@ export declare const WebSdkSettings: z.ZodObject<{
         GamepadInput?: boolean | undefined;
         TouchInput?: boolean | undefined;
         XRControllerInput?: boolean | undefined;
-        UseMic?: boolean | undefined;
         FakeMouseWithTouches?: boolean | undefined;
         ForceMonoAudio?: boolean | undefined;
         HoveringMouse?: boolean | undefined;
-        MatchViewportRes?: boolean | undefined;
-        SuppressBrowserKeys?: boolean | undefined;
     } | undefined;
 }>;