@webex/plugin-meetings 3.0.0-beta.143 → 3.0.0-beta.145

package/src/meetings/index.ts

@@ -59,6 +59,7 @@ import CaptchaError from '../common/errors/captcha-error';
 import MeetingCollection from './collection';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
+import {INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
 
 let mediaLogger;
 
@@ -807,6 +808,36 @@ export default class Meetings extends WebexPlugin {
     );
   }
 
+  /**
+   * Creates a noise reduction effect
+   *
+   * @param {INoiseReductionEffect} options optional custom effect options
+   * @returns {Promise<effect>} noise reduction effect.
+   * @public
+   * @memberof Meetings
+   */
+  createNoiseReductionEffect = async (options?: INoiseReductionEffect) => {
+    // @ts-ignore
+    const authToken = this.webex.credentials.supertoken.access_token;
+
+    return new mediaHelpersModule.NoiseReductionEffect({authToken, ...options});
+  };
+
+  /**
+   * Creates a virtual background effect
+   *
+   * @param {IVirtualBackgroundEffect} options optional custom effect options
+   * @returns {Promise<effect>} virtual background effect.
+   * @public
+   * @memberof Meetings
+   */
+  createVirtualBackgroundEffect = async (options?: IVirtualBackgroundEffect) => {
+    // @ts-ignore
+    const authToken = this.webex.credentials.supertoken.access_token;
+
+    return new mediaHelpersModule.VirtualBackgroundEffect({authToken, ...options});
+  };
+
   /**
    * Uploads logs to the webex services for tracking
    * @param {Object} [options={}]

package/src/meetings/meetings.types.ts

@@ -0,0 +1,9 @@
+import type {
+  NoiseReductionEffectOptions,
+  VirtualBackgroundEffectOptions,
+} from '@webex/media-helpers';
+
+type INoiseReductionEffect = Omit<NoiseReductionEffectOptions, 'authToken'>;
+type IVirtualBackgroundEffect = Omit<VirtualBackgroundEffectOptions, 'authToken'>;
+
+export type {INoiseReductionEffect, IVirtualBackgroundEffect};

package/test/unit/spec/meeting/in-meeting-actions.ts

@@ -38,6 +38,7 @@ describe('plugin-meetings', () => {
         waitingForOthersToJoin: null,
         canSendReactions: null,
         canManageBreakout: null,
+        canBroadcastMessageToBreakout: null,
         canAdmitLobbyToBreakout: null,
         canUserAskForHelp: null,
         canUserRenameSelfAndObserved: null,
@@ -108,6 +109,7 @@ describe('plugin-meetings', () => {
       'waitingForOthersToJoin',
       'canSendReactions',
       'canManageBreakout',
+      'canBroadcastMessageToBreakout',
       'canAdmitLobbyToBreakout',
       'canUserAskForHelp',
       'canUserRenameSelfAndObserved',

package/test/unit/spec/meeting/utils.js

@@ -590,6 +590,13 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('canBroadcastMessageToBreakout', () => {
+      it('works as expected', () => {
+        assert.deepEqual(MeetingUtil.canBroadcastMessageToBreakout(['BROADCAST_MESSAGE_TO_BREAKOUT']), true);
+        assert.deepEqual(MeetingUtil.canBroadcastMessageToBreakout([]), false);
+      });
+    });
+
     describe('isSuppressBreakoutSupport', () => {
       it('works as expected', () => {
         assert.deepEqual(

package/test/unit/spec/meetings/index.js

@@ -34,6 +34,7 @@ import CaptchaError from '@webex/plugin-meetings/src/common/errors/captcha-error
 import { forEach } from 'lodash';
 import PasswordError from '@webex/plugin-meetings/src/common/errors/password-error';
 import PermissionError from '@webex/plugin-meetings/src/common/errors/permission';
+import {NoiseReductionEffect,VirtualBackgroundEffect} from '@webex/media-helpers';
 
 describe('plugin-meetings', () => {
   const logger = {
@@ -352,6 +353,102 @@ describe('plugin-meetings', () => {
         });
       });
 
+      describe('virtual background effect', () => {
+        beforeEach(() => {
+          webex.credentials = {
+            supertoken: {
+              access_token: "fake_token"
+            }
+          };
+        })
+
+        it('creates background effect', async () => {
+          const result = await webex.meetings.createVirtualBackgroundEffect();
+
+          assert.exists(result);
+          assert.instanceOf(result, VirtualBackgroundEffect);
+          assert.containsAllKeys(result, ['loadModel', 'isEnabled', 'isLoaded', 'options']);
+          assert.deepEqual(result.options, {
+            mode: 'BLUR',
+            blurStrength: 'STRONG',
+            generator: 'worker',
+            quality: 'LOW',
+            authToken: 'fake_token',
+            mirror: false
+          });
+          assert.exists(result.enable);
+          assert.exists(result.disable);
+          assert.exists(result.dispose);
+        });
+
+        it('creates background effect with custom options passed', async () => {
+          const effectOptions = {
+            generator: "local",
+            frameRate: 45,
+            mode: "IMAGE",
+            mirror: false,
+            quality: "HIGH",
+            blurStrength: "STRONG",
+            bgImageUrl: "https://test.webex.com/landscape.5a535788.jpg",
+          };
+
+          const result = await webex.meetings.createVirtualBackgroundEffect(effectOptions);
+
+          assert.exists(result);
+          assert.instanceOf(result, VirtualBackgroundEffect);
+          assert.containsAllKeys(result, ['loadModel', 'isEnabled', 'isLoaded', 'options']);
+          assert.deepEqual(result.options, {...effectOptions, authToken: "fake_token"});
+          assert.exists(result.enable);
+          assert.exists(result.disable);
+          assert.exists(result.dispose);
+        });
+      })
+
+      describe('noise reduction effect', () => {
+        beforeEach(() => {
+          webex.credentials = {
+            supertoken: {
+              access_token: "fake_token"
+            }
+          };
+        })
+
+        it('creates noise reduction effect', async () => {
+          const result = await webex.meetings.createNoiseReductionEffect({audioContext: {}});
+
+          assert.exists(result);
+          assert.instanceOf(result, NoiseReductionEffect);
+          assert.containsAllKeys(result, ['audioContext', 'isEnabled', 'isReady', 'options']);
+          assert.deepEqual(result.options, {
+            authToken: 'fake_token',
+            audioContext: {}
+          });
+          assert.exists(result.enable);
+          assert.exists(result.disable);
+          assert.exists(result.dispose);
+        });
+
+        it('creates noise reduction effect with custom options passed', async () => {
+          const effectOptions = {
+            audioContext: {},
+            workletProcessorUrl: "test.url.com",
+            mode: "WORKLET",
+            env: "prod",
+            avoidSimd: false
+          };
+
+          const result = await webex.meetings.createNoiseReductionEffect(effectOptions);
+
+          assert.exists(result);
+          assert.instanceOf(result, NoiseReductionEffect);
+          assert.containsAllKeys(result, ['audioContext', 'isEnabled', 'isReady', 'options']);
+          assert.deepEqual(result.options, {...effectOptions, authToken: "fake_token"});
+          assert.exists(result.enable);
+          assert.exists(result.disable);
+          assert.exists(result.dispose);
+        });
+      })
+
       describe('gets', () => {
         describe('#getReachability', () => {
           it('should have #getReachability', () => {