@arcware-cloud/pixelstreaming-websdk 0.1.0-beta → 0.1.2

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.0-beta",
+  "version": "0.1.2",
   "type": "commonjs",
   "main": "./index.umd.js",
   "module": "./index.umd.js",

package/types/lib/ArcwareApplication.d.ts

@@ -15,13 +15,31 @@ export declare class ArcwareApplication extends Application {
     constructor(options: UIOptions & {
         stream: ArcwarePixelStreaming;
     });
+    /** Set's and resets hidden state of "additional" UI Elements.
+     * For example buttons or connection icon.
+     * These will fade in through css animation upon the videoInitialized event.
+     * At this point in time the streamInfo is already processed.
+     */
+    private uiElementsVisibility;
     private adjustSettingsPanel;
     private createAudioToggleButton;
     private createMicToggleButton;
+    private createStopButton;
     private uiDefaultButtonVisibilty;
     private autoPlayHandler;
+    /** Request a response from you UE Application.
+     * The returned response depends on the implementation of your UE Application.
+     * It can be used to request information from the application, such as:
+     * - a state to update your custom ui
+     * - get the url to the pdf it uploaded to some remote service of yours
+     * - the id of the save-game
+     * .. anything else you could imagine.
+     */
     getApplicationResponse(callback: (response: string) => void): void;
     applicationResponse(response: string): void;
     private applyArcwareStyles;
+    /** Emit an event towards the UE Application.
+     * Mainly used to bubble events like a button press or other command inputs towards the UE Application.
+     */
     emitUIInteraction(descriptor: object | string): void;
 }

package/types/lib/ArcwareConfig.d.ts

@@ -2,6 +2,8 @@ import { Config } from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2";
 import { ConfigParams } from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2/types/Config/Config";
 import { Session } from "./domain/Session";
 import { Settings } from "./domain/ArcwareSettingsSchema";
+/** Default arcware signalling endpoint. */
+export declare const DefaultUrl: "wss://signalling-client.ragnarok.arcware.cloud";
 export interface ArcwareConfigParams extends ConfigParams {
     settings: Settings;
 }
