@yang__yj/pixelstreaming-core 1.0.0

package/library/types/Inputs/InputClassesFactory.d.ts

@@ -0,0 +1,54 @@
+import { FakeTouchController } from './FakeTouchController';
+import { KeyboardController } from './KeyboardController';
+import { MouseController } from './MouseController';
+import { TouchController } from './TouchController';
+import { GamePadController } from './GamepadController';
+import { Config, ControlSchemeType } from '../Config/Config';
+import { CoordinateConverter } from '../Util/CoordinateConverter';
+import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
+import { VideoPlayer } from '../VideoPlayer/VideoPlayer';
+/**
+ * Class for making and setting up input class types
+ */
+export declare class InputClassesFactory {
+    toStreamerMessagesProvider: StreamMessageController;
+    videoElementProvider: VideoPlayer;
+    coordinateConverter: CoordinateConverter;
+    activeKeys: ActiveKeys;
+    /**
+     * @param toStreamerMessagesProvider - Stream message instance
+     * @param videoElementProvider - Video Player instance
+     * @param coordinateConverter - A coordinateConverter instance
+     */
+    constructor(toStreamerMessagesProvider: StreamMessageController, videoElementProvider: VideoPlayer, coordinateConverter: CoordinateConverter);
+    /**
+     * Registers browser key events.
+     */
+    registerKeyBoard(config: Config): KeyboardController;
+    /**
+     * register mouse events based on a control type
+     * @param controlScheme - if the mouse is either hovering or locked
+     */
+    registerMouse(controlScheme: ControlSchemeType): MouseController;
+    /**
+     * register touch events
+     * @param fakeMouseTouch - the faked mouse touch event
+     */
+    registerTouch(fakeMouseTouch: boolean, videoElementParentClientRect: DOMRect): FakeTouchController | TouchController;
+    /**
+     * registers a gamepad
+     */
+    registerGamePad(): GamePadController;
+}
+/**
+ * A class that keeps track of current active keys
+ */
+export declare class ActiveKeys {
+    activeKeys: Array<number>;
+    constructor();
+    /**
+     * Get the current array of active keys
+     * @returns - an array of active keys
+     */
+    getActiveKeys(): number[];
+}

package/library/types/Inputs/KeyboardController.d.ts

@@ -0,0 +1,57 @@
+import { ActiveKeys } from './InputClassesFactory';
+import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
+import { Config } from '../Config/Config';
+interface ICodeToKeyCode {
+    [key: string]: number;
+}
+/**
+ * Handles the Keyboard Inputs for the document
+ */
+export declare class KeyboardController {
+    toStreamerMessagesProvider: StreamMessageController;
+    activeKeysProvider: ActiveKeys;
+    config: Config;
+    private keyboardEventListenerTracker;
+    CodeToKeyCode: ICodeToKeyCode;
+    /**
+     * @param toStreamerMessagesProvider Stream message provider class object
+     * @param config The applications configuration. We're interested in the suppress browser keys option
+     * @param activeKeysProvider Active keys provider class object
+     */
+    constructor(toStreamerMessagesProvider: StreamMessageController, config: Config, activeKeysProvider: ActiveKeys);
+    /**
+     * Registers document keyboard events with the controller
+     */
+    registerKeyBoardEvents(): void;
+    /**
+     * Unregisters document keyboard events
+     */
+    unregisterKeyBoardEvents(): void;
+    /**
+     * Handles When a key is down
+     * @param keyboardEvent - Keyboard event
+     */
+    handleOnKeyDown(keyboardEvent: KeyboardEvent): void;
+    /**
+     * handles when a key is up
+     * @param keyboardEvent - Keyboard event
+     */
+    handleOnKeyUp(keyboardEvent: KeyboardEvent): void;
+    /**
+     * Handles when a key is press
+     * @param keyboard - Keyboard Event
+     */
+    handleOnKeyPress(keyboard: KeyboardEvent): void;
+    /**
+     * Gets the Keycode of the Key pressed
+     * @param keyboardEvent - Key board Event
+     * @returns - the key code of the Key
+     */
+    getKeycode(keyboardEvent: KeyboardEvent): number;
+    /**
+     * Browser keys do not have a charCode so we only need to test keyCode.
+     * @param keyCode - the browser keycode number
+     */
+    isKeyCodeBrowserKey(keyCode: number): boolean;
+}
+export {};

