|
@@ -37,7 +37,14 @@ You can access the following methods and objects trough ```JitsiMeetJS``` object
|
37
|
37
|
* ```JitsiMeetJS.init(options)``` - this method initialized Jitsi Meet API.
|
38
|
38
|
The ```options``` parameter is JS object with the following properties:
|
39
|
39
|
1. useIPv6 - boolean property
|
40
|
|
-
|
|
40
|
+ 2. desktopSharingChromeMethod - Desktop sharing method. Can be set to 'ext', 'webrtc' or false to disable.
|
|
41
|
+ 3. desktopSharingChromeExtId - The ID of the jidesha extension for Chrome or Firefox. Example: 'mbocklcggfhnbahlnepmldehdhpjfcjp'
|
|
42
|
+ desktopSharingChromeSources - Array of strings with the media sources to use when using screen sharing with the Chrome extension. Example: ['screen', 'window']
|
|
43
|
+ 4. desktopSharingChromeMinExtVersion - Required version of Chrome extension. Example: '0.1'
|
|
44
|
+ 5. desktopSharingFirefoxExtId - The ID of the jidesha extension for Firefox. If null, we assume that no extension is required.
|
|
45
|
+ 6. desktopSharingFirefoxDisabled - Boolean. Whether desktop sharing should be disabled on Firefox. Example: false.
|
|
46
|
+ 7. desktopSharingFirefoxMaxVersionExtRequired - The maximum version of Firefox which requires a jidesha extension. Example: if set to 41, we will require the extension for Firefox versions up to and including 41. On Firefox 42 and higher, we will run without the extension. If set to -1, an extension will be required for all versions of Firefox.
|
|
47
|
+ 8. desktopSharingFirefoxExtensionURL - The URL to the Firefox extension for desktop sharing. "null" if no extension is required.
|
41
|
48
|
|
42
|
49
|
* ```JitsiMeetJS.JitsiConnection``` - the ```JitsiConnection``` constructor. You can use that to create new server connection.
|
43
|
50
|
|
|
@@ -48,7 +55,7 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
|
48
|
55
|
|
49
|
56
|
* ```JitsiMeetJS.createLocalTracks(options)``` - Creates the media tracks and returns them trough ```Promise``` object.
|
50
|
57
|
- options - JS object with configuration options for the local media tracks. You can change the following properties there:
|
51
|
|
- 1. devices - array with the devices - "video" and "audio" that will be passed to GUM. If that property is not set GUM will try to get all available devices.
|
|
58
|
+ 1. devices - array with the devices - "desktop", "video" and "audio" that will be passed to GUM. If that property is not set GUM will try to get all available devices.
|
52
|
59
|
2. resolution - the prefered resolution for the local video.
|
53
|
60
|
3. cameraDeviceId - the deviceID for the video device that is going to be used
|
54
|
61
|
4. micDeviceId - the deviceID for the audio device that is going to be used
|
|
@@ -60,6 +67,8 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
|
60
|
67
|
|
61
|
68
|
* ```JitsiMeetJS.isDeviceListAvailable()```- returns true if retrieving the device list is support and false - otherwise.
|
62
|
69
|
|
|
70
|
+* ```JitsiMeetJS.isDesktopSharingEnabled()``` - returns true if desktop sharing is supported and false otherwise. NOTE: that method can be used after ```JitsiMeetJS.init(options)``` is completed otherwise the result will be always null.
|
|
71
|
+
|
63
|
72
|
* ```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.
|
64
|
73
|
We have two event types - connection and conference. You can access the events with the following code ```JitsiMeetJS.events.<event_type>.<event_name>```.
|
65
|
74
|
For example if you want to use the conference event that is fired when somebody leave conference you can use the following code - ```JitsiMeetJS.events.conference.USER_LEFT```.
|
|
@@ -316,7 +325,7 @@ room.on(JitsiMeetJS.events.conference.CONFERENCE_JOINED, onConferenceJoined);
|
316
|
325
|
|
317
|
326
|
5. You also may want to get your local tracks from the camera and microphone:
|
318
|
327
|
```javascript
|
319
|
|
-room.createLocalTracks().then(onLocalTracks);
|
|
328
|
+JitsiMeetJS.createLocalTracks().then(onLocalTracks);
|
320
|
329
|
```
|
321
|
330
|
|
322
|
331
|
NOTE: Adding listeners and creating local streams are not mandatory steps.
|