Sfoglia il codice sorgente

Update docs and examples

master
Jaya Allamsetty 4 anni fa
parent
commit
1c5e244635
5 ha cambiato i file con 2 aggiunte e 32 eliminazioni
  1. 0
    4
      JitsiMeetJS.js
  2. 0
    5
      doc/API.md
  3. 1
    17
      doc/example/example.js
  4. 0
    4
      modules/RTC/RTCUtils.js
  5. 1
    2
      modules/RTC/ScreenObtainer.js

+ 0
- 4
JitsiMeetJS.js Vedi File

299
      * @param {string} options.resolution resolution constraints
299
      * @param {string} options.resolution resolution constraints
300
      * @param {string} options.cameraDeviceId
300
      * @param {string} options.cameraDeviceId
301
      * @param {string} options.micDeviceId
301
      * @param {string} options.micDeviceId
302
-     * @param {object} options.desktopSharingExtensionExternalInstallation -
303
-     * enables external installation process for desktop sharing extension if
304
-     * the inline installation is not posible. The following properties should
305
-     * be provided:
306
      * @param {intiger} interval - the interval (in ms) for
302
      * @param {intiger} interval - the interval (in ms) for
307
      * checking whether the desktop sharing extension is installed or not
303
      * checking whether the desktop sharing extension is installed or not
308
      * @param {Function} checkAgain - returns boolean. While checkAgain()==true
304
      * @param {Function} checkAgain - returns boolean. While checkAgain()==true

+ 0
- 5
doc/API.md Vedi File

39
 *  ```JitsiMeetJS.init(options)``` - this method initialized Jitsi Meet API.
39
 *  ```JitsiMeetJS.init(options)``` - this method initialized Jitsi Meet API.
40
 The ```options``` parameter is JS object with the following properties:
40
 The ```options``` parameter is JS object with the following properties:
41
     - `useIPv6` - boolean property
41
     - `useIPv6` - boolean property
42
-    - `desktopSharingChromeExtId` - The ID of the jidesha extension for Chrome. Example: 'mbocklcggfhnbahlnepmldehdhpjfcjp'
43
-    - `desktopSharingChromeDisabled` - Boolean. Whether desktop sharing should be disabled on Chrome. Example: false.
44
-    - `desktopSharingChromeSources` - Array of strings with the media sources to use when using screen sharing with the Chrome extension. Example: ['screen', 'window']
45
-    - `desktopSharingChromeMinExtVersion` - Required version of Chrome extension. Example: '0.1'
46
-    - `desktopSharingFirefoxDisabled` - Boolean. Whether desktop sharing should be disabled on Firefox. Example: false.
47
     - `disableAudioLevels` - boolean property. Enables/disables audio levels.
42
     - `disableAudioLevels` - boolean property. Enables/disables audio levels.
48
     - `disableSimulcast` - boolean property. Enables/disables simulcast.
43
     - `disableSimulcast` - boolean property. Enables/disables simulcast.
49
     - `enableWindowOnErrorHandler` - boolean property (default false). Enables/disables attaching global onerror handler (window.onerror).
44
     - `enableWindowOnErrorHandler` - boolean property (default false). Enables/disables attaching global onerror handler (window.onerror).

+ 1
- 17
doc/example/example.js Vedi File

238
 
238
 
239
 // JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
239
 // JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
240
 const initOptions = {
240
 const initOptions = {
241
-    disableAudioLevels: true,
242
-
243
-    // The ID of the jidesha extension for Chrome.
244
-    desktopSharingChromeExtId: 'mbocklcggfhnbahlnepmldehdhpjfcjp',
245
-
246
-    // Whether desktop sharing should be disabled on Chrome.
247
-    desktopSharingChromeDisabled: false,
248
-
249
-    // The media sources to use when using screen sharing with the Chrome
250
-    // extension.
251
-    desktopSharingChromeSources: [ 'screen', 'window' ],
252
-
253
-    // Required version of Chrome extension
254
-    desktopSharingChromeMinExtVersion: '0.1',
255
-
256
-    // Whether desktop sharing should be disabled on Firefox.
257
-    desktopSharingFirefoxDisabled: true
241
+    disableAudioLevels: true
258
 };
242
 };
259
 
243
 
260
 JitsiMeetJS.init(initOptions);
244
 JitsiMeetJS.init(initOptions);

+ 0
- 4
modules/RTC/RTCUtils.js Vedi File

998
      * in RTCUtils#_newGetUserMediaWithConstraints.
998
      * in RTCUtils#_newGetUserMediaWithConstraints.
999
      *
999
      *
1000
      * @param {Object} options
1000
      * @param {Object} options
1001
-     * @param {Object} options.desktopSharingExtensionExternalInstallation
1002
      * @param {string[]} options.desktopSharingSources
1001
      * @param {string[]} options.desktopSharingSources
1003
      * @param {Object} options.desktopSharingFrameRate
1002
      * @param {Object} options.desktopSharingFrameRate
1004
      * @param {Object} options.desktopSharingFrameRate.min - Minimum fps
1003
      * @param {Object} options.desktopSharingFrameRate.min - Minimum fps
1169
      */
1168
      */
1170
     _parseDesktopSharingOptions(options) {
1169
     _parseDesktopSharingOptions(options) {
1171
         return {
1170
         return {
1172
-            ...options.desktopSharingExtensionExternalInstallation,
1173
             desktopSharingSources: options.desktopSharingSources,
1171
             desktopSharingSources: options.desktopSharingSources,
1174
             gumOptions: {
1172
             gumOptions: {
1175
                 frameRate: options.desktopSharingFrameRate
1173
                 frameRate: options.desktopSharingFrameRate
1221
             }
1219
             }
1222
 
1220
 
1223
             const {
1221
             const {
1224
-                desktopSharingExtensionExternalInstallation,
1225
                 desktopSharingSourceDevice,
1222
                 desktopSharingSourceDevice,
1226
                 desktopSharingSources,
1223
                 desktopSharingSources,
1227
                 desktopSharingFrameRate
1224
                 desktopSharingFrameRate
1278
             }
1275
             }
1279
 
1276
 
1280
             return this._newGetDesktopMedia({
1277
             return this._newGetDesktopMedia({
1281
-                desktopSharingExtensionExternalInstallation,
1282
                 desktopSharingSources,
1278
                 desktopSharingSources,
1283
                 desktopSharingFrameRate
1279
                 desktopSharingFrameRate
1284
             });
1280
             });

+ 1
- 2
modules/RTC/ScreenObtainer.js Vedi File

117
 
117
 
118
             window.JitsiMeetScreenObtainer.openDesktopPicker(
118
             window.JitsiMeetScreenObtainer.openDesktopPicker(
119
                 {
119
                 {
120
-                    desktopSharingSources: desktopSharingSources
121
-                        || this.options.desktopSharingChromeSources
120
+                    desktopSharingSources
122
                 },
121
                 },
123
                 (streamId, streamType, screenShareAudio = false) =>
122
                 (streamId, streamType, screenShareAudio = false) =>
124
                     onGetStreamResponse(
123
                     onGetStreamResponse(

Loading…
Annulla
Salva