@arcware-cloud/pixelstreaming-websdk 0.1.0-beta

package/package.json

@@ -0,0 +1,32 @@
+{
+  "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",
+  "type": "commonjs",
+  "main": "./index.umd.js",
+  "module": "./index.umd.js",
+  "types": "./types/index.d.ts",
+  "keywords": [
+    "arcware",
+    "cloudrt",
+    "pixelstreaming",
+    "epicgames",
+    "unrealengine"
+  ],
+  "author": {
+    "name": "Arcware GmbH",
+    "email": "info@arcware.com",
+    "url": "https://www.arcware.com"
+  },
+  "license": "MIT",
+  "dependencies": {},
+  "peerDependencies": {
+    "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2": "0.4.0",
+    "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2": "0.3.0",
+    "lodash": "4.17.21",
+    "lottie-web": "5.10.2",
+    "moment": "2.29.4",
+    "zod": "3.21.4"
+  },
+  "cjs": "./index.cjs.js"
+}

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2";
+export * from "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2";
+export * from "./lib";

package/types/lib/ApplyUrlHack.d.ts

@@ -0,0 +1,2 @@
+export declare function UrlBuilder(input: () => string, urlFlags?: string): string;
+export declare function ApplyUrlHack(): void;

package/types/lib/ArcwareApplication.d.ts

@@ -0,0 +1,27 @@
+import { Application, UIOptions } from "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2";
+import { ArcwarePixelStreaming } from "./ArcwarePixelStreaming";
+export declare class ArcwareApplication extends Application {
+    static Flags: {
+        new (): {};
+        noSession: "noSession";
+    };
+    stream: ArcwarePixelStreaming;
+    private videoElementParent;
+    private parentElement;
+    private responseCallback;
+    private webRtcController;
+    get rootElement(): HTMLElement;
+    private ArcwareSection;
+    constructor(options: UIOptions & {
+        stream: ArcwarePixelStreaming;
+    });
+    private adjustSettingsPanel;
+    private createAudioToggleButton;
+    private createMicToggleButton;
+    private uiDefaultButtonVisibilty;
+    private autoPlayHandler;
+    getApplicationResponse(callback: (response: string) => void): void;
+    applicationResponse(response: string): void;
+    private applyArcwareStyles;
+    emitUIInteraction(descriptor: object | string): void;
+}

package/types/lib/ArcwareConfig.d.ts

