@stormstreaming/stormstreamer 0.9.2-beta.2 → 0.9.3-beta.0

package/dist/types/network/AbstractSocket.d.ts

@@ -1,26 +1,120 @@
+/**
+ * Base for all classes that use WebSocksts
+ */
 import { ConnectionState } from "../playback/enum/ConnectionState";
 import { Logger } from "../logger/Logger";
+/**
+ * Abstract socket connection
+ */
 export declare class AbstractSocket {
+    /**
+     * Connection timeout
+     * @protected
+     */
     protected readonly CONNECTION_TIMEOUT: number;
+    /**
+     * Logger for this class
+     * @private
+     */
     protected _logger: Logger;
+    /**
+     * WebSocket object
+     * @protected
+     */
     protected socket: WebSocket;
+    /**
+     * Current WebSocket URL (with protocol and port)
+     * @protected
+     */
     protected socketURL: string;
+    /**
+     * Whenever it is binary data or not
+     * @protected
+     */
     protected isBinary: boolean;
+    /**
+     * Current state of the connection
+     * @private
+     */
     protected _connectionState: ConnectionState;
+    /**
+     * Number of messages that arrived
+     * @private
+     */
     protected _messageCount: number;
+    /**
+     * Connection timeout for the player
+     * @protected
+     */
     protected _connectionTimeout: any;
+    /**
+     * Was disconnected by user?
+     * @protected
+     */
     protected _disconnectedByUser: boolean;
+    /**
+     * Whenever we're connected to a server or not
+     * @private
+     */
     protected _isConnected: boolean;
+    /**
+     * Counts connections
+     * @protected
+     */
     protected _sequenceNumber: number;
+    /**
+     * Creates and starts new socket connection
+     *
+     * @param socketURL
+     * @private
+     */
     startConnection(): void;
+    /**
+     * Method is called once connection with the server is established
+     * @param event
+     */
     protected onSocketOpen(event: Event): void;
+    /**
+     * Method is called once connection with the server is closed (
+     *
+     * @param event
+     */
     protected onSocketClose(event: CloseEvent): void;
+    /**
+     * Method is called whenever a new message from socket arrives
+     * @private
+     */
     protected onSocketMessage(event: MessageEvent): void;
+    /**
+     * Method is called whenever an error on socket occures
+     *
+     * @param event
+     * @private
+     */
     protected onSocketError(event: Event): void;
     protected onError(error: string): void;
+    /**
+     * Sends data via socket
+     * @param data
+     */
     sendData(data: any): void;
+    /**
+     * Returns player state e.g. NOT_INITIALIZED, STARTED, CONNECTED, ENDED
+     */
     getConnectionState(): ConnectionState;
+    /**
+     * Rozłacza z serwerem
+     */
     disconnect(byUser?: boolean): void;
+    /**
+     * Destroys connection
+     *
+     * @protected
+     */
     protected destroy(): void;
+    /**
+     * Returns currenly used socketURL
+     * @protected
+     */
     getSocketURL(): string;
 }

package/dist/types/network/NetworkController.d.ts

@@ -1,12 +1,39 @@
 import { WowzaConnection } from "./WowzaConnection";
 import { Logger } from "../logger/Logger";
 import { StormStreamer } from "../StormStreamer";