package/library/types/Inputs/LockedMouseEvents.d.ts

@@ -0,0 +1,80 @@
+import { MouseController } from './MouseController';
+import { IMouseEvents } from './IMouseEvents';
+import { NormalizedQuantizedUnsignedCoord } from '../Util/CoordinateConverter';
+import { ActiveKeys } from './InputClassesFactory';
+import { VideoPlayer } from '../VideoPlayer/VideoPlayer';
+/**
+ * Handle the mouse locked events
+ */
+export declare class LockedMouseEvents implements IMouseEvents {
+    x: number;
+    y: number;
+    coord: NormalizedQuantizedUnsignedCoord;
+    videoElementProvider: VideoPlayer;
+    mouseController: MouseController;
+    activeKeysProvider: ActiveKeys;
+    updateMouseMovePositionEvent: (mouseEvent: MouseEvent) => void;
+    private mouseEventListenerTracker;
+    /**
+     * @param videoElementProvider - Video Player instance
+     * @param mouseController - Mouse controller instance
+     * @param activeKeysProvider - Active keys provider instance
+     * @param playerStyleAttributesProvider - Player style attributes instance
+     */
+    constructor(videoElementProvider: VideoPlayer, mouseController: MouseController, activeKeysProvider: ActiveKeys);
+    /**
+     * Unregisters all event handlers
+     */
+    unregisterMouseEvents(): void;
+    /**
+     * Handle when the locked state Changed
+     */
+    lockStateChange(): void;
+    /**
+     * Handle the mouse move event, sends the mouse data to the UE Instance
+     * @param mouseEvent - Mouse Event
+     */
+    updateMouseMovePosition(mouseEvent: MouseEvent): void;
+    /**
+     * Handle the mouse Down event, sends the mouse data to the UE Instance
+     * @param mouseEvent - Mouse Event
+     */
+    handleMouseDown(mouseEvent: MouseEvent): void;
+    /**
+     * Handle the mouse Up event, sends the mouse data to the UE Instance
+     * @param mouseEvent - Mouse Event
+     */
+    handleMouseUp(mouseEvent: MouseEvent): void;
+    /**
+     * Handle the mouse wheel event, sends the mouse wheel data to the UE Instance
+     * @param wheelEvent - Mouse Event
+     */
+    handleMouseWheel(wheelEvent: WheelEvent): void;
+    /**
+     * Handle the mouse double click event, sends the mouse data to the UE Instance
+     * @param mouseEvent - Mouse Event
+     */
+    handleMouseDouble(mouseEvent: MouseEvent): void;
+    /**
+     * Handle the press mouse buttons event, sends the mouse data to the UE Instance
+     * @param mouseEvent - Mouse Event
+     */
+    handlePressMouseButtons(mouseEvent: MouseEvent): void;
+    /**
+     * Handle the release mouse buttons event, sends the mouse data to the UE Instance
+     * @param mouseEvent - Mouse Event
+     */
+    handleReleaseMouseButtons(mouseEvent: MouseEvent): void;
+}
+/**
+ * Extra types for Document and WheelEvent
+ */
+declare global {
+    interface Document {
+        mozPointerLockElement: unknown;
+        mozExitPointerLock?(): void;
+    }
+    interface WheelEvent {
+        wheelDelta: number;
+    }
+}

package/library/types/Inputs/MouseButtons.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Mouse Button Data
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button}
+ */
+export declare class MouseButton {
+    static mainButton: number;
+    static auxiliaryButton: number;
+    static secondaryButton: number;
+    static fourthButton: number;
+    static fifthButton: number;
+}
+/**
+ * Mouse Button Mask Data
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons}
+ */
+export declare class MouseButtonsMask {
+    static primaryButton: number;
+    static secondaryButton: number;
+    static auxiliaryButton: number;
+    static fourthButton: number;
+    static fifthButton: number;
+}