@@ -25,7 +27,7 @@ export declare class ArcwareConfig extends Config {
     readonly session: Session;
     readonly settings: Settings;
     private _initialSettings;
-    readonly VERSION = "0.0.0";
+    readonly VERSION = "0.1.2";
     constructor(config: ArcwareConfigParams);
     /** Setup connection string. */
     get urlFlags(): string;

package/types/lib/ArcwareInit.d.ts

@@ -0,0 +1,15 @@
+import { ArcwareConfig, ArcwareConfigParams } from "./ArcwareConfig";
+import { ArcwarePixelStreaming } from "./ArcwarePixelStreaming";
+import { ArcwareApplication } from "./ArcwareApplication";
+type DeepPartial<T> = T extends Function ? T : T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+export declare function ArcwareInit({ shareId, projectId }: {
+    shareId?: string;
+    projectId?: string;
+}, configuration?: DeepPartial<ArcwareConfigParams>): {
+    Config: ArcwareConfig;
+    PixelStreaming: ArcwarePixelStreaming;
+    Application: ArcwareApplication;
+};
+export {};

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -4,6 +4,7 @@ import { PixelStreamingOverrides } from "@epicgames-ps/lib-pixelstreamingfronten
 import { ArcwareConfig } from "./ArcwareConfig";
 import { EventHandler } from "./domain/EventHandler";
 import { Session } from "./domain/Session";
+import { WebsocketState } from "./domain/ConnectionIdentifier";
 export declare class ArcwarePixelStreaming extends PixelStreaming {
     /** Override default config with ArcwareConfig. */
     config: ArcwareConfig;
@@ -14,7 +15,12 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
     private loveLettersQueue;
     private isProcessingQueue;
     private microphoneOverlay;
-    get videoStartTime(): number | undefined;
+    /** Returns a list of WebSocketStates of all PixelStreaming Instances generated. */
+    get WebsocketStates(): WebsocketState[];
+    /** Counts all active PixelStreaming Instances generated. (CONNECTING & CONNECTED) */
+    get ActiveInstances(): () => number;
+    /** Returns this PixelStreaming Instances websocket state. */
+    get websocketState(): WebsocketState;
     constructor(config: ArcwareConfig, overrides?: PixelStreamingOverrides);
     /** Getter for the session object. */
     get session(): Session;
@@ -23,6 +29,8 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
      *  Listen   *
      * * * * * * *
      */
+    /** On version requested, the version of the WebSDK would be returned. */
+    private onVersion;
     /** On ping the session creation timestamp will be updated. */
     private onPing;
     /** Handle incoming configurations. */
@@ -62,6 +70,8 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
     /** VideoInitialized */
     readonly videoInitializedHandler: EventHandler<never>;
     private onVideoInitialized;
+    /** WebSocket Close */
+    readonly websocketOnCloseHandler: EventHandler<CloseEvent>;
     /** Adding a zod-safe handler. */
     private addMessageHandler;
     /**
@@ -76,9 +86,10 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
     private handleMouseLock;
     private initLoveLettersContainer;
     private pushLetter;
-    private processQueue;
+    private processLoveLetterQueue;
     private handleRemoveLoveLetters;
     toggleAudio(videoElement: HTMLVideoElement, enabled: boolean): void;
     private createMicrophoneOverlay;
     toggleMic(enable: boolean, isDefault: boolean): void;
+    private wrapWebSocketOnCloseHandler;
 }

package/types/lib/MessageTypes.d.ts

@@ -0,0 +1,4 @@
+import { Messages } from "@arcware-cloud/shared-pixelstreaming-websdk";
+export type ErrorMessage = Messages.ErrorMessage;
+export type Queue = Messages.Queue;
+export type LoveLetter = Messages.LoveLetter;

package/types/lib/domain/ArcwareSettingsSchema.d.ts

@@ -38,11 +38,10 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
             valueType: z.ZodEnum<["milliseconds", "seconds", "minutes", "hours", "days"]>;
         }, "strip", z.ZodTypeAny, {
             valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            /** Show or hide the settings button. */
             index?: number | undefined;
             queueLength?: number | undefined;
             waited?: number | undefined;
-            estimatedWaitTime?: number | undefined; /** Show or hide the audio button. */
+            estimatedWaitTime?: number | undefined;
             averageWaitTime?: number | undefined;
         }, {
             valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
@@ -51,7 +50,7 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
             waited?: number | undefined;
             estimatedWaitTime?: number | undefined;
             averageWaitTime?: number | undefined;
-        }>;
+        }>; /** Show or hide the connectionStrengthIcon button. */
     }, "strip", z.ZodTypeAny, {
         type: "queue";
         queue: {
@@ -75,7 +74,8 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
     }>], z.ZodUnknown>, z.ZodVoid>>;
     /** Handler for sessionId message. */
     sessionIdHandler: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
-    /** Handler for love letters. */
+    /** Handler for love letters.
+     * "LoveLetters" are send from backend to the SDK to state what phase the connection currently is in. */
     loveLetterHandler: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
         type: z.ZodLiteral<"letter">;
         reason: z.ZodString;
@@ -102,11 +102,20 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
     audioButton: z.ZodOptional<z.ZodBoolean>;
     /** Show or hide the microphone button. */
     micButton: z.ZodOptional<z.ZodBoolean>;
+    /** Show or hide the microphone button. */
+    stopButton: z.ZodOptional<z.ZodBoolean>;
     /** Show or hide the connectionStrengthIcon button. */
     connectionStrengthIcon: z.ZodOptional<z.ZodBoolean>;
+    /** ShareId, used for sharing your project.
+     * Using ArcwareInit will set this required property for you. */
     shareId: z.ZodOptional<z.ZodString>;
+    /** Id of your project, only required if your shareId refers to multiple projects.
+     * Using ArcwareInit will set this required property for you. */
     projectId: z.ZodOptional<z.ZodString>;
+    /** Enable/Disable LoveLetter logging to the console. */
     loveLetterLogging: z.ZodOptional<z.ZodBoolean>;
+    /** Enable/Disable Connection Identifier logging to the console. */
+    connectionIdentifierLoggingDisabled: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     session?: string | undefined;
     token?: string | undefined;
@@ -140,10 +149,12 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
     infoButton?: boolean | undefined;
     audioButton?: boolean | undefined;
     micButton?: boolean | undefined;
