@arcware-cloud/pixelstreaming-websdk 0.1.0-beta

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

@@ -0,0 +1,388 @@
+export declare const ArcwareStyles: {
+    customStyles: {
+        ":root": {
+            "--color0": string;
+            "--color1": string;
+            "--color2": string;
+            "--color3": string;
+            "--color4": string;
+            "--color5": string;
+            "--color6": string;
+            "--color7": string;
+            "--color8": string;
+            "--color9": string;
+            "--color10": string;
+            "--color11": string;
+            "--color12": string;
+            "--color13": string;
+            "--colorBoxShadow": string;
+        };
+        "*": {
+            fontFamily: string;
+        };
+        "::-webkit-scrollbar": {
+            width: string;
+        };
+        "::-webkit-scrollbar-track": {
+            background: string;
+            opacity: string;
+            borderRadius: string;
+            borderTop: string;
+            borderRight: string;
+            borderBottom: string;
+            borderLeft: string;
+        };
+        "::-webkit-scrollbar-track-piece": {
+            background: string;
+        };
+        "::-webkit-scrollbar-thumb": {
+            background: string;
+            width: string;
+            borderRight: string;
+            borderLeft: string;
+            transition: string;
+            borderRadius: string;
+        };
+        "::-webkit-scrollbar-thumb:hover": {
+            transition: string;
+            background: string;
+        };
+        "#uiFeatures #controls": {
+            top: string;
+            left: string;
+            bottom: string;
+            right: string;
+            display: string;
+            flexDirection: string;
+        };
+        "#uiFeatures #connection": {
+            bottom: string;
+            left: string;
+            width: string;
+            heihgt: string;
+        };
+        "#uiFeatures button": {
+            backgroundColor: string;
+            border: string;
+            position: string;
+            width: string;
+            height: string;
+            padding: string;
+            textAlign: string;
+            cursor: string;
+            display: string;
+            flexDirection: string;
+            justifyContent: string;
+            alignItems: string;
+            boxShadow: string;
+            borderRadius: string;
+            outline: string;
+        };
+        "#uiFeatures button:hover, #uiFeatures button:active": {
+            padding: string;
+            border: string;
+        };
+        "#uiFeatures button #audioIconMuted, #uiFeatures button #audioIconUnmuted, #uiFeatures button #micIconMuted, #uiFeatures button #micIconUnmuted": {
+            width: string;
+            height: string;
+        };
+        "#uiFeatures button #maximizeIcon, #uiFeatures button #minimizeIcon": {
+            width: string;
+            height: string;
+        };
+        "#uiFeatures button .tooltiptext": {
+            right: string;
+            left: string;
+            boxShadow: string;
+            borderRadius: string;
+            backgroundColor: string;
+            width: string;
+        };
+        "#controls>*": {
+            marginBottom: string;
+            display: string;
+            lineHeight: string;
+            padding: string;
+            backgroundColor: string;
+        };
+        ".svgIcon": {
+            fill: string;
+        };
+        "#uiFeatures button:hover .svgIcon, #uiFeatures button:active .svgIcon": {
+            fill: string;
+        };
+        ".tgl-switch .tgl-slider, .tgl-flat:checked+.tgl-slider": {
+            border: string;
+        };
+        ".tgl-switch .tgl-slider": {
+            background: string;
+        };
+        ".tgl-switch .tgl-slider::before": {
+            content: string;
+            display: string;
+            background: string;
+            position: string;
+            height: string;
+            width: string;
+            borderRadius: string;
+            margin: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+        };
+        ".tgl-switch .tgl-slider::after": {
+            height: string;
+            width: string;
+            borderRadius: string;
+            top: string;
+            left: string;
+        };
+        ".tgl-flat:checked+.tgl-slider:after": {
+            left: string;
+            background: string;
+        };
+        ".form-control": {
+            backgroundColor: string;
+            border: string;
+            borderRadius: string;
+            color: string;
+            textAlign: string;
+            fontFamily: string;
+            padding: string;
+        };
+        ".btn-flat": {
+            background: string;
+            color: string;
+            border: string;
+            padding: string;
+            cursor: string;
+            borderRadius: string;
+            textTransform: string;
+            minWidth: string;
+        };
+        ".btn-flat:disabled": {
+            background: string;
+            borderColor: string;
+            color: string;
+            cursor: string;
+        };
+        ".btn-flat:focus": {
+            outline: string;
+        };
+        ".arcware-logo-loader": {
+            position: string;
+            display: string;
+            width: string;
+            height: string;
+        };
+        "#playOverlay img#playButton": {
+            width: string;
+        };
+        "#disconnectOverlay, #errorOverlay": {
+            textTransform: string;
+            textAlign: string;
+            fontSize: string;
+            lineHeight: number;
+        };
+        "#disconnectOverlay .clickableState": {
+            textTransform: string;
+            textAlign: string;
+            color: string;
+            padding: string;
+            fontSize: string;
+            border: string;
+            margin: string;
+            width: string;
+        };
+        "#afkOverlay": {
+            background: string;
+            transition: string;
+            opacity: number;
+            pointerEvents: string;
+        };
+        "#afkOverlayInner": {
+            textTransform: string;
+            background: string;
+            padding: string;
+            fontSize: string;
+            width: string;
+            textAlign: string;
+            lineHeight: number;
+        };
+        "#afkOverlayInner center::first-line": {
+            textTransform: string;
+            color: string;
+            fontWeight: string;
+            fontSize: string;
+        };
+        "#afkOverlayInner #afkCountDownNumber": {
+            color: string;
+            fontSize: string;
+            lineHeight: string;
+        };
+        "#afkOverlayInner center .retry-button": {
+            textTransform: string;
+            textAlign: string;
+            color: string;
+            padding: string;
+            fontSize: string;
+            border: string;
+            margin: string;
+            width: string;
+        };
+        "#infoOverlay.hiddenState": {
+            display: string;
+        };
+        "#disconnectOverlay, #playOverlay, #errorOverlay, #microphoneOverlay": {
+            background: string;
+            display: string;
+            transition: string;
+            opacity: number;
+            pointerEvents: string;
+        };
+        "#microphoneOverlay": {
+            textTransform: string;
+            padding: string;
+            fontSize: string;
+            height: string;
+            width: string;
+            textAlign: string;
+            lineHeight: number;
+            position: string;
+            margin: string;
+            top: string;
+            bottom: string;
+            left: string;
+            right: string;
+            justifyContent: string;
+            alignItems: string;
+            flexDirection: string;
+            zIndex: number;
+        };
+        "#microphoneOverlay .title": {
+            fontSize: string;
+            position: string;
+            marginBottom: string;
+            color: string;
+        };
+        "#microphoneOverlay .title:after": {
+            content: string;
+            display: string;
+            animation: string;
+            position: string;
+        };
+        "#microphoneOverlay p": {
+            margin: number;
+            color: string;
+        };
+        "#microphoneOverlay svg": {
+            height: string;
+            marginBottom: string;
+            marginTop: string;
+        };
+        "#microphoneOverlay .svgIcon": {
+            fill: string;
+        };
+        "#disconnectOverlay.hiddenState, #playOverlay.hiddenState, #errorOverlay.hiddenState, #afkOverlay.hiddenState, #microphoneOverlay.hiddenState": {
+            opacity: number;
+            pointerEvents: string;
+        };
+        "#disconnectOverlay.mic-overlay-is-visible, #errorOverlay.mic-overlay-is-visible, #infoOverlay.mic-overlay-is-visible": {
+            opacity: number;
+            pointerEvents: string;
+        };
+        "#infoOverlay.hiddenState, #connectOverlay.hiddenState": {
+            display: string;
+        };
+        "#infoOverlay": {
+            display: string;
+        };
+        ".love-letters-box-root": {
+            display: string;
+            position: string;
+            width: string;
+            height: string;
+            color: string;
+            justifyContent: string;
+            alignItems: string;
+            flexDirection: string;
+            background: string;
+            zIndex: number;
+        };
+        ".love-letters-box-root.fade-out": {
+            opacity: number;
+            transition: string;
+        };
+        "#letters-block": {
+            position: string;
+            top: number;
+            left: number;
+            right: number;
+            bottom: number;
+            margin: string;
+            color: string;
+            zIndex: number;
+            display: string;
+            flexDirection: string;
+            justifyContent: string;
+            alignItems: string;
+            fontSize: string;
+            textTransform: string;
+            textAlign: string;
+        };
+        "#letters-block p": {
+            textAlign: string;
+            lineHeight: number;
+            margin: string;
+            fontSize: string;
+        };
+        ".letter-animation:nth-last-of-type(1)::after": {
+            display: string;
+            animation: string;
+            content: string;
+            position: string;
+        };
+        ".letter-animation": {
+            transition: string;
+            transformOrigin: string;
+        };
+        ".letter-animation-enter": {
+            animation: string;
+        };
+        ".letter-animation-exit": {
+            opacity: number;
+            scale: number;
+            transition: string;
+        };
+        "@keyframes dotty": {
+            "0%": {
+                content: string;
+            };
+            "25%": {
+                content: string;
+            };
+            "50%": {
+                content: string;
+            };
+            "75%": {
+                content: string;
+            };
+            "100%": {
+                content: string;
+            };
+        };
+        "@keyframes fadeInUp": {
+            from: {
+                opacity: number;
+                transform: string;
+                scale: number;
+            };
+            to: {
+                opacity: number;
+                transform: string;
+                scale: number;
+            };
+        };
+    };
+};

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

