@pexip/media-control 17.1.2 → 17.3.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 17.3.0
+
+### Minor Changes
+
+- 7b29d953: Update babel/traverse related deps
+- 821d9a1ef8: Add toMediaDeviceInfo util function
+
+### Patch Changes
+
+- Updated dependencies [7b29d953]
+  - @pexip/utils@16.9.0
+
+## 17.2.0
+
+### Minor Changes
+
+- 244cb04c: Add screen capture constraints
+
+  - Add screen capture constraints
+  - Add fallback implementation of `mointorTypeSurfaces`
+  - Fix typo of `areMultipleFacingModeSupported`
+
+- 26878b60: Add contentHint to InputConstraintSet
+- 7e02391e9c: Changest to support FECC and PTZ capabilities
+
+### Patch Changes
+
+- 4ea55a5205: Prettier and linting for new prettier version.
+- Updated dependencies [244cb04c]
+- Updated dependencies [4ea55a5205]
+  - @pexip/utils@16.8.0
+
 ## 17.1.2
 
 ## 17.1.1

package/dist/index.d.ts

@@ -72,6 +72,16 @@ interface InputConstraintSet extends MediaTrackConstraints {
      * Image Url that is being used for video overlay effects
      */
     resizeMode?: ConstrainDOMString;
+    /**
+     * Current pan, tilt and zoom level for a PTZ controllable camera on web
+     */
+    pan?: boolean;
+    tilt?: boolean;
+    zoom?: boolean;
+    /**
+     * Content Hint for the track to apply
+     */
+    contentHint?: ConstrainDOMString;
 }
 type InputDeviceConstraint = DeviceConstraint | InputConstraintSet | boolean;
 /**
@@ -209,6 +219,35 @@ interface InputDevicePermission {
     audio: PermissionState;
     video: PermissionState;
 }
+interface DisplayVideoTrackConstraint extends MediaTrackConstraintSet {
+    displaySurface?: ConstrainDOMString;
+    cursor?: ConstrainDOMString;
+}
+interface DisplayAudioTrackConstraint extends MediaTrackConstraintSet {
+    restrictOwnAudio?: ConstrainBoolean;
+    suppressLocalAudioPlayback?: ConstrainBoolean;
+}
+interface DisplayVideoTrackConstraints extends DisplayVideoTrackConstraint {
+    advanced?: DisplayVideoTrackConstraint[];
+}
+interface DisplayAudioTrackConstraints extends DisplayAudioTrackConstraint {
+    advanced?: DisplayAudioTrackConstraint[];
+}
+/**
+ * The `DisplayMediaStreamOptions` dictionary is used to instruct the user agent
+ * what sort of `MediaStreamTracks` may be included in the `MediaStream`
+ * returned by `getDisplayMedia`.
+ *
+ * @see {@link https://w3c.github.io/mediacapture-screen-share/#displaymediastreamoptions}
+ */
+interface DisplayMediaOptions extends DisplayMediaStreamOptions {
+    audio?: boolean | DisplayAudioTrackConstraints;
+    video?: boolean | DisplayVideoTrackConstraints;
+    selfBrowserSurface?: ConstrainDOMString;
+    systemAudio?: ConstrainDOMString;
+    surfaceSwitching?: ConstrainDOMString;
+    monitorTypeSurfaces?: ConstrainDOMString;
+}
 
 /**
  * DeviceChange Event
@@ -278,6 +317,12 @@ declare const deviceChanged: (fn: (event: DeviceChangedChanges) => void) => () =
  * @beta
  */
 declare const toMediaDeviceInfoLike: (track: MediaStreamTrack) => MediaDeviceInfoLike | undefined;