+    stopButton?: boolean | undefined;
     connectionStrengthIcon?: boolean | undefined;
     shareId?: string | undefined;
     projectId?: string | undefined;
     loveLetterLogging?: boolean | undefined;
+    connectionIdentifierLoggingDisabled?: boolean | undefined;
 }, {
     session?: string | undefined;
     token?: string | undefined;
@@ -177,9 +188,11 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
     infoButton?: boolean | undefined;
     audioButton?: boolean | undefined;
     micButton?: boolean | undefined;
+    stopButton?: boolean | undefined;
     connectionStrengthIcon?: boolean | undefined;
     shareId?: string | undefined;
     projectId?: string | undefined;
     loveLetterLogging?: boolean | undefined;
+    connectionIdentifierLoggingDisabled?: boolean | undefined;
 }>;
 export type Settings = z.infer<typeof ArcwareSettingsSchema>;

package/types/lib/domain/ConnectionIdentifier.d.ts

@@ -0,0 +1,27 @@
+import { ArcwarePixelStreaming } from "../ArcwarePixelStreaming";
+export declare enum WebsocketState {
+    CONNECTING = 0,
+    OPEN = 1,
+    CLOSING = 2,
+    CLOSED = 3
+}
+export declare class ConnectionIdentifier {
+    private static instance;
+    static get Instance(): ConnectionIdentifier;
+    private interval;
+    private aps;
+    get WebsocketStates(): WebsocketState[];
+    private constructor();
+    register(ps: ArcwarePixelStreaming): void;
+    GetWebSocketStates(): WebsocketState[];
+    ActiveInstances(): number;
+    private enabled;
+    disable(): void;
+    /**
+     * The purpose of this method is to periodically tell the developer the amount of connected instances.
+     * This way the developer can figure out, when they messed up the implementation and there's shadow instances still running.
+     * Or when they accidentally set up multiple connections!
+     * Things like that can happen, for example if the React.useEffect was not setup perfectly!
+     */
+    private connectionWatcher;
+}

package/types/lib/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./ArcwareApplication";
 export * from "./ArcwareConfig";
 export * from "./ArcwarePixelStreaming";
+export * from "./ArcwareInit";
+export type * from "./MessageTypes";
 export * from "./styles/ArcwarePixelStreamingApplicationStyles";

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

@@ -47,6 +47,16 @@ export declare const ArcwareStyles: {
             transition: string;
             background: string;
         };
+        "#playerUI, #videoElementParent": {
+            position: string;
+            width: string;
+            height: string;
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+            margin: string;
+        };
         "#uiFeatures #controls": {
             top: string;
             left: string;
@@ -384,5 +394,14 @@ export declare const ArcwareStyles: {
                 scale: number;
             };
         };
+        ".hidden": {
+            display: string;
+            opacity: number;
+        };
+        ".visible": {
+            display: string;
+            opacity: number;
+            transition: string;
+        };
     };
 };

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

@@ -0,0 +1,12 @@
+import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+export declare class StopButton {
+    private button;
+    private stream;
+    private stopIcon;
+    private tooltipText;
+    constructor(stream: ArcwarePixelStreaming);
+    private createButton;
+    private createTooltipText;
+    private stop;
+    get element(): HTMLButtonElement;
+}

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

@@ -0,0 +1,5 @@
+export declare class StopIcon {
+    stopIcon: SVGElement;
+    constructor();
+    private createStopIcon;
+}

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

@@ -37,6 +37,116 @@ export declare const ZStreamInfo: z.ZodObject<{
             version?: string | undefined;
             mouseLock?: boolean | undefined;
         }>>;