@@ -0,0 +1,5 @@
+export declare class ArcwareLogoLoader {
+    arcwareLogoLoader: HTMLDivElement;
+    constructor();
+    private createArcwareLogoLoader;
+}

package/types/lib/ui/AudioButton/AudioIcon.d.ts

@@ -0,0 +1,7 @@
+export declare class AudioIcon {
+    audioIconUnmuted: SVGElement;
+    audioIconMuted: SVGElement;
+    constructor();
+    private createAudioIconUnmuted;
+    private createAudioIconMuted;
+}

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

@@ -0,0 +1,15 @@
+import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+export declare class AudioButton {
+    private button;
+    private stream;
+    private audioIcon;
+    private tooltipText;
+    constructor(stream: ArcwarePixelStreaming);
+    private setAudioMutedByDefault;
+    private createButton;
+    private createTooltipText;
+    private toggleAudio;
+    private updateAudioIcon;
+    get element(): HTMLButtonElement;
+    private onVolumeChange;
+}

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

@@ -0,0 +1,6 @@
+export declare class LoveLetters {
+    loveLettersRoot: HTMLElement | null;
+    constructor();
+    addLetter(letter: string, listLength: number): void;
+    updateOpacity(listLength: number): void;
+}

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

@@ -0,0 +1,14 @@
+import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+export declare class MicButton {
+    private button;
+    private stream;
+    private micIcon;
+    private tooltipText;
+    constructor(stream: ArcwarePixelStreaming);
+    private setMicMutedByDefault;
+    private createButton;
+    private createTooltipText;
+    private toggleMic;
+    private updateMicIcon;
+    get element(): HTMLButtonElement;
+}

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

