capacitor-jitsi-meet 2.2.0-beta.0 → 2.2.0

package/CHANGELOG.md

@@ -4,8 +4,26 @@ Each version of the capacitor plugin uses a specific Jitsi SDK version. In iOS d
 
 See Jitsi-meet SDK [changelog](https://github.com/jitsi/jitsi-meet-release-notes/blob/master/CHANGELOG-MOBILE-SDKS.md)
 
-# 2.2.0 (2022-02-25)
+# 2.2.0 (2022-03-04)
 
+## Breaking Changes
+
+The newly introduced featureFlags param provides a lot of flexibility to the developers, as the developers can now directly control ALL featureFlags settings supported by the SDKs, and no longer need to map the plugin params to the SDK featureFlags params, as we have done before.
+
+-with this increased flexibility, the following plugin params will be deprecated in our 3.0 version. Their default values will be reset to following the SDK default values in this current plugin release.
+  - callIntegrationEnabled (plugin default true -> SDK default true)
+  - liveStreamingEnabled (plugin default false -> 4.1.0 SDK default auto-detected)
+  - recordingEnabled (plugin default false -> 4.1.0 Android SDK true, 4.1.0 iOS SDK false)
+  - screenSharingEnabled (plugin default false -> 4.1.0 Android SDK true, 4.1.0 iOS SDK false)
+
+Going forward, for a stable production build, my recommendation is to add the following featureFlags params in your syntax:
+```
+featureFlags: {
+'recording.enabled': false, // disable as it requires Dropbox integration
+'live-streaming.enabled': false, // 'Sign in with Google' button not yet functional
+'android.screensharing.enabled': false // experimental feature, not fully production ready
+},
+```
 - adds the subject, featureFlags, and configOverrides params
 
 # 2.1.3 (2022-02-09)

package/README.md

@@ -72,7 +72,6 @@ import { Jitsi } from 'capacitor-jitsi-meet';
 // On Capacitor 1 and 2
 import { Plugins } from '@capacitor/core';
 import 'capacitor-jitsi-meet';
-
 const { Jitsi } = Plugins;
 ```
 
@@ -81,7 +80,14 @@ const result = await Jitsi.joinConference({
     // required parameters
     roomName: 'room1', // room identifier for the conference
     url: 'https://meet.jit.si', // endpoint of the Jitsi Meet video bridge
-    
+
+    // recommended settings for production build. see full list of featureFlags in the official Jitsi Meet SDK documentation
+    featureFlags: {
+        'recording.enabled': false, // disable as it requires Dropbox integration
+        'live-streaming.enabled': false, // 'sign in on Google' button not yet functional
+        'android.screensharing.enabled': false // experimental feature, not fully production ready
+    },
+
     // optional parameters
     subject: string, // name of the video room
     displayName: string, // user's display name
@@ -92,16 +98,15 @@ const result = await Jitsi.joinConference({
     chatEnabled: false, // enable Chat feature, default: true
     inviteEnabled: false, // enable Invitation feature, default: true
     
-    // advanced settings, optional
+    // advanced parameters (optional)
     token: string, // jwt authentication token
-    featureFlags: { 'call-integration.enabled': true, 'live-streaming.enabled': false }, // see list of featureFlags in the official Jitsi Meet SDK documentation
     configOverrides: { 'p2p.enabled': false }, // see list of config overrides in the official Jitsi Meet SDK documentation
 
    // advanced settings to be deprecated in 3.0. Use featureFlags and configOverrides instead
-    callIntegrationEnabled: true, // enable call integration (CallKit on iOS, ConnectionService on Android), default: true
-    liveStreamingEnabled: false, // enable live streaming feature, default: auto-detected
-    recordingEnabled: false, // (experimental) enable recording feature, default: false, requires adding Dropbox APP_KEY to Info.plist and AndroidManifest.xml
-    screenSharingEnabled: false, // enable screen sharing feature, default: false, iOS requires manually adding the Broadcast Upload Extension
+    callIntegrationEnabled: true, // enable call integration (CallKit on iOS, ConnectionService on Android)
+    liveStreamingEnabled: false, // enable live streaming feature
+    recordingEnabled: false, // (experimental) enable recording feature
+    screenSharingEnabled: false, // (experimental) enable screen sharing feature
 });
 
 window.addEventListener('onConferenceJoined', () => {
@@ -129,9 +134,9 @@ This plugin uses the Jitsi Meet SDK. See the [Jitsi Meet SDK documentation](http
 
 You can see a [React Demo App](https://github.com/calvinckho/react-capacitor-jitsi-meet-sample) which runs the Jitsi meeting on the Android device
 
-## Feature Requests and Jitsi SDK Customizations
+## Feature Requests, Jitsi SDK UI Customizations, Picture-In-Picture Mode Implementation
 
-I appreciate those who use this plugin in their production apps and are funding this project as sponsors. Your sponsorship enables me to continue to maintain and roll out releases in a timely manner. Consider joining as a sponsor to get first-class support and consultation. For feature requests, create an issue with a label 'feature request'. I also offer paid consultation service to those needing to modify the Jitsi UI interface. To submit a request, create an issue and add the label 'sdk customization'.
+For feature requests, create an issue with a label 'feature request'. I also offer paid consultation services, such as SDK UI customization, and helping you implement the [Picture-in-Picture mode of the video view](https://ds.ivr.solutions/media/pip_demo.mp4). To submit a request, create an issue and add the label 'sdk customization' or 'pip implementation'.
 
 ## Acknowledgements
 

package/android/README.md

@@ -101,7 +101,11 @@ See [Jitsi Meet Handbook](https://jitsi.github.io/handbook/docs/dev-guide/dev-gu
 
 ### Screen Sharing Integration
 
-Some users experienced issues on Android. Report your issues [here](https://github.com/calvinckho/capacitor-jitsi-meet/issues/35).
+This is an experimental feature and some users experienced issues on Android. The recommendation is to disable it in production build until a working solution is found.
+```
+featureFlags: { 'android.screensharing.enabled': false }
+```
+Report your working solutions [here](https://github.com/calvinckho/capacitor-jitsi-meet/issues/35).
 
 ### Android SDK Developer Guide
 

package/dist/esm/web.d.ts

@@ -18,8 +18,8 @@ export declare class JitsiWeb extends WebPlugin implements JitsiPlugin {
         recordingEnabled?: boolean;
         liveStreamingEnabled?: boolean;
         screenSharingEnabled?: boolean;
-        featureFlags?: Map<string, any>;
-        configOverrides?: Map<string, any>;
+        featureFlags?: any;
+        configOverrides?: any;
     }): Promise<{
         roomName: string;
         url: string;
@@ -37,8 +37,8 @@ export declare class JitsiWeb extends WebPlugin implements JitsiPlugin {
         recordingEnabled?: boolean;
         liveStreamingEnabled?: boolean;
         screenSharingEnabled?: boolean;
-        featureFlags?: Map<string, any>;
-        configOverrides?: Map<string, any>;
+        featureFlags?: any;
+        configOverrides?: any;
     }>;
     leaveConference(options: {}): Promise<{}>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-jitsi-meet",
-  "version": "2.2.0-beta.0",
+  "version": "2.2.0",
   "description": "This Ionic Capacitor plugin is created to make video calls through the free, open-sourced Jitsi video platform (https://meet.jit.si) on iOS and Android.",
   "main": "dist/esm/index.js",
   "module": "dist/esm/index.js",