@webex/media-helpers 3.0.0-bnr.5 → 3.0.0-next.2

package/README.md

@@ -21,6 +21,78 @@ npm install --save @webex/media-helpers
 
 ## Usage
 
+### Effects
+There are two effects included in this package:
+
+Virtual background (e.g., blur, image replacement, video replacement)
+Noise reduction (e.g., background noise removal)
+
+#### Virtual background
+The virtual background effect provides a virtual background for video calling. The virtual background may be an image, an mp4 video, or the user's background with blur applied.
+
+**Applying the effect**
+1. Create a new camera track instance by using LocalCameraTrack() method.
+2. Create a VirtualBackgroundEffect instance by passing appropriate constraints.
+3. Use addEffect() method on cameraTrack to apply effect on it.
+4. Enable the effect after adding it to cameraTrack using enable() method available on effect. Effect will be enabled on cameraTrack.
+
+```javascript
+import {LocalCameraTrack, VirtualBackgroundEffect} from '@webex/media-helpers';
+
+// Create a new video stream by a getting user's video media.
+const stream = await navigator.mediaDevices.getUserMedia({ video: { width, height } });
+
+const videoTrackFromLocalStream = stream.getVideoTracks()[0];
+
+const cameraTrack = new LocalCameraTrack(new MediaStream([videoTrackFromLocalStream]));
+
+// Create the effect.
+const effect = new VirtualBackgroundEffect({
+  authToken: '<encoded-string>',
+  mode: `BLUR`,
+  blurStrength: `STRONG`,
+  quality: `LOW`,
+});
+
+// add the effect on the input camera track.
+await cameraTrack.addEffect("background-blur", effect);
+
+//enable the effect once it is added to the track
+await effect.enable()
+```
+
+#### Noise reduction
+The noise reduction effect removes background noise from an audio stream to provide clear audio for calling.
+
+**Applying the effect**
+1. Create a new microphone track instance by using LocalMicrophoneTrack() method.
+2. Create a NoiseReductionEffect instance by passing appropriate constraints.
+3. Use addEffect() method on microphoneTrack to apply effect on it.
+4. Enable the effect after adding it to microphoneTrack using enable() method available on effect. Effect will be enabled on microphoneTrack.
+
+```javascript
+import {LocalMicrophoneTrack, NoiseReductionEffect} from '@webex/media-helpers';
+
+// Create a new audio stream by getting a user's audio media.
+const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
+
+const audioTrackFromLocalStream = stream.getAudioTracks()[0];
+
+const microphoneTrack = new LocalMicrophoneTrack(new MediaStream([audioTrackFromLocalStream]));
+
+// Create the effect.
+const effect = new NoiseReductionEffect({
+  authToken: '<encoded-string>',
+  mode: 'WORKLET', // or 'LEGACY'
+});
+
+// add the effect on microphone track.
+await microphoneTrack.addEffect("background-noise-removal", effect);
+
+//enable the effect once it is added to the track
+await effect.enable()
+```
+
 ## Maintainers
 
 This package is maintained by [Cisco Webex for Developers](https://developer.webex.com/).

package/babel.config.json

@@ -0,0 +1,13 @@
+{
+    "presets": [
+      [
+        "@babel/preset-env",
+        {
+          "targets": {
+            "node": "current"
+          }
+        }
+      ],
+      "@babel/preset-typescript"
+    ],
+}

package/dist/constants.d.ts

@@ -0,0 +1,13 @@
+import { VideoDeviceConstraints } from '@webex/internal-media-core';
+export declare enum FacingMode {
+    user = "user",
+    environment = "environment"
+}
+export declare enum DisplaySurface {
+    browser = "browser",
+    monitor = "monitor",
+    window = "window"
+}
+export declare const PresetCameraConstraints: {
+    [key: string]: VideoDeviceConstraints;
+};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, type ServerMuteReason, LocalMicrophoneStreamEventNames, LocalCameraStreamEventNames, LocalMicrophoneStream, LocalCameraStream, createMicrophoneStream, createCameraStream, createDisplayStream, createDisplayStreamWithAudio, } from './webrtc-core';
+export { NoiseReductionEffect, VirtualBackgroundEffect } from '@webex/web-media-effects';
+export type { NoiseReductionEffectOptions, VirtualBackgroundEffectOptions, } from '@webex/web-media-effects';
+export { FacingMode, DisplaySurface, PresetCameraConstraints } from './constants';

package/dist/webrtc-core.d.ts

