|
@@ -1,44 +0,0 @@
|
1
|
|
-# Jitsi Meet browser capabilities
|
2
|
|
-
|
3
|
|
-An API for checking browser capabilities for Jitsi Meet.
|
4
|
|
-
|
5
|
|
-## Installation
|
6
|
|
-
|
7
|
|
-To use the Jitsi Meet browser capabilities API in your application you need to add a JS file with `BrowserCapabilities` implementation:
|
8
|
|
-
|
9
|
|
-```javascript
|
10
|
|
-<script src="https://example.com/libs/browser_capabilities.min.js"></script>
|
11
|
|
-```
|
12
|
|
-
|
13
|
|
-## API
|
14
|
|
-
|
15
|
|
-### Constructor
|
16
|
|
-
|
17
|
|
-* **isUsingIFrame**: `true` if Jitsi Meet is loaded in iframe and `false` otherwise. The default value is `false`.
|
18
|
|
-* **browserInfo**: Information about the browser which capabilities will be checked. If not specified `BrowserCapabilities` class will detect the current browser. `browserInfo` is JS object with the following properties:
|
19
|
|
- * **name**: The name of the browser compatible with the names returned by [bowser](https://github.com/lancedikson/bowser#all-detected-browsers)
|
20
|
|
- * **version**: The version of the browser compatible with the version returned by [bowser](https://github.com/lancedikson/bowser#all-detected-browsers)
|
21
|
|
-
|
22
|
|
-**Example:**
|
23
|
|
-```javascript
|
24
|
|
-const browserCapabilities = new BrowserCapabilities(); // not using iframe; capabilities for the current browser
|
25
|
|
-const browserCapabilities1 = new BrowserCapabilities(true); // using iframe; capabilities for the current browser.
|
26
|
|
-const browserCapabilities1 = new BrowserCapabilities(true, {
|
27
|
|
- name: 'Chrome',
|
28
|
|
- version: '63.0'
|
29
|
|
-}); // using iframe; capabilities for Chrome 63.0
|
30
|
|
-```
|
31
|
|
-
|
32
|
|
-### Methods:
|
33
|
|
-
|
34
|
|
-* **isSupported** - returns `true` if the browser is supported by Jitsi Meet and `false` otherwise.
|
35
|
|
-
|
36
|
|
-* **supportsAudioIn** - returns `true` if the browser supports incoming audio and `false` otherwise.
|
37
|
|
-
|
38
|
|
-* **supportsAudioOut** - returns `true` if the browser supports outgoing audio and `false` otherwise.
|
39
|
|
-
|
40
|
|
-* **supportsVideoIn** - returns `true` if the browser is supports incoming video and `false` otherwise.
|
41
|
|
-
|
42
|
|
-* **supportsVideoOut** - returns `true` if the browser is supports outgoing video and `false` otherwise.
|
43
|
|
-
|
44
|
|
-* **supportsScreenSharing** - returns `true` if the browser is supports screen sharing and `false` otherwise.
|