Expose JitsiMeetJS.environment with methods for environment detection

JitsiMeetJS.js

@@ -18,6 +18,7 @@ var Statistics = require("./modules/statistics/statistics");
 var Resolutions = require("./service/RTC/Resolutions");
 var ScriptUtil = require("./modules/util/ScriptUtil");
 var GlobalOnErrorHandler = require("./modules/util/GlobalOnErrorHandler");
+var RTCBrowserType = require("./modules/RTC/RTCBrowserType");
 
 function getLowerResolution(resolution) {
     if(!Resolutions[resolution])
@@ -42,6 +43,9 @@ var LibJitsiMeet = {
 
     version: '{#COMMIT_HASH#}',
 
+    // expose JitsiTrackError this way to give library consumers to do checks
+    // like if (error instanceof JitsiMeetJS.JitsiTrackError) { }
+    JitsiTrackError: JitsiTrackError,
     JitsiConnection: JitsiConnection,
     events: {
         conference: JitsiConferenceEvents,
@@ -57,6 +61,7 @@ var LibJitsiMeet = {
     },
     logLevels: Logger.levels,
     mediaDevices: JitsiMediaDevices,
+    environment: RTCBrowserType,
     init: function (options) {
         Statistics.audioLevelsEnabled = !options.disableAudioLevels;
 
@@ -202,10 +207,6 @@ var LibJitsiMeet = {
     }
 };
 
-// expose JitsiTrackError this way to give library consumers to do checks like
-// if (error instanceof JitsiMeetJS.JitsiTrackError) { }
-LibJitsiMeet.JitsiTrackError = JitsiTrackError;
-
 //Setups the promise object.
 window.Promise = window.Promise || require("es6-promise").Promise;
 

doc/API.md

@@ -53,6 +53,8 @@ The ```options``` parameter is JS object with the following properties:
 
 * ```JitsiMeetJS.JitsiConnection``` - the ```JitsiConnection``` constructor. You can use that to create new server connection.
 
+* ```JitsiMeetJS.JitsiTrackError``` - the ```JitsiTrackError``` constructor. You can use that to check ```instanceof``` errors you get from ```JitsiMeetJS.createLocalTracks()``` method.
+
 * ```JitsiMeetJS.setLogLevel``` - changes the log level for the library. For example to have only error messages you should do:
 ```
 JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
@@ -88,6 +90,26 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
     - ```addEventListener(event, handler)``` - attaches an event handler.
     - ```removeEventListener(event, handler)``` - removes an event handler.
 
+* ```JitsiMeetJS.environment``` - environment detection helper. Provides following methods and properties:
+    - ```RTC_BROWSER_CHROME```
+    - ```RTC_BROWSER_OPERA```
+    - ```RTC_BROWSER_FIREFOX```
+    - ```RTC_BROWSER_IEXPLORER```
+    - ```RTC_BROWSER_SAFARI```
+    - ```RTC_BROWSER_NWJS```
+    - ```RTC_BROWSER_REACT_NATIVE```
+    - ```getBrowserType()``` - gets current browser type.
+    - ```isChrome()``` - checks if current browser is Chrome.
+    - ```isOpera()``` - checks if current browser is Opera.
+    - ```isFirefox()``` - checks if current browser is Firefox.
+    - ```isIExplorer()``` - checks if current browser is Internet Explorer.
+    - ```isSafari()``` - checks if current browser is Safari.
+    - ```isNWJS()``` - checks if current environment is NWJS.
+    - ```isReactNative()``` - checks if current environment is React Native.
+    - ```isTemasysPluginUsed()``` - checks if Temasys RTC plugin is used.
+    - ```getFirefoxVersion()``` - returns Firefox version.
+    - ```getChromeVersion()``` - returns Chrome version.
+    - ```isAndroid()``` - checks whether the browser is running on an android device.
 
 * ```JitsiMeetJS.events``` - JS object that contains all events used by the API. You will need that JS object when you try to subscribe for connection or conference events.
     We have two event types - connection and conference. You can access the events with the following code ```JitsiMeetJS.events.<event_type>.<event_name>```.

modules/RTC/RTCBrowserType.js

@@ -22,41 +22,90 @@ var RTCBrowserType = {
 
     RTC_BROWSER_REACT_NATIVE: "rtc_browser.react-native",
 
+    /**
+     * Gets current browser type.
+     * @returns {string}
+     */
     getBrowserType: function () {
         return currentBrowser;
     },
 
+    /**
+     * Checks if current browser is Chrome.
+     * @returns {boolean}
+     */
     isChrome: function () {
         return currentBrowser === RTCBrowserType.RTC_BROWSER_CHROME;
     },
 
+    /**
+     * Checks if current browser is Opera.
+     * @returns {boolean}
+     */
     isOpera: function () {
         return currentBrowser === RTCBrowserType.RTC_BROWSER_OPERA;
     },
+
+    /**
+     * Checks if current browser is Firefox.
+     * @returns {boolean}
+     */
     isFirefox: function () {
         return currentBrowser === RTCBrowserType.RTC_BROWSER_FIREFOX;
     },
 
+    /**
+     * Checks if current browser is Internet Explorer.
+     * @returns {boolean}
+     */
     isIExplorer: function () {
         return currentBrowser === RTCBrowserType.RTC_BROWSER_IEXPLORER;
     },
 
+    /**
+     * Checks if current browser is Safari.
+     * @returns {boolean}
+     */
     isSafari: function () {
         return currentBrowser === RTCBrowserType.RTC_BROWSER_SAFARI;
     },
+
+    /**
+     * Checks if current environment is NWJS.
+     * @returns {boolean}
+     */
     isNWJS: function () {
         return currentBrowser === RTCBrowserType.RTC_BROWSER_NWJS;
     },
+
+    /**
+     * Checks if current environment is React Native.
+     * @returns {boolean}
+     */
     isReactNative: function () {
         return currentBrowser === RTCBrowserType.RTC_BROWSER_REACT_NATIVE;
     },
+
+    /**
+     * Checks if Temasys RTC plugin is used.
+     * @returns {boolean}
+     */
     isTemasysPluginUsed: function () {
         return RTCBrowserType.isIExplorer() || RTCBrowserType.isSafari();
     },
+
+    /**
+     * Returns Firefox version.
+     * @returns {number|null}
+     */
     getFirefoxVersion: function () {
         return RTCBrowserType.isFirefox() ? browserVersion : null;
     },
 
+    /**
+     * Returns Chrome version.
+     * @returns {number|null}
+     */
     getChromeVersion: function () {
         return RTCBrowserType.isChrome() ? browserVersion : null;
     },
@@ -72,6 +121,7 @@ var RTCBrowserType = {
 
     /**
      * Whether the browser is running on an android device.
+     * @returns {boolean}
      */
     isAndroid: function() {
         return isAndroid;