@@ -0,0 +1,34 @@
+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";
+export interface ArcwareConfigParams extends ConfigParams {
+    settings: Settings;
+}
+export declare class ArcwareConfig extends Config {
+    /**
+     * Can be used to fetch projectId and shareId from the current url.
+     * Example:
+     * /something/:projectId/:shareId/something?something => { projectId, shareId }
+     * /:projectId => { projectId }
+     * /:shareId => { shareId }
+     * /:shareId/:projectId => { projectId, shareId }
+     *
+     * The projectId must be uuidv4.
+     * The shareId must be "shareId-" prefixed.
+     *
+     * Usage:
+     * // This will spread the projectId and the shareId into the settings. Define anything you want to override after the spread operation.
+     * new ArcwareConfig({ settings: { ...ArcwareConfig.PickIdsOfUrl() } });
+     */
+    static PickIdsOfUrl(): Pick<Settings, "shareId" | "projectId">;
+    readonly session: Session;
+    readonly settings: Settings;
+    private _initialSettings;
+    readonly VERSION = "0.0.0";
+    constructor(config: ArcwareConfigParams);
+    /** Setup connection string. */
+    get urlFlags(): string;
+    get initialSettings(): Partial<import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").AllSettings>;
+    modifyInitialSettings(mouseLock: boolean): void;
+}

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -0,0 +1,84 @@
+import { Messages } from "@arcware-cloud/shared-pixelstreaming-websdk";
+import { PixelStreaming } from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2";
+import { PixelStreamingOverrides } from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2/types/PixelStreaming/PixelStreaming";
+import { ArcwareConfig } from "./ArcwareConfig";
+import { EventHandler } from "./domain/EventHandler";
+import { Session } from "./domain/Session";
+export declare class ArcwarePixelStreaming extends PixelStreaming {
+    /** Override default config with ArcwareConfig. */
+    config: ArcwareConfig;
+    streamInfo?: Messages.StreamInfo;
+    private webRtcController;
+    loveLettersContainer: HTMLDivElement | undefined;
+    private loveLettersList;
+    private loveLettersQueue;
+    private isProcessingQueue;
+    private microphoneOverlay;
+    get videoStartTime(): number | undefined;
+    constructor(config: ArcwareConfig, overrides?: PixelStreamingOverrides);
+    /** Getter for the session object. */
+    get session(): Session;
+    /**
+     * * * * * * *
+     *  Listen   *
+     * * * * * * *
+     */
+    /** On ping the session creation timestamp will be updated. */
+    private onPing;
+    /** Handle incoming configurations. */
+    private onStreamInfo;
+    /** On ping the session creation timestamp will be updated. */
+    readonly queueHandler: EventHandler<{
+        type: "queue";
+        queue: {
+            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+            index?: number | undefined;
+            queueLength?: number | undefined;
+            waited?: number | undefined;
+            estimatedWaitTime?: number | undefined;
+            averageWaitTime?: number | undefined;
+        };
+    }>;
+    private onQueue;
+    /** Error receiver. */
+    readonly errorHandler: EventHandler<{
+        type: "error";
+        code: number;
+        reason: string;
+        verbosity: number;
+    }>;
+    private onError;
+    /** LoveLetter */
+    readonly loveLetterHandler: EventHandler<{
+        type: "letter";
+        code: number;
+        reason: string;
+        verbosity: number;
+    }>;
+    private onLoveLetter;
+    /** SessionId */
+    readonly sessionIdHandler: EventHandler<string>;
+    private onSessionId;
+    /** VideoInitialized */
+    readonly videoInitializedHandler: EventHandler<never>;
+    private onVideoInitialized;
+    /** Adding a zod-safe handler. */
+    private addMessageHandler;
+    /**
+     * * * * * *
+     *  Send   *
+     * * * * * *
+     */
+    private sendStats;
+    private send;
+    private handleResolutionChange;
+    removePlayer(): void;
+    private handleMouseLock;
+    private initLoveLettersContainer;
+    private pushLetter;
+    private processQueue;
+    private handleRemoveLoveLetters;
+    toggleAudio(videoElement: HTMLVideoElement, enabled: boolean): void;
+    private createMicrophoneOverlay;
+    toggleMic(enable: boolean, isDefault: boolean): void;
+}

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

