cordova-plugin-jitsi-meet-sdk

4.0.8 • Public • Published

cordova-plugin-jitsi-meet-sdk

Cordova plugin for Jitsi Meet React Native SDK.

All options, feature flags and listeners are available.

All feature flags available can be found here: https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/flags/constants.js

Supported Platforms

  • Android >= 23
  • iOS

Installation

The plugin can be installed via Cordova-CLI

Install the latest head version

cordova plugin add cordova-plugin-jitsi-meet-sdk

Usage

All paramenters are optional except for room. You need to specify at least the room name.

  • If serverURL is not specified by default is "https://meet.jit.si".

  • All feature flags not specified are in their default value.

  • All boolean options by default are false.

  • All string options by default are empty.

This is the minimal setup to enter into a conference

JitsiMeet.startConference(
{
    room: "MyAmazingRoom",
});

And this is a complete example

JitsiMeet.startConference(
{
    serverURL: "https://meet.jit.si",
    room: "MyAmazingRoom",
    displayName: "Max!",
    email: "max@amazingmax.it",
    audioMuted: false,
    videoMuted: false,
    welcomePageEnabled: false,
    subject: "My amazing name",
    audioOnly: false,
    //token: "your jwt token, if you have one",
    flags: {
        "chat.enabled": true,
        "invite.enabled": true,
        "kick-out.enabled": true,
        "live-streaming.enabled": true,
        "pip.enabled": true,
        "raise-hand.enabled":true,
        "recording.enabled": true,
        "video-share.enabled": true,
        "add-people.enabled": true,
        "calendar.enabled": true,
        "meeting-name.enabled": true,
        "meeting-password.enabled": true,
        "toolbox.alwaysVisible": true
    }
}, function(listener){
    // a listener has been fired!
    console.log(listener);
    
    switch(listener){
        case "CONFERENCE_JOINED":
            //Broadcasted when a conference was joined.
            break;
        case "CONFERENCE_TERMINATED":
            //Broadcasted when the active conference ends, be it because of user choice or because of a failure.
            break;
        case "CONFERENCE_WILL_JOIN":
            //Broadcasted before a conference is joined. 
            break;
        case "AUDIO_MUTED_CHANGED":
            //Broadcasted when audioMuted state changed
            break;
        case "VIDEO_MUTED_CHANGED":
            //Broadcasted when videoMuted state changed
            break;
        case "PARTICIPANT_JOINED":
            //Broadcasted when a participant has joined the conference. 
            break;
        case "PARTICIPANT_LEFT":
            //Broadcasted when a participant has joined the conference.
            break;
        case "ENDPOINT_TEXT_MESSAGE_RECEIVED":
            //Broadcasted when an endpoint text message is received. 
            break;
	case "PARTICIPANTS_INFO_RETRIEVED":
	    //Broadcasted when a RETRIEVE_PARTICIPANTS_INFO action is called. 
            break;
	case "CHAT_MESSAGE_RECEIVED":
	    //Broadcasted when a chat text message is received.
            break;
	case "CHAT_TOGGLED":
	    //Broadcasted when the chat dialog is opened or closed.
            break;
    }
});

Close the conference

JitsiMeet.disposeConference(function(success){
	console.log("You successfully closed your conference!");
},function(error){
	console.log("Something goes wrong. Check tab error in the console");
	console.error(error);
});

Supported events

CONFERENCE_JOINED

Broadcasted when a conference was joined. The data HashMap contains a url key with the conference URL.

CONFERENCE_TERMINATED

Broadcasted when the active conference ends, be it because of user choice or because of a failure. The data HashMap 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.

CONFERENCE_WILL_JOIN

Broadcasted before a conference is joined. The data HashMap contains a url key with the conference URL.

AUDIO_MUTED_CHANGED

Broadcasted when audioMuted state changed. The data HashMap contains a muted key with state of the audioMuted for the localParticipant.

VIDEO_MUTED_CHANGED

Broadcasted when videoMuted state changed. The data HashMap contains a muted key with state of the videoMuted for the localParticipant.

PARTICIPANT_JOINED

Broadcasted when a participant has joined the conference. The data HashMap contains information of the participant that has joined. Depending of whether the participant is the local one or not, some of them are present/missing. isLocal email name participantId

PARTICIPANT_LEFT

Broadcasted when a participant has joined the conference. The data HashMap contains information of the participant that has left. Depending of whether the participant is the local one or not, some of them are present/missing. isLocal email name participantId

ENDPOINT_TEXT_MESSAGE_RECEIVED

Broadcasted when an endpoint text message is received. The data HashMap contains a senderId key with the participantId of the sender and a message key with the content.

PARTICIPANTS_INFO_RETRIEVED

Broadcasted when a RETRIEVE_PARTICIPANTS_INFO action is called. The data HashMap contains a participantsInfo key with a list of participants information and a requestId key with the id that was sent in the RETRIEVE_PARTICIPANTS_INFO action.

CHAT_MESSAGE_RECEIVED

Broadcasted when a chat text message is received. The data HashMap contains a senderId key with the participantId of the sender, a message key with the content, a isPrivate key with a boolean value and a timestamp key.

CHAT_TOGGLED

Broadcasted when the chat dialog is opened or closed. The data HashMap contains a isOpen key with a boolean value.

Broadcasting Actions

Working in progress...

Issues

The plugin will receive updates and fixes. Write in the Issues section for any problem.

I am looking Freelance work!

You can email me at maxcoppola97@libero.it

Thanks!

Package Sidebar

Install

npm i cordova-plugin-jitsi-meet-sdk

Weekly Downloads

10

Version

4.0.8

License

Apache 2.0

Unpacked Size

48.8 kB

Total Files

10

Last publish

Collaborators

  • zeno97