@@ -0,0 +1,7 @@
+export declare class MicIcon {
+    micIconUnmuted: SVGElement;
+    micIconMuted: SVGElement;
+    constructor();
+    private createMicIconUnmuted;
+    private createMicIconMuted;
+}

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

@@ -0,0 +1,11 @@
+import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+export declare class MicrophoneOverlay {
+    private overlay;
+    private parentElement;
+    private micIcon;
+    private stream;
+    constructor(stream: ArcwarePixelStreaming);
+    createOverlay(): void;
+    toggleMessage(enabled: boolean): void;
+    toggleVisibility(visible: boolean): void;
+}

package/types/shared/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib";

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

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const ZErrorMessage: z.ZodObject<{
+    type: z.ZodLiteral<"error">;
+    code: z.ZodNumber;
+    reason: z.ZodString;
+    verbosity: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "error";
+    code: number;
+    reason: string;
+    verbosity: number;
+}, {
+    type: "error";
+    code: number;
+    reason: string;
+    verbosity: number;
+}>;
+export type ErrorMessage = z.infer<typeof ZErrorMessage>;

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

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const ZLoveLetter: z.ZodObject<{
+    type: z.ZodLiteral<"letter">;
+    reason: z.ZodString;
+    code: z.ZodNumber;
+    verbosity: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "letter";
+    code: number;
+    reason: string;
+    verbosity: number;
+}, {
+    type: "letter";
+    code: number;
+    reason: string;
+    verbosity: number;
+}>;
+export type LoveLetter = z.infer<typeof ZLoveLetter>;

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

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const ZPing: z.ZodObject<{
+    type: z.ZodLiteral<"ping">;
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "ping";
+    message: string;
+}, {
+    type: "ping";
+    message: string;
+}>;
+export type Ping = z.infer<typeof ZPing>;

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

