@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.0.5

package/types/Config/Config.d.ts

@@ -0,0 +1,218 @@
+import { SettingFlag } from './SettingFlag';
+import { SettingNumber } from './SettingNumber';
+import { SettingText } from './SettingText';
+import { SettingOption } from './SettingOption';
+import { EventEmitter } from '../Util/EventEmitter';
+/**
+ * A collection of flags that can be toggled and are core to all Pixel Streaming experiences.
+ * These are used in the `Config.Flags` map.
+ */
+export declare class Flags {
+    static AutoConnect: "AutoConnect";
+    static AutoPlayVideo: "AutoPlayVideo";
+    static AFKDetection: "TimeoutIfIdle";
+    static BrowserSendOffer: "OfferToReceive";
+    static HoveringMouseMode: "HoveringMouse";
+    static ForceMonoAudio: "ForceMonoAudio";
+    static ForceTURN: "ForceTURN";
+    static FakeMouseWithTouches: "FakeMouseWithTouches";
+    static IsQualityController: "ControlsQuality";
+    static MatchViewportResolution: "MatchViewportRes";
+    static StartVideoMuted: "StartVideoMuted";
+    static SuppressBrowserKeys: "SuppressBrowserKeys";
+    static UseMic: "UseMic";
+    static KeyboardInput: "KeyboardInput";
+    static MouseInput: "MouseInput";
+    static TouchInput: "TouchInput";
+    static GamepadInput: "GamepadInput";
+    static XRControllerInput: "XRControllerInput";
+    static WaitForStreamer: "WaitForStreamer";
+}
+export type FlagsKeys = Exclude<keyof typeof Flags, 'prototype'>;
+export type FlagsIds = typeof Flags[FlagsKeys];
+/**
+ * A collection of numeric parameters that are core to all Pixel Streaming experiences.
+ *
+ */
+export declare class NumericParameters {
+    static AFKTimeoutSecs: "AFKTimeout";
+    static MinQP: "MinQP";
+    static MaxQP: "MaxQP";
+    static WebRTCFPS: "WebRTCFPS";
+    static WebRTCMinBitrate: "WebRTCMinBitrate";
+    static WebRTCMaxBitrate: "WebRTCMaxBitrate";
+    static MaxReconnectAttempts: "MaxReconnectAttempts";
+    static StreamerAutoJoinInterval: "StreamerAutoJoinInterval";
+}
+export type NumericParametersKeys = Exclude<keyof typeof NumericParameters, 'prototype'>;
+export type NumericParametersIds = typeof NumericParameters[NumericParametersKeys];
+/**
+ * A collection of textual parameters that are core to all Pixel Streaming experiences.
+ *
+ */
+export declare class TextParameters {
+    static SignallingServerUrl: "ss";
+}
+export type TextParametersKeys = Exclude<keyof typeof TextParameters, 'prototype'>;
+export type TextParametersIds = typeof TextParameters[TextParametersKeys];
+/**
+ * A collection of enum based parameters that are core to all Pixel Streaming experiences.
+ *
+ */
+export declare class OptionParameters {
+    static PreferredCodec: "PreferredCodec";
+    static StreamerId: "StreamerId";
+}
+export type OptionParametersKeys = Exclude<keyof typeof OptionParameters, 'prototype'>;
+export type OptionParametersIds = typeof OptionParameters[OptionParametersKeys];
+/**
+ * Utility types for inferring data type based on setting ID
+ */
+export type OptionIds = FlagsIds | NumericParametersIds | TextParametersIds | OptionParametersIds;
+export type OptionKeys<T> = T extends FlagsIds ? boolean : T extends NumericParametersIds ? number : T extends TextParametersIds ? string : T extends OptionParametersIds ? string : never;
+export type AllSettings = {
+    [K in OptionIds]: OptionKeys<K>;
+};
+export interface ConfigParams {
+    /** Initial Pixel Streaming settings */
+    initialSettings?: Partial<AllSettings>;
+    /** If useUrlParams is set true, will read initial values from URL parameters and persist changed settings into URL */
+    useUrlParams?: boolean;
+}
+export declare class Config {
+    private flags;
+    private numericParameters;
+    private textParameters;
+    private optionParameters;
+    private _useUrlParams;
+    constructor(config?: ConfigParams);
+    /**
+     * True if reading configuration initial values from URL parameters, and
+     * persisting changes in URL when changed.
+     */
+    get useUrlParams(): boolean;
+    /**
+     * Populate the default settings for a Pixel Streaming application
+     */
+    private populateDefaultSettings;
+    /**
+     * Add a callback to fire when the numeric setting is toggled.
+     * @param id The id of the flag.
+     * @param onChangedListener The callback to fire when the numeric value changes.
+     */
+    _addOnNumericSettingChangedListener(id: NumericParametersIds, onChangedListener: (newValue: number) => void): void;
+    _addOnOptionSettingChangedListener(id: OptionParametersIds, onChangedListener: (newValue: string) => void): void;
+    /**
+     * @param id The id of the numeric setting we are interested in getting a value for.
+     * @returns The numeric value stored in the parameter with the passed id.
+     */
+    getNumericSettingValue(id: NumericParametersIds): number;
+    /**
+     * @param id The id of the text setting we are interested in getting a value for.
+     * @returns The text value stored in the parameter with the passed id.
+     */
+    getTextSettingValue(id: TextParametersIds): string;
+    /**
+     * Set number in the setting.
+     * @param id The id of the numeric setting we are interested in.
+     * @param value The numeric value to set.
+     */
+    setNumericSetting(id: NumericParametersIds, value: number): void;
+    /**
+     * Add a callback to fire when the flag is toggled.
+     * @param id The id of the flag.
+     * @param onChangeListener The callback to fire when the value changes.
+     */
+    _addOnSettingChangedListener(id: FlagsIds, onChangeListener: (newFlagValue: boolean) => void): void;
+    /**
+     * Add a callback to fire when the text is changed.
+     * @param id The id of the flag.
+     * @param onChangeListener The callback to fire when the value changes.
+     */
+    _addOnTextSettingChangedListener(id: TextParametersIds, onChangeListener: (newTextValue: string) => void): void;
+    /**
+     * Get the option which has the given id.
+     * @param id The id of the option.
+     * @returns The SettingOption object matching id
+     */
+    getSettingOption(id: OptionParametersIds): SettingOption;
+    /**
+     * Get the value of the configuration flag which has the given id.
+     * @param id The unique id for the flag.
+     * @returns True if the flag is enabled.
+     */
+    isFlagEnabled(id: FlagsIds): boolean;
+    /**
+     * Set flag to be enabled/disabled.
+     * @param id The id of the flag to toggle.
+     * @param flagEnabled True if the flag should be enabled.
+     */
+    setFlagEnabled(id: FlagsIds, flagEnabled: boolean): void;
+    /**
+     * Set the text setting.
+     * @param id The id of the setting
+     * @param settingValue The value to set in the setting.
+     */
+    setTextSetting(id: TextParametersIds, settingValue: string): void;
+    /**
+     * Set the option setting list of options.
+     * @param id The id of the setting
+     * @param settingOptions The values the setting could take
+     */
+    setOptionSettingOptions(id: OptionParametersIds, settingOptions: Array<string>): void;
+    /**
+     * Set option enum settings selected option.
+     * @param id The id of the setting
+     * @param settingOptions The value to select out of all the options
+     */
+    setOptionSettingValue(id: OptionParametersIds, settingValue: string): void;
+    /**
+     * Set the label for the flag.
+     * @param id The id of the flag.
+     * @param label The new label to use for the flag.
+     */
+    setFlagLabel(id: FlagsIds, label: string): void;
+    /**
+     * Set a subset of all settings in one function call.
+     *
+     * @param settings A (partial) list of settings to set
+     */
+    setSettings(settings: Partial<AllSettings>): void;
+    /**
+     * Get all settings
+     * @returns All setting values as an object with setting ids as keys
+     */
+    getSettings(): Partial<AllSettings>;
+    /**
+     * Get all Flag settings as an array.
+     * @returns All SettingFlag objects
+     */
+    getFlags(): Array<SettingFlag>;
+    /**
+     * Get all Text settings as an array.
+     * @returns All SettingText objects
+     */
+    getTextSettings(): Array<SettingText>;
+    /**
+     * Get all Number settings as an array.
+     * @returns All SettingNumber objects
+     */
+    getNumericSettings(): Array<SettingNumber>;
+    /**
+     * Get all Option settings as an array.
+     * @returns All SettingOption objects
+     */
+    getOptionSettings(): Array<SettingOption>;
+    /**
+     * Emit events when settings change.
+     * @param eventEmitter
+     */
+    _registerOnChangeEvents(eventEmitter: EventEmitter): void;
+}
+/**
+ * The enum associated with the mouse being locked or hovering
+ */
+export declare enum ControlSchemeType {
+    LockedMouse = 0,
+    HoveringMouse = 1
+}

