@webex/media-helpers 3.0.0-next.4 → 3.0.0-next.6

package/src/webrtc-core.ts

@@ -1,136 +1,136 @@
-/* eslint-disable @typescript-eslint/no-misused-new */
-/* eslint-disable valid-jsdoc */
-/* eslint-disable require-jsdoc */
-import {
-  AudioDeviceConstraints,
-  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 {
-  getDevices,
-  LocalStream,
-  LocalDisplayStream,
-  LocalSystemAudioStream,
-  LocalStreamEventNames,
-  StreamEventNames,
-  RemoteStream,
-} from '@webex/internal-media-core';
-
-export type ServerMuteReason =
-  | 'remotelyMuted' // other user has remotely muted us
-  | 'clientRequestFailed' // client called setMuted() but server request failed
-  | '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 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 LocalCameraStreamEventNames {
-  ServerMuted = 'muted:byServer',
-}
-
-export class LocalMicrophoneStream extends WcmeLocalMicrophoneStream {
-  private unmuteAllowed = true;
-
-  [LocalMicrophoneStreamEventNames.ServerMuted] = new TypedEvent<
-    (muted: boolean, reason: ServerMuteReason) => void
-  >();
-
-  /**
-   * @internal
-   */
-  setUnmuteAllowed(allowed) {
-    this.unmuteAllowed = allowed;
-  }
-
-  /**
-   * @returns true if user is allowed to unmute the Stream, false otherwise
-   */
-  isUnmuteAllowed() {
-    return this.unmuteAllowed;
-  }
-
-  setMuted(muted: boolean): void {
-    if (!muted) {
-      if (!this.isUnmuteAllowed()) {
-        throw new Error('Unmute is not allowed');
-      }
-    }
-
-    return super.setMuted(muted);
-  }
-
-  /**
-   * @internal
-   */
-  setServerMuted(muted: boolean, reason: ServerMuteReason) {
-    if (muted !== this.muted) {
-      this.setMuted(muted);
-      this[LocalMicrophoneStreamEventNames.ServerMuted].emit(muted, reason);
-    }
-  }
-}
-
-export class LocalCameraStream extends WcmeLocalCameraStream {
-  private unmuteAllowed = true;
-
-  [LocalCameraStreamEventNames.ServerMuted] = new TypedEvent<
-    (muted: boolean, reason: ServerMuteReason) => void
-  >();
-
-  /**
-   * @internal
-   */
-  setUnmuteAllowed(allowed) {
-    this.unmuteAllowed = allowed;
-  }
-
-  /**
-   * @returns true if user is allowed to unmute the Stream, false otherwise
-   */
-  isUnmuteAllowed() {
-    return this.unmuteAllowed;
-  }
-
-  setMuted(muted: boolean): void {
-    if (!muted) {
-      if (!this.isUnmuteAllowed()) {
-        throw new Error('Unmute is not allowed');
-      }
-    }
-
-    return super.setMuted(muted);
-  }
-
-  /**
-   * @internal
-   */
-  setServerMuted(muted: boolean, reason: ServerMuteReason) {
-    if (muted !== this.muted) {
-      this.setMuted(muted);
-      this[LocalCameraStreamEventNames.ServerMuted].emit(muted, reason);
-    }
-  }
-}
-
-export const createMicrophoneStream = (constraints?: AudioDeviceConstraints) =>
-  wcmeCreateMicrophoneStream(LocalMicrophoneStream, constraints);
-
-export const createCameraStream = (constraints?: VideoDeviceConstraints) =>
-  wcmeCreateCameraStream(LocalCameraStream, constraints);
-
-export const createDisplayStream = () => wcmeCreateDisplayStream(LocalDisplayStream);
-
-export const createDisplayStreamWithAudio = () =>
-  wcmeCreateDisplayStreamWithAudio(LocalDisplayStream, LocalSystemAudioStream);
+/* eslint-disable @typescript-eslint/no-misused-new */
+/* eslint-disable valid-jsdoc */
+/* eslint-disable require-jsdoc */
+import {
+  AudioDeviceConstraints,
+  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 {
+  getDevices,
+  LocalStream,
+  LocalDisplayStream,
+  LocalSystemAudioStream,
+  LocalStreamEventNames,
+  StreamEventNames,
+  RemoteStream,
+} from '@webex/internal-media-core';
+
+export type ServerMuteReason =
+  | 'remotelyMuted' // other user has remotely muted us
+  | 'clientRequestFailed' // client called setMuted() but server request failed
+  | '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 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 LocalCameraStreamEventNames {
+  ServerMuted = 'muted:byServer',
+}
+
+export class LocalMicrophoneStream extends WcmeLocalMicrophoneStream {
+  private unmuteAllowed = true;
+
+  [LocalMicrophoneStreamEventNames.ServerMuted] = new TypedEvent<
+    (muted: boolean, reason: ServerMuteReason) => void
+  >();
+
+  /**
+   * @internal
+   */
+  setUnmuteAllowed(allowed) {
+    this.unmuteAllowed = allowed;
+  }
+
+  /**
+   * @returns true if user is allowed to unmute the Stream, false otherwise
+   */
+  isUnmuteAllowed() {
+    return this.unmuteAllowed;
+  }
+
+  setMuted(muted: boolean): void {
+    if (!muted) {
+      if (!this.isUnmuteAllowed()) {
+        throw new Error('Unmute is not allowed');
+      }
+    }
+
+    return super.setMuted(muted);
+  }
+
+  /**
+   * @internal
+   */
+  setServerMuted(muted: boolean, reason: ServerMuteReason) {
+    if (muted !== this.muted) {
+      this.setMuted(muted);
+      this[LocalMicrophoneStreamEventNames.ServerMuted].emit(muted, reason);
+    }
+  }
+}
+
+export class LocalCameraStream extends WcmeLocalCameraStream {
+  private unmuteAllowed = true;
+
+  [LocalCameraStreamEventNames.ServerMuted] = new TypedEvent<
+    (muted: boolean, reason: ServerMuteReason) => void
+  >();
+
+  /**
+   * @internal
+   */
+  setUnmuteAllowed(allowed) {
+    this.unmuteAllowed = allowed;
+  }
+
+  /**
+   * @returns true if user is allowed to unmute the Stream, false otherwise
+   */
+  isUnmuteAllowed() {
+    return this.unmuteAllowed;
+  }
+
+  setMuted(muted: boolean): void {
+    if (!muted) {
+      if (!this.isUnmuteAllowed()) {
+        throw new Error('Unmute is not allowed');
+      }
+    }
+
+    return super.setMuted(muted);
+  }
+
+  /**
+   * @internal
+   */
+  setServerMuted(muted: boolean, reason: ServerMuteReason) {
+    if (muted !== this.muted) {
+      this.setMuted(muted);
+      this[LocalCameraStreamEventNames.ServerMuted].emit(muted, reason);
+    }
+  }
+}
+
+export const createMicrophoneStream = (constraints?: AudioDeviceConstraints) =>
+  wcmeCreateMicrophoneStream(LocalMicrophoneStream, constraints);
+
+export const createCameraStream = (constraints?: VideoDeviceConstraints) =>
+  wcmeCreateCameraStream(LocalCameraStream, constraints);
+
+export const createDisplayStream = () => wcmeCreateDisplayStream(LocalDisplayStream);
+
+export const createDisplayStreamWithAudio = () =>
+  wcmeCreateDisplayStreamWithAudio(LocalDisplayStream, LocalSystemAudioStream);

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

