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

package/dist/types/events/EventDispatcher.d.ts

@@ -1,15 +1,49 @@
 import { StormStreamerEvent } from "./StormStreamerEvent";
 import { StormStreamerListener } from "./StormStreamerListener";
 import { Logger } from "../logger/Logger";
+/**
+ * General class for event-listeners
+ */
 export declare class EventDispatcher {
+    /**
+     * Whenever instance of this class has been removed
+     * @protected
+     */
     protected _isRemoved: boolean;
+    /**
+     * Logger attached to this player
+     * @private
+     */
     protected _logger: Logger;
+    /**
+     * An array storing all the listeners
+     * @private
+     */
     protected _listeners: {
         [K in keyof StormStreamerEvent]?: Array<StormStreamerListener<K>>;
     };
     constructor();
+    /**
+     * Method registers event listener with the object
+     * @param eventName name of an event (as a string)
+     * @param listener a reference to a method
+     * @param removable whenever this listener can be removed or not
+     */
     addEventListener<K extends keyof StormStreamerEvent>(eventName: K, listener: (ev: StormStreamerEvent[K]) => void, removable?: boolean): boolean;
+    /**
+     * Method removes a listener from this object based on event name and used method
+     * @param eventName name of an event (as a string)
+     * @param listenera reference to a method (optional)
+     */
     removeEventListener<K extends keyof StormStreamerEvent>(eventName: K, listener?: (ev: StormStreamerEvent[K]) => void): boolean;
+    /**
+     * Method removes all event listeners
+     */
     removeAllEventListeners<K extends keyof StormStreamerEvent>(): void;
+    /**
+     * Method dispatches an event of a given eventName
+     * @param eventName
+     * @param event
+     */
     dispatchEvent<K extends keyof StormStreamerEvent>(eventName: K, event: StormStreamerEvent[K]): void;
 }

package/dist/types/graph/MicrophoneGraph.d.ts

@@ -0,0 +1,11 @@
+import { StormStreamer } from "../StormStreamer";
+import { IGraph } from "./IGraph";
+export declare class MicrophoneGraph implements IGraph {
+    private _object;
+    private _main;
+    private _graph;
+    constructor(main: StormStreamer, container: string | HTMLElement);
+    start(): MicrophoneGraph;
+    private onStreamStatsUpdate;
+    stop(): MicrophoneGraph;
+}

package/dist/types/logger/Logger.d.ts

@@ -1,26 +1,129 @@
+/**
+ * Logger that helps outputting messages
+ */
 import { DebugData } from "../config/DebugData";
 import { StormStreamer } from "../StormStreamer";
 export declare class Logger {
+    /**
+     * Defines what color an info log would be outputted (can be either a color name or #hex)
+     * @private
+     */
     private static INFO_COLOR;
+    /**
+     * Defines what color a warning log would be outputted (can be either a color name or #hex)
+     * @private
+     */
     private static WARNING_COLOR;
+    /**
+     * Defines what color an error log would be outputted (can be either a color name or #hex)
+     * @private
+     */
     private static ERROR_COLOR;
+    /**
+     * Defines what color a success log would be outputted (can be either a color name or #hex)
+     * @private
+     */
     private static SUCCESS_COLOR;
+    /**
+     * Defines what color a success log would be outputted (can be either a color name or #hex)
+     * @private
+     */
     private static TRACE_COLOR;
+    /**
+     * Stores original debug config object
+     * @private
+     */
     private _debugConfig;
+    /**
+     * Reference to main object
+     * @private
+     */
     private _stormStreamer;
+    /**
+     * List of colors used for monoColor option
+     * @private
+     */
     private colorOrder;
+    /**
+     * Selected monocolor
+     * @private
+     */
     private _monoColor;
+    /**
+     * Stores all loges within this array
+     * @private
+     */
     private _logMemory;
+    /**
+     * Main name of the instance
+     * @private
+     */
     private _streamerInstanceID;
+    /**
+     * Constructor
+     *
+     * @param config object containing settings for logger
+     * @param stormLibrary reference to main class
+     */
     constructor(config: DebugData, stormStreamer: StormStreamer);
+    /**
+     * Creates new "info" type log
+     *
+     * @param objectName object that called the log
+     * @param message log message
+     */
     info(objectName: any, message: string): void;
+    /**
+     * Creates new "warning" type log
+     *
+     * @param objectName object that called the log
+     * @param message log message
+     */
     warning(objectName: any, message: string): void;
     decoratedLog(text: string, scheme: string): void;
+    /**
+     * Creates new "error" type log
+     *
+     * @param objectName object that called the log
+     * @param message log message
+     */
     error(objectName: any, message: string): void;
+    /**
+     * Creates new "success" type log
+     *
+     * @param objectName object that called the log
+     * @param message log message
+     */
     success(objectName: any, message: string): void;
+    /**
+     * Creates new "trace" type log
+     *
+     * @param objectName object that called the log
+     * @param message log message
+     */
     trace(objectName: any, message: string): void;
+    /**
+     * Prepares console message and formats its text
+     * @param _objectName object that called the log
+     * @param message log message
+     * @private
+     */
     private logData;
+    /**
+     * Writes log to a DOM container
+     *
+     * @param message the message
+     * @param color of the log
+     * @private
+     */
     private writeToContainer;
+    /**
+     * Sets player id
+     * @param playerID
+     */
     setPlayerID(playerID: number): void;
+    /**
+     * Returns all logs
+     */
     getAllLogs(): Array<string>;
 }