+        webSdkSettings: z.ZodOptional<z.ZodObject<{
+            conf: z.ZodOptional<z.ZodObject<{
+                fullscreenButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                stopButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                audioButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                infoButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                micButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                settingsButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                connectionStrengthIcon: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, "strip", z.ZodTypeAny, {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            }, {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            }>>;
+            init: z.ZodOptional<z.ZodObject<{
+                KeyboardInput: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                MouseInput: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+                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?: {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            } | undefined;
+            init?: {
+                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;
+            } | undefined;
+        }, {
+            conf?: {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            } | undefined;
+            init?: {
+                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;
+            } | undefined;
+        }>>;
         afk: z.ZodOptional<z.ZodObject<{
             enabled: z.ZodBoolean;
             warn: z.ZodNumber;
@@ -69,6 +179,30 @@ export declare const ZStreamInfo: z.ZodObject<{
             version?: string | undefined;
             mouseLock?: boolean | undefined;
         } | undefined;
+        webSdkSettings?: {
+            conf?: {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            } | undefined;
+            init?: {
+                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;
+            } | undefined;
+        } | undefined;
         afk?: {
             error: number;
             enabled: boolean;
@@ -91,6 +225,30 @@ export declare const ZStreamInfo: z.ZodObject<{
             version?: string | undefined;
             mouseLock?: boolean | undefined;
         } | undefined;
+        webSdkSettings?: {
+            conf?: {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            } | undefined;
+            init?: {
+                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;
+            } | undefined;
+        } | undefined;
         afk?: {
             error: number;
             enabled: boolean;
@@ -116,6 +274,30 @@ export declare const ZStreamInfo: z.ZodObject<{
             version?: string | undefined;
             mouseLock?: boolean | undefined;
         } | undefined;
+        webSdkSettings?: {
+            conf?: {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            } | undefined;
+            init?: {
+                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;
+            } | undefined;
+        } | undefined;
         afk?: {
             error: number;
             enabled: boolean;
@@ -141,6 +323,30 @@ export declare const ZStreamInfo: z.ZodObject<{
             version?: string | undefined;
             mouseLock?: boolean | undefined;
         } | undefined;
+        webSdkSettings?: {
+            conf?: {
+                fullscreenButton?: boolean | undefined;
+                stopButton?: boolean | undefined;
+                audioButton?: boolean | undefined;
+                infoButton?: boolean | undefined;
+                micButton?: boolean | undefined;
+                settingsButton?: boolean | undefined;
+                connectionStrengthIcon?: boolean | undefined;
+            } | undefined;
+            init?: {
+                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;
+            } | undefined;
+        } | undefined;
         afk?: {
             error: number;
             enabled: boolean;

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

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const ZVersion: z.ZodObject<{
+    type: z.ZodLiteral<"version">;
+    version: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "version";
+    version?: string | undefined;
+}, {
+    type: "version";
+    version?: string | undefined;
+}>;
+export type Version = z.infer<typeof ZVersion>;

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

@@ -0,0 +1,111 @@
+import { z } from "zod";
+export declare const WebSdkSettings: z.ZodObject<{
+    conf: z.ZodOptional<z.ZodObject<{
+        fullscreenButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        stopButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        audioButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        infoButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        micButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        settingsButton: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        connectionStrengthIcon: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        fullscreenButton?: boolean | undefined;
+        stopButton?: boolean | undefined;
+        audioButton?: boolean | undefined;
+        infoButton?: boolean | undefined;
+        micButton?: boolean | undefined;
+        settingsButton?: boolean | undefined;
+        connectionStrengthIcon?: boolean | undefined;
+    }, {
+        fullscreenButton?: boolean | undefined;
+        stopButton?: boolean | undefined;
+        audioButton?: boolean | undefined;
+        infoButton?: boolean | undefined;
+        micButton?: boolean | undefined;
+        settingsButton?: boolean | undefined;
+        connectionStrengthIcon?: boolean | undefined;
+    }>>;
+    init: z.ZodOptional<z.ZodObject<{
+        KeyboardInput: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        MouseInput: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        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?: {
+        fullscreenButton?: boolean | undefined;
+        stopButton?: boolean | undefined;
+        audioButton?: boolean | undefined;
+        infoButton?: boolean | undefined;
+        micButton?: boolean | undefined;
+        settingsButton?: boolean | undefined;
+        connectionStrengthIcon?: boolean | undefined;
+    } | undefined;
+    init?: {
+        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;
+    } | undefined;
+}, {
+    conf?: {
+        fullscreenButton?: boolean | undefined;
+        stopButton?: boolean | undefined;
+        audioButton?: boolean | undefined;
+        infoButton?: boolean | undefined;
+        micButton?: boolean | undefined;
+        settingsButton?: boolean | undefined;
+        connectionStrengthIcon?: boolean | undefined;
+    } | undefined;
+    init?: {
+        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;
+    } | undefined;
+}>;