capacitor-cloudvoice-meet
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Cloudvoice Meet Capacitor Plugin for Ionic Apps

This plugin is used to make video calls using Cloudvoice video platform (https://devmeet.cloudvoice.in) on iOS and Android.

iOS Compatible Versions

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

Upgrade to Capacitor 2.0

Follow the official Capacitor doc to upgrade to 2.0+.

For android deployment, ensure you follow step 6 in README.

Embedding in web applications

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

Usage

  1. npm install capacitor-cloudvoice-meet

  2. use it as a Capacitor Plugin

import { Plugins } from '@capacitor/core';
import 'capacitor-cloudvoice-meet';

const { Cloudvoice } = Plugins;
const result = await Cloudvoice.joinConference({
   roomName: 'room1', // room identifier for the conference
   url: 'https://devmeet.cloudvoice.in' // endpoint of the Cloudvoice Meet video bridge,
   token: string; // jwt authentication token
   displayName: string; // user's display name
   email: string; // user's email
   avatarURL: string; // user's avatar url
   channelLastN: string; // last N participants allowed to join
   startWithAudioMuted: true, // start with audio muted
   startWithVideoMuted: false // start with video muted
   chatEnabled: false, // enable Chat feature
   inviteEnabled: false // enable Invitation feature
   callIntegrationEnabled: true // enable call integration (CallKit on iOS, ConnectionService on Android)
});

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

await Cloudvoice.leaveConference();

  1. Build the project

  2. Follow the deployment instructions for Android and iOS.

Feature Requests and Cloudvoice SDK Customizations

I appreciate those who use this plugin in their production apps and are funding this project as sponsors. Your sponsorship enables me to continue to maintain and roll out releases in a timely manner. Consider joining as a sponsor to get first-class support and consultation. For feature requests, create an issue with a label 'feature request'. I also offer paid consultation service to those needing to modify the Cloudvoice UI interface. To submit a request, create an issue and add the label 'sdk customization'.

Acknowledgements

This plugin uses the Cloudvoice Meet SDK. It was originally developed by then ESTOS' developer Philipp Hancke who then contributed it to the community where development continues with joint forces!

Readme

Keywords

Package Sidebar

Install

npm i capacitor-cloudvoice-meet

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

1.06 MB

Total Files

224

Last publish

Collaborators

  • cloudvoice