package/dist/types/model/AbstractSourceItem.d.ts

@@ -1,9 +1,32 @@
 import { ProtocolType } from "../config/enum/ProtocolType";
 import { StreamInfo } from "./StreamInfo";
+/**
+ * Abstract class for all source items (e.g. webrtc, rtmp, mpeg-dash)
+ */
 export declare class AbstractSourceItem {
+    /**
+     * Protocol type e.g. RTMP, RTSP
+     * @private
+     */
     protected type: ProtocolType;
+    /**
+     * Info object (cointains data related to video width, height, fps, bitrate e.g.)
+     * @private
+     */
     protected streamInfo: StreamInfo;
+    /**
+     * Constructor
+     *
+     * @param type
+     * @param info
+     */
     constructor(type: ProtocolType, info: StreamInfo);
+    /**
+     * Returns protocol type
+     */
     getType(): ProtocolType;
+    /**
+     * Return info object
+     */
     getStreamInfo(): StreamInfo;
 }

package/dist/types/model/GatewayServerItem.d.ts

@@ -1,17 +1,70 @@
 import { IServerItem } from "./IServerItem";
+/**
+ * Class stores information related to storm gateway servers
+ */
 export declare class GatewayServerItem implements IServerItem {
+    /**
+     * Server url
+     * @private
+     */
     private host;
+    /**
+     * Application name
+     * @private
+     */
     private application;
+    /**
+     * Port for storm (default is 443)
+     * @private
+     */
     private port;
+    /**
+     * Whenver connection should be made via SSL (default is true)
+     * @private
+     */
     private isSSL;
+    /**
+     * Whenever player could not establish connection with this host
+     * @private
+     */
     private hasFaild;
+    /**
+     * Constructor
+     *
+     * @param host server URL e.g. "cdn-e001.stormstreaming.com"
+     * @param applicationName e.g. "live
+     * @param port usually 443
+     * @param isSSL whenever connection should be stablished via SSL (true by default)
+     */
     constructor(host: string, application: string, port?: number, isSSL?: boolean);
+    /**
+     * Returns server URL
+     */
     getHost(): string;
+    /**
+     * Returns port number
+     */
     getPort(): number;
+    /**
+     * Returns whenever connection should be established via SSL
+     */
     getIfSSL(): boolean;
+    /**
+     * Returns whenever connection faild while trying to connect
+     */
     getIfFaild(): boolean;
+    /**
+     * Marks this server as faild, prevent it from being used anymore
+     * @param value
+     */
     setAsFaild(value: boolean): void;
+    /**
+     * Returns application
+     */
     getApplication(): string;
+    /**
+     * Returns data from this object
+     */
     getData(): any;
     toString(): string;
 }

