@yang__yj/pixelstreaming-core 1.0.0

package/library/types/WebSockets/WebSocketController.d.ts

@@ -0,0 +1,96 @@
+import * as MessageReceive from './MessageReceive';
+import { SignallingProtocol } from './SignallingProtocol';
+declare global {
+    interface WebSocket {
+        onmessagebinary?(event?: MessageEvent): void;
+    }
+}
+/**
+ * The controller for the WebSocket and all associated methods
+ */
+export declare class WebSocketController {
+    WS_OPEN_STATE: number;
+    webSocket: WebSocket;
+    onOpen: EventTarget;
+    onClose: EventTarget;
+    signallingProtocol: SignallingProtocol;
+    constructor();
+    /**
+     * Connect to the signaling server
+     * @param connectionURL - The Address of the signaling server
+     * @returns - If there is a connection
+     */
+    connect(connectionURL: string): boolean;
+    /**
+     * Handles what happens when a message is received in binary form
+     * @param event - Message Received
+     */
+    handleOnMessageBinary(event: MessageEvent): void;
+    /**
+     * Handles what happens when a message is received
+     * @param event - Message Received
+     */
+    handleOnMessage(event: MessageEvent): void;
+    /**
+     * Handles when the Websocket is opened
+     * @param event - Not Used
+     */
+    handleOnOpen(event: Event): void;
+    /**
+     * Handles when there is an error on the websocket
+     * @param event - Error Payload
+     */
+    handleOnError(): void;
+    /**
+     * Handles when the Websocket is closed
+     * @param event - Close Event
+     */
+    handleOnClose(event: CloseEvent): void;
+    requestStreamerList(): void;
+    sendSubscribe(streamerid: string): void;
+    sendUnsubscribe(): void;
+    sendWebRtcOffer(offer: RTCSessionDescriptionInit): void;
+    sendWebRtcAnswer(answer: RTCSessionDescriptionInit): void;
+    sendWebRtcDatachannelRequest(): void;
+    sendSFURecvDataChannelReady(): void;
+    /**
+     * Sends an RTC Ice Candidate to the Server
+     * @param candidate - RTC Ice Candidate
+     */
+    sendIceCandidate(candidate: RTCIceCandidate): void;
+    /**
+     * Closes the Websocket connection
+     */
+    close(): void;
+    /** Event used for Displaying websocket closed messages */
+    onWebSocketOncloseOverlayMessage(event: CloseEvent): void;
+    /**
+     * The Message Contains the payload of the peer connection options used for the RTC Peer hand shake
+     * @param messageConfig - Config Message received from he signaling server
+     */
+    onConfig(messageConfig: MessageReceive.MessageConfig): void;
+    /**
+     * The Message Contains the payload of the peer connection options used for the RTC Peer hand shake
+     * @param messageConfig - Config Message received from he signaling server
+     */
+    onStreamerList(messageStreamerList: MessageReceive.MessageStreamerList): void;
+    /**
+     * @param iceCandidate - Ice Candidate sent from the Signaling server server's RTC hand shake
+     */
+    onIceCandidate(iceCandidate: RTCIceCandidateInit): void;
+    /**
+     * Event is fired when the websocket receives the answer for the RTC peer Connection
+     * @param messageAnswer - The RTC Answer payload from the signaling server
+     */
+    onWebRtcAnswer(messageAnswer: MessageReceive.MessageAnswer): void;
+    /**
+     * Event is fired when the websocket receives the offer for the RTC peer Connection
+     * @param messageOffer - The sdp offer
+     */
+    onWebRtcOffer(messageOffer: MessageReceive.MessageOffer): void;
+    /**
+     * Event is fired when the websocket receives the data channels for the RTC peer Connection from the SFU
+     * @param messageDataChannels - The data channels details
+     */
+    onWebRtcPeerDataChannels(messageDataChannels: MessageReceive.MessagePeerDataChannels): void;
+}

package/library/types/WebXR/WebXRController.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="webxr" />
+import { WebRtcPlayerController } from '../WebRtcPlayer/WebRtcPlayerController';
+export declare class WebXRController {
+    private xrSession;
+    private xrRefSpace;
+    private gl;
+    private positionLocation;
+    private texcoordLocation;
+    private resolutionLocation;
+    private offsetLocation;
+    private positionBuffer;
+    private texcoordBuffer;
+    private webRtcController;
+    private xrGamepadController;
+    private xrControllers;
+    onSessionStarted: EventTarget;
+    onSessionEnded: EventTarget;
+    onFrame: EventTarget;
+    constructor(webRtcPlayerController: WebRtcPlayerController);
+    xrClicked(): void;
+    onXrSessionEnded(): void;
+    onXrSessionStarted(session: XRSession): void;
+    onXrFrame(time: DOMHighResTimeStamp, frame: XRFrame): void;
+    private render;
+    static isSessionSupported(mode: XRSessionMode): Promise<boolean>;
+}

package/library/types/pixelstreamingfrontend.d.ts

@@ -0,0 +1,25 @@
+export { WebRtcPlayerController } from './WebRtcPlayer/WebRtcPlayerController';
+export { WebXRController } from './WebXR/WebXRController';
+export { Config, ControlSchemeType, Flags, NumericParameters, TextParameters, OptionParameters, FlagsIds, NumericParametersIds, TextParametersIds, OptionParametersIds, AllSettings } from './Config/Config';
+export { SettingBase } from './Config/SettingBase';
+export { SettingFlag } from './Config/SettingFlag';
+export { SettingNumber } from './Config/SettingNumber';
+export { SettingOption } from './Config/SettingOption';
+export { SettingText } from './Config/SettingText';
+export { PixelStreaming } from './PixelStreaming/PixelStreaming';
+export { AFKController as AfkLogic } from './AFK/AFKController';
+export { LatencyTestResults } from './DataChannel/LatencyTestResults';
+export { EncoderSettings, InitialSettings, WebRTCSettings } from './DataChannel/InitialSettings';
+export { AggregatedStats } from './PeerConnectionController/AggregatedStats';
+export { Logger } from './Logger/Logger';
+export { UnquantizedDenormalizedUnsignedCoord as UnquantizedAndDenormalizeUnsigned } from './Util/CoordinateConverter';
+export { MessageSend } from './WebSockets/MessageSend';
+export { MessageRecv, MessageStreamerList } from './WebSockets/MessageReceive';
+export { WebSocketController } from './WebSockets/WebSocketController';
+export { SignallingProtocol } from './WebSockets/SignallingProtocol';
+export { CandidatePairStats } from './PeerConnectionController/CandidatePairStats';
+export { CandidateStat } from './PeerConnectionController/CandidateStat';
+export { DataChannelStats } from './PeerConnectionController/DataChannelStats';
+export { InboundAudioStats, InboundVideoStats } from './PeerConnectionController/InboundRTPStats';
+export { OutBoundVideoStats } from './PeerConnectionController/OutBoundRTPStats';
+export * from './Util/EventEmitter';

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@yang__yj/pixelstreaming-core",
+  "version": "1.0.0",
+  "main": "library/dist/lib-pixelstreamingfrontend.js",
+  "module": "library/dist/lib-pixelstreamingfrontend.esm.js",
+  "types": "library/types/pixelstreamingfrontend.d.ts",
+  "files": [
+    "library/dist",
+    "library/types"
+  ],
+  "scripts": {
+    "prepublishOnly": "echo using existing build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "ISC"
+}