package/types/Config/SettingBase.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Base class for a setting that has a text label and an arbitrary setting value it stores.
+ */
+export declare class SettingBase {
+    id: string;
+    description: string;
+    _label: string;
+    _value: unknown;
+    onChange: (changedValue: unknown, setting: SettingBase) => void;
+    onChangeEmit: (changedValue: unknown) => void;
+    constructor(id: string, label: string, description: string, defaultSettingValue: unknown, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
+    /**
+     * Set the label text for the setting.
+     * @param label setting label.
+     */
+    set label(inLabel: string);
+    /**
+     * @returns The label text for the setting.
+     */
+    get label(): string;
+    /**
+     * @return The setting's value.
+     */
+    get value(): unknown;
+    /**
+     * Update the setting's stored value.
+     * @param inValue The new value for the setting.
+     */
+    set value(inValue: unknown);
+}

package/types/Config/SettingFlag.d.ts

@@ -0,0 +1,33 @@
+import type { FlagsIds } from './Config';
+import { SettingBase } from './SettingBase';
+/**
+ * A boolean flag setting object with a text label.
+ */
+export declare class SettingFlag<CustomIds extends string = FlagsIds> extends SettingBase {
+    id: FlagsIds | CustomIds;
+    onChangeEmit: (changedValue: boolean) => void;
+    useUrlParams: boolean;
+    constructor(id: FlagsIds | CustomIds, label: string, description: string, defaultFlagValue: boolean, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
+    /**
+     * Parse the flag value from the url parameters.
+     * @returns True if the url parameters contains /?id, but False if /?id=false
+     */
+    getUrlParamFlag(): boolean;
+    /**
+     * Persist the setting value in URL.
+     */
+    updateURLParams(): void;
+    /**
+     * Enables this flag.
+     */
+    enable(): void;
+    /**
+     * @return The setting's value.
+     */
+    get flag(): boolean;
+    /**
+     * Update the setting's stored value.
+     * @param inValue The new value for the setting.
+     */
+    set flag(inValue: boolean);
+}

package/types/Config/SettingNumber.d.ts

@@ -0,0 +1,45 @@
+import type { NumericParametersIds } from './Config';
+import { SettingBase } from './SettingBase';
+/**
+ * A number setting object with a text label. Min and max limit the range of allowed values.
+ */
+export declare class SettingNumber<CustomIds extends string = NumericParametersIds> extends SettingBase {
+    _min: number;
+    _max: number;
+    id: NumericParametersIds | CustomIds;
+    onChangeEmit: (changedValue: number) => void;
+    useUrlParams: boolean;
+    constructor(id: NumericParametersIds | CustomIds, label: string, description: string, min: number, max: number, defaultNumber: number, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
+    /**
+     * Persist the setting value in URL.
+     */
+    updateURLParams(): void;
+    /**
+     * Set the number value (will be clamped within range).
+     */
+    set number(newNumber: number);
+    /**
+     * @returns The number stored.
+     */
+    get number(): number;
+    /**
+     * Clamps a number between the min and max values (inclusive).
+     * @param inNumber The number to clamp.
+     * @returns The clamped number.
+     */
+    clamp(inNumber: number): number;
+    /**
+     * Returns the minimum value
+     * @returns The minimum value
+     */
+    get min(): number;
+    /**
+     * Returns the maximum value
+     * @returns The maximum value
+     */
+    get max(): number;
+    /**
+     * Add a change listener to the number object.
+     */
+    addOnChangedListener(onChangedFunc: (newNumber: number) => void): void;
+}

package/types/Config/SettingOption.d.ts

@@ -0,0 +1,43 @@
+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>;
+    useUrlParams: boolean;
+    constructor(id: OptionParametersIds | CustomIds, label: string, description: string, defaultTextValue: string, options: Array<string>, useUrlParams: boolean, defaultOnChangeListener?: (changedValue: unknown, setting: SettingBase) => void);
+    /**
+     * Parse the text value from the url parameters.
+     * @returns The text value parsed from the url if the url parameters contains /?id=value, but empty string if just /?id or no url param found.
+     */
+    getUrlParamText(): string;
+    /**
+     * Persist the setting value in URL.
+     */
+    updateURLParams(): void;
+    /**
+     * 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);
+}

package/types/Config/SettingText.d.ts

@@ -0,0 +1,29 @@
+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);
+    /**
+     * Parse the text value from the url parameters.
+     * @returns The text value parsed from the url if the url parameters contains /?id=value, but empty string if just /?id or no url param found.
+     */
+    getUrlParamText(): string;
+    /**
+     * Persist the setting value in URL.
+     */
+    updateURLParams(): void;
+    /**
+     * @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/DataChannel/DataChannelController.d.ts

@@ -0,0 +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;
+}

package/types/DataChannel/DataChannelLatencyTestController.d.ts

@@ -0,0 +1,26 @@
+/// <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;
+}

package/types/DataChannel/DataChannelLatencyTestResults.d.ts

@@ -0,0 +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;
+}

package/types/DataChannel/DataChannelSender.d.ts

@@ -0,0 +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;
+}

package/types/DataChannel/InitialSettings.d.ts

@@ -0,0 +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;
+}

package/types/DataChannel/LatencyTestResults.d.ts

@@ -0,0 +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;
+}

package/types/FreezeFrame/FreezeFrame.d.ts

@@ -0,0 +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;
+}