@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.2.1 → 0.3.0

package/{types → dist/types}/Config/SettingOption.d.ts

@@ -1,34 +1,41 @@
-import type { OptionParametersIds } from './Config';
-import { SettingBase } from './SettingBase';
-/**
- * An Option setting object with a text label. Allows you to specify an array of options and select one of them.
- */
-export declare class SettingOption<CustomIds extends string = OptionParametersIds> extends SettingBase {
-    id: OptionParametersIds | CustomIds;
-    onChangeEmit: (changedValue: string) => void;
-    _options: Array<string>;
-    constructor(id: OptionParametersIds | CustomIds, label: string, description: string, defaultTextValue: string, options: Array<string>, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
-    protected getValueAsString(): string;
-    /**
-     * Add a change listener to the select element.
-     */
-    addOnChangedListener(onChangedFunc: (newValue: string) => void): void;
-    /**
-     * @returns All available options as an array
-     */
-    get options(): Array<string>;
-    /**
-     * Set options
-     * @param values Array of options
-     */
-    set options(values: Array<string>);
-    /**
-     * @returns Selected option as a string
-     */
-    get selected(): string;
-    /**
-     * Set selected option if it matches one of the available options
-     * @param value Selected option
-     */
-    set selected(value: string);
-}
+import type { OptionParametersIds } from './Config';
+import { SettingBase } from './SettingBase';
+/**
+ * An Option setting object with a text label. Allows you to specify an array of options and select one of them.
+ */
+export declare class SettingOption<CustomIds extends string = OptionParametersIds> extends SettingBase {
+    id: OptionParametersIds | CustomIds;
+    onChangeEmit: (changedValue: string) => void;
+    _options: Array<string>;
+    _urlParamResolver: (urlParamValue: string) => string;
+    constructor(id: OptionParametersIds | CustomIds, label: string, description: string, defaultTextValue: string, options: Array<string>, useUrlParams: boolean, defaultUrlParamResolver?: (urlParamValue: string) => string, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
+    protected getValueAsString(): string;
+    /**
+     * Add a change listener to the select element.
+     */
+    addOnChangedListener(onChangedFunc: (newValue: string) => void): void;
+    /**
+     * @returns All available options as an array
+     */
+    get options(): Array<string>;
+    /**
+     * Set options
+     * @param values Array of options
+     */
+    set options(values: Array<string>);
+    /**
+     * @returns Selected option as a string
+     */
+    get selected(): string;
+    /**
+     * Set selected option if it matches one of the available options
+     * @param value Selected option
+     */
+    set selected(value: string);
+    /**
+     * Set the url parameter resolver to do some transformation to the string value
+     * that is extracted from the url parameters.
+     * @param urlParam A function that transforms the extracted url parameter string for this setting to something else.
+     */
+    set urlParamResolver(value: (urlParam: string) => string);
+}

package/{types → dist/types}/Config/SettingText.d.ts

@@ -1,21 +1,21 @@
-import type { TextParametersIds } from './Config';
-import { SettingBase } from './SettingBase';
-/**
- * A text setting object with a text label.
- */
-export declare class SettingText<CustomIds extends string = TextParametersIds> extends SettingBase {
-    id: TextParametersIds | CustomIds;
-    onChangeEmit: (changedValue: string) => void;
-    useUrlParams: boolean;
-    constructor(id: TextParametersIds | CustomIds, label: string, description: string, defaultTextValue: string, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
-    protected getValueAsString(): string;
-    /**
-     * @return The setting's value.
-     */
-    get text(): string;
-    /**
-     * Update the setting's stored value.
-     * @param inValue The new value for the setting.
-     */
-    set text(inValue: string);
-}
+import type { TextParametersIds } from './Config';
+import { SettingBase } from './SettingBase';
+/**
+ * A text setting object with a text label.
+ */
+export declare class SettingText<CustomIds extends string = TextParametersIds> extends SettingBase {
+    id: TextParametersIds | CustomIds;
+    onChangeEmit: (changedValue: string) => void;
+    useUrlParams: boolean;
+    constructor(id: TextParametersIds | CustomIds, label: string, description: string, defaultTextValue: string, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
+    protected getValueAsString(): string;
+    /**
+     * @return The setting's value.
+     */
+    get text(): string;
+    /**
+     * Update the setting's stored value.
+     * @param inValue The new value for the setting.
+     */
+    set text(inValue: string);
+}

package/{types → dist/types}/DataChannel/DataChannelController.d.ts

@@ -1,59 +1,59 @@
-/**
- * Handles the Sending and Receiving of messages to the UE Instance via the Data Channel
- */
-export declare class DataChannelController {
-    dataChannel: RTCDataChannel;
-    peerConnection: RTCPeerConnection;
-    datachannelOptions: RTCDataChannelInit;
-    label: string;
-    isReceivingFreezeFrame: boolean;
-    /**
-     * return the current state of a datachannel controller instance
-     * @returns the current DataChannelController instance
-     */
-    getDataChannelInstance(): DataChannelController;
-    /**
-     * To Create and Set up a Data Channel
-     * @param peerConnection - The RTC Peer Connection
-     * @param label - Label of the Data Channel
-     * @param datachannelOptions - Optional RTC DataChannel options
-     */
-    createDataChannel(peerConnection: RTCPeerConnection, label: string, datachannelOptions?: RTCDataChannelInit): void;
-    setupDataChannel(): void;
-    /**
-     * Handles when the Data Channel is opened
-     */
-    handleOnOpen(ev: Event): void;
-    /**
-     * Handles when the Data Channel is closed
-     */
-    handleOnClose(ev: Event): void;
-    /**
-     * Handles when a message is received
-     * @param event - Message Event
-     */
-    handleOnMessage(event: MessageEvent): void;
-    /**
-     * Handles when an error is thrown
-     * @param event - Error Event
-     */
-    handleOnError(event: MessageEvent): void;
-    /**
-     * Override to register onOpen handler
-     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
-     * @param ev event
-     */
-    onOpen(label: string, ev: Event): void;
-    /**
-     * Override to register onClose handler
-     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
-     * @param ev event
-     */
-    onClose(label: string, ev: Event): void;
-    /**
-     * Override to register onError handler
-     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
-     * @param ev event
-     */
-    onError(label: string, ev: Event): void;
-}
+/**
+ * Handles the Sending and Receiving of messages to the UE Instance via the Data Channel
+ */
+export declare class DataChannelController {
+    dataChannel: RTCDataChannel;
+    peerConnection: RTCPeerConnection;
+    datachannelOptions: RTCDataChannelInit;
+    label: string;
+    isReceivingFreezeFrame: boolean;
+    /**
+     * return the current state of a datachannel controller instance
+     * @returns the current DataChannelController instance
+     */
+    getDataChannelInstance(): DataChannelController;
+    /**
+     * To Create and Set up a Data Channel
+     * @param peerConnection - The RTC Peer Connection
+     * @param label - Label of the Data Channel
+     * @param datachannelOptions - Optional RTC DataChannel options
+     */
+    createDataChannel(peerConnection: RTCPeerConnection, label: string, datachannelOptions?: RTCDataChannelInit): void;
+    setupDataChannel(): void;
+    /**
+     * Handles when the Data Channel is opened
+     */
+    handleOnOpen(ev: Event): void;
+    /**
+     * Handles when the Data Channel is closed
+     */
+    handleOnClose(ev: Event): void;
+    /**
+     * Handles when a message is received
+     * @param event - Message Event
+     */
+    handleOnMessage(event: MessageEvent): void;
+    /**
+     * Handles when an error is thrown
+     * @param event - Error Event
+     */
+    handleOnError(event: MessageEvent): void;
+    /**
+     * Override to register onOpen handler
+     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
+     * @param ev event
+     */
+    onOpen(label: string, ev: Event): void;
+    /**
+     * Override to register onClose handler
+     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
+     * @param ev event
+     */
+    onClose(label: string, ev: Event): void;
+    /**
+     * Override to register onError handler
+     * @param label Data channel label ("datachannel", "send-datachannel", "recv-datachannel")
+     * @param ev event
+     */
+    onError(label: string, ev: Event): void;
+}

package/{types → dist/types}/DataChannel/DataChannelLatencyTestController.d.ts

@@ -1,26 +1,25 @@
-/// <reference types="node" />
-import { DataChannelLatencyTestRecord, DataChannelLatencyTestRequest, DataChannelLatencyTestResponse, DataChannelLatencyTestResult, DataChannelLatencyTestSeq, DataChannelLatencyTestTimestamp } from './DataChannelLatencyTestResults';
-export type DataChannelLatencyTestConfig = {
-    duration: number;
-    rps: number;
-    requestSize: number;
-    responseSize: number;
-};
-export type DataChannelLatencyTestSink = (request: DataChannelLatencyTestRequest) => void;
-export type DataChannelLatencyTestResultCallback = (result: DataChannelLatencyTestResult) => void;
-export declare class DataChannelLatencyTestController {
-    startTime: DataChannelLatencyTestTimestamp;
-    sink: DataChannelLatencyTestSink;
-    callback: DataChannelLatencyTestResultCallback;
-    records: Map<DataChannelLatencyTestSeq, DataChannelLatencyTestRecord>;
-    seq: DataChannelLatencyTestSeq;
-    interval: NodeJS.Timer;
-    constructor(sink: DataChannelLatencyTestSink, callback: DataChannelLatencyTestResultCallback);
-    start(config: DataChannelLatencyTestConfig): boolean;
-    stop(): void;
-    produceResult(): DataChannelLatencyTestResult;
-    isRunning(): boolean;
-    receive(response: DataChannelLatencyTestResponse): void;
-    sendRequest(requestSize: number, responseSize: number): void;
-    createRequest(requestSize: number, responseSize: number): DataChannelLatencyTestRequest;
-}
+import { DataChannelLatencyTestRecord, DataChannelLatencyTestRequest, DataChannelLatencyTestResponse, DataChannelLatencyTestResult, DataChannelLatencyTestSeq, DataChannelLatencyTestTimestamp } from './DataChannelLatencyTestResults';
+export type DataChannelLatencyTestConfig = {
+    duration: number;
+    rps: number;
+    requestSize: number;
+    responseSize: number;
+};
+export type DataChannelLatencyTestSink = (request: DataChannelLatencyTestRequest) => void;
+export type DataChannelLatencyTestResultCallback = (result: DataChannelLatencyTestResult) => void;
+export declare class DataChannelLatencyTestController {
+    startTime: DataChannelLatencyTestTimestamp;
+    sink: DataChannelLatencyTestSink;
+    callback: DataChannelLatencyTestResultCallback;
+    records: Map<DataChannelLatencyTestSeq, DataChannelLatencyTestRecord>;
+    seq: DataChannelLatencyTestSeq;
+    intervalHandle: number;
+    constructor(sink: DataChannelLatencyTestSink, callback: DataChannelLatencyTestResultCallback);
+    start(config: DataChannelLatencyTestConfig): boolean;
+    stop(): void;
+    produceResult(): DataChannelLatencyTestResult;
+    isRunning(): boolean;
+    receive(response: DataChannelLatencyTestResponse): void;
+    sendRequest(requestSize: number, responseSize: number): void;
+    createRequest(requestSize: number, responseSize: number): DataChannelLatencyTestRequest;
+}

package/{types → dist/types}/DataChannel/DataChannelLatencyTestResults.d.ts

@@ -1,46 +1,46 @@
-/**
- * Data Channel Latency Test types
- */
-/**
- * Unix epoch
- */
-export type DataChannelLatencyTestTimestamp = number;
-/**
- * Sequence number represented by unsigned int
- */
-export type DataChannelLatencyTestSeq = number;
-/**
- * Request sent to Streamer
- */
-export type DataChannelLatencyTestRequest = {
-    Seq: DataChannelLatencyTestSeq;
-    FillResponseSize: number;
-    Filler: string;
-};
-/**
- * Response from the Streamer
- */
-export type DataChannelLatencyTestResponse = {
-    Seq: DataChannelLatencyTestSeq;
-    Filler: string;
-    ReceivedTimestamp: DataChannelLatencyTestTimestamp;
-    SentTimestamp: DataChannelLatencyTestTimestamp;
-};
-export type DataChannelLatencyTestResult = {
-    records: Map<DataChannelLatencyTestSeq, DataChannelLatencyTestRecord>;
-    dataChannelRtt: number;
-    playerToStreamerTime: number;
-    streamerToPlayerTime: number;
-    exportLatencyAsCSV: () => string;
-};
-export declare class DataChannelLatencyTestRecord {
-    seq: DataChannelLatencyTestSeq;
-    playerSentTimestamp: DataChannelLatencyTestTimestamp;
-    playerReceivedTimestamp: DataChannelLatencyTestTimestamp;
-    streamerReceivedTimestamp: DataChannelLatencyTestTimestamp;
-    streamerSentTimestamp: DataChannelLatencyTestTimestamp;
-    requestFillerSize: number;
-    responseFillerSize: number;
-    constructor(request: DataChannelLatencyTestRequest);
-    update(response: DataChannelLatencyTestResponse): void;
-}
+/**
+ * Data Channel Latency Test types
+ */
+/**
+ * Unix epoch
+ */
+export type DataChannelLatencyTestTimestamp = number;
+/**
+ * Sequence number represented by unsigned int
+ */
+export type DataChannelLatencyTestSeq = number;
+/**
+ * Request sent to Streamer
+ */
+export type DataChannelLatencyTestRequest = {
+    Seq: DataChannelLatencyTestSeq;
+    FillResponseSize: number;
+    Filler: string;
+};
+/**
+ * Response from the Streamer
+ */
+export type DataChannelLatencyTestResponse = {
+    Seq: DataChannelLatencyTestSeq;
+    Filler: string;
+    ReceivedTimestamp: DataChannelLatencyTestTimestamp;
+    SentTimestamp: DataChannelLatencyTestTimestamp;
+};
+export type DataChannelLatencyTestResult = {
+    records: Map<DataChannelLatencyTestSeq, DataChannelLatencyTestRecord>;
+    dataChannelRtt: number;
+    playerToStreamerTime: number;
+    streamerToPlayerTime: number;
+    exportLatencyAsCSV: () => string;
+};
+export declare class DataChannelLatencyTestRecord {
+    seq: DataChannelLatencyTestSeq;
+    playerSentTimestamp: DataChannelLatencyTestTimestamp;
+    playerReceivedTimestamp: DataChannelLatencyTestTimestamp;
+    streamerReceivedTimestamp: DataChannelLatencyTestTimestamp;
+    streamerSentTimestamp: DataChannelLatencyTestTimestamp;
+    requestFillerSize: number;
+    responseFillerSize: number;
+    constructor(request: DataChannelLatencyTestRequest);
+    update(response: DataChannelLatencyTestResponse): void;
+}

package/{types → dist/types}/DataChannel/DataChannelSender.d.ts

@@ -1,21 +1,21 @@
-import { DataChannelController } from './DataChannelController';
-/**
- * A class for sending data channel messages
- */
-export declare class DataChannelSender {
-    dataChannelProvider: DataChannelController;
-    /**
-     * @param dataChannelProvider - Data channel object type
-     */
-    constructor(dataChannelProvider: DataChannelController);
-    canSend(): boolean;
-    /**
-     * Send Data over the Data channel to the UE Instance
-     * @param data - Message Data Array Buffer
-     */
-    sendData(data: ArrayBuffer): void;
-    /**
-     * An override method for resetting the Afk warning timer when data is sent over the data channel
-     */
-    resetAfkWarningTimerOnDataSend(): void;
-}
+import { DataChannelController } from './DataChannelController';
+/**
+ * A class for sending data channel messages
+ */
+export declare class DataChannelSender {
+    dataChannelProvider: DataChannelController;
+    /**
+     * @param dataChannelProvider - Data channel object type
+     */
+    constructor(dataChannelProvider: DataChannelController);
+    canSend(): boolean;
+    /**
+     * Send Data over the Data channel to the UE Instance
+     * @param data - Message Data Array Buffer
+     */
+    sendData(data: ArrayBuffer): void;
+    /**
+     * An override method for resetting the Afk warning timer when data is sent over the data channel
+     */
+    resetAfkWarningTimerOnDataSend(): void;
+}

package/{types → dist/types}/DataChannel/InitialSettings.d.ts

@@ -1,44 +1,44 @@
-/**
- * Latency Test Results Data
- */
-export declare class InitialSettings {
-    PixelStreamingSettings: PixelStreamingSettings;
-    EncoderSettings: EncoderSettings;
-    WebRTCSettings: WebRTCSettings;
-    constructor();
-    /**
-     * Checks for compatibility with the FPS and MaxFPS stats between 4.27 and 5
-     */
-    ueCompatible(): void;
-}
-/**
- * A class for handling Pixel Streaming details
- */
-export declare class PixelStreamingSettings {
-    AllowPixelStreamingCommands?: boolean;
-    DisableLatencyTest?: boolean;
-}
-/**
- * A class for handling encoder stats
- */
-export declare class EncoderSettings {
-    TargetBitrate?: number;
-    MaxBitrate?: number;
-    MinQP?: number;
-    MaxQP?: number;
-    RateControl?: 'CBR' | 'VBR' | 'ConstQP';
-    FillerData?: boolean;
-    MultiPass?: 'DISABLED' | 'QUARTER' | 'FULL';
-}
-/**
- * A class for handling web rtc stats
- */
-export declare class WebRTCSettings {
-    DegradationPref?: 'BALANCED' | 'MAINTAIN_FRAMERATE' | 'MAINTAIN_RESOLUTION';
-    MinBitrate?: number;
-    MaxBitrate?: number;
-    LowQP?: number;
-    HighQP?: number;
-    MaxFPS?: number;
-    FPS?: number;
-}
+/**
+ * Latency Test Results Data
+ */
+export declare class InitialSettings {
+    PixelStreamingSettings: PixelStreamingSettings;
+    EncoderSettings: EncoderSettings;
+    WebRTCSettings: WebRTCSettings;
+    constructor();
+    /**
+     * Checks for compatibility with the FPS and MaxFPS stats between 4.27 and 5
+     */
+    ueCompatible(): void;
+}
+/**
+ * A class for handling Pixel Streaming details
+ */
+export declare class PixelStreamingSettings {
+    AllowPixelStreamingCommands?: boolean;
+    DisableLatencyTest?: boolean;
+}
+/**
+ * A class for handling encoder stats
+ */
+export declare class EncoderSettings {
+    TargetBitrate?: number;
+    MaxBitrate?: number;
+    MinQP?: number;
+    MaxQP?: number;
+    RateControl?: 'CBR' | 'VBR' | 'ConstQP';
+    FillerData?: boolean;
+    MultiPass?: 'DISABLED' | 'QUARTER' | 'FULL';
+}
+/**
+ * A class for handling web rtc stats
+ */
+export declare class WebRTCSettings {
+    DegradationPref?: 'BALANCED' | 'MAINTAIN_FRAMERATE' | 'MAINTAIN_RESOLUTION';
+    MinBitrate?: number;
+    MaxBitrate?: number;
+    LowQP?: number;
+    HighQP?: number;
+    MaxFPS?: number;
+    FPS?: number;
+}

package/{types → dist/types}/DataChannel/LatencyTestResults.d.ts

@@ -1,31 +1,31 @@
-/**
- * Latency Test Results Data
- */
-export declare class LatencyTestResults {
-    ReceiptTimeMs: number;
-    TransmissionTimeMs: number;
-    PreCaptureTimeMs: number;
-    PostCaptureTimeMs: number;
-    PreEncodeTimeMs: number;
-    PostEncodeTimeMs: number;
-    EncodeMs: number;
-    CaptureToSendMs: number;
-    testStartTimeMs: number;
-    browserReceiptTimeMs: number;
-    latencyExcludingDecode: number;
-    testDuration: number;
-    networkLatency: number;
-    browserSendLatency: number;
-    frameDisplayDeltaTimeMs: number;
-    endToEndLatency: number;
-    encodeLatency: number;
-    /**
-     * Sets the Delta Time Milliseconds
-     * @param DeltaTimeMs - Delta Time Milliseconds
-     */
-    setFrameDisplayDeltaTime(DeltaTimeMs: number): void;
-    /**
-     * Process the encoder times and set them
-     */
-    processFields(): void;
-}
+/**
+ * Latency Test Results Data
+ */
+export declare class LatencyTestResults {
+    ReceiptTimeMs: number;
+    TransmissionTimeMs: number;
+    PreCaptureTimeMs: number;
+    PostCaptureTimeMs: number;
+    PreEncodeTimeMs: number;
+    PostEncodeTimeMs: number;
+    EncodeMs: number;
+    CaptureToSendMs: number;
+    testStartTimeMs: number;
+    browserReceiptTimeMs: number;
+    latencyExcludingDecode: number;
+    testDuration: number;
+    networkLatency: number;
+    browserSendLatency: number;
+    frameDisplayDeltaTimeMs: number;
+    endToEndLatency: number;
+    encodeLatency: number;
+    /**
+     * Sets the Delta Time Milliseconds
+     * @param DeltaTimeMs - Delta Time Milliseconds
+     */
+    setFrameDisplayDeltaTime(DeltaTimeMs: number): void;
+    /**
+     * Process the encoder times and set them
+     */
+    processFields(): void;
+}

package/{types → dist/types}/FreezeFrame/FreezeFrame.d.ts

@@ -1,36 +1,36 @@
-/**
- * A class for managing the freeze frame object
- */
-export declare class FreezeFrame {
-    protected rootDiv: HTMLElement;
-    protected rootElement: HTMLDivElement;
-    imageElement: HTMLImageElement;
-    freezeFrameHeight: number;
-    freezeFrameWidth: number;
-    /**
-     * Construct a freeze frame
-     * @param rootDiv the div that a freeze frame element will be injected into
-     */
-    constructor(rootDiv: HTMLElement);
-    /**
-     * Set the freeze frame element for showing
-     */
-    setElementForShow(): void;
-    /**
-     * Set the freeze frame element for hiding
-     */
-    setElementForHide(): void;
-    /**
-     * Update the freeze frames image source
-     * @param jpeg - the freeze frame image as a byte array data
-     */
-    updateImageElementSource(jpeg: Uint8Array): void;
-    /**
-     * Set the dimensions for the freeze frame from the element and resize it
-     */
-    setDimensionsFromElementAndResize(): void;
-    /**
-     * Resize a freeze frame element
-     */
-    resize(): void;
-}
+/**
+ * A class for managing the freeze frame object
+ */
+export declare class FreezeFrame {
+    protected rootDiv: HTMLElement;
+    protected rootElement: HTMLDivElement;
+    imageElement: HTMLImageElement;
+    freezeFrameHeight: number;
+    freezeFrameWidth: number;
+    /**
+     * Construct a freeze frame
+     * @param rootDiv the div that a freeze frame element will be injected into
+     */
+    constructor(rootDiv: HTMLElement);
+    /**
+     * Set the freeze frame element for showing
+     */
+    setElementForShow(): void;
+    /**
+     * Set the freeze frame element for hiding
+     */
+    setElementForHide(): void;
+    /**
+     * Update the freeze frames image source
+     * @param jpeg - the freeze frame image as a byte array data
+     */
+    updateImageElementSource(jpeg: Uint8Array): void;
+    /**
+     * Set the dimensions for the freeze frame from the element and resize it
+     */
+    setDimensionsFromElementAndResize(): void;
+    /**
+     * Resize a freeze frame element
+     */
+    resize(): void;
+}