75c7cfd9e1 | ||
---|---|---|
.. | ||
app | ||
gradle/wrapper | ||
keystores | ||
sdk | ||
README.md | ||
build.gradle | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
settings.gradle |
README.md
Jitsi Meet SDK for Android
Build
-
Install all required dependencies.
-
cd android/ ./gradlew :sdk:assembleRelease
-
Configure the Maven repositories in which you are going to publish the artifacts/binaries during step 4. Modify
"file:${rootProject.projectDir}/../../../jitsi/jitsi-maven-repository/releases"
in adroid/sdk/build.gradle for Jitsi Meet SDK for Android and/or"file:${rootProject.projectDir}/../../../jitsi/jitsi-maven-repository/releases"
in android/build.gradle for the third-party react-native modules which Jitsi Meet SDK for Android depends on and are not publicly available in Maven repositories. Generally, if you are modifying the JavaScript code of Jitsi Meet SDK for Android only, you will very likely need to consider the former only. -
Publish the Maven artifact/binary of Jitsi Meet SDK for Android in the Maven repository configured in step 3:
./gradlew :sdk:publish cd ../
If you would like to publish a third-party react-native module which Jitsi Meet SDK for Android depends on and is not publicly available in Maven repositories, replace
sdk
with the name of the react-native module. For example, to publish react-native-webrtc:./gradlew :react-native-webrtc:publish
Install
Add the Maven repository
https://github.com/jitsi/jitsi-maven-repository/raw/master/releases
and the
dependency org.jitsi.react:jitsi-meet-sdk:1.9.0
into your build.gradle
.
API
Jitsi Meet SDK is an Android library which embodies the whole Jitsi Meet experience and makes it reusable by third-party apps.
To get started, extends your android.app.Activity
from
org.jitsi.meet.sdk.JitsiMeetActivity
:
package org.jitsi.example;
import org.jitsi.meet.sdk.JitsiMeetActivity;
public class MainActivity extends JitsiMeetActivity {
}
Alternatively, you can use the org.jitsi.meet.sdk.JitsiMeetView
class which
extends android.view.View
:
package org.jitsi.example;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import org.jitsi.meet.sdk.JitsiMeetView;
public class MainActivity extends AppCompatActivity {
private JitsiMeetView view;
@Override
public void onBackPressed() {
if (!JitsiMeetView.onBackPressed()) {
// Invoke the default handler if it wasn't handled by React.
super.onBackPressed();
}
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
view = new JitsiMeetView(this);
view.loadURL(null);
setContentView(view);
}
@Override
protected void onDestroy() {
super.onDestroy();
view.dispose();
view = null;
JitsiMeetView.onHostDestroy(this);
}
@Override
public void onNewIntent(Intent intent) {
JitsiMeetView.onNewIntent(intent);
}
@Override
protected void onResume() {
super.onResume();
JitsiMeetView.onHostResume(this);
}
@Override
protected void onStop() {
super.onStop();
JitsiMeetView.onHostPause(this);
}
}
JitsiMeetActivity
This class encapsulates a high level API in the form of an Android Activity
which displays a single JitsiMeetView
.
getDefaultURL()
See JitsiMeetView.getDefaultURL.
getPictureInPictureEnabled()
See JitsiMeetView.getPictureInPictureEnabled.
getWelcomePageEnabled()
See JitsiMeetView.getWelcomePageEnabled.
loadURL(URL)
See JitsiMeetView.loadURL.
setDefaultURL(URL)
See JitsiMeetView.setDefaultURL.
setPictureInPictureEnabled(boolean)
See JitsiMeetView.setPictureInPictureEnabled.
setWelcomePageEnabled(boolean)
See JitsiMeetView.setWelcomePageEnabled.
JitsiMeetView
The JitsiMeetView
class is the core of Jitsi Meet SDK. It's designed to
display a Jitsi Meet conference (or a welcome page).
dispose()
Releases all resources associated with this view. This method MUST be called
when the Activity holding this view is going to be destroyed, usually in the
onDestroy()
method.
getDefaultURL()
Returns the default base URL used to join a conference when a partial URL (e.g.
a room name only) is specified to loadURLString
/loadURLObject
. If not set or
if set to null
, the default built in JavaScript is used: https://meet.jit.si.
getListener()
Returns the JitsiMeetViewListener
instance attached to the view.
getPictureInPictureEnabled()
Returns true
if Picture-in-Picture is enabled; false
, otherwise. If not
explicitly set (by a preceding setPictureInPictureEnabled
call), defaults to
true
if the platform supports Picture-in-Picture natively; false
, otherwise.
getWelcomePageEnabled()
Returns true if the Welcome page is enabled; otherwise, false. If false, a black empty view will be rendered when not in a conference. Defaults to false.
loadURL(URL)
Loads a specific URL which may identify a conference to join. If the specified URL is null and the Welcome page is enabled, the Welcome page is displayed instead.
loadURLString(String)
Loads a specific URL which may identify a conference to join. If the specified URL is null and the Welcome page is enabled, the Welcome page is displayed instead.
loadURLObject(Bundle)
Loads a specific URL which may identify a conference to join. The URL is specified in the form of a Bundle of properties which (1) internally are sufficient to construct a URL (string) while (2) abstracting the specifics of constructing the URL away from API clients/consumers. If the specified URL is null and the Welcome page is enabled, the Welcome page is displayed instead.
Example:
Bundle config = new Bundle();
config.putBoolean("startWithAudioMuted", true);
config.putBoolean("startWithVideoMuted", false);
Bundle urlObject = new Bundle();
urlObject.putBundle("config", config);
urlObject.putString("url", "https://meet.jit.si/Test123");
view.loadURLObject(urlObject);
setDefaultURL(URL)
Sets the default URL. See getDefaultURL
for more information.
NOTE: Must be called before (if at all) loadURL
/loadURLString
for it to take
effect.
setListener(listener)
Sets the given listener (class implementing the JitsiMeetViewListener
interface) on the view.
setPictureInPictureEnabled(boolean)
Sets whether Picture-in-Picture is enabled. If not set, Jitsi Meet SDK automatically enables/disables Picture-in-Picture based on native platform support.
NOTE: Must be called (if at all) before loadURL
/loadURLString
for it to take
effect.
setWelcomePageEnabled(boolean)
Sets whether the Welcome page is enabled. See getWelcomePageEnabled
for more
information.
NOTE: Must be called (if at all) before loadURL
/loadURLString
for it to take
effect.
onBackPressed()
Helper method which should be called from the activity's onBackPressed
method.
If this function returns true
, it means the action was handled and thus no
extra processing is required; otherwise the app should call the parent's
onBackPressed
method.
This is a static method.
onHostDestroy(activity)
Helper method which should be called from the activity's onDestroy
method.
This is a static method.
onHostPause(activity)
Helper method which should be called from the activity's onPause
method.
This is a static method.
onHostResume(activity)
Helper method which should be called from the activity's onResume
or onStop
method.
This is a static method.
onNewIntent(intent)
Helper method for integrating the deep linking functionality. If your app's
activity is launched in "singleTask" mode this method should be called from the
activity's onNewIntent
method.
This is a static method.
onUserLeaveHint()
Helper method for integrating automatic Picture-in-Picture. It should be called
from the activity's onUserLeaveHint
method.
This is a static method.
JitsiMeetViewListener
JitsiMeetViewListener
provides an interface apps can implement to listen to
the state of the Jitsi Meet conference displayed in a JitsiMeetView
.
JitsiMeetViewAdapter
A default implementation of the JitsiMeetViewListener
interface. Apps may
extend the class instead of implementing the interface in order to minimize
boilerplate.
onConferenceFailed
Called when a joining a conference was unsuccessful or when there was an error while in a conference.
The data
Map
contains an "error" key describing the error and a "url" key
with the conference URL.
onConferenceJoined
Called when a conference was joined.
The data
Map
contains a "url" key with the conference URL.
onConferenceLeft
Called when a conference was left.
The data
Map
contains a "url" key with the conference URL.
onConferenceWillJoin
Called before a conference is joined.
The data
Map
contains a "url" key with the conference URL.
onConferenceWillLeave
Called before a conference is left.
The data
Map
contains a "url" key with the conference URL.
onLoadConfigError
Called when loading the main configuration file from the Jitsi Meet deployment fails.
The data
Map
contains an "error" key with the error and a "url" key with the
conference URL which necessitated the loading of the configuration file.
ProGuard rules
When using the SDK on a project some proguard rules have to be added in order to avoid necessary code being stripped. Add the following to your project's rules file:
# React Native
# Keep our interfaces so they can be used by other ProGuard rules.
# See http://sourceforge.net/p/proguard/bugs/466/
-keep,allowobfuscation @interface com.facebook.proguard.annotations.DoNotStrip
-keep,allowobfuscation @interface com.facebook.proguard.annotations.KeepGettersAndSetters
-keep,allowobfuscation @interface com.facebook.common.internal.DoNotStrip
# Do not strip any method/class that is annotated with @DoNotStrip
-keep @com.facebook.proguard.annotations.DoNotStrip class *
-keep @com.facebook.common.internal.DoNotStrip class *
-keepclassmembers class * {
@com.facebook.proguard.annotations.DoNotStrip *;
@com.facebook.common.internal.DoNotStrip *;
}
-keepclassmembers @com.facebook.proguard.annotations.KeepGettersAndSetters class * {
void set*(***);
*** get*();
}
-keep class * extends com.facebook.react.bridge.JavaScriptModule { *; }
-keep class * extends com.facebook.react.bridge.NativeModule { *; }
-keepclassmembers,includedescriptorclasses class * { native <methods>; }
-keepclassmembers class * { @com.facebook.react.uimanager.UIProp <fields>; }
-keepclassmembers class * { @com.facebook.react.uimanager.annotations.ReactProp <methods>; }
-keepclassmembers class * { @com.facebook.react.uimanager.annotations.ReactPropGroup <methods>; }
-dontwarn com.facebook.react.**
# TextLayoutBuilder uses a non-public Android constructor within StaticLayout.
# See libs/proxy/src/main/java/com/facebook/fbui/textlayoutbuilder/proxy for details.
-dontwarn android.text.StaticLayout
# okhttp
-keepattributes Signature
-keepattributes *Annotation*
-keep class okhttp3.** { *; }
-keep interface okhttp3.** { *; }
-dontwarn okhttp3.**
# okio
-keep class sun.misc.Unsafe { *; }
-dontwarn java.nio.file.*
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
-dontwarn okio.**
# WebRTC
-keep class org.webrtc.** { *; }
-dontwarn org.chromium.build.BuildHooksAndroid
# Jisti Meet SDK
-keep class org.jitsi.meet.sdk.** { *; }
Picture-in-Picture
JitsiMeetView
will automatically adjust its UI when presented in a
Picture-in-Picture style scenario, in a rectangle too small to accommodate its
"full" UI.
Jitsi Meet SDK automatically enables (unless explicitly disabled by a
setPictureInPictureEnabled(false)
call) Android's native Picture-in-Picture
mode iff the platform is supported i.e. Android >= Oreo.