@@ -0,0 +1,48 @@
+import { AudioDeviceConstraints, LocalDisplayStream, LocalSystemAudioStream, LocalMicrophoneStream as WcmeLocalMicrophoneStream, LocalCameraStream as WcmeLocalCameraStream, VideoDeviceConstraints } from '@webex/internal-media-core';
+import { TypedEvent } from '@webex/ts-events';
+export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, RemoteStream, } from '@webex/internal-media-core';
+export type ServerMuteReason = 'remotelyMuted' | 'clientRequestFailed' | 'localUnmuteRequired';
+export declare enum LocalMicrophoneStreamEventNames {
+    ServerMuted = "muted:byServer"
+}
+export declare enum LocalCameraStreamEventNames {
+    ServerMuted = "muted:byServer"
+}
+export declare class LocalMicrophoneStream extends WcmeLocalMicrophoneStream {
+    private unmuteAllowed;
+    [LocalMicrophoneStreamEventNames.ServerMuted]: TypedEvent<(muted: boolean, reason: ServerMuteReason) => void>;
+    /**
+     * @internal
+     */
+    setUnmuteAllowed(allowed: any): void;
+    /**
+     * @returns true if user is allowed to unmute the Stream, false otherwise
+     */
+    isUnmuteAllowed(): boolean;
+    setMuted(muted: boolean): void;
+    /**
+     * @internal
+     */
+    setServerMuted(muted: boolean, reason: ServerMuteReason): void;
+}
+export declare class LocalCameraStream extends WcmeLocalCameraStream {
+    private unmuteAllowed;
+    [LocalCameraStreamEventNames.ServerMuted]: TypedEvent<(muted: boolean, reason: ServerMuteReason) => void>;
+    /**
+     * @internal
+     */
+    setUnmuteAllowed(allowed: any): void;
+    /**
+     * @returns true if user is allowed to unmute the Stream, false otherwise
+     */
+    isUnmuteAllowed(): boolean;
+    setMuted(muted: boolean): void;
+    /**
+     * @internal
+     */
+    setServerMuted(muted: boolean, reason: ServerMuteReason): void;
+}
+export declare const createMicrophoneStream: (constraints?: AudioDeviceConstraints) => Promise<LocalMicrophoneStream>;
+export declare const createCameraStream: (constraints?: VideoDeviceConstraints) => Promise<LocalCameraStream>;
+export declare const createDisplayStream: () => Promise<LocalDisplayStream>;
+export declare const createDisplayStreamWithAudio: () => Promise<[LocalDisplayStream, LocalSystemAudioStream]>;

package/package.json

@@ -1,6 +1,5 @@
 {
   "name": "@webex/media-helpers",
-  "version": "3.0.0-bnr.5",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "main": "dist/index.js",
@@ -13,8 +12,23 @@
   "engines": {
     "node": ">=16"
   },
+  "scripts": {
+    "build:src": "yarn run -T tsc --declaration true --declarationDir ./dist",
+    "test:broken": "yarn test:style && yarn test:unit && yarn test:integration && yarn test:browser",
+    "test:browser:broken": "webex-legacy-tools test --integration --unit --runner karma",
+    "test:integration:broken": "webex-legacy-tools test --integration --runner mocha",
+    "test:style": "eslint 'src/**/*.ts' --fix",
+    "test:unit:broken": "webex-legacy-tools test --unit --runner mocha",
+    "deploy:npm": "npm publish"
+  },
   "dependencies": {
-    "@webex/internal-media-core": "1.36.0"
+    "@webex/babel-config-legacy": "workspace:^",
+    "@webex/eslint-config-legacy": "workspace:^",
+    "@webex/internal-media-core": "^2.0.0",
+    "@webex/jest-config-legacy": "workspace:^",
+    "@webex/legacy-tools": "workspace:^",
+    "@webex/ts-events": "^1.1.0",
+    "@webex/web-media-effects": "^2.12.0"
   },
   "browserify": {
     "transform": [
@@ -23,8 +37,11 @@
     ]
   },
   "devDependencies": {
-    "@webex/test-helper-chai": "3.0.0-bnr.5",
-    "@webex/test-helper-mock-webex": "3.0.0-bnr.5",
+    "@babel/preset-typescript": "7.22.11",
+    "@webex/test-helper-chai": "workspace:^",
+    "@webex/test-helper-mock-webex": "workspace:^",
+    "eslint": "^8.24.0",
     "sinon": "^9.2.4"
-  }
+  },
+  "version": "3.0.0-next.2"
 }

package/src/constants.ts

@@ -0,0 +1,29 @@
+import {VideoDeviceConstraints} from '@webex/internal-media-core';
+
+export enum FacingMode {
+  user = 'user',
+  environment = 'environment',
+}
+
+// can be used later on when we add constraints in create display track
+export enum DisplaySurface {
+  browser = 'browser',
+  monitor = 'monitor',
+  window = 'window',
+}
+
+export const PresetCameraConstraints: {[key: string]: VideoDeviceConstraints} = {
+  '1080p': {frameRate: 30, width: 1920, height: 1080},
+
+  '720p': {frameRate: 30, width: 1280, height: 720},
+
+  '480p': {frameRate: 30, width: 640, height: 480},
+
+  '360p': {frameRate: 30, width: 640, height: 360},
+
+  '240p': {frameRate: 30, width: 320, height: 240},
+
+  '180p': {frameRate: 30, width: 320, height: 180},
+
+  '120p': {frameRate: 30, width: 160, height: 120},
+};

package/src/index.ts

@@ -1,14 +1,25 @@
 export {
-  LocalTrack,
-  LocalDisplayTrack,
-  LocalTrackEvents,
-  type TrackMuteEvent,
+  getDevices,
+  LocalStream,
+  LocalDisplayStream,
+  LocalSystemAudioStream,
+  LocalStreamEventNames,
+  StreamEventNames,
   type ServerMuteReason,
-  LocalMicrophoneTrackEvents,
-  LocalCameraTrackEvents,
-  LocalMicrophoneTrack,
-  LocalCameraTrack,
-  createMicrophoneTrack,
-  createCameraTrack,
-  createDisplayTrack,
+  LocalMicrophoneStreamEventNames,
+  LocalCameraStreamEventNames,
+  LocalMicrophoneStream,
+  LocalCameraStream,
+  createMicrophoneStream,
+  createCameraStream,
+  createDisplayStream,
+  createDisplayStreamWithAudio,
 } from './webrtc-core';