@@ -0,0 +1,58 @@
+import { z } from "zod";
+export declare const ZQueue: z.ZodObject<{
+    type: z.ZodLiteral<"queue">;
+    queue: z.ZodObject<{
+        /** Ticket._id - will not be exposed to frontend. */
+        /** Position in queue (zero based). */
+        index: z.ZodOptional<z.ZodNumber>;
+        /** Length of the queue. */
+        queueLength: z.ZodOptional<z.ZodNumber>;
+        /** Already waited for. */
+        waited: z.ZodOptional<z.ZodNumber>;
+        /** Based on Average Watch Time,
+         * we calculate an average interval of expected connection closings and based on the amount of concurrent sessions,
+         * we can calculate the estimated time until another slot will be freed up. */
+        estimatedWaitTime: z.ZodOptional<z.ZodNumber>;
+        /** The average time all current sessions.
+         * (How long did it actually take those that waited for them that received a connection to the currently running instances.)
+         */
+        averageWaitTime: z.ZodOptional<z.ZodNumber>;
+        /** Type of all time-values in the que. */
+        valueType: z.ZodEnum<["milliseconds", "seconds", "minutes", "hours", "days"]>;
+    }, "strip", z.ZodTypeAny, {
+        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+        index?: number | undefined;
+        queueLength?: number | undefined;
+        waited?: number | undefined;
+        estimatedWaitTime?: number | undefined;
+        averageWaitTime?: number | undefined;
+    }, {
+        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+        index?: number | undefined;
+        queueLength?: number | undefined;
+        waited?: number | undefined;
+        estimatedWaitTime?: number | undefined;
+        averageWaitTime?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "queue";
+    queue: {
+        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+        index?: number | undefined;
+        queueLength?: number | undefined;
+        waited?: number | undefined;
+        estimatedWaitTime?: number | undefined;
+        averageWaitTime?: number | undefined;
+    };
+}, {
+    type: "queue";
+    queue: {
+        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+        index?: number | undefined;
+        queueLength?: number | undefined;
+        waited?: number | undefined;
+        estimatedWaitTime?: number | undefined;
+        averageWaitTime?: number | undefined;
+    };
+}>;
+export type Queue = z.infer<typeof ZQueue>;

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

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const ZSessionId: z.ZodObject<{
+    type: z.ZodLiteral<"sessionId">;
+    sessionId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "sessionId";
+    sessionId: string;
+}, {
+    type: "sessionId";
+    sessionId: string;
+}>;
+export type SessionId = z.infer<typeof ZSessionId>;