@webex/plugin-meetings 3.0.0-beta.122 → 3.0.0-beta.124

package/dist/types/meeting/index.d.ts

@@ -1731,6 +1731,13 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {void}
      */
     private checkMediaConnection;
+    /**
+     * Method to enable or disable the 'Music mode' effect on audio track
+     *
+     * @param {boolean} shouldEnableMusicMode
+     * @returns {Promise}
+     */
+    enableMusicMode(shouldEnableMusicMode: boolean): Promise<void>;
     /**
      * Publishes specified local tracks in the meeting
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.122",
+  "version": "3.0.0-beta.124",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.122",
-    "@webex/test-helper-chai": "3.0.0-beta.122",
-    "@webex/test-helper-mocha": "3.0.0-beta.122",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.122",
-    "@webex/test-helper-retry": "3.0.0-beta.122",
-    "@webex/test-helper-test-users": "3.0.0-beta.122",
+    "@webex/plugin-meetings": "3.0.0-beta.124",
+    "@webex/test-helper-chai": "3.0.0-beta.124",
+    "@webex/test-helper-mocha": "3.0.0-beta.124",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.124",
+    "@webex/test-helper-retry": "3.0.0-beta.124",
+    "@webex/test-helper-test-users": "3.0.0-beta.124",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,19 +46,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.122",
+    "@webex/common": "3.0.0-beta.124",
     "@webex/internal-media-core": "1.38.1",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.122",
-    "@webex/internal-plugin-device": "3.0.0-beta.122",
-    "@webex/internal-plugin-llm": "3.0.0-beta.122",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.122",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.122",
-    "@webex/internal-plugin-support": "3.0.0-beta.122",
-    "@webex/internal-plugin-user": "3.0.0-beta.122",
-    "@webex/media-helpers": "3.0.0-beta.122",
-    "@webex/plugin-people": "3.0.0-beta.122",
-    "@webex/plugin-rooms": "3.0.0-beta.122",
-    "@webex/webex-core": "3.0.0-beta.122",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.124",
+    "@webex/internal-plugin-device": "3.0.0-beta.124",
+    "@webex/internal-plugin-llm": "3.0.0-beta.124",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.124",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.124",
+    "@webex/internal-plugin-support": "3.0.0-beta.124",
+    "@webex/internal-plugin-user": "3.0.0-beta.124",
+    "@webex/media-helpers": "3.0.0-beta.124",
+    "@webex/plugin-people": "3.0.0-beta.124",
+    "@webex/plugin-rooms": "3.0.0-beta.124",
+    "@webex/webex-core": "3.0.0-beta.124",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/meeting/index.ts

@@ -7565,6 +7565,32 @@ export default class Meeting extends StatelessWebexPlugin {
     throw new Error('Webrtc media connection is missing, call addMedia() first');
   }
 
+  /**
+   * Method to enable or disable the 'Music mode' effect on audio track
+   *
+   * @param {boolean} shouldEnableMusicMode
+   * @returns {Promise}
+   */
+  async enableMusicMode(shouldEnableMusicMode: boolean) {
+    this.checkMediaConnection();
+
+    if (!this.isMultistream) {
+      throw new Error('enableMusicMode() only supported with multistream');
+    }
+
+    if (shouldEnableMusicMode) {
+      await this.mediaProperties.webrtcMediaConnection.setCodecParameters(MediaType.AudioMain, {
+        maxaveragebitrate: '64000',
+        maxplaybackrate: '48000',
+      });
+    } else {
+      await this.mediaProperties.webrtcMediaConnection.deleteCodecParameters(MediaType.AudioMain, [
+        'maxaveragebitrate',
+        'maxplaybackrate',
+      ]);
+    }
+  }
+
   /**
    * Publishes specified local tracks in the meeting
    *

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

@@ -4126,6 +4126,43 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#enableMusicMode', () => {
+      beforeEach(() => {
+        meeting.isMultistream = true;
+          meeting.mediaProperties.webrtcMediaConnection = {
+            setCodecParameters: sinon.stub().resolves({}),
+            deleteCodecParameters: sinon.stub().resolves({}),
+          };
+      });
+      [
+        {shouldEnableMusicMode: true},
+        {shouldEnableMusicMode: false},
+      ].forEach(({shouldEnableMusicMode}) => {
+        it(`fails if there is no media connection for shouldEnableMusicMode: ${shouldEnableMusicMode}`, async () => {
+          meeting.mediaProperties.webrtcMediaConnection = undefined;
+          await assert.isRejected(meeting.enableMusicMode(shouldEnableMusicMode));
+        });
+      });
+
+      it('should set the codec parameters when shouldEnableMusicMode is true', async () => {
+        await meeting.enableMusicMode(true);
+        assert.calledOnceWithExactly(meeting.mediaProperties.webrtcMediaConnection.setCodecParameters, MediaType.AudioMain, {
+          maxaveragebitrate: '64000',
+          maxplaybackrate: '48000',
+        });
+        assert.notCalled(meeting.mediaProperties.webrtcMediaConnection.deleteCodecParameters);
+      });
+
+      it('should set the codec parameters when shouldEnableMusicMode is false', async () => {
+        await meeting.enableMusicMode(false);
+        assert.calledOnceWithExactly(meeting.mediaProperties.webrtcMediaConnection.deleteCodecParameters, MediaType.AudioMain, [
+          'maxaveragebitrate',
+          'maxplaybackrate',
+        ]);
+        assert.notCalled(meeting.mediaProperties.webrtcMediaConnection.setCodecParameters);
+      });
+    });
+
     describe('Public Event Triggers', () => {
       let sandbox;
       const {ENDED} = CONSTANTS;