+
+export {NoiseReductionEffect, VirtualBackgroundEffect} from '@webex/web-media-effects';
+export type {
+  NoiseReductionEffectOptions,
+  VirtualBackgroundEffectOptions,
+} from '@webex/web-media-effects';
+
+export {FacingMode, DisplaySurface, PresetCameraConstraints} from './constants';

package/src/webrtc-core.ts

@@ -3,20 +3,26 @@
 /* eslint-disable require-jsdoc */
 import {
   AudioDeviceConstraints,
-  createCameraTrack as wcmeCreateCameraTrack,
-  createDisplayTrack as wcmeCreateDisplayTrack,
-  createMicrophoneTrack as wcmeCreateMicrophoneTrack,
-  LocalDisplayTrack,
-  LocalMicrophoneTrack as WcmeLocalMicrophoneTrack,
-  LocalCameraTrack as WcmeLocalCameraTrack,
+  createCameraStream as wcmeCreateCameraStream,
+  createDisplayStream as wcmeCreateDisplayStream,
+  createDisplayStreamWithAudio as wcmeCreateDisplayStreamWithAudio,
+  createMicrophoneStream as wcmeCreateMicrophoneStream,
+  LocalDisplayStream,
+  LocalSystemAudioStream,
+  LocalMicrophoneStream as WcmeLocalMicrophoneStream,
+  LocalCameraStream as WcmeLocalCameraStream,
   VideoDeviceConstraints,
 } from '@webex/internal-media-core';
+import {TypedEvent} from '@webex/ts-events';
 
 export {
-  LocalTrack,
-  LocalDisplayTrack,
-  LocalTrackEvents,
-  type TrackMuteEvent,
+  getDevices,
+  LocalStream,
+  LocalDisplayStream,
+  LocalSystemAudioStream,
+  LocalStreamEventNames,
+  StreamEventNames,
+  RemoteStream,
 } from '@webex/internal-media-core';
 
 export type ServerMuteReason =
@@ -25,18 +31,22 @@ export type ServerMuteReason =
   | 'localUnmuteRequired'; // server forced the client to be unmuted
 
 // these events are in addition to WCME events. This will be properly typed once webrtc-core event types inheritance is fixed
-export enum LocalMicrophoneTrackEvents {
+export enum LocalMicrophoneStreamEventNames {
   ServerMuted = 'muted:byServer',
 }
 
 // these events are in addition to WCME events. This will be properly typed once webrtc-core event types inheritance is fixed
-export enum LocalCameraTrackEvents {
+export enum LocalCameraStreamEventNames {
   ServerMuted = 'muted:byServer',
 }
 
-export class LocalMicrophoneTrack extends WcmeLocalMicrophoneTrack {
+export class LocalMicrophoneStream extends WcmeLocalMicrophoneStream {
   private unmuteAllowed = true;
 
+  [LocalMicrophoneStreamEventNames.ServerMuted] = new TypedEvent<
+    (muted: boolean, reason: ServerMuteReason) => void
+  >();
+
   /**
    * @internal
    */
@@ -45,7 +55,7 @@ export class LocalMicrophoneTrack extends WcmeLocalMicrophoneTrack {
   }
 
   /**
-   * @returns true if user is allowed to unmute the track, false otherwise
+   * @returns true if user is allowed to unmute the Stream, false otherwise
    */
   isUnmuteAllowed() {
     return this.unmuteAllowed;
@@ -67,14 +77,18 @@ export class LocalMicrophoneTrack extends WcmeLocalMicrophoneTrack {
   setServerMuted(muted: boolean, reason: ServerMuteReason) {
     if (muted !== this.muted) {
       this.setMuted(muted);
-      this.emit(LocalMicrophoneTrackEvents.ServerMuted, {muted, reason});
+      this[LocalMicrophoneStreamEventNames.ServerMuted].emit(muted, reason);
     }
   }
 }
 
-export class LocalCameraTrack extends WcmeLocalCameraTrack {
+export class LocalCameraStream extends WcmeLocalCameraStream {
   private unmuteAllowed = true;
 
+  [LocalCameraStreamEventNames.ServerMuted] = new TypedEvent<
+    (muted: boolean, reason: ServerMuteReason) => void
+  >();
+
   /**
    * @internal
    */
@@ -83,7 +97,7 @@ export class LocalCameraTrack extends WcmeLocalCameraTrack {
   }
 
   /**
-   * @returns true if user is allowed to unmute the track, false otherwise
+   * @returns true if user is allowed to unmute the Stream, false otherwise
    */
   isUnmuteAllowed() {
     return this.unmuteAllowed;
@@ -105,15 +119,18 @@ export class LocalCameraTrack extends WcmeLocalCameraTrack {
   setServerMuted(muted: boolean, reason: ServerMuteReason) {
     if (muted !== this.muted) {
       this.setMuted(muted);
-      this.emit(LocalCameraTrackEvents.ServerMuted, {muted, reason});
+      this[LocalCameraStreamEventNames.ServerMuted].emit(muted, reason);
     }
   }
 }
 
-export const createMicrophoneTrack = (constraints?: AudioDeviceConstraints) =>
-  wcmeCreateMicrophoneTrack(LocalMicrophoneTrack, constraints);
+export const createMicrophoneStream = (constraints?: AudioDeviceConstraints) =>
+  wcmeCreateMicrophoneStream(LocalMicrophoneStream, constraints);
+
+export const createCameraStream = (constraints?: VideoDeviceConstraints) =>
+  wcmeCreateCameraStream(LocalCameraStream, constraints);
 
-export const createCameraTrack = (constraints?: VideoDeviceConstraints) =>
-  wcmeCreateCameraTrack(LocalCameraTrack, constraints);
+export const createDisplayStream = () => wcmeCreateDisplayStream(LocalDisplayStream);
 
-export const createDisplayTrack = () => wcmeCreateDisplayTrack(LocalDisplayTrack);
+export const createDisplayStreamWithAudio = () =>
+  wcmeCreateDisplayStreamWithAudio(LocalDisplayStream, LocalSystemAudioStream);

package/test/unit/spec/webrtc-core.js

@@ -1,115 +1,145 @@
 import {assert, expect} from '@webex/test-helper-chai';
 import sinon from 'sinon';
-import {LocalCameraTrack, LocalMicrophoneTrack, LocalMicrophoneTrackEvents, LocalCameraTrackEvents, LocalDisplayTrack, createCameraTrack, createMicrophoneTrack, createDisplayTrack} from '@webex/media-helpers';
-import * as wcmetracks from '@webex/internal-media-core';
+import {
+  LocalCameraStream,
+  LocalMicrophoneStream,
+  LocalMicrophoneStreamEventNames,
+  LocalCameraStreamEventNames,
+  LocalDisplayStream,
+  LocalSystemAudioStream,
+  createCameraStream,
+  createMicrophoneStream,
+  createDisplayStream,
+  createDisplayStreamWithAudio,
+} from '../../../src/webrtc-core';
+import * as wcmeStreams from '@webex/internal-media-core';
 
 describe('media-helpers', () => {
   describe('webrtc-core', () => {
-
     const classesToTest = [
-      {className: LocalCameraTrack, title: 'LocalCameraTrack', event: LocalCameraTrackEvents, createFn: createCameraTrack, spyFn: 'createCameraTrack'},
-      {className: LocalMicrophoneTrack, title: 'LocalMicrophoneTrack', event: LocalMicrophoneTrackEvents, createFn: createMicrophoneTrack, spyFn: 'createMicrophoneTrack'},
+      {
+        className: LocalCameraStream,
+        title: 'LocalCameraStream',
+        event: LocalCameraStreamEventNames,
+        createFn: createCameraStream,
+        spyFn: 'createCameraStream',
+      },
+      {
+        className: LocalMicrophoneStream,
+        title: 'LocalMicrophoneStream',
+        event: LocalMicrophoneStreamEventNames,
+        createFn: createMicrophoneStream,
+        spyFn: 'createMicrophoneStream',
+      },
     ];
 
     classesToTest.forEach(({className, title, event, createFn, spyFn}) =>
-    describe(title, () => {
-      const fakeStream = {
-        getTracks: sinon.stub().returns([{
-          label: 'fake track',
-          id: 'fake track id',
-          enabled: true,
-        }])
-      };
-      const track = new className(fakeStream);
-
-      afterEach(() => {
-        sinon.restore();
-      });
-
-      it('by default allows unmuting', async () => {
-        assert.equal(track.isUnmuteAllowed(), true);
-        await track.setMuted(false);
-      })
+      describe(title, () => {
+        const fakeStream = {
+          getStreams: sinon.stub().returns([
+            {
+              label: 'fake Stream',
+              id: 'fake Stream id',
+              enabled: true,
+            },
+          ]),
+        };
+        const stream = new className(fakeStream);
 
-      it('rejects setMute(false) if unmute is not allowed', async () => {
-        track.setUnmuteAllowed(false);
+        afterEach(() => {
+          sinon.restore();
+        });
 
-        assert.equal(track.isUnmuteAllowed(), false);
-        const fn = () => track.setMuted(false);
-        expect(fn).to.throw(/Unmute is not allowed/);
-      });
+        it('by default allows unmuting', async () => {
+          assert.equal(stream.isUnmuteAllowed(), true);
+          await stream.setMuted(false);
+        });
 
-      it('resolves setMute(false) if unmute is allowed', async () => {
-        track.setUnmuteAllowed(true);
+        it('rejects setMute(false) if unmute is not allowed', async () => {
+          stream.setUnmuteAllowed(false);
 
-        assert.equal(track.isUnmuteAllowed(), true);
-        await track.setMuted(false);
-      });
+          assert.equal(stream.isUnmuteAllowed(), false);
+          const fn = () => stream.setMuted(false);
+          expect(fn).to.throw(/Unmute is not allowed/);
+        });
 
-      describe('#setServerMuted', () => {
+        it('resolves setMute(false) if unmute is allowed', async () => {
+          stream.setUnmuteAllowed(true);
 
-        afterEach(() => {
-          sinon.restore();
+          assert.equal(stream.isUnmuteAllowed(), true);
+          await stream.setMuted(false);
         });
 
-        const checkSetServerMuted = async (startMute, setMute, expectedCalled) => {
-          await track.setMuted(startMute);
+        describe('#setServerMuted', () => {
+          afterEach(() => {
+            sinon.restore();
+          });
 
-          assert.equal(track.muted, startMute);
+          const checkSetServerMuted = async (startMute, setMute, expectedCalled) => {
+            await stream.setMuted(startMute);
 
-          const handler = sinon.fake();
-          track.on(event.ServerMuted, handler);
+            assert.equal(stream.muted, startMute);
 
-          await track.setServerMuted(setMute, 'remotelyMuted');
+            const handler = sinon.fake();
+            stream.on(event.ServerMuted, handler);
 
-          assert.equal(track.muted, setMute);
-          if (expectedCalled) {
-            assert.calledOnceWithExactly(handler, {muted: setMute, reason: 'remotelyMuted'});
-          } else {
-            assert.notCalled(handler);
-          }
-        };
+            await stream.setServerMuted(setMute, 'remotelyMuted');
 
-        it('tests true to false', async () => {
-          await checkSetServerMuted(true, false, true);
-        });
-  
-        it('tests false to true', async () => {
-          await checkSetServerMuted(false, true, true);
-        });
-  
-        it('tests true to true', async () => {
-          await checkSetServerMuted(true, true, false);
-        });
-  
-        it('tests false to false', async () => {
-          await checkSetServerMuted(false, false, false);
-        });
-      });
+            assert.equal(stream.muted, setMute);
+            if (expectedCalled) {
+              assert.calledOnceWithExactly(handler, {muted: setMute, reason: 'remotelyMuted'});
+            } else {
+              assert.notCalled(handler);
+            }
+          };
+
+          it('tests true to false', async () => {
+            await checkSetServerMuted(true, false, true);
+          });
+
+          it('tests false to true', async () => {
+            await checkSetServerMuted(false, true, true);
+          });
+
+          it('tests true to true', async () => {
+            await checkSetServerMuted(true, true, false);
+          });
 
-      describe('#wcmeCreateMicrophoneTrack, #wcmeCreateCameraTrack', () => {
-        it('checks creating tracks', async () => {
-          const constraints = {devideId: 'abc'};
-  
-          const spy = sinon.stub(wcmetracks, spyFn).returns('something');
-          const result = createFn(constraints);
-  
-          assert.equal(result, 'something');
-          assert.calledOnceWithExactly(spy, className, constraints);
+          it('tests false to false', async () => {
+            await checkSetServerMuted(false, false, false);
+          });
         });
-      });
 
-    })
-  );
+        describe('#wcmeCreateMicrophoneStream, #wcmeCreateCameraStream', () => {
+          it('checks creating Streams', async () => {
+            const constraints = {devideId: 'abc'};
+
+            const spy = sinon.stub(wcmeStreams, spyFn).returns('something');
+            const result = createFn(constraints);
 
-  describe('createDisplayTrack', () => {
-    it('checks createDisplayTrack', async () => {
-      const spy = sinon.stub(wcmetracks, 'createDisplayTrack').returns('something');
-      const result = createDisplayTrack();
-      assert.equal(result, 'something');
-      assert.calledOnceWithExactly(spy, LocalDisplayTrack);
+            assert.equal(result, 'something');
+            assert.calledOnceWithExactly(spy, className, constraints);
+          });
+        });
+      })
+    );
+
+    describe('createDisplayStream', () => {
+      it('checks createDisplayStream', async () => {
+        const spy = sinon.stub(wcmeStreams, 'createDisplayStream').returns('something');
+        const result = createDisplayStream();
+        assert.equal(result, 'something');
+        assert.calledOnceWithExactly(spy, LocalDisplayStream);
+      });
     });
 
+    describe('createDisplayStreamWithAudio', () => {
+      it('checks createDisplayStreamWithAudio', async () => {
+        const spy = sinon.stub(wcmeStreams, 'createDisplayStreamWithAudio').returns('something');
+        const result = createDisplayStreamWithAudio();
+        assert.equal(result, 'something');
+        assert.calledOnceWithExactly(spy, LocalDisplayStream, LocalSystemAudioStream);
+      });
+    });
   });
- });
-});
+});

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "extends": "../../../tsconfig.json",
+    "include": [
+        "src"
+    ],
+}

package/dist/index.js

@@ -1,68 +0,0 @@
-"use strict";
-
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-_Object$defineProperty(exports, "LocalCameraTrack", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.LocalCameraTrack;
-  }
-});
-_Object$defineProperty(exports, "LocalCameraTrackEvents", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.LocalCameraTrackEvents;
-  }
-});
-_Object$defineProperty(exports, "LocalDisplayTrack", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.LocalDisplayTrack;
-  }
-});
-_Object$defineProperty(exports, "LocalMicrophoneTrack", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.LocalMicrophoneTrack;
-  }
-});
-_Object$defineProperty(exports, "LocalMicrophoneTrackEvents", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.LocalMicrophoneTrackEvents;
-  }
-});
-_Object$defineProperty(exports, "LocalTrack", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.LocalTrack;
-  }
-});
-_Object$defineProperty(exports, "LocalTrackEvents", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.LocalTrackEvents;
-  }
-});
-_Object$defineProperty(exports, "createCameraTrack", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.createCameraTrack;
-  }
-});
-_Object$defineProperty(exports, "createDisplayTrack", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.createDisplayTrack;
-  }
-});
-_Object$defineProperty(exports, "createMicrophoneTrack", {
-  enumerable: true,
-  get: function get() {
-    return _webrtcCore.createMicrophoneTrack;
-  }
-});
-var _webrtcCore = require("./webrtc-core");
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export {\n  LocalTrack,\n  LocalDisplayTrack,\n  LocalTrackEvents,\n  type TrackMuteEvent,\n  type ServerMuteReason,\n  LocalMicrophoneTrackEvents,\n  LocalCameraTrackEvents,\n  LocalMicrophoneTrack,\n  LocalCameraTrack,\n  createMicrophoneTrack,\n  createCameraTrack,\n  createDisplayTrack,\n} from './webrtc-core';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA"}

package/dist/webrtc-core.js

@@ -1,185 +0,0 @@
-"use strict";
-
-var _Reflect$construct = require("@babel/runtime-corejs2/core-js/reflect/construct");
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.LocalCameraTrackEvents = exports.LocalCameraTrack = void 0;
-_Object$defineProperty(exports, "LocalDisplayTrack", {
-  enumerable: true,
-  get: function get() {
-    return _internalMediaCore.LocalDisplayTrack;
-  }
-});
-exports.LocalMicrophoneTrackEvents = exports.LocalMicrophoneTrack = void 0;
-_Object$defineProperty(exports, "LocalTrack", {
-  enumerable: true,
-  get: function get() {
-    return _internalMediaCore.LocalTrack;
-  }
-});
-_Object$defineProperty(exports, "LocalTrackEvents", {
-  enumerable: true,
-  get: function get() {
-    return _internalMediaCore.LocalTrackEvents;
-  }
-});
-exports.createMicrophoneTrack = exports.createDisplayTrack = exports.createCameraTrack = void 0;
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
-var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/assertThisInitialized"));
-var _get2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/get"));
-var _inherits2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/inherits"));
-var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/possibleConstructorReturn"));
-var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/getPrototypeOf"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
-var _internalMediaCore = require("@webex/internal-media-core");
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-// server forced the client to be unmuted
-// these events are in addition to WCME events. This will be properly typed once webrtc-core event types inheritance is fixed
-var LocalMicrophoneTrackEvents; // these events are in addition to WCME events. This will be properly typed once webrtc-core event types inheritance is fixed
-exports.LocalMicrophoneTrackEvents = LocalMicrophoneTrackEvents;
-(function (LocalMicrophoneTrackEvents) {
-  LocalMicrophoneTrackEvents["ServerMuted"] = "muted:byServer";
-})(LocalMicrophoneTrackEvents || (exports.LocalMicrophoneTrackEvents = LocalMicrophoneTrackEvents = {}));
-var LocalCameraTrackEvents;
-exports.LocalCameraTrackEvents = LocalCameraTrackEvents;
-(function (LocalCameraTrackEvents) {
-  LocalCameraTrackEvents["ServerMuted"] = "muted:byServer";
-})(LocalCameraTrackEvents || (exports.LocalCameraTrackEvents = LocalCameraTrackEvents = {}));
-var LocalMicrophoneTrack = /*#__PURE__*/function (_WcmeLocalMicrophoneT) {
-  (0, _inherits2.default)(LocalMicrophoneTrack, _WcmeLocalMicrophoneT);
-  var _super = _createSuper(LocalMicrophoneTrack);
-  function LocalMicrophoneTrack() {
-    var _this;
-    (0, _classCallCheck2.default)(this, LocalMicrophoneTrack);
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-    _this = _super.call.apply(_super, [this].concat(args));
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "unmuteAllowed", true);
-    return _this;
-  }
-  (0, _createClass2.default)(LocalMicrophoneTrack, [{
-    key: "setUnmuteAllowed",
-    value:
-    /**
-     * @internal
-     */
-    function setUnmuteAllowed(allowed) {
-      this.unmuteAllowed = allowed;
-    }
-
-    /**
-     * @returns true if user is allowed to unmute the track, false otherwise
-     */
-  }, {
-    key: "isUnmuteAllowed",
-    value: function isUnmuteAllowed() {
-      return this.unmuteAllowed;
-    }
-  }, {
-    key: "setMuted",
-    value: function setMuted(muted) {
-      if (!muted) {
-        if (!this.isUnmuteAllowed()) {
-          throw new Error('Unmute is not allowed');
-        }
-      }
-      return (0, _get2.default)((0, _getPrototypeOf2.default)(LocalMicrophoneTrack.prototype), "setMuted", this).call(this, muted);
-    }
-
-    /**
-     * @internal
-     */
-  }, {
-    key: "setServerMuted",
-    value: function setServerMuted(muted, reason) {
-      if (muted !== this.muted) {
-        this.setMuted(muted);
-        this.emit(LocalMicrophoneTrackEvents.ServerMuted, {
-          muted: muted,
-          reason: reason
-        });
-      }
-    }
-  }]);
-  return LocalMicrophoneTrack;
-}(_internalMediaCore.LocalMicrophoneTrack);
-exports.LocalMicrophoneTrack = LocalMicrophoneTrack;
-var LocalCameraTrack = /*#__PURE__*/function (_WcmeLocalCameraTrack) {
-  (0, _inherits2.default)(LocalCameraTrack, _WcmeLocalCameraTrack);
-  var _super2 = _createSuper(LocalCameraTrack);
-  function LocalCameraTrack() {
-    var _this2;
-    (0, _classCallCheck2.default)(this, LocalCameraTrack);
-    for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-      args[_key2] = arguments[_key2];
-    }
-    _this2 = _super2.call.apply(_super2, [this].concat(args));
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this2), "unmuteAllowed", true);
-    return _this2;
-  }
-  (0, _createClass2.default)(LocalCameraTrack, [{
-    key: "setUnmuteAllowed",
-    value:
-    /**
-     * @internal
-     */
-    function setUnmuteAllowed(allowed) {
-      this.unmuteAllowed = allowed;
-    }
-
-    /**
-     * @returns true if user is allowed to unmute the track, false otherwise
-     */
-  }, {
-    key: "isUnmuteAllowed",
-    value: function isUnmuteAllowed() {
-      return this.unmuteAllowed;
-    }
-  }, {
-    key: "setMuted",
-    value: function setMuted(muted) {
-      if (!muted) {
-        if (!this.isUnmuteAllowed()) {
-          throw new Error('Unmute is not allowed');
-        }
-      }
-      return (0, _get2.default)((0, _getPrototypeOf2.default)(LocalCameraTrack.prototype), "setMuted", this).call(this, muted);
-    }
-
-    /**
-     * @internal
-     */
-  }, {
-    key: "setServerMuted",
-    value: function setServerMuted(muted, reason) {
-      if (muted !== this.muted) {
-        this.setMuted(muted);
-        this.emit(LocalCameraTrackEvents.ServerMuted, {
-          muted: muted,
-          reason: reason
-        });
-      }
-    }
-  }]);
-  return LocalCameraTrack;
-}(_internalMediaCore.LocalCameraTrack);
-exports.LocalCameraTrack = LocalCameraTrack;
-var createMicrophoneTrack = function createMicrophoneTrack(constraints) {
-  return (0, _internalMediaCore.createMicrophoneTrack)(LocalMicrophoneTrack, constraints);
-};
-exports.createMicrophoneTrack = createMicrophoneTrack;
-var createCameraTrack = function createCameraTrack(constraints) {
-  return (0, _internalMediaCore.createCameraTrack)(LocalCameraTrack, constraints);
-};
-exports.createCameraTrack = createCameraTrack;
-var createDisplayTrack = function createDisplayTrack() {
-  return (0, _internalMediaCore.createDisplayTrack)(_internalMediaCore.LocalDisplayTrack);
-};
-exports.createDisplayTrack = createDisplayTrack;
-//# sourceMappingURL=webrtc-core.js.map

package/dist/webrtc-core.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["LocalMicrophoneTrackEvents","LocalCameraTrackEvents","LocalMicrophoneTrack","allowed","unmuteAllowed","muted","isUnmuteAllowed","Error","reason","setMuted","emit","ServerMuted","WcmeLocalMicrophoneTrack","LocalCameraTrack","WcmeLocalCameraTrack","createMicrophoneTrack","constraints","wcmeCreateMicrophoneTrack","createCameraTrack","wcmeCreateCameraTrack","createDisplayTrack","wcmeCreateDisplayTrack","LocalDisplayTrack"],"sources":["webrtc-core.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-misused-new */\n/* eslint-disable valid-jsdoc */\n/* eslint-disable require-jsdoc */\nimport {\n  AudioDeviceConstraints,\n  createCameraTrack as wcmeCreateCameraTrack,\n  createDisplayTrack as wcmeCreateDisplayTrack,\n  createMicrophoneTrack as wcmeCreateMicrophoneTrack,\n  LocalDisplayTrack,\n  LocalMicrophoneTrack as WcmeLocalMicrophoneTrack,\n  LocalCameraTrack as WcmeLocalCameraTrack,\n  VideoDeviceConstraints,\n} from '@webex/internal-media-core';\n\nexport {\n  LocalTrack,\n  LocalDisplayTrack,\n  LocalTrackEvents,\n  type TrackMuteEvent,\n} from '@webex/internal-media-core';\n\nexport type ServerMuteReason =\n  | 'remotelyMuted' // other user has remotely muted us\n  | 'clientRequestFailed' // client called setMuted() but server request failed\n  | 'localUnmuteRequired'; // server forced the client to be unmuted\n\n// these events are in addition to WCME events. This will be properly typed once webrtc-core event types inheritance is fixed\nexport enum LocalMicrophoneTrackEvents {\n  ServerMuted = 'muted:byServer',\n}\n\n// these events are in addition to WCME events. This will be properly typed once webrtc-core event types inheritance is fixed\nexport enum LocalCameraTrackEvents {\n  ServerMuted = 'muted:byServer',\n}\n\nexport class LocalMicrophoneTrack extends WcmeLocalMicrophoneTrack {\n  private unmuteAllowed = true;\n\n  /**\n   * @internal\n   */\n  setUnmuteAllowed(allowed) {\n    this.unmuteAllowed = allowed;\n  }\n\n  /**\n   * @returns true if user is allowed to unmute the track, false otherwise\n   */\n  isUnmuteAllowed() {\n    return this.unmuteAllowed;\n  }\n\n  setMuted(muted: boolean): void {\n    if (!muted) {\n      if (!this.isUnmuteAllowed()) {\n        throw new Error('Unmute is not allowed');\n      }\n    }\n\n    return super.setMuted(muted);\n  }\n\n  /**\n   * @internal\n   */\n  setServerMuted(muted: boolean, reason: ServerMuteReason) {\n    if (muted !== this.muted) {\n      this.setMuted(muted);\n      this.emit(LocalMicrophoneTrackEvents.ServerMuted, {muted, reason});\n    }\n  }\n}\n\nexport class LocalCameraTrack extends WcmeLocalCameraTrack {\n  private unmuteAllowed = true;\n\n  /**\n   * @internal\n   */\n  setUnmuteAllowed(allowed) {\n    this.unmuteAllowed = allowed;\n  }\n\n  /**\n   * @returns true if user is allowed to unmute the track, false otherwise\n   */\n  isUnmuteAllowed() {\n    return this.unmuteAllowed;\n  }\n\n  setMuted(muted: boolean): void {\n    if (!muted) {\n      if (!this.isUnmuteAllowed()) {\n        throw new Error('Unmute is not allowed');\n      }\n    }\n\n    return super.setMuted(muted);\n  }\n\n  /**\n   * @internal\n   */\n  setServerMuted(muted: boolean, reason: ServerMuteReason) {\n    if (muted !== this.muted) {\n      this.setMuted(muted);\n      this.emit(LocalCameraTrackEvents.ServerMuted, {muted, reason});\n    }\n  }\n}\n\nexport const createMicrophoneTrack = (constraints?: AudioDeviceConstraints) =>\n  wcmeCreateMicrophoneTrack(LocalMicrophoneTrack, constraints);\n\nexport const createCameraTrack = (constraints?: VideoDeviceConstraints) =>\n  wcmeCreateCameraTrack(LocalCameraTrack, constraints);\n\nexport const createDisplayTrack = () => wcmeCreateDisplayTrack(LocalDisplayTrack);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA;AASoC;AAAA;AAYT;AAE3B;AAAA,IACYA,0BAA0B,EAItC;AAAA;AAAA,WAJYA,0BAA0B;EAA1BA,0BAA0B;AAAA,GAA1BA,0BAA0B,0CAA1BA,0BAA0B;AAAA,IAK1BC,sBAAsB;AAAA;AAAA,WAAtBA,sBAAsB;EAAtBA,sBAAsB;AAAA,GAAtBA,sBAAsB,sCAAtBA,sBAAsB;AAAA,IAIrBC,oBAAoB;EAAA;EAAA;EAAA;IAAA;IAAA;IAAA;MAAA;IAAA;IAAA;IAAA,4FACP,IAAI;IAAA;EAAA;EAAA;IAAA;IAAA;IAE5B;AACF;AACA;IACE,0BAAiBC,OAAO,EAAE;MACxB,IAAI,CAACC,aAAa,GAAGD,OAAO;IAC9B;;IAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,2BAAkB;MAChB,OAAO,IAAI,CAACC,aAAa;IAC3B;EAAC;IAAA;IAAA,OAED,kBAASC,KAAc,EAAQ;MAC7B,IAAI,CAACA,KAAK,EAAE;QACV,IAAI,CAAC,IAAI,CAACC,eAAe,EAAE,EAAE;UAC3B,MAAM,IAAIC,KAAK,CAAC,uBAAuB,CAAC;QAC1C;MACF;MAEA,sHAAsBF,KAAK;IAC7B;;IAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,wBAAeA,KAAc,EAAEG,MAAwB,EAAE;MACvD,IAAIH,KAAK,KAAK,IAAI,CAACA,KAAK,EAAE;QACxB,IAAI,CAACI,QAAQ,CAACJ,KAAK,CAAC;QACpB,IAAI,CAACK,IAAI,CAACV,0BAA0B,CAACW,WAAW,EAAE;UAACN,KAAK,EAALA,KAAK;UAAEG,MAAM,EAANA;QAAM,CAAC,CAAC;MACpE;IACF;EAAC;EAAA;AAAA,EAnCuCI,uCAAwB;AAAA;AAAA,IAsCrDC,gBAAgB;EAAA;EAAA;EAAA;IAAA;IAAA;IAAA;MAAA;IAAA;IAAA;IAAA,6FACH,IAAI;IAAA;EAAA;EAAA;IAAA;IAAA;IAE5B;AACF;AACA;IACE,0BAAiBV,OAAO,EAAE;MACxB,IAAI,CAACC,aAAa,GAAGD,OAAO;IAC9B;;IAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,2BAAkB;MAChB,OAAO,IAAI,CAACC,aAAa;IAC3B;EAAC;IAAA;IAAA,OAED,kBAASC,KAAc,EAAQ;MAC7B,IAAI,CAACA,KAAK,EAAE;QACV,IAAI,CAAC,IAAI,CAACC,eAAe,EAAE,EAAE;UAC3B,MAAM,IAAIC,KAAK,CAAC,uBAAuB,CAAC;QAC1C;MACF;MAEA,kHAAsBF,KAAK;IAC7B;;IAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,wBAAeA,KAAc,EAAEG,MAAwB,EAAE;MACvD,IAAIH,KAAK,KAAK,IAAI,CAACA,KAAK,EAAE;QACxB,IAAI,CAACI,QAAQ,CAACJ,KAAK,CAAC;QACpB,IAAI,CAACK,IAAI,CAACT,sBAAsB,CAACU,WAAW,EAAE;UAACN,KAAK,EAALA,KAAK;UAAEG,MAAM,EAANA;QAAM,CAAC,CAAC;MAChE;IACF;EAAC;EAAA;AAAA,EAnCmCM,mCAAoB;AAAA;AAsCnD,IAAMC,qBAAqB,GAAG,SAAxBA,qBAAqB,CAAIC,WAAoC;EAAA,OACxE,IAAAC,wCAAyB,EAACf,oBAAoB,EAAEc,WAAW,CAAC;AAAA;AAAC;AAExD,IAAME,iBAAiB,GAAG,SAApBA,iBAAiB,CAAIF,WAAoC;EAAA,OACpE,IAAAG,oCAAqB,EAACN,gBAAgB,EAAEG,WAAW,CAAC;AAAA;AAAC;AAEhD,IAAMI,kBAAkB,GAAG,SAArBA,kBAAkB;EAAA,OAAS,IAAAC,qCAAsB,EAACC,oCAAiB,CAAC;AAAA;AAAC"}