diff --git a/android/README.md b/android/README.md index d3c739f68..b69457e1e 100644 --- a/android/README.md +++ b/android/README.md @@ -1,380 +1,3 @@ # Jitsi Meet SDK for Android -## Sample applications using the SDK - -If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the -[sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples). - -## Build your own, or use a pre-build SDK artifacts/binaries - -Jitsi conveniently provides a pre-build SDK artifacts/binaries in its Maven repository. When you do not require any -modification to the SDK itself or any of its dependencies, it's suggested to use the pre-build SDK. This avoids the -complexity of building and installing your own SDK artifacts/binaries. - -### Use pre-build SDK artifacts/binaries - -In your project, add the Maven repository -`https://github.com/jitsi/jitsi-maven-repository/raw/master/releases` and the -dependency `org.jitsi.react:jitsi-meet-sdk` into your `build.gradle` files. - -The repository typically goes into the `build.gradle` file in the root of your project: - -```gradle -allprojects { - repositories { - google() - jcenter() - maven { - url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases" - } - } -} -``` - -Dependency definitions belong in the individual module `build.gradle` files: - -```gradle -dependencies { - // (other dependencies) - implementation ('org.jitsi.react:jitsi-meet-sdk:2.+') { transitive = true } -} -``` - -### Build and use your own SDK artifacts/binaries - -
-Show building instructions - -Start by making sure that your development environment [is set up correctly](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile.md). - -A note on dependencies: Apart from the SDK, Jitsi also publishes a binary Maven artifact for some of the SDK dependencies (that are not otherwise publicly available) to the Jitsi Maven repository. When you're planning to use a SDK that is built from source, you'll likely use a version of the source code that is newer (or at least _different_) than the version of the source that was used to create the binary SDK artifact. As a consequence, the dependencies that your project will need, might also be different from those that are published in the Jitsi Maven repository. This might lead to build problems, caused by dependencies that are unavailable. - -If you want to use a SDK that is built from source, you will likely benefit from composing a local Maven repository that contains these dependencies. The text below describes how you create a repository that includes both the SDK as well as these dependencies. For illustration purposes, we'll define the location of this local Maven repository as `/tmp/repo` - -In source code form, the Android SDK dependencies are locked/pinned by package.json and package-lock.json of the Jitsi Meet project. To obtain the data, execute NPM in the jitsi-meet project directory: - - npm install - -This will pull in the dependencies in either binary format, or in source code format, somewhere under /node_modules/ - -Third-party React Native _modules_, which Jitsi Meet SDK for Android depends on, are download by NPM in source code -or binary form. These need to be assembled into Maven artifacts, and then published to your local Maven repository. -A script is provided to facilitate this. From the root of the jitsi-meet project repository, run: - - ./android/scripts/release-sdk.sh /tmp/repo - -This will build and publish the SDK, and all of its dependencies to the specified Maven repository (`/tmp/repo`) in -this example. - -You're now ready to use the artifacts. In _your_ project, add the Maven repository that you used above (`/tmp/repo`) into your top-level `build.gradle` file: - - allprojects { - repositories { - maven { url "file:/tmp/repo" } - google() - jcenter() - } - } - -You can use your local repository to replace the Jitsi repository (`maven { url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases" }`) when you published _all_ subprojects. If you didn't do that, you'll have to add both repositories. Make sure your local repository is listed first! - -Then, define the dependency `org.jitsi.react:jitsi-meet-sdk` into the `build.gradle` file of your module: - - implementation ('org.jitsi.react:jitsi-meet-sdk:+') { transitive = true } - -Note that there should not be a need to explicitly add the other dependencies, as they will be pulled in as transitive -dependencies of `jitsi-meet-sdk`. - -
- -## Using the API - -Jitsi Meet SDK is an Android library which embodies the whole Jitsi Meet -experience and makes it reusable by third-party apps. - -First, 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 -} -``` - -To get started, extends your `android.app.Activity` from -`org.jitsi.meet.sdk.JitsiMeetActivity`: - -```java -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`. - -Note that this should only be needed when `JitsiMeetActivity` cannot be used for -some reason. Extending `JitsiMeetView` requires manual wiring of the view to -the activity, using a lot of boilerplate code. Using the Activity instead of the -View is strongly recommended. - -
-Show example - -```java -package org.jitsi.example; - -import android.os.Bundle; -import android.support.v4.app.FragmentActivity; - -import org.jitsi.meet.sdk.JitsiMeetView; -import org.jitsi.meet.sdk.ReactActivityLifecycleCallbacks; - -// Example -// -public class MainActivity extends FragmentActivity implements JitsiMeetActivityInterface { - private JitsiMeetView view; - - @Override - protected void onActivityResult( - int requestCode, - int resultCode, - Intent data) { - JitsiMeetActivityDelegate.onActivityResult( - this, requestCode, resultCode, data); - } - - @Override - public void onBackPressed() { - JitsiMeetActivityDelegate.onBackPressed(); - } - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - - view = new JitsiMeetView(this); - JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder() - .setRoom("https://meet.jit.si/test123") - .build(); - view.join(options); - - setContentView(view); - } - - @Override - protected void onDestroy() { - super.onDestroy(); - - view.dispose(); - view = null; - - JitsiMeetActivityDelegate.onHostDestroy(this); - } - - @Override - public void onNewIntent(Intent intent) { - JitsiMeetActivityDelegate.onNewIntent(intent); - } - - @Override - public void onRequestPermissionsResult( - final int requestCode, - final String[] permissions, - final int[] grantResults) { - JitsiMeetActivityDelegate.onRequestPermissionsResult(requestCode, permissions, grantResults); - } - - @Override - protected void onResume() { - super.onResume(); - - JitsiMeetActivityDelegate.onHostResume(this); - } - - @Override - protected void onStop() { - super.onStop(); - - JitsiMeetActivityDelegate.onHostPause(this); - } -} -``` - -
- -### JitsiMeetActivity - -This class encapsulates a high level API in the form of an Android `FragmentActivity` -which displays a single `JitsiMeetView`. You can pass a URL as a `ACTION_VIEW` -on the Intent when starting it and it will join the conference, and will be -automatically terminated (finish() will be called on the activity) when the -conference ends or fails. - -### JitsiMeetView - -The `JitsiMeetView` class is the core of Jitsi Meet SDK. It's designed to -display a Jitsi Meet conference (or a welcome page). - -#### join(options) - -Joins the conference specified by the given `JitsiMeetConferenceOptions`. - -#### leave() - -Leaves the currently active conference. If the welcome page is enabled it will -go back to it, otherwise a black window will be shown. - -#### 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. - -#### getListener() - -Returns the `JitsiMeetViewListener` instance attached to the view. - -#### setListener(listener) - -Sets the given listener (class implementing the `JitsiMeetViewListener` -interface) on the view. - -### JitsiMeetConferenceOptions - -This object encapsulates all the options that can be tweaked when joining -a conference. - -Example: - -```java -JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder() - .setServerURL(new URL("https://meet.jit.si")) - .setRoom("test123") - .setAudioMuted(false) - .setVideoMuted(false) - .setAudioOnly(false) - .setWelcomePageEnabled(false) - .build(); -``` - -See the `JitsiMeetConferenceOptions` implementation for all available options. - -### JitsiMeetActivityDelegate - -This class handles the interaction between `JitsiMeetView` and its enclosing -`Activity`. Generally this shouldn't be consumed by users, because they'd be -using `JitsiMeetActivity` instead, which is already completely integrated. - -All its methods are static. - -#### onActivityResult(...) - -Helper method to handle results of auxiliary activities launched by the SDK. -Should be called from the activity method of the same name. - -#### 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. - -#### onHostDestroy(...) - -Helper method which should be called from the activity's `onDestroy` method. - -#### onHostResume(...) - -Helper method which should be called from the activity's `onResume` or `onStop` -method. - -#### onHostStop(...) - -Helper method which should be called from the activity's `onSstop` method. - -#### onNewIntent(...) - -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. - -#### onRequestPermissionsResult(...) - -Helper method to handle permission requests inside the SDK. It should be called -from the activity method of the same name. - -#### 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`. - -#### onConferenceJoined - -Called when a conference was joined. - -The `data` `Map` contains a "url" key with the conference URL. - -#### onConferenceTerminated - -Called when a conference was terminated either by user choice or due to a -failure. - -The `data` `Map` contains an "error" key with the error and a "url" key -with the conference URL. If the conference finished gracefully no `error` -key will be present. - -#### onConferenceWillJoin - -Called before a conference is joined. - -The `data` `Map` contains a "url" key with the conference URL. - -## 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: https://github.com/jitsi/jitsi-meet/blob/master/android/app/proguard-rules.pro - -## 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. - -## Dropbox integration - -To setup the Dropbox integration, follow these steps: - -1. Add the following to the app's AndroidManifest.xml and change `` to -your Dropbox app key: -``` - - - - - - - - -``` - -2. Add the following to the app's strings.xml and change `` to your -Dropbox app key: -``` - -``` +This document has been moved to [The Handbook](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk). diff --git a/ios/README.md b/ios/README.md index 7c9037685..b01171ded 100644 --- a/ios/README.md +++ b/ios/README.md @@ -1,206 +1,3 @@ # Jitsi Meet SDK for iOS -The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app, -in a customizable way which you can embed in your apps. - -## Sample applications using the SDK - -If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the -[sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples). - -## Usage - -There are 2 ways to integrate the SDK into your project: - -- Using CocoaPods -- Building it yourself - -### Using CocoaPods - -Follow the instructions [here](https://github.com/jitsi/jitsi-meet-ios-sdk-releases/blob/master/README.md). - -### Building it yourself - -1. Install all required [dependencies](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile.md). - -2. `xcodebuild -workspace ios/jitsi-meet.xcworkspace -scheme JitsiMeet -destination='generic/platform=iOS' -configuration Release archive` - -After successfully building Jitsi Meet SDK for iOS, copy -`ios/sdk/JitsiMeet.framework` (if the path points to a symbolic link, follow the -symbolic link) and -`node_modules/react-native-webrtc/ios/WebRTC.framework` into your project. - -## API - -JitsiMeet is an iOS framework which embodies the whole Jitsi Meet experience and -makes it reusable by third-party apps. - -To get started: - -1. Add a `JitsiMeetView` to your app using a Storyboard or Interface Builder, - for example. - -2. Then, once the view has loaded, set the delegate in your controller and load - the desired URL: - -```objc -- (void)viewDidLoad { - [super viewDidLoad]; - - JitsiMeetView *jitsiMeetView = (JitsiMeetView *) self.view; - jitsiMeetView.delegate = self; - - JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) { - builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"]; - builder.room = @"test123"; - builder.audioOnly = YES; - }]; - - [jitsiMeetView join:options]; -} -``` - -### JitsiMeetView class - -The `JitsiMeetView` class is the entry point to the SDK. It a subclass of -`UIView` which renders a full conference in the designated area. - -#### delegate - -Property to get/set the `JitsiMeetViewDelegate` on `JitsiMeetView`. - -#### join:JitsiMeetConferenceOptions - -Joins the conference specified by the given options. - -```objc - JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) { - builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"]; - builder.room = @"test123"; - builder.audioOnly = NO; - builder.audioMuted = NO; - builder.videoMuted = NO; - builder.welcomePageEnabled = NO; - }]; - - [jitsiMeetView join:options]; -``` - -#### leave - -Leaves the currently active conference. - -#### Universal / deep linking - -In order to support Universal / deep linking, `JitsiMeet` offers 2 class -methods that you app's delegate should call in order for the app to follow those -links. - -If these functions return NO it means the URL wasn't handled by the SDK. This -is useful when the host application uses other SDKs which also use linking. - -```objc -- (BOOL)application:(UIApplication *)application -continueUserActivity:(NSUserActivity *)userActivity - restorationHandler:(void (^)(NSArray *restorableObjects))restorationHandler -{ - return [[JitsiMeet sharedInstance] application:application - continueUserActivity:userActivity - restorationHandler:restorationHandler]; -} -``` - -And also one of the following: - -```objc -// See https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623073-application?language=objc -- (BOOL)application:(UIApplication *)app - openURL:(NSURL *)url - options:(NSDictionary *)options { - return [[JitsiMeet sharedInstance] application:app - openURL:url - options: options]; -} -``` - -### JitsiMeetViewDelegate - -This delegate is optional, and can be set on the `JitsiMeetView` instance using -the `delegate` property. - -It provides information about the conference state: was it joined, left, did it -fail? - -All methods in this delegate are optional. - -#### conferenceJoined - -Called when a conference was joined. - -The `data` dictionary contains a "url" key with the conference URL. - -#### conferenceTerminated - -Called when a conference was terminated either by user choice or due to a -failure. - -The `data` dictionary contains an "error" key with the error and a "url" key -with the conference URL. If the conference finished gracefully no `error` -key will be present. - -#### conferenceWillJoin - -Called before a conference is joined. - -The `data` dictionary contains a "url" key with the conference URL. - -#### enterPictureInPicture - -Called when entering Picture-in-Picture is requested by the user. The app should -now activate its Picture-in-Picture implementation (and resize the associated -`JitsiMeetView`. The latter will automatically detect its new size and adjust -its user interface to a variant appropriate for the small size ordinarily -associated with Picture-in-Picture.) - -The `data` dictionary is empty. - -### 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 does not currently implement native Picture-in-Picture on iOS. If -desired, apps need to implement non-native Picture-in-Picture themselves and -resize `JitsiMeetView`. - -If `delegate` implements `enterPictureInPicture:`, the in-call toolbar will -render a button to afford the user to request entering Picture-in-Picture. - -## Dropbox integration - -To setup the Dropbox integration, follow these steps: - -1. Add the following to the app's Info.plist and change `` to your -Dropbox app key: -``` -CFBundleURLTypes - - - CFBundleURLName - - CFBundleURLSchemes - - db- - - - -LSApplicationQueriesSchemes - - dbapi-2 - dbapi-8-emm - -``` - -2. Make sure your app calls the Jitsi Meet SDK universal / deep linking delegate - methods. +This document has been moved to [The Handbook](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk).