@pexip/media 17.0.0 → 17.1.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @pexip/media
 
+## 17.1.1
+
+### Patch Changes
+
+- 51b06b3c: Fix initial media status derive
+  - @pexip/media-control@17.1.1
+  - @pexip/media-processor@17.1.1
+
+## 17.1.0
+
+### Minor Changes
+
+- 4298b039: Allow setting default constraints to `false` Fix Audio mixing
+  processor to return immediately when no main tracks
+
+### Patch Changes
+
+- Updated dependencies [4298b039]
+- Updated dependencies [9fa7884d]
+  - @pexip/media-control@17.1.0
+  - @pexip/utils@16.7.0
+  - @pexip/media-processor@17.1.0
+
 ## 17.0.0
 
 ### Patch Changes

package/README.md

@@ -3,21 +3,25 @@
 A package to connect `@pexip/media-control` and `@pexip/media-processor` to
 create a streamlined media process
 
+## Install
+
+`npm install @pexip/media`
+
 ## Overview
 
 ### `createMedia`
 
-It create an object to interact with the media stream, which is usually used for
-our main stream.
+It create's an object to interact with the media stream, which is usually used
+for our main stream.
 
-Its majority features:
+Its major features:
 
 - Create a media pipeline to get and process the `MediaStream`, see
   `createMediaPipeline`. It also provides some media features including:
 
       - Video Processing - background blur
       - Audio Processing - Noise Suppression
-      - Audio Signal Detection - To detect if the active audio input device capturing any audio
+      - Audio Signal Detection - To detect if the active audio input device is capturing any audio
       - Voice Activity Detection - To detect if there is any voice activity
 
 - Provide media input related information
@@ -36,8 +40,8 @@ A processor to process video from the stream to be used together with
 
 ### `createPreviewController`
 
-It create an object to control the provided media stream, e.g. change the
-audio/video input device and apply changes to main stream when necessary.
+It create's an object to control the provided media stream, e.g. change the
+audio/video input device and apply changes to the main stream when necessary.
 
 ## Usage
 
@@ -259,7 +263,7 @@ signals.onStreamTrackEnabled.add(track => {
   console.log(track);
 });
 
-// Later we can initial a gUM to get a MediaStream
+// Later we can initialize a gUM to get a MediaStream
 mediaController.getUserMedia({
   audio: {
     sampleRate: 48000, // Ideal sample rate for our own noise suppression implementation
@@ -291,7 +295,7 @@ mediaController.media.status = UserMediaStatus.Initial;
 // Stop the `MediaStream`
 await mediaController.media.release();
 
-// Later we can make changes to the media on-demand without initiate a new gUM call
+// Later we can make changes to the media on-demand without initiating a new gUM call
 
 // Turn off background blur
 await mediaController.media.applyConstraints({
@@ -305,7 +309,7 @@ await mediaController.media.applyConstraints({
 await mediaController.media.applyConstraints({
   audio: {denoise: true, noiseSuppression: false},
 });
-// Use build-in noise suppression
+// Use built-in noise suppression
 await mediaController.media.applyConstraints({
   audio: {denoise: false, noiseSuppression: true},
 });
@@ -345,6 +349,4 @@ const controller = createPreviewController({
   },
   psySegScriptLoaded: true,
 });
-
-// Want to learn more? Please checkout the `@pexip/media-demo` sample app to try
 ```

package/dist/index.d.ts

@@ -369,8 +369,8 @@ interface MediaOptions {
      * Pass default constraints to use with get media wrappers
      */
     getDefaultConstraints?: () => {
-        audio?: InputConstraintSet;
-        video?: InputConstraintSet;
+        audio?: InputConstraintSet | false;
+        video?: InputConstraintSet | false;
     };
 }
 interface MediaProps {

package/dist/index.mjs

@@ -234,7 +234,8 @@ var deriveInitialPermissionStatus = async (prevStatus, getPermissionState = getI
   if (isInitialPermissions(prevStatus) || isRejected(prevStatus)) {
     return prevStatus;
   }
-  if (areBothGranted(prevStatus)) {
+  const { audio, video } = await getPermissionState();
+  if (areBothGranted(prevStatus) || audio === "granted" && video === "granted") {
     return "initial-permissions-granted" /* InitialPermissionsGranted */;
   }
   if (isGrantedAudio(prevStatus)) {
@@ -1825,7 +1826,7 @@ var createAudioMixingProcess = (getCurrrentMedia, scope = "mixer") => {
       }
       return Promise.resolve();
     });
-    if (!media.stream) {
+    if (!media.stream || !mainTrack && !displayTrack) {
       return media;
     }
     if (!mainTrack && displayTrack) {
@@ -2148,16 +2149,18 @@ var createMedia = ({
       });
     }
   };
-  const mergeMediaConstraints = (constraints) => ({
-    audio: mergeConstraints(getDefaultConstraints().audio)(
-      constraints.audio
-    ),
-    video: mergeConstraints(getDefaultConstraints().video)(
-      constraints.video
-    )
-  });
+  const mergeMediaConstraints = (constraints) => {
+    const { audio, video } = getDefaultConstraints();
+    return {
+      audio: audio === false ? false : mergeConstraints(audio)(constraints.audio),
+      video: video === false ? false : mergeConstraints(video)(constraints.video)
+    };
+  };
   const getUserMediaAsync = async (constraints) => {
-    queue.enqueue(async () => await updateMedia(constraints), false);
+    queue.enqueue(
+      async () => await updateMedia(mergeMediaConstraints(constraints)),
+      false
+    );
     await queue.execute();
   };
   const getUserMedia3 = (constraints) => {
@@ -2172,11 +2175,14 @@ var createMedia = ({
         { status: props.media.status },
         "Current Permission State"
       );
+      const mergedConstraints = mergeMediaConstraints(constraints);
+      props.media.constraints = mergedConstraints;
       props.devices = await getDevices2();
+      if (!mergedConstraints.audio && !mergedConstraints.video) {
+        return;
+      }
       if (isInitialPermissionsGranted(props.media.status)) {
-        return await updateMedia(
-          mergeMediaConstraints(constraints)
-        );
+        return await updateMedia(mergedConstraints);
       }
     });
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pexip/media",
-  "version": "17.0.0",
+  "version": "17.1.1",
   "description": "Home for media related stuff",
   "homepage": "https://gitlab.com/pexip/zoo",
   "bugs": "https://gitlab.com/pexip/zoo/issues",
@@ -32,10 +32,10 @@
     "typecheck": "yarn tsc --noEmit -p ."
   },
   "dependencies": {
-    "@pexip/media-control": "17.0.0",
-    "@pexip/media-processor": "17.0.0",
+    "@pexip/media-control": "17.1.1",
+    "@pexip/media-processor": "17.1.1",
     "@pexip/signal": "16.5.0",
-    "@pexip/utils": "16.6.0"
+    "@pexip/utils": "16.7.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",