Skip to content

Latest commit

 

History

History
187 lines (149 loc) · 6.32 KB

README.md

File metadata and controls

187 lines (149 loc) · 6.32 KB
Raw

Jitsi Meet Capacitor Plugin for Ionic Apps

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.

Compatibility to Capacitor Versions

Capacitor capacitor-jitsi-meet supported
v5 >= 4.0.0 current
v4 <= 3.1.0 until May 31, 2023
v3 <= 2.3.0 until Dec 31, 2022
v2 <= 1.5.14 until Sept 30, 2021
v1 <= 1.3.6 until June 30, 2020

Follow the official Capacitor doc to upgrade to Capacitor 5.

iOS Compatible Versions

See the plugin changelog for plugin versions that are compatible to your local Xcode version.

Embedding in web applications

This plugin does not currently support web implementation. We recommend using the Jitsi iFrame API (https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe) for full web implementation.

Usage

  1. Install the plugin

Install from NPM (release build):

npm install capacitor-jitsi-meet

Install from Github. Make sure you insert the branch name at the end:

npm i git+ssh://[email protected]:calvinckho/capacitor-jitsi-meet#[branch name]
  1. use it as a Capacitor Plugin. See below for Capacitor 3 and 4 usage. For older versions of Capacitor, see here.
import { Jitsi } from 'capacitor-jitsi-meet';

```javascript
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: {
        'prejoinpage.enabled': false, // go straight to the meeting and do not show the pre-join page
        '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
    email: string, // user's email
    avatarURL: string, // user's avatar url
    startWithAudioMuted: true, // start with audio muted, default: false
    startWithVideoMuted: false, // start with video muted, default: false
    chatEnabled: false, // enable Chat feature, default: true
    inviteEnabled: false, // enable Invitation feature, default: true
    
    // advanced parameters (optional)
    token: string, // jwt authentication token
    configOverrides: { 'p2p.enabled': false }, // see list of config overrides in the official Jitsi Meet SDK documentation
});
console.log(result) // { success: true }

window.addEventListener('onConferenceJoined', () => {
    // do things here
});
window.addEventListener('onConferenceTerminated', () => {
    // do things here
});
window.addEventListener('onConferenceLeft', () => {
    // do things here
});

const result = await Jitsi.leaveConference()
console.log(result) // { success: true }
  1. Build the project
$ npm run build
  1. Follow the deployment instructions for Android and iOS.

Official Jitsi-Meet SDK Documentation

This plugin uses the Jitsi Meet SDK. See the Jitsi Meet SDK documentation, and the lists of feature flags and config overrides.

Sample React App for Android

You can see a React Demo App which runs the Jitsi meeting on the Android device

Feature Requests, Jitsi SDK UI Customizations, Picture-In-Picture Mode Implementation

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. To submit a request, create an issue and add the label 'sdk customization' or 'pip implementation'.

Using the Latest SDK Version

Jitsi releases new SDK versions fairly frequently. Help is appreciated to update the plugin to use the latest SDKs, and to test it on actual projects. Follow the instructions below to update the plugin, then create a PR. I will release it on NPM once it is thoroughly tested.

iOS folder:

in /CapacitorJitsiMeet.podspec, change s.dependency 'JitsiMeetSDK' with the latest version number

in /ios/Plugin/Podfile, update line 10 and line 25 with the latest version number

Android folder:

in /capacitor-jitsi-meet/android/build.gradle, update line 50 with the latest version number

implementation ('org.jitsi.react:jitsi-meet-sdk:[version number]') { transitive = true }

Acknowledgements

This plugin enables web and mobile apps to implement video conferencing feature for free. The Jitsi Meet mobile SDKs are actively maintained by Jitsi. Video bridges for multi-user video conferencing is powered by Jitsi Meet, or you can run your own video bridge.