+declare const toMediaDeviceInfo: (info: MediaDeviceInfoLike) => {
+    deviceId: string;
+    groupId: string;
+    kind: MediaDeviceKind;
+    label: string;
+};
 /**
  * Find the MediaDeviceInfo from provided MediaDeviceInfo[] by comparing with
  * provided MediaStreamTrack
@@ -553,7 +598,7 @@ declare const hasChangedInput: (oldInput: MediaDeviceInfoLike | undefined, newIn
  * i.e. `navigator.mediaDevices.getSupportedConstraints()`
  * @param tracks - Current video input track
  */
-declare const areMultipleFacingModeSupportted: (currentDevices: MediaDeviceInfoLike[], getSupportedConstraints?: () => MediaTrackSupportedConstraints) => boolean;
+declare const areMultipleFacingModeSupported: (currentDevices: MediaDeviceInfoLike[], getSupportedConstraints?: () => MediaTrackSupportedConstraints) => boolean;
 /**
  * Interpret the current facing mode from the provided track, and try to get the
  * mode from settings, or use the label to guess the facing mode when facingMode
@@ -601,7 +646,7 @@ declare const findDevice: (deviceToFind: MediaDeviceInfoLike, useFallback?: bool
  * Reference https://w3c.github.io/mediacapture-main/#dom-mediatrackconstraintset
  */
 declare const CONSTRAIN_STRING_KEYS: readonly ["facingMode", "resizeMode", "deviceId", "groupId"];
-declare const EXTENDED_CONSTRAIN_STRING_KEYS: readonly ["videoSegmentation", "videoSegmentationModel", "bgImageUrl"];
+declare const EXTENDED_CONSTRAIN_STRING_KEYS: readonly ["videoSegmentation", "videoSegmentationModel", "bgImageUrl", "contentHint"];
 type ExtendedConstrainStringKeys = (typeof EXTENDED_CONSTRAIN_STRING_KEYS)[number];
 type ConstrainStringKeys = (typeof CONSTRAIN_STRING_KEYS)[number];
 declare const CONSTRAIN_U_LONG_KEYS: readonly ["width", "height", "sampleRate", "sampleSize", "channelCount"];