package/library/types/Inputs/MouseController.d.ts

@@ -0,0 +1,75 @@
+import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
+import { CoordinateConverter } from '../Util/CoordinateConverter';
+import { VideoPlayer } from '../VideoPlayer/VideoPlayer';
+import type { ActiveKeys } from './InputClassesFactory';
+/**
+ * Handles the Mouse Inputs for the document
+ */
+export declare class MouseController {
+    videoElementProvider: VideoPlayer;
+    toStreamerMessagesProvider: StreamMessageController;
+    coordinateConverter: CoordinateConverter;
+    activeKeysProvider: ActiveKeys;
+    private mouseEventListenerTracker;
+    /**
+     * @param toStreamerMessagesProvider - Stream message instance
+     * @param videoElementProvider - Video Player instance
+     * @param normalizeAndQuantize - A normalize and quantize instance
+     */
+    constructor(toStreamerMessagesProvider: StreamMessageController, videoElementProvider: VideoPlayer, coordinateConverter: CoordinateConverter, activeKeysProvider: ActiveKeys);
+    /**
+     * Clears all the click events on the current video element parent div
+     */
+    unregisterMouseEvents(): void;
+    /**
+     * Register a locked mouse class
+     * @param mouseController - a mouse controller instance
+     * @param playerStyleAttributesProvider - a player style attributes instance
+     */
+    registerLockedMouseEvents(mouseController: MouseController): void;
+    /**
+     * Register a hovering mouse class
+     * @param mouseController - A mouse controller object
+     */
+    registerHoveringMouseEvents(mouseController: MouseController): void;
+    /**
+     * Set the mouse enter and mouse leave events
+     */
+    registerMouseEnterAndLeaveEvents(): void;
+    /**
+     * Handle when a mouse button is released
+     * @param buttons - Mouse Button
+     * @param X - Mouse pointer X coordinate
+     * @param Y - Mouse pointer Y coordinate
+     */
+    releaseMouseButtons(buttons: number, X: number, Y: number): void;
+    /**
+     * Handle when a mouse button is pressed
+     * @param buttons - Mouse Button
+     * @param X - Mouse pointer X coordinate
+     * @param Y - Mouse pointer Y coordinate
+     */
+    pressMouseButtons(buttons: number, X: number, Y: number): void;
+    /**
+     * Handles mouse enter
+     */
+    sendMouseEnter(): void;
+    /**
+     * Handles mouse Leave
+     */
+    sendMouseLeave(): void;
+    /**
+     * Handles when a mouse button is pressed down
+     * @param button - Mouse Button Pressed
+     * @param X  - Mouse X Coordinate
+     * @param Y  - Mouse Y Coordinate
+     */
+    sendMouseDown(button: number, X: number, Y: number): void;
+    /**
+     * Handles when a mouse button is pressed up
+     * @param button - Mouse Button Pressed
+     * @param X  - Mouse X Coordinate
+     * @param Y  - Mouse Y Coordinate
+     */
+    sendMouseUp(button: number, X: number, Y: number): void;
+}

package/library/types/Inputs/SpecialKeyCodes.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Registers the Special Key codes
+ *  Must be kept in sync with JavaScriptKeyCodeToFKey C++ array.
+ * The index of the entry in the array is the special key code given below.
+ */
+export declare class SpecialKeyCodes {
+    static backSpace: number;
+    static shift: number;
+    static control: number;
+    static alt: number;
+    static rightShift: number;
+    static rightControl: number;
+    static rightAlt: number;
+}

package/library/types/Inputs/TouchController.d.ts