+/**
+ * Main class for managing socket connections (only one per instance) and parsing packets.
+ */
 export declare class NetworkController {
+    /**
+     * Reference to the main class
+     * @private
+     */
     private readonly _main;
+    /**
+     * Object containing WebSocket Connection (only one is needed)
+     * @private
+     */
     private _connection;
+    /**
+     * Reference to the player logger
+     * @private
+     */
     protected _logger: Logger;
+    /**
+     * Current streamKey
+     * @private
+     */
     private _currentStreamKey;
+    /**
+     * Last state
+     * @private
+     */
     private _lastState;
+    /**
+     * Constructor
+     * @param main reference to the main class
+     */
     constructor(main: StormStreamer);
     initialize(): void;
     start(): void;
@@ -15,6 +42,12 @@ export declare class NetworkController {
     private onServerDisconnect;
     onMessage: (event: MessageEvent) => void;
     sendMessage(message: String): void;
+    /**
+     * Returns current SocketConnection object
+     */
     getConnection(): WowzaConnection;
+    /**
+     * Returns streamKey that is currently being used
+     */
     getCurrentStreamKey(): string;
 }

package/dist/types/network/WowzaConnection.d.ts

@@ -2,21 +2,84 @@ import { AbstractSocket } from "./AbstractSocket";
 import { StormServerItem } from "../model/StormServerItem";
 import { NetworkController } from "./NetworkController";
 import { StormStreamer } from "../StormStreamer";
+/**
+ * Main class for communicating with Storm Streaming Server
+ */
 export declare class WowzaConnection extends AbstractSocket {
+    /**
+     * Reference to the main class
+     * @private
+     */
     private readonly _main;
+    /**
+     * Reference to the NetworkController object
+     * @private
+     */
     private readonly _networkController;
+    /**
+     * Current server connection data
+     * @private
+     */
     private _currServer;
+    /**
+     * How long (in seconds) will it take to reconnect to a server after a failure
+     * @private
+     */
     private _reconnectTimer;
+    /**
+     * Constructor
+     * @param main
+     * @constructor
+     */
     constructor(main: StormStreamer, networkController: NetworkController);
     initialize(): void;
+    /**
+     * On server connection opened;
+     * @param event
+     * @protected
+     */
     protected onSocketOpen(event: Event): void;
+    /**
+     * On server connection error
+     * @param event
+     * @protected
+     */
     protected onSocketError(event: Event): void;
+    /**
+     * On server connection closed
+     * @param event
+     * @protected
+     */
     protected onSocketClose(event: CloseEvent): void;
+    /**
+     * Method is called whenever a new message from socket arrives
+     * @private
+     */
     protected onSocketMessage(event: MessageEvent): void;
+    /**
+     * Creates new URL for WebSockets based on serverItem object
+     * @param serverItem
+     * @private
+     */
     private createURL;
+    /**
+     * Initiates reconnection procedure
+     * @private
+     */
     private initiateReconnect;
+    /**
+     * Picks new server from this list of available ones
+     * @param serverList
+     * @private
+     */
     private pickServerFromList;
+    /**
+     * Returns true/false depending if a connection with a server is active
+     */
     isConnectionActive(): boolean;
     getCurrentServer(): StormServerItem | null;
+    /**
+     * Destroys object and clean-ups everything that is needed
+     */
     destroy(): void;
 }

package/dist/types/network/WowzaStatusConnection.d.ts

@@ -1,19 +1,73 @@
 import { AbstractSocket } from "./AbstractSocket";
 import { StormServerItem } from "../model/StormServerItem";
 import { StormStreamer } from "../StormStreamer";
+/**
+ * Main class for communicating with Storm Streaming Server
+ */
 export declare class WowzaStatusConnection extends AbstractSocket {
+    /**
+     * Reference to the main class
+     * @private
+     */
     private readonly _main;
+    /**
+     * Current server connection data
+     * @private
+     */
     private _currServer;
+    /**
+     * How long (in seconds) will it take to reconnect to a server after a failure
+     * @private
+     */
     private _reconnectTimer;
+    /**
+     * Constructor
+     * @param main
+     * @constructor
+     */
     constructor(main: StormStreamer, server: StormServerItem);
     initialize(): void;
+    /**
+     * On server connection opened;
+     * @param event
+     * @protected
+     */
     protected onSocketOpen(event: Event): void;
+    /**
+     * On server connection error
+     * @param event
+     * @protected
+     */
     protected onSocketError(event: Event): void;
+    /**
+     * On server connection closed
+     * @param event
+     * @protected
+     */
     protected onSocketClose(event: CloseEvent): void;
+    /**
+     * Method is called whenever a new message from socket arrives
+     * @private
+     */
     protected onSocketMessage(event: MessageEvent): void;
+    /**
+     * Initiates reconnection procedure
+     * @private
+     */
     private initiateReconnect;
+    /**
+     * Creates new URL for WebSockets based on serverItem object
+     * @param serverItem
+     * @private
+     */
     private createURL;
+    /**
+     * Returns true/false depending if a connection with a server is active
+     */
     isConnectionActive(): boolean;
     getCurrentServer(): StormServerItem | null;
+    /**
+     * Destroys object and clean-ups everything that is needed
+     */
     destroy(): void;
 }

package/dist/types/playback/CooldownMonitor.d.ts

@@ -1,9 +1,26 @@
+/**
+ * Simple cooldown mechanism
+ */
 export declare class CooldownMonitor {
     private cooldownDuration;
     private lastCooldownTime;
+    /**
+     * Constructs a new instance of CooldownMonitor.
+     * @param cooldownDuration The cooldown duration in seconds.
+     */
     constructor(cooldownDuration?: number);
+    /**
+     * Triggers the cooldown, setting the last cooldown time to the current timestamp.
+     */
     triggerCooldown(): void;
     setCooldownDuration(newTime: number): void;
+    /**
+     * Checks if the cooldown is still in effect.
+     * @returns true if within cooldown period, otherwise false.
+     */
     isCooling(): boolean;
+    /**
+     * Resets the cooldown by setting the last cooldown time to zero.
+     */
     reset(): void;
 }