@@ -1,145 +1,145 @@
-import {assert, expect} from '@webex/test-helper-chai';
-import sinon from 'sinon';
-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: 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 = {
-          getStreams: sinon.stub().returns([
-            {
-              label: 'fake Stream',
-              id: 'fake Stream id',
-              enabled: true,
-            },
-          ]),
-        };
-        const stream = new className(fakeStream);
-
-        afterEach(() => {
-          sinon.restore();
-        });
-
-        it('by default allows unmuting', async () => {
-          assert.equal(stream.isUnmuteAllowed(), true);
-          await stream.setMuted(false);
-        });
-
-        it('rejects setMute(false) if unmute is not allowed', async () => {
-          stream.setUnmuteAllowed(false);
-
-          assert.equal(stream.isUnmuteAllowed(), false);
-          const fn = () => stream.setMuted(false);
-          expect(fn).to.throw(/Unmute is not allowed/);
-        });
-
-        it('resolves setMute(false) if unmute is allowed', async () => {
-          stream.setUnmuteAllowed(true);
-
-          assert.equal(stream.isUnmuteAllowed(), true);
-          await stream.setMuted(false);
-        });
-
-        describe('#setServerMuted', () => {
-          afterEach(() => {
-            sinon.restore();
-          });
-
-          const checkSetServerMuted = async (startMute, setMute, expectedCalled) => {
-            await stream.setMuted(startMute);
-
-            assert.equal(stream.muted, startMute);
-
-            const handler = sinon.fake();
-            stream.on(event.ServerMuted, handler);
-
-            await stream.setServerMuted(setMute, 'remotelyMuted');
-
-            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);
-          });
-
-          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);
-
-            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);
-      });
-    });
-  });
-});
+import {assert, expect} from '@webex/test-helper-chai';
+import sinon from 'sinon';
+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: 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 = {
+          getStreams: sinon.stub().returns([
+            {
+              label: 'fake Stream',
+              id: 'fake Stream id',
+              enabled: true,
+            },
+          ]),
+        };
+        const stream = new className(fakeStream);
+
+        afterEach(() => {
+          sinon.restore();
+        });
+
+        it('by default allows unmuting', async () => {
+          assert.equal(stream.isUnmuteAllowed(), true);
+          await stream.setMuted(false);
+        });
+
+        it('rejects setMute(false) if unmute is not allowed', async () => {
+          stream.setUnmuteAllowed(false);
+
+          assert.equal(stream.isUnmuteAllowed(), false);
+          const fn = () => stream.setMuted(false);
+          expect(fn).to.throw(/Unmute is not allowed/);
+        });
+
+        it('resolves setMute(false) if unmute is allowed', async () => {
+          stream.setUnmuteAllowed(true);
+
+          assert.equal(stream.isUnmuteAllowed(), true);
+          await stream.setMuted(false);
+        });
+
+        describe('#setServerMuted', () => {
+          afterEach(() => {
+            sinon.restore();
+          });
+
+          const checkSetServerMuted = async (startMute, setMute, expectedCalled) => {
+            await stream.setMuted(startMute);
+
+            assert.equal(stream.muted, startMute);
+
+            const handler = sinon.fake();
+            stream.on(event.ServerMuted, handler);
+
+            await stream.setServerMuted(setMute, 'remotelyMuted');
+
+            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);
+          });
+
+          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);
+
+            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

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