@@ -0,0 +1,53 @@
+import { CoordinateConverter } from '../Util/CoordinateConverter';
+import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
+import { VideoPlayer } from '../VideoPlayer/VideoPlayer';
+import { ITouchController } from './ITouchController';
+/**
+ * Handles the Touch input Events
+ */
+export declare class TouchController implements ITouchController {
+    toStreamerMessagesProvider: StreamMessageController;
+    videoElementProvider: VideoPlayer;
+    coordinateConverter: CoordinateConverter;
+    videoElementParent: HTMLVideoElement;
+    fingers: number[];
+    fingerIds: Map<any, any>;
+    maxByteValue: number;
+    private touchEventListenerTracker;
+    /**
+     * @param toStreamerMessagesProvider - Stream message instance
+     * @param videoElementProvider - Video Player instance
+     * @param coordinateConverter - A coordinate converter instance
+     */
+    constructor(toStreamerMessagesProvider: StreamMessageController, videoElementProvider: VideoPlayer, coordinateConverter: CoordinateConverter);
+    /**
+     * Unregister all touch events
+     */
+    unregisterTouchEvents(): void;
+    /**
+     * Remember a touch command
+     * @param touch - the touch command
+     */
+    rememberTouch(touch: Touch): void;
+    /**
+     * Forgets a touch command
+     * @param touch - the touch command
+     */
+    forgetTouch(touch: Touch): void;
+    /**
+     * When a touch event starts
+     * @param touchEvent - the touch event being intercepted
+     */
+    onTouchStart(touchEvent: TouchEvent): void;
+    /**
+     * When a touch event ends
+     * @param touchEvent - the touch event being intercepted
+     */
+    onTouchEnd(touchEvent: TouchEvent): void;
+    /**
+     * when a moving touch event occurs
+     * @param touchEvent - the touch event being intercepted
+     */
+    onTouchMove(touchEvent: TouchEvent): void;
+    emitTouchData(type: string, touches: TouchList): void;
+}

package/library/types/Inputs/XRGamepadController.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="webxr" />
+import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
+import { Controller } from './GamepadTypes';
+/**
+ * The class that handles the functionality of xrgamepads and controllers
+ */
+export declare class XRGamepadController {
+    controllers: Array<Controller>;
+    toStreamerMessagesProvider: StreamMessageController;
+    /**
+     * @param toStreamerMessagesProvider - Stream message instance
+     */
+    constructor(toStreamerMessagesProvider: StreamMessageController);
+    updateStatus(source: XRInputSource, frame: XRFrame, refSpace: XRReferenceSpace): void;
+}

package/library/types/Logger/Logger.d.ts

@@ -0,0 +1,38 @@
+export declare class Logger {
+    static verboseLogLevel: number;
+    /**
+     * Captures the stack and returns it
+     * @returns the current stack
+     */
+    static GetStackTrace(): string;
+    /**
+     * Set the log verbosity level
+     */
+    static SetLoggerVerbosity(verboseLogLevel: number): void;
+    /**
+     * The standard logging output
+     * @param stack - the stack trace
+     * @param message - the message to be logged
+     * @param verbosity - the verbosity level
+     */
+    static Log(stack: string, message: string, verbosity?: number): void;
+    /**
+     * The standard logging output
+     * @param stack - the stack trace
+     * @param message - the message to be logged
+     * @param verbosity - the verbosity level
+     */
+    static Info(stack: string, message: string, verbosity?: number): void;
+    /**
+     * The standard logging output
+     * @param stack - the stack trace
+     * @param message - the message to be logged
+     */
+    static Error(stack: string, message: string): void;
+    /**
+     * The standard logging output
+     * @param stack - the stack trace
+     * @param message - the message to be logged
+     */
+    static Warning(stack: string, message: string): void;
+}

package/library/types/PeerConnectionController/AggregatedStats.d.ts

