eko_jitsi

Description:

eko jitsi

eko_jitsi #
Jitsi Meet Plugin for Flutter. Supports Android and iOS platforms.
"Jitsi Meet is an open-source (Apache) WebRTC JavaScript application that uses Jitsi Videobridge to provide high quality, secure and scalable video conferences."
Find more information about Jitsi Meet here
Table of Contents #

Configuration

IOS
Android


Join A Meeting
JitsiMeetingOptions
FeatureFlags
JitsiMeetingResponse
Listening to Meeting Events
Closing a Meeting Programmatically
Contributing
Feature Requests
Issues


Configuration #

IOS #

Note: Example compilable with XCode 12.1 & Flutter 1.22.3.

Podfile
Ensure in your Podfile you have an entry like below declaring platform of 11.0 or above.
platform :ios, '11.0'
copied to clipboard
Info.plist
Add NSCameraUsageDescription and NSMicrophoneUsageDescription to your
Info.plist.
<key>NSCameraUsageDescription</key>
<string>$(PRODUCT_NAME) MyApp needs access to your camera for meetings.</string>
<key>NSMicrophoneUsageDescription</key>
<string>$(PRODUCT_NAME) MyApp needs access to your microphone for meetings.</string>
copied to clipboard

Android #
Gradle
Set dependencies of build tools gradle to minimum 3.6.3:
dependencies {
classpath 'com.android.tools.build:gradle:3.6.3' <!-- Upgrade this -->
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}
copied to clipboard
Set distribution gradle wrapper to minimum 5.6.4.
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip <!-- Upgrade this -->
copied to clipboard
Add Java 1.8 compatibility support to your project by adding the following lines into your build.gradle file:
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
copied to clipboard
AndroidManifest.xml
Jitsi Meet's SDK AndroidManifest.xml will conflict with your project, namely
the application:label field. To counter that, go into
android/app/src/main/AndroidManifest.xml and add the tools library
and tools:replace="android:label" to the application tag.
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="yourpackage.com"
xmlns:tools="http://schemas.android.com/tools"> <!-- Add this -->
<application
tools:replace="android:label"
android:name="your.application.name"
android:label="My Application"
android:icon="@mipmap/ic_launcher">
...
</application>
...
</manifest>
copied to clipboard
Minimum SDK Version 23
Update your minimum sdk version to 23 in android/app/build.gradle
defaultConfig {
applicationId "com.ekodemy.eko_jitsi_example"
minSdkVersion 23 //Required for Jitsi
targetSdkVersion 28
versionCode flutterVersionCode.toInteger()
versionName flutterVersionName
}
copied to clipboard
Proguard
Jitsi's SDK enables proguard, but without a proguard-rules.pro file, your release
apk build will be missing the Flutter Wrapper as well as react-native code.
In your Flutter project's android/app/build.gradle file, add proguard support
buildTypes {
release {
// TODO: Add your own signing config for the release build.
// Signing with the debug keys for now, so `flutter run --release` works.
signingConfig signingConfigs.debug

// Add below 3 lines for proguard
minifyEnabled true
useProguard true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
copied to clipboard
Then add a file in the same directory called proguard-rules.pro. See the example
app's proguard-rules.pro file to know what to paste in.
Note
If you do not create the proguard-rules.pro file, then your app will
crash when you try to join a meeting or the meeting screen tries to open
but closes immediately. You will see one of the below errors in logcat.
## App crashes ##
java.lang.RuntimeException: Parcel android.os.Parcel@8530c57: Unmarshalling unknown type code 7536745 at offset 104
at android.os.Parcel.readValue(Parcel.java:2747)
at android.os.Parcel.readSparseArrayInternal(Parcel.java:3118)
at android.os.Parcel.readSparseArray(Parcel.java:2351)
.....
copied to clipboard
## Meeting won't open and you go to previous screen ##
W/unknown:ViewManagerPropertyUpdater: Could not find generated setter for class com.BV.LinearGradient.LinearGradientManager
W/unknown:ViewManagerPropertyUpdater: Could not find generated setter for class com.facebook.react.uimanager.g
W/unknown:ViewManagerPropertyUpdater: Could not find generated setter for class com.facebook.react.views.art.ARTGroupViewManager
W/unknown:ViewManagerPropertyUpdater: Could not find generated setter for class com.facebook.react.views.art.a
.....
copied to clipboard

Join A Meeting #
_joinMeeting() async {
try {
var options = JitsiMeetingOptions()
..room = "myroom" // Required, spaces will be trimmed
..serverURL = "https://someHost.com"
..subject = "Meeting with Shubham"
..userDisplayName = "My Name"
..userEmail = "[email protected]"
..audioOnly = true
..audioMuted = true
..videoMuted = true;

await JitsiMeet.joinMeeting(options);
} catch (error) {
debugPrint("error: $error");
}
}
copied to clipboard

JitsiMeetingOptions #



Field
Required
Default
Description




room
Yes
N/A
Unique room name that will be appended to serverURL. Valid characters: alphanumeric, dashes, and underscores.


subject
No
$room
Meeting name displayed at the top of the meeting. If null, defaults to room name where dashes and underscores are replaced with spaces and first characters are capitalized.


userDisplayName
No
"Fellow Jitster"
User's display name


userEmail
No
none
User's email address


audioOnly
No
false
Start meeting without video. Can be turned on in meeting.


audioMuted
No
false
Start meeting with audio muted. Can be turned on in meeting.


videoMuted
No
false
Start meeting with video muted. Can be turned on in meeting.


serverURL
No
meet.jitsi.si
Specify your own hosted server. Must be a valid absolute URL of the format <scheme>://<host>[/path], i.e. https://someHost.com. Defaults to Jitsi Meet's servers.


userAvatarURL
N/A
none
Not yet implemented. User's avatar URL.


token
N/A
none
JWT token used for authentication.


featureFlags
No
see below
Map of feature flags and their values (true/false), used to enable/disable features of the Jitsi Meet SDK




FeatureFlags
Feature flags allow you to enable or disable any feature of the Jitsi Meet SDK.
If you don't provide any flag to JitsiMeetingOptions, default values will be used.
If you don't provide a flag in featureFlags in JitsiMeetingOptions, its default value will be used.
We are using the official list of flags, taken from the Jitsi Meet repository



Flag
Default (Android)
Default (iOS)
Description




ADD_PEOPLE_ENABLED
true
true
Enable the blue button "Add people", showing up when you are alone in a call. Requires flag INVITE_ENABLED to work.


CALENDAR_ENABLED
true
auto
Enable calendar integration.


CALL_INTEGRATION_ENABLED
true
true
Enable call integration (CallKit on iOS, ConnectionService on Android). SEE REMARK BELOW


CLOSE_CAPTIONS_ENABLED
true
true
Enable close captions (subtitles) option in menu.


CHAT_ENABLED
true
true
Enable chat (button and feature).


INVITE_ENABLED
true
true
Enable invite option in menu.


IOS_RECORDING_ENABLED
N/A
false
Enable recording in iOS.


LIVE_STREAMING_ENABLED
auto
auto
Enable live-streaming option in menu.


MEETING_NAME_ENABLED
true
true
Display meeting name.


MEETING_PASSWORD_ENABLED
true
true
Display meeting password option in menu (if a meeting has a password set, the dialog will still show up).


PIP_ENABLED
auto
auto
Enable Picture-in-Picture mode.


RAISE_HAND_ENABLED
true
true
Enable raise hand option in menu.


RECORDING_ENABLED
auto
N/A
Enable recording option in menu.


TILE_VIEW_ENABLED
true
true
Enable tile view option in menu.


TOOLBOX_ALWAYS_VISIBLE
true
true
Toolbox (buttons and menus) always visible during call (if not, a single tap displays it).


WELCOME_PAGE_ENABLED
false
false
Enable welcome page. "The welcome page lists recent meetings and calendar appointments and it's meant to be used by standalone applications."



REMARK about Call integration Call integration on Android (known as ConnectionService) has been disabled on the official Jitsi Meet app because it creates a lot of issues. You should disable it too to avoid these issues.
JitsiMeetingResponse #



Field
Type
Description




isSuccess
bool
Success indicator.


message
String
Success message or error as a String.


error
dynamic
Optional, only exists if isSuccess is false. The error object.




Listening to Meeting Events #
Events supported



Name
Description




onConferenceWillJoin
Meeting is loading.


onConferenceJoined
User has joined meeting.


onConferenceTerminated
User has exited the conference.


onError
Error has occurred with listening to meeting events.



Per Meeting Events
To listen to meeting events per meeting, pass in a JitsiMeetingListener
in joinMeeting. The listener will automatically be removed when an
onConferenceTerminated event is fired.
await JitsiMeet.joinMeeting(options,
listener: JitsiMeetingListener(onConferenceWillJoin: ({message}) {
debugPrint("${options.room} will join with message: $message");
}, onConferenceJoined: ({message}) {
debugPrint("${options.room} joined with message: $message");
}, onConferenceTerminated: ({message}) {
debugPrint("${options.room} terminated with message: $message");
}));
copied to clipboard
Global Meeting Events
To listen to global meeting events, simply add a JitsiMeetListener with
JitsiMeet.addListener(myListener). You can remove listeners using
JitsiMeet.removeListener(listener) or JitsiMeet.removeAllListeners().
@override
void initState() {
super.initState();
JitsiMeet.addListener(JitsiMeetingListener(
onConferenceWillJoin: _onConferenceWillJoin,
onConferenceJoined: _onConferenceJoined,
onConferenceTerminated: _onConferenceTerminated,
onError: _onError));
}

@override
void dispose() {
super.dispose();
JitsiMeet.removeAllListeners();
}

_onConferenceWillJoin({message}) {
debugPrint("_onConferenceWillJoin broadcasted");
}

_onConferenceJoined({message}) {
debugPrint("_onConferenceJoined broadcasted");
}

_onConferenceTerminated({message}) {
debugPrint("_onConferenceTerminated broadcasted");
}

_onError(error) {
debugPrint("_onError broadcasted");
}
copied to clipboard
Closing a Meeting Programmatically #
JitsiMeet.closeMeeting();
copied to clipboard

Contributing #
Send a pull request with as much information as possible clearly
describing the issue or feature. Keep changes small and for one issue at
a time.
Feature Requests #
First, this plugin uses
Jitsi Meet's mobile SDK,
so if their SDK does not support a feature, this plugin will probably
not be able to do so either. Check if Jitsi Meet supports your requests.
If not, open a feature request with Jitsi Meet team rather than here.
If the new feature is available in Jitsi Meet's SDK, but not available
in this plugin, or the new feature is unrelated to the SDK, open a
request with the
following template:
New Feature Request

Use case: Describe the use case for the feature request, from a user or
developer point of view. For example, "As a user, I would like to be able
to close the meeting using a voice command." or "As a developer, I would like
to detect when a user winks." Include as much detail as possible.

Include examples, like screenshots, UX design, story boards, another app or code
of what the feature could look like.
copied to clipboard
Issues #
Open an issue here. Use
the following template:
Platform: specify one or both: [iOS, Android]
Device Physical or Simulator: [Physical, Simulator]
Device Model: specify model
Device OS Version: specify Android or iOS version

Flutter Doctor: run flutter doctor and paste results below:
--- flutter doctor results here ---

Steps to recreate: detailed step by step on how to recreate below:
1. Step 1
2. Step 2
...

Error logs:
--- paste error logs here if any ---
copied to clipboard