package/dist/constants.js

@@ -1,59 +0,0 @@
-"use strict";
-
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.PresetCameraConstraints = exports.FacingMode = exports.DisplaySurface = void 0;
-var FacingMode; // can be used later on when we add constraints in create display track
-exports.FacingMode = FacingMode;
-(function (FacingMode) {
-  FacingMode["user"] = "user";
-  FacingMode["environment"] = "environment";
-})(FacingMode || (exports.FacingMode = FacingMode = {}));
-var DisplaySurface;
-exports.DisplaySurface = DisplaySurface;
-(function (DisplaySurface) {
-  DisplaySurface["browser"] = "browser";
-  DisplaySurface["monitor"] = "monitor";
-  DisplaySurface["window"] = "window";
-})(DisplaySurface || (exports.DisplaySurface = DisplaySurface = {}));
-var PresetCameraConstraints = {
-  '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
-  }
-};
-exports.PresetCameraConstraints = PresetCameraConstraints;
-//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["FacingMode","exports","DisplaySurface","PresetCameraConstraints","frameRate","width","height"],"sources":["constants.ts"],"sourcesContent":["import {VideoDeviceConstraints} from '@webex/internal-media-core';\r\n\r\nexport enum FacingMode {\r\n  user = 'user',\r\n  environment = 'environment',\r\n}\r\n\r\n// can be used later on when we add constraints in create display track\r\nexport enum DisplaySurface {\r\n  browser = 'browser',\r\n  monitor = 'monitor',\r\n  window = 'window',\r\n}\r\n\r\nexport const PresetCameraConstraints: {[key: string]: VideoDeviceConstraints} = {\r\n  '1080p': {frameRate: 30, width: 1920, height: 1080},\r\n\r\n  '720p': {frameRate: 30, width: 1280, height: 720},\r\n\r\n  '480p': {frameRate: 30, width: 640, height: 480},\r\n\r\n  '360p': {frameRate: 30, width: 640, height: 360},\r\n\r\n  '240p': {frameRate: 30, width: 320, height: 240},\r\n\r\n  '180p': {frameRate: 30, width: 320, height: 180},\r\n\r\n  '120p': {frameRate: 30, width: 160, height: 120},\r\n};\r\n"],"mappings":";;;;;;;IAEYA,UAAU,EAKtB;AAAAC,OAAA,CAAAD,UAAA,GAAAA,UAAA;AAAA,WALYA,UAAU;EAAVA,UAAU;EAAVA,UAAU;AAAA,GAAVA,UAAU,KAAAC,OAAA,CAAAD,UAAA,GAAVA,UAAU;AAAA,IAMVE,cAAc;AAAAD,OAAA,CAAAC,cAAA,GAAAA,cAAA;AAAA,WAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;AAAA,GAAdA,cAAc,KAAAD,OAAA,CAAAC,cAAA,GAAdA,cAAc;AAMnB,IAAMC,uBAAgE,GAAG;EAC9E,OAAO,EAAE;IAACC,SAAS,EAAE,EAAE;IAAEC,KAAK,EAAE,IAAI;IAAEC,MAAM,EAAE;EAAI,CAAC;EAEnD,MAAM,EAAE;IAACF,SAAS,EAAE,EAAE;IAAEC,KAAK,EAAE,IAAI;IAAEC,MAAM,EAAE;EAAG,CAAC;EAEjD,MAAM,EAAE;IAACF,SAAS,EAAE,EAAE;IAAEC,KAAK,EAAE,GAAG;IAAEC,MAAM,EAAE;EAAG,CAAC;EAEhD,MAAM,EAAE;IAACF,SAAS,EAAE,EAAE;IAAEC,KAAK,EAAE,GAAG;IAAEC,MAAM,EAAE;EAAG,CAAC;EAEhD,MAAM,EAAE;IAACF,SAAS,EAAE,EAAE;IAAEC,KAAK,EAAE,GAAG;IAAEC,MAAM,EAAE;EAAG,CAAC;EAEhD,MAAM,EAAE;IAACF,SAAS,EAAE,EAAE;IAAEC,KAAK,EAAE,GAAG;IAAEC,MAAM,EAAE;EAAG,CAAC;EAEhD,MAAM,EAAE;IAACF,SAAS,EAAE,EAAE;IAAEC,KAAK,EAAE,GAAG;IAAEC,MAAM,EAAE;EAAG;AACjD,CAAC;AAACL,OAAA,CAAAE,uBAAA,GAAAA,uBAAA"}