@@ -0,0 +1,77 @@
+import { InboundRTPStats, InboundVideoStats, InboundAudioStats } from './InboundRTPStats';
+import { InboundTrackStats } from './InboundTrackStats';
+import { DataChannelStats } from './DataChannelStats';
+import { CandidateStat } from './CandidateStat';
+import { CandidatePairStats } from './CandidatePairStats';
+import { OutBoundRTPStats, OutBoundVideoStats } from './OutBoundRTPStats';
+import { SessionStats } from './SessionStats';
+import { StreamStats } from './StreamStats';
+import { CodecStats } from './CodecStats';
+export declare class AggregatedStats {
+    inboundVideoStats: InboundVideoStats;
+    inboundAudioStats: InboundAudioStats;
+    lastVideoStats: InboundVideoStats;
+    lastAudioStats: InboundAudioStats;
+    candidatePair: CandidatePairStats;
+    DataChannelStats: DataChannelStats;
+    localCandidates: Array<CandidateStat>;
+    remoteCandidates: Array<CandidateStat>;
+    outBoundVideoStats: OutBoundVideoStats;
+    sessionStats: SessionStats;
+    streamStats: StreamStats;
+    codecs: Map<string, string>;
+    constructor();
+    /**
+     * Gather all the information from the RTC Peer Connection Report
+     * @param rtcStatsReport - RTC Stats Report
+     */
+    processStats(rtcStatsReport: RTCStatsReport): void;
+    /**
+     * Process stream stats data from webrtc
+     *
+     * @param stat - the stats coming in from webrtc
+     */
+    handleStream(stat: StreamStats): void;
+    /**
+     * Process the Ice Candidate Pair Data
+     * @param stat - the stats coming in from ice candidates
+     */
+    handleCandidatePair(stat: CandidatePairStats): void;
+    /**
+     * Process the Data Channel Data
+     * @param stat - the stats coming in from the data channel
+     */
+    handleDataChannel(stat: DataChannelStats): void;
+    /**
+     * Process the Local Ice Candidate Data
+     * @param stat - local stats
+     */
+    handleLocalCandidate(stat: CandidateStat): void;
+    /**
+     * Process the Remote Ice Candidate Data
+     * @param stat - ice candidate stats
+     */
+    handleRemoteCandidate(stat: CandidateStat): void;
+    /**
+     * Process the Inbound RTP Audio and Video Data
+     * @param stat - inbound rtp stats
+     */
+    handleInBoundRTP(stat: InboundRTPStats): void;
+    /**
+     * Process the outbound RTP Audio and Video Data
+     * @param stat - remote outbound stats
+     */
+    handleRemoteOutBound(stat: OutBoundRTPStats): void;
+    /**
+     * Process the Inbound Video Track Data
+     * @param stat - video track stats
+     */
+    handleTrack(stat: InboundTrackStats): void;
+    handleCodec(stat: CodecStats): void;
+    handleSessionStatistics(videoStartTime: number, inputController: boolean | null, videoEncoderAvgQP: number): void;
+    /**
+     * Check if a value coming in from our stats is actually a number
+     * @param value - the number to be checked
+     */
+    isNumber(value: unknown): boolean;
+}

package/library/types/PeerConnectionController/CandidatePairStats.d.ts

@@ -0,0 +1,15 @@
+/**
+ * ICE Candidate Pair Stats collected from the RTC Stats Report
+ */
+export declare class CandidatePairStats {
+    bytesReceived: number;
+    bytesSent: number;
+    localCandidateId: string;
+    remoteCandidateId: string;
+    nominated: boolean;
+    readable: boolean;
+    writable: boolean;
+    selected: boolean;
+    state: string;
+    currentRoundTripTime: number;
+}

package/library/types/PeerConnectionController/CandidateStat.d.ts

@@ -0,0 +1,11 @@
+/**
+ * ICE Candidate Stat collected from the RTC Stats Report
+ */
+export declare class CandidateStat {
+    label: string;
+    id: string;
+    address: string;
+    candidateType: string;
+    port: number;
+    protocol: 'tcp' | 'udp';
+}

package/library/types/PeerConnectionController/CodecStats.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Codec Stats collected from the RTC Stats Report
+ */
+export declare class CodecStats {
+    clockRate: number;
+    id: string;
+    mimeType: string;
+    payloadType: number;
+    sdpFmtpLine: string;
+    timestamp: number;
+    transportId: string;
+    type: string;
+    channels: number;
+}

package/library/types/PeerConnectionController/DataChannelStats.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Data Channel Stats collected from the RTC Stats Report
+ */
+export declare class DataChannelStats {
+    bytesReceived: number;
+    bytesSent: number;
+    dataChannelIdentifier: number;
+    id: string;
+    label: string;
+    messagesReceived: number;
+    messagesSent: number;
+    protocol: string;
+    state: string;
+    timestamp: number;
+}