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

package/dist/types/utilities/UserCapabilities.d.ts

@@ -1,19 +1,63 @@
+/**
+ * Class for detecting user device, browser, etc.
+ */
 export declare class UserCapabilities {
+    /**
+     * Returns true or false depending on availability of WebSockets
+     */
     static hasWebSocketsSupport(): boolean;
+    /**
+     * Returns true if user is using a mobile browser
+     */
     static isMobile(): boolean;
+    /**
+     * Returns true if cookies are enabled for this browser/device
+     */
     static isCookieEnabled(): boolean;
+    /**
+     * Returns an OS Version
+     */
     static getOSVersion(): string;
+    /**
+     * Returns a browser name
+     */
     static getBrowserName(): string;
+    /**
+     * Returns a browser version
+     */
     static getBrowserVersion(): number;
+    /**
+     * Returns a full browser name
+     */
     static getFullBrowser(): {
         name: string;
         fullVersion: string;
         version: number;
     };
+    /**
+     * Returns Operating System name
+     */
     static getOS(): string;
+    /**
+     * Returns true whenever device supports WebRTC
+     */
     static hasWebRTCSupport(): boolean;
+    /**
+     * Checks whenever player support "out-of-box" HLS (mobile browsers mostly do)
+     * @param videoObject html element video
+     */
     static hasHLSSupport(videoObject: HTMLVideoElement | null): boolean;
+    /**
+     * Returns true or false depending on availability of Media Source Extensions (MSE)
+     */
     static hasMSESupport(): boolean;
+    /**
+     * Returns true or false depending on availability of Managed Media Source Extensions (MMS).
+     * This API is MacOS / iOS only.
+     */
     static hasMMSSupport(): boolean;
+    /**
+     * Returns true whenever user is connected via HTTPS
+     */
     static isSSL(): boolean;
 }