@@ -0,0 +1,185 @@
+import { z } from "zod";
+/** Arcware Settings. */
+export declare const ArcwareSettingsSchema: z.ZodObject<{
+    /** Overwrites the Session-Tool and uses the provided session instead. */
+    session: z.ZodOptional<z.ZodString>;
+    /** Can be used to be added to the request in order to verify access to private projects.
+     * For internal use only. => Preview page.
+     */
+    token: z.ZodOptional<z.ZodString>;
+    /** @deprecated in there for legacy use. Can only be used when token is provided. */
+    bypass: z.ZodOptional<z.ZodBoolean>;
+    /** Handler for server side error messages. */
+    errorHandler: z.ZodOptional<z.ZodFunction<z.ZodTuple<[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;
+    }>], z.ZodUnknown>, z.ZodVoid>>;
+    /** Handler for queue events. */
+    queueHandler: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
+        type: z.ZodLiteral<"queue">;
+        queue: z.ZodObject<{
+            index: z.ZodOptional<z.ZodNumber>;
+            queueLength: z.ZodOptional<z.ZodNumber>;
+            waited: z.ZodOptional<z.ZodNumber>;
+            estimatedWaitTime: z.ZodOptional<z.ZodNumber>;
+            averageWaitTime: z.ZodOptional<z.ZodNumber>;
+            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. */
+            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;
+        };
+    }>], 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. */
+    loveLetterHandler: z.ZodOptional<z.ZodFunction<z.ZodTuple<[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;
+    }>], z.ZodUnknown>, z.ZodVoid>>;
+    /** Show or hide the fullscreen button. */
+    fullscreenButton: z.ZodOptional<z.ZodBoolean>;
+    /** Show or hide the settings button. */
+    settingsButton: z.ZodOptional<z.ZodBoolean>;
+    /** Show or hide the info button. */
+    infoButton: z.ZodOptional<z.ZodBoolean>;
+    /** Show or hide the audio button. */
+    audioButton: z.ZodOptional<z.ZodBoolean>;
+    /** Show or hide the microphone button. */
+    micButton: z.ZodOptional<z.ZodBoolean>;
+    /** Show or hide the connectionStrengthIcon button. */
+    connectionStrengthIcon: z.ZodOptional<z.ZodBoolean>;
+    shareId: z.ZodOptional<z.ZodString>;
+    projectId: z.ZodOptional<z.ZodString>;
+    loveLetterLogging: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    session?: string | undefined;
+    token?: string | undefined;
+    bypass?: boolean | undefined;
+    errorHandler?: ((args_0: {
+        type: "error";
+        code: number;
+        reason: string;
+        verbosity: number;
+    }, ...args_1: unknown[]) => void) | undefined;
+    queueHandler?: ((args_0: {
+        type: "queue";
+        queue: {
+            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+            index?: number | undefined;
+            queueLength?: number | undefined;
+            waited?: number | undefined;
+            estimatedWaitTime?: number | undefined;
+            averageWaitTime?: number | undefined;
+        };
+    }, ...args_1: unknown[]) => void) | undefined;
+    sessionIdHandler?: ((args_0: string, ...args_1: unknown[]) => void) | undefined;
+    loveLetterHandler?: ((args_0: {
+        type: "letter";
+        code: number;
+        reason: string;
+        verbosity: number;
+    }, ...args_1: unknown[]) => void) | undefined;
+    fullscreenButton?: boolean | undefined;
+    settingsButton?: boolean | undefined;
+    infoButton?: boolean | undefined;
+    audioButton?: boolean | undefined;
+    micButton?: boolean | undefined;
+    connectionStrengthIcon?: boolean | undefined;
+    shareId?: string | undefined;
+    projectId?: string | undefined;
+    loveLetterLogging?: boolean | undefined;
+}, {
+    session?: string | undefined;
+    token?: string | undefined;
+    bypass?: boolean | undefined;
+    errorHandler?: ((args_0: {
+        type: "error";
+        code: number;
+        reason: string;
+        verbosity: number;
+    }, ...args_1: unknown[]) => void) | undefined;
+    queueHandler?: ((args_0: {
+        type: "queue";
+        queue: {
+            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+            index?: number | undefined;
+            queueLength?: number | undefined;
+            waited?: number | undefined;
+            estimatedWaitTime?: number | undefined;
+            averageWaitTime?: number | undefined;
+        };
+    }, ...args_1: unknown[]) => void) | undefined;
+    sessionIdHandler?: ((args_0: string, ...args_1: unknown[]) => void) | undefined;
+    loveLetterHandler?: ((args_0: {
+        type: "letter";
+        code: number;
+        reason: string;
+        verbosity: number;
+    }, ...args_1: unknown[]) => void) | undefined;
+    fullscreenButton?: boolean | undefined;
+    settingsButton?: boolean | undefined;
+    infoButton?: boolean | undefined;
+    audioButton?: boolean | undefined;
+    micButton?: boolean | undefined;
+    connectionStrengthIcon?: boolean | undefined;
+    shareId?: string | undefined;
+    projectId?: string | undefined;
+    loveLetterLogging?: boolean | undefined;
+}>;
+export type Settings = z.infer<typeof ArcwareSettingsSchema>;

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

@@ -0,0 +1,11 @@
+/** A helper class to spread the event to additional event handlers added from external sources. */
+export declare class EventHandler<Type> {
+    private callbacks;
+    /** Returns the added callback on success or null, if something went wrong. */
+    add<Callback extends (arg: Type) => void>(callback: Callback): Callback | null;
+    /** Returns true if the input callback has been found and removed and false if not. */
+    remove<Callback extends (arg: Type) => void>(callback: Callback): boolean;
+    constructor();
+    /** Emits the event-data for each of the existing handlers. */
+    static Emit<Type>(handler: EventHandler<Type>, event: Type): void;
+}

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