@@ -612,7 +657,7 @@ declare const CONSTRAIN_DOUBLE_KEYS: readonly ["aspectRatio", "frameRate", "late
 declare const EXTENDED_CONSTRAIN_DOUBLE_KEYS: readonly ["foregroundThreshold"];
 type ExtendedConstrainDoubleKeys = (typeof EXTENDED_CONSTRAIN_DOUBLE_KEYS)[number];
 type ConstrainDoubleKeys = (typeof CONSTRAIN_DOUBLE_KEYS)[number];
-declare const CONSTRAIN_BOOLEAN_KEYS: readonly ["echoCancellation", "autoGainControl", "noiseSuppression"];
+declare const CONSTRAIN_BOOLEAN_KEYS: readonly ["echoCancellation", "autoGainControl", "noiseSuppression", "pan", "tilt", "zoom"];
 /**
  * Extends boolean constraint keys for our own implementation of the media
  * feature
@@ -696,7 +741,7 @@ type Constraints = ConstrainStrings & ConstrainNumbers & ConstrainBooleans & Con
  * expect(noiseSuppressionParam).toEqual('ideal');
  * ```
  */
-declare const extractConstraintsWithKeys: <T extends "deviceId" | "groupId" | "facingMode" | "resizeMode" | "videoSegmentation" | "videoSegmentationModel" | "bgImageUrl" | ConstrainNumberKeys | "echoCancellation" | "autoGainControl" | "noiseSuppression" | "vad" | "asd" | "mixWithAdditionalMedia" | "denoise" | "flipHorizontal" | "device">(keys: T[]) => (constraints: InputDeviceConstraint | undefined) => Pick<Constraints, T>;
+declare const extractConstraintsWithKeys: <T extends "deviceId" | "groupId" | "facingMode" | "resizeMode" | "videoSegmentation" | "videoSegmentationModel" | "bgImageUrl" | "contentHint" | ConstrainNumberKeys | "echoCancellation" | "autoGainControl" | "noiseSuppression" | "pan" | "tilt" | "zoom" | "vad" | "asd" | "mixWithAdditionalMedia" | "denoise" | "flipHorizontal" | "device">(keys: T[]) => (constraints: InputDeviceConstraint | undefined) => Pick<Constraints, T>;
 /**
  * Find device from the device list with provided constraints
  *
@@ -876,6 +921,59 @@ interface Logger extends LogMethods {
 
 declare function setLogger(newLogger: Logger): void;
 
+type ExtractObjectValueTypes<T extends object> = T[keyof T];
+/**
+ * The `DisplayCaptureSurfaceType` enumeration describes the different types of
+ * display surface
+ *
+ * @see {@link https://w3c.github.io/mediacapture-screen-share/#displaycapturesurfacetype}
+ */
+declare const DISPLAY_CAPTURE_SURFACE_TYPE: {
+    readonly Monitor: "monitor";
+    readonly Window: "window";
+    readonly Browser: "browser";
+};
+/**
+ * The `DisplayCaptureSurfaceType` enumeration describes the different types of
+ * display surface
+ *
+ * @see {@link https://w3c.github.io/mediacapture-screen-share/#displaycapturesurfacetype}
+ */
+type DisplayCaptureSurfaceType = ExtractObjectValueTypes<typeof DISPLAY_CAPTURE_SURFACE_TYPE>;
+/**
+ * The `CursorCaptureConstraint` enumerates the conditions under which the
+ * cursor is captured.
+ *
+ * @see {@link https://w3c.github.io/mediacapture-screen-share/#cursorcaptureconstraint}
+ */
+declare const CURSOR_CAPTURE_CONSTRAINT: {
+    readonly Never: "never";
+    readonly Always: "always";
+    readonly Motion: "motion";
+};
+/**
+ * The `CursorCaptureConstraint` enumerates the conditions under which the
+ * cursor is captured.
+ *
+ * @see {@link https://w3c.github.io/mediacapture-screen-share/#cursorcaptureconstraint}
+ */
+type CursorCaptureConstraint = ExtractObjectValueTypes<typeof CURSOR_CAPTURE_CONSTRAINT>;
+declare const INCLUDE_EXCLUDE_CONSTRAINT: {
+    readonly Include: "include";
+    readonly Exclude: "exclude";
+};
+type IncludeExcludeConstraint = ExtractObjectValueTypes<typeof INCLUDE_EXCLUDE_CONSTRAINT>;
+
+/**
+ * A fallback implementation of `monitorTypeSurfaces` limitation when it is not
+ * supported by the current browser and the source of the `displaySurface` is
+ * available.
+ *
+ * @param constraints - The constraints used to request display media.
+ * @param stream - The MediaStream returned from the requesting display media.
+ */
+declare const limitSharingMonitorInterface: (constraints: DisplayMediaOptions, stream: MediaStream) => MediaStream;
+
 /**
  * media-control is meant to extend the mediaDevices api methods such as
  * `getUserMedia`, `enumerateDevices` and events on media streams and tracks.
@@ -924,4 +1022,4 @@ interface MediaControl {
     subscribe: typeof subscribe;
 }
 
-export { DeviceChangedChanges, Events, FacingMode, InputConstraintSet, InputDevicePermission, MediaControl, MediaDeviceFailure, MediaDeviceInfoLike, MediaDeviceKinds, MediaDeviceRequest, MediaEvent, MediaEventType, MediaInput, MediaStreamTrackLike, StreamTrackEventHandlers, Unsubscribe, applyConstraints, areMultipleFacingModeSupportted, areTracksEnabled, compareDevices, createStreamTrackEventSubscriptions, createTrackDevicesChanges, deviceChanged, extractConstraintsWithKeys, findAudioInputDevices, findAudioOutputDevices, findCurrentAudioOutputId, findCurrentVideoInputDeviceIdFromStream, findDevice, findDeviceFromConstraints, findDeviceWithDeviceId, findDevicesByKind, findMediaInputFromMediaStreamTrack, findMediaInputFromStream, findPermissionGrantedDevices, findVideoInputDevices, getDevices, getFacingModeFromConstraintString, getInputDevicePermissionState, getUserMedia, getValueFromConstrainNumber, hasAnyGrantedInput, hasAnyInputs, hasAudioInputs, hasAudioOrVideoInputs, hasChangedInput, hasRequestingDevice, hasVideoInputs, interpretCurrentFacingMode, isAudioInput, isAudioOutput, isDeviceGranted, isExactDeviceConstraint, isFacingMode, isMediaDeviceInfo, isMediaDeviceInfoArray, isMediaStreamTrack, isRequestedInputDevice, isRequestedInputTrack, isRequestedResolution, isStreamingRequestedDevices, isStreamingRequestedDevicesBase, isVideoInput, mergeConstraints, muteStreamTrack, relaxInputConstraint, setDefaultConstraints, setLogger, shouldRequestDevice, stopMediaStream, subscribe, toKey, toMediaDeviceInfoLike };
+export { CURSOR_CAPTURE_CONSTRAINT, CursorCaptureConstraint, DISPLAY_CAPTURE_SURFACE_TYPE, DeviceChangedChanges, DisplayCaptureSurfaceType, DisplayMediaOptions, Events, FacingMode, INCLUDE_EXCLUDE_CONSTRAINT, IncludeExcludeConstraint, InputConstraintSet, InputDevicePermission, MediaControl, MediaDeviceFailure, MediaDeviceInfoLike, MediaDeviceKinds, MediaDeviceRequest, MediaEvent, MediaEventType, MediaInput, MediaStreamTrackLike, StreamTrackEventHandlers, Unsubscribe, applyConstraints, areMultipleFacingModeSupported, areTracksEnabled, compareDevices, createStreamTrackEventSubscriptions, createTrackDevicesChanges, deviceChanged, extractConstraintsWithKeys, findAudioInputDevices, findAudioOutputDevices, findCurrentAudioOutputId, findCurrentVideoInputDeviceIdFromStream, findDevice, findDeviceFromConstraints, findDeviceWithDeviceId, findDevicesByKind, findMediaInputFromMediaStreamTrack, findMediaInputFromStream, findPermissionGrantedDevices, findVideoInputDevices, getDevices, getFacingModeFromConstraintString, getInputDevicePermissionState, getUserMedia, getValueFromConstrainNumber, hasAnyGrantedInput, hasAnyInputs, hasAudioInputs, hasAudioOrVideoInputs, hasChangedInput, hasRequestingDevice, hasVideoInputs, interpretCurrentFacingMode, isAudioInput, isAudioOutput, isDeviceGranted, isExactDeviceConstraint, isFacingMode, isMediaDeviceInfo, isMediaDeviceInfoArray, isMediaStreamTrack, isRequestedInputDevice, isRequestedInputTrack, isRequestedResolution, isStreamingRequestedDevices, isStreamingRequestedDevicesBase, isVideoInput, limitSharingMonitorInterface, mergeConstraints, muteStreamTrack, relaxInputConstraint, setDefaultConstraints, setLogger, shouldRequestDevice, stopMediaStream, subscribe, toKey, toMediaDeviceInfo, toMediaDeviceInfoLike };

package/dist/index.mjs

@@ -41,7 +41,8 @@ var CONSTRAIN_STRING_KEYS = [
 var EXTENDED_CONSTRAIN_STRING_KEYS = [
   "videoSegmentation",
   "videoSegmentationModel",
-  "bgImageUrl"
+  "bgImageUrl",
+  "contentHint"
 ];
 var CONSTRAIN_U_LONG_KEYS = [
   "width",
@@ -63,7 +64,10 @@ var EXTENDED_CONSTRAIN_DOUBLE_KEYS = ["foregroundThreshold"];
 var CONSTRAIN_BOOLEAN_KEYS = [
   "echoCancellation",
   "autoGainControl",
-  "noiseSuppression"
+  "noiseSuppression",
+  "pan",
+  "tilt",
+  "zoom"
 ];
 var EXTENDED_CONSTRAIN_BOOLEAN_KEYS = [
   // Voice Activity Detection
@@ -348,15 +352,18 @@ var normalizeDeviceConstraint = (constraints) => {
     return void 0;
   }
   if (isConstraintDeviceParameters(constraints)) {
-    return Object.keys(constraints).filter((k) => ["ideal", "exact"].includes(k)).reduce((cs, k) => {
-      const key = k;
-      const value = constraints[key];
-      const devices = normalizeDevice(value);
-      if (devices) {
-        return { ...cs ?? {}, [key]: devices };
-      }
-      return cs;
-    }, void 0);
+    return Object.keys(constraints).filter((k) => ["ideal", "exact"].includes(k)).reduce(
+      (cs, k) => {
+        const key = k;
+        const value = constraints[key];
+        const devices = normalizeDevice(value);
+        if (devices) {
+          return { ...cs ?? {}, [key]: devices };
+        }
+        return cs;
+      },
+      void 0
+    );
   }
   const normalized = normalizeDevice(constraints);
   return normalized && { ideal: normalized };
@@ -655,21 +662,36 @@ function extractConstraints(key) {
     return [void 0, "ideal"];
   };
 }
-var extractConstraintsWithKeys = (keys) => (constraints) => keys.reduce((result, key) => {
-  if (key === "device") {
-    return { ...result, [key]: extractConstraints(key)(constraints) };
-  }
-  if (isConstrainULongKeys(key) || isConstrainDoubleKeys(key) || isExtendedConstrainULongKeys(key) || isExtendedConstrainDoubleKeys(key)) {
-    return { ...result, [key]: extractConstraints(key)(constraints) };
-  }
-  if (isConstrainStringKeys(key) || isExtendedConstrainStringKeys(key)) {
-    return { ...result, [key]: extractConstraints(key)(constraints) };
-  }
-  if (isConstrainBooleanKeys(key) || isExtendedConstrainBooleanKeys(key)) {
-    return { ...result, [key]: extractConstraints(key)(constraints) };
-  }
-  return result;
-}, {});
+var extractConstraintsWithKeys = (keys) => (constraints) => keys.reduce(
+  (result, key) => {
+    if (key === "device") {
+      return {
+        ...result,
+        [key]: extractConstraints(key)(constraints)
+      };
+    }
+    if (isConstrainULongKeys(key) || isConstrainDoubleKeys(key) || isExtendedConstrainULongKeys(key) || isExtendedConstrainDoubleKeys(key)) {
+      return {
+        ...result,
+        [key]: extractConstraints(key)(constraints)
+      };
+    }
+    if (isConstrainStringKeys(key) || isExtendedConstrainStringKeys(key)) {
+      return {
+        ...result,
+        [key]: extractConstraints(key)(constraints)
+      };
+    }
+    if (isConstrainBooleanKeys(key) || isExtendedConstrainBooleanKeys(key)) {
+      return {
+        ...result,
+        [key]: extractConstraints(key)(constraints)
+      };
+    }
+    return result;
+  },
+  {}
+);
 var extractDeviceId = extractConstrainString("deviceId");
 var findDeviceFromConstraints = (constraints, devices) => {
   if (typeof constraints === "boolean") {
@@ -836,6 +858,12 @@ var toMediaDeviceInfoLikeJSON = (info) => ({
   label: info.label,
   settings: info.settings
 });
+var toMediaDeviceInfo = (info) => ({
+  deviceId: info.deviceId,
+  groupId: info.groupId,
+  kind: info.kind,
+  label: info.label
+});
 var findMediaInputFromMediaStreamTrack = (devices) => (track) => {
   if (!devices.length || !track) {
     return void 0;
@@ -1142,7 +1170,7 @@ var hasChangedInput = (oldInput, newInput) => {
   }
   return false;
 };
-var areMultipleFacingModeSupportted = (currentDevices, getSupportedConstraints = () => navigator.mediaDevices.getSupportedConstraints()) => {
+var areMultipleFacingModeSupported = (currentDevices, getSupportedConstraints = () => navigator.mediaDevices.getSupportedConstraints()) => {
   if (!getSupportedConstraints().facingMode) {
     return false;
   }
@@ -1492,6 +1520,44 @@ var createStreamTrackMap = (tracks) => {
   };
 };
 
+// src/constants.ts
+var DISPLAY_CAPTURE_SURFACE_TYPE = {
+  Monitor: "monitor",
+  Window: "window",
+  Browser: "browser"
+};
+var CURSOR_CAPTURE_CONSTRAINT = {
+  Never: "never",
+  Always: "always",
+  Motion: "motion"
+};
+var INCLUDE_EXCLUDE_CONSTRAINT = {
+  Include: "include",
+  Exclude: "exclude"
+};
+
+// src/displayMedia.ts
+var limitSharingMonitorInterface = (constraints, stream) => {
+  if (!constraints.monitorTypeSurfaces || constraints.monitorTypeSurfaces !== "exclude") {
+    return stream;
+  }
+  for (const track of stream.getTracks()) {
+    const { displaySurface } = track.getSettings();
+    if (!displaySurface || displaySurface !== "monitor") {
+      continue;
+    }
+    stopMediaStream(stream);
+    throw new TypeError("MonitorSharingNotAllowed", {
+      cause: {
+        monitorTypeSurfaces: constraints.monitorTypeSurfaces,
+        track,
+        displaySurface
+      }
+    });
+  }
+  return stream;
+};
+
 // src/index.ts
 var state = () => {
   const { dispatch, subscriber } = eventEmitter();
@@ -1572,11 +1638,14 @@ var {
   subscribe
 } = state();
 export {
+  CURSOR_CAPTURE_CONSTRAINT,
+  DISPLAY_CAPTURE_SURFACE_TYPE,
+  INCLUDE_EXCLUDE_CONSTRAINT,
   MediaDeviceFailure,
   MediaDeviceKinds,
   MediaEventType,
   applyConstraints,
-  areMultipleFacingModeSupportted,
+  areMultipleFacingModeSupported,
   areTracksEnabled,
   compareDevices,
   createStreamTrackEventSubscriptions,
@@ -1622,6 +1691,7 @@ export {
   isStreamingRequestedDevices,
   isStreamingRequestedDevicesBase,
   isVideoInput,
+  limitSharingMonitorInterface,
   mergeConstraints,
   muteStreamTrack,
   relaxInputConstraint,
@@ -1631,5 +1701,6 @@ export {
   stopMediaStream,
   subscribe,
   toKey,
+  toMediaDeviceInfo,
   toMediaDeviceInfoLike
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pexip/media-control",
-  "version": "17.1.2",
+  "version": "17.3.0",
   "homepage": "https://gitlab.com/pexip/zoo",
   "bugs": "https://gitlab.com/pexip/zoo/issues",
   "repository": {
@@ -26,18 +26,18 @@
     "typecheck": "yarn tsc --noEmit -p tsconfig.build.json"
   },
   "dependencies": {
-    "@pexip/utils": "16.7.0"
+    "@pexip/utils": "16.9.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@pexip/bundler": "16.4.0",
+    "@jest/globals": "^29.7.0",
+    "@pexip/bundler": "16.5.0",
     "@types/core-js": "^2.5.3",
     "@types/prettier": "^2.0.2",
     "@types/uuid": "^8.3.0",
     "@types/webrtc": "^0.0.31",
     "core-js": "^3.6.5",
-    "prettier": "2.8.8",
-    "typescript": "~5.0.0",
+    "prettier": "^3.0.3",
+    "typescript": "~5.3.0",
     "uuid": "^9.0.0"
   },
   "publishConfig": {