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

package/LICENSE

@@ -1,2 +1,2 @@
-All contents are licensed under the Cisco EULA
+All contents are licensed under the Cisco EULA
 (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)

package/README.md

@@ -1,106 +1,106 @@
-# @webex/media-helpers
-
-[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-
-> Media helpers
-
-This is an internal Cisco Webex plugin. As such, it does not strictly adhere to semantic versioning. Use at your own risk. If you're not working on one of our first party clients, please look at our [developer api](https://developer.webex.com/) and stick to our public plugins.
-
-- [@webex/media-helpers](#webexmedia-helpers)
-  - [Install](#install)
-  - [Usage](#usage)
-  - [Maintainers](#maintainers)
-  - [Contribute](#contribute)
-  - [License](#license)
-
-## Install
-
-```bash
-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/).
-
-## Contribute
-
-Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/webex-js-sdk/blob/master/CONTRIBUTING.md) for more details.
-
-## License
-
-© 2016-2022 Cisco and/or its affiliates. All Rights Reserved.
+# @webex/media-helpers
+
+[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
+
+> Media helpers
+
+This is an internal Cisco Webex plugin. As such, it does not strictly adhere to semantic versioning. Use at your own risk. If you're not working on one of our first party clients, please look at our [developer api](https://developer.webex.com/) and stick to our public plugins.
+
+- [@webex/media-helpers](#webexmedia-helpers)
+  - [Install](#install)
+  - [Usage](#usage)
+  - [Maintainers](#maintainers)
+  - [Contribute](#contribute)
+  - [License](#license)
+
+## Install
+
+```bash
+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/).
+
+## Contribute
+
+Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/webex-js-sdk/blob/master/CONTRIBUTING.md) for more details.
+
+## License
+
+© 2016-2022 Cisco and/or its affiliates. All Rights Reserved.

package/babel.config.json

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

package/dist/constants.d.ts

@@ -1,13 +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;
-};
+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

@@ -1,4 +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';
+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

@@ -1,48 +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]>;
+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

@@ -22,11 +22,7 @@
     "deploy:npm": "yarn npm publish"
   },
   "dependencies": {
-    "@webex/babel-config-legacy": "^0.0.0",
-    "@webex/eslint-config-legacy": "^0.0.0",
     "@webex/internal-media-core": "^2.0.0",
-    "@webex/jest-config-legacy": "^0.0.0",
-    "@webex/legacy-tools": "^0.0.0",
     "@webex/ts-events": "^1.1.0",
     "@webex/web-media-effects": "^2.12.0"
   },
@@ -38,10 +34,14 @@
   },
   "devDependencies": {
     "@babel/preset-typescript": "7.22.11",
+    "@webex/babel-config-legacy": "^0.0.0",
+    "@webex/eslint-config-legacy": "^0.0.0",
+    "@webex/jest-config-legacy": "^0.0.0",
+    "@webex/legacy-tools": "^0.0.0",
     "@webex/test-helper-chai": "^2.59.3-next.1",
     "@webex/test-helper-mock-webex": "^2.59.3-next.1",
     "eslint": "^8.24.0",
     "sinon": "^9.2.4"
   },
-  "version": "3.0.0-next.4"
+  "version": "3.0.0-next.5"
 }

package/src/constants.ts

@@ -1,29 +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},
-};
+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,25 +1,25 @@
-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';
+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';