@@ -0,0 +1,29 @@
+import { z } from "zod";
+declare const ZOptions: z.ZodObject<{
+    localStorageKey: z.ZodDefault<z.ZodString>;
+    keepSession: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    localStorageKey: string;
+    keepSession: number;
+}, {
+    localStorageKey?: string | undefined;
+    keepSession?: number | undefined;
+}>;
+type Options = z.infer<typeof ZOptions>;
+/** The sessionId is stored in the localStorage to allow for reconnection and
+ * to prevent spamming start requests of instances, when smashing F5.
+ */
+export declare class Session {
+    private _current?;
+    get current(): string | undefined;
+    get noSession(): boolean;
+    get id(): string | null;
+    private options;
+    private get localStorageKey();
+    constructor(options?: Options);
+    /** Set's the session with creation date for the given storage key to the localStorage. */
+    set(sessionId: string): void;
+    /** Removes a session from the localStorage. */
+    unset(): void;
+}
+export {};

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

@@ -0,0 +1,36 @@
+import { AggregatedStats } from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2";
+export declare function Stats(stats: AggregatedStats): import("zod").objectOutputType<{
+    codecs: import("zod").ZodOptional<import("zod").ZodType<Map<string, string>, import("zod").ZodTypeDef, Map<string, string>>>;
+    candidatePair: import("zod").ZodOptional<import("zod").ZodType<import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").CandidatePairStats, import("zod").ZodTypeDef, import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").CandidatePairStats>>;
+    localCandidates: import("zod").ZodOptional<import("zod").ZodType<import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").CandidateStat[], import("zod").ZodTypeDef, import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").CandidateStat[]>>;
+    remoteCandidates: import("zod").ZodOptional<import("zod").ZodType<import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").CandidateStat[], import("zod").ZodTypeDef, import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").CandidateStat[]>>;
+    DataChannelStats: import("zod").ZodOptional<import("zod").ZodType<import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").DataChannelStats, import("zod").ZodTypeDef, import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.2").DataChannelStats>>;
+    bytesReceived: import("zod").ZodOptional<import("zod").ZodNumber>;
+    packetsLost: import("zod").ZodOptional<import("zod").ZodNumber>;
+    frameWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
+    frameHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
+    framesDecoded: import("zod").ZodOptional<import("zod").ZodNumber>;
+    framesPerSecond: import("zod").ZodOptional<import("zod").ZodNumber>;
+    framesDropped: import("zod").ZodOptional<import("zod").ZodNumber>;
+    videoCodec: import("zod").ZodOptional<import("zod").ZodString>;
+    audioCodec: import("zod").ZodOptional<import("zod").ZodString>;
+    browserInfo: import("zod").ZodOptional<import("zod").ZodObject<{
+        userAgent: import("zod").ZodOptional<import("zod").ZodString>;
+        platform: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        language: import("zod").ZodOptional<import("zod").ZodString>;
+    }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
+        userAgent: import("zod").ZodOptional<import("zod").ZodString>;
+        platform: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        language: import("zod").ZodOptional<import("zod").ZodString>;
+    }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
+        userAgent: import("zod").ZodOptional<import("zod").ZodString>;
+        platform: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        language: import("zod").ZodOptional<import("zod").ZodString>;
+    }, import("zod").ZodTypeAny, "passthrough">>>;
+    currentRTT: import("zod").ZodOptional<import("zod").ZodNumber>;
+    sessionRunTime: import("zod").ZodOptional<import("zod").ZodString>;
+    controlsStreamInput: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
+    videoEncoderAvgQP: import("zod").ZodOptional<import("zod").ZodNumber>;
+    videoBitrate: import("zod").ZodOptional<import("zod").ZodNumber>;
+    audioBitrate: import("zod").ZodOptional<import("zod").ZodNumber>;
+}, import("zod").ZodTypeAny, "passthrough">;

package/types/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ArcwareApplication";
+export * from "./ArcwareConfig";
+export * from "./ArcwarePixelStreaming";
+export * from "./styles/ArcwarePixelStreamingApplicationStyles";