package/dist/types/model/IServerItem.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Interface for source item
+ */
 export interface IServerItem {
     getHost(): string;
     getApplication(): string;

package/dist/types/model/ISourceItem.d.ts

@@ -1,5 +1,8 @@
 import { ProtocolType } from "../config/enum/ProtocolType";
 import { StreamInfo } from "./StreamInfo";
+/**
+ * Interface for source item
+ */
 export interface ISourceItem {
     getType(): ProtocolType;
     getStreamInfo(): StreamInfo;

package/dist/types/model/IStreamItem.d.ts

@@ -1,4 +1,7 @@
 import { ProtocolType } from "../config/enum/ProtocolType";
+/**
+ * Interface for source item
+ */
 export interface IStreamItem {
     getType(): ProtocolType;
     getStreamName(): string;

package/dist/types/model/RTMPSourceItem.d.ts

@@ -1,17 +1,67 @@
 import { AbstractSourceItem } from "./AbstractSourceItem";
 import { ISourceItem } from "./ISourceItem";
 import { StreamInfo } from "./StreamInfo";
+/**
+ * Class containing RTMP Source Item
+ */
 export declare class RTMPSourceItem extends AbstractSourceItem implements ISourceItem {
+    /**
+     * RTMP URL
+     * @private
+     */
     private host;
+    /**
+     * RTMP Application name. May also include instance e.g. "live/test")
+     * @private
+     */
     private application;
+    /**
+     * Name of the stream. May include prefix and paths  e.g. mp4:/vod/test
+     * @private
+     */
     private streamKey;
+    /**
+     * RTMP Port
+     * @private
+     */
     private port;
+    /**
+     * Whenever this source item is default
+     * @private
+     */
     private defaultSource;
+    /**
+     * Constructor
+     * @param host rtmp url
+     * @param application
+     * @param streamName
+     * @param port rtmp port
+     * @param streamInfo
+     * @param defaultSource
+     */
     constructor(host: string, application: string, streamKey: string, port: number, streamInfo: StreamInfo, defaultSource: boolean);
+    /**
+     * Returns source URL
+     */
     getHost(): string;
+    /**
+     * Returns source port
+     */
     getPort(): number;
+    /**
+     * Returns source application name
+     */
     getApplicationName(): string;
+    /**
+     * Returns source stream name
+     */
     getStreamKey(): string;
+    /**
+     * Returns whenver source is default for this playback
+     */
     isDefaultSource(): boolean;
+    /**
+     * Creates a string containing source information in readble form
+     */
     toString(): string;
 }

package/dist/types/model/RTSPSourceItem.d.ts

@@ -1,17 +1,67 @@
 import { AbstractSourceItem } from "./AbstractSourceItem";
 import { ISourceItem } from "./ISourceItem";
 import { StreamInfo } from "./StreamInfo";
+/**
+ * Class containing RTMP Source Item
+ */
 export declare class RTSPSourceItem extends AbstractSourceItem implements ISourceItem {
+    /**
+     * RTMP URL
+     * @private
+     */
     private host;
+    /**
+     * RTMP Application name. May also include instance e.g. "live/test")
+     * @private
+     */
     private application;
+    /**
+     * Name of the stream. May include prefix and paths  e.g. mp4:/vod/test
+     * @private
+     */
     private streamKey;
+    /**
+     * RTMP Port
+     * @private
+     */
     private port;
+    /**
+     * Whenever this source item is default
+     * @private
+     */
     private defaultSource;
+    /**
+     * Constructor
+     * @param host rtmp url
+     * @param application
+     * @param streamName
+     * @param port rtmp port
+     * @param streamInfo
+     * @param defaultSource
+     */
     constructor(host: string, application: string, streamKey: string, port: number, streamInfo: StreamInfo, defaultSource: boolean);
+    /**
+     * Returns source URL
+     */
     getHost(): string;
+    /**
+     * Returns source port
+     */
     getPort(): number;
+    /**
+     * Returns source application name
+     */
     getApplicationName(): string;
+    /**
+     * Returns source stream name
+     */
     getStreamKey(): string;
+    /**
+     * Returns whenver source is default for this playback
+     */
     isDefaultSource(): boolean;
+    /**
+     * Creates a string containing source information in readble form
+     */
     toString(): string;
 }

package/dist/types/model/StormMetaDataItem.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Interface for source item
+ */
 export declare class StormMetaDataItem {
     private videoWidth;
     private videoHeight;

package/dist/types/model/StormServerItem.d.ts

@@ -1,17 +1,70 @@
 import { IServerItem } from "./IServerItem";
+/**
+ * Class stores information related to storm servers
+ */
 export declare class StormServerItem implements IServerItem {
+    /**
+     * Server url
+     * @private
+     */
     private host;
+    /**
+     * Application name
+     * @private
+     */
     private application;
+    /**
+     * Port for storm (default is 443)
+     * @private
+     */
     private port;
+    /**
+     * Whenver connection should be made via SSL (default is true)
+     * @private
+     */
     private isSSL;
+    /**
+     * Whenever player could not establish connection with this host
+     * @private
+     */
     private hasFaild;
+    /**
+     * Constructor
+     *
+     * @param host server URL e.g. "cdn-e001.stormstreaming.com"
+     * @param applicationName e.g. "live
+     * @param port usually 443
+     * @param isSSL whenever connection should be stablished via SSL (true by default)
+     */
     constructor(host: string, application: string, port?: number, isSSL?: boolean);
+    /**
+     * Returns server URL
+     */
     getHost(): string;
+    /**
+     * Returns server application
+     */
     getApplication(): string;
+    /**
+     * Returns port number
+     */
     getPort(): number;
+    /**
+     * Returns whenever connection should be established via SSL
+     */
     getIfSSL(): boolean;
+    /**
+     * Returns whenever connection faild while trying to connect
+     */
     getIfFaild(): boolean;
+    /**
+     * Marks this server as faild, prevent it from being used anymore
+     * @param value
+     */
     setAsFaild(value: boolean): void;
+    /**
+     * Returns data from this object
+     */
     getData(): any;
     toString(): string;
 }

package/dist/types/model/StormSourceItem.d.ts

@@ -1,11 +1,38 @@
 import { AbstractSourceItem } from "./AbstractSourceItem";
 import { ISourceItem } from "./ISourceItem";
 import { StreamInfo } from "./StreamInfo";
+/**
+ * Class containing Storm Source Item
+ */
 export declare class StormSourceItem extends AbstractSourceItem implements ISourceItem {
+    /**
+     * Name of the stream.
+     * @private
+     */
     private streamKey;
+    /**
+     * Whenever this source item is default
+     * @private
+     */
     private defaultSource;
+    /**
+     * Constructor
+     * @param streamKey
+     * @param applicationName
+     * @param streamInfo
+     * @param defaultSource
+     */
     constructor(streamKey: string, streamInfo: StreamInfo, defaultSource: boolean);
+    /**
+     * Returns source stream name
+     */
     getStreamKey(): string;
+    /**
+     * Returns whenver source is default for this playback
+     */
     isDefaultSource(): boolean;
+    /**
+     * Creates a string containing source information in readble form
+     */
     toString(): string;
 }

package/dist/types/model/StreamInfo.d.ts

@@ -1,17 +1,63 @@
+/**
+ * Class containing information related to the stream
+ */
 export declare class StreamInfo {
+    /**
+     * Label (e.g. "720p)
+     * @private
+     */
     private label;
+    /**
+     * Monogram (e.g. "hd")
+     * @private
+     */
     private monogram;
+    /**
+     * Video width
+     * @private
+     */
     private width;
+    /**
+     * Video height
+     * @private
+     */
     private height;
+    /**
+     * Video Frames Per Seconds
+     * @private
+     */
     private fps;
+    /**
+     * Video BitRate
+     * @private
+     */
     private bitrate;
+    /**
+     * Constructor
+     * @param config object with video data
+     */
     constructor(config: any);
     assignMonogram(): void;
+    /**
+     * Returns source label
+     */
     getLabel(): string;
     getMonogram(): string;
+    /**
+     * Returns video width
+     */
     getWidth(): number;
+    /**
+     * Returns video height
+     */
     getHeight(): number;
+    /**
+     * Returns video fps
+     */
     getFPS(): number;
+    /**
+     * Returns video BitRate
+     */
     getBitrate(): number;
     toString(): string;
 }