@pexip/media-control 17.2.0 → 17.4.0

package/dist/types.d.ts

@@ -0,0 +1,265 @@
+/**
+ * A striped version of MediaDeviceInfo
+ *
+ * @beta
+ */
+export type MediaDeviceInfoLike = Omit<MediaDeviceInfo, 'toJSON'> & {
+    settings?: MediaTrackSettings;
+    toJSON?: MediaDeviceInfo['toJSON'];
+};
+export type DeviceConstraint = MediaDeviceInfoLike | MediaDeviceInfoLike[];
+export interface NormalizedConstraintDeviceParameters {
+    exact?: MediaDeviceInfoLike[];
+    ideal?: MediaDeviceInfoLike[];
+}
+export interface ConstraintDeviceParameters {
+    exact?: DeviceConstraint;
+    ideal?: DeviceConstraint;
+}
+export interface InputConstraintSet extends MediaTrackConstraints {
+    /**
+     * Same purpose as `deviceId` but it gives more information about the device
+     * so that we can have extra tolerance on device selection
+     */
+    device?: DeviceConstraint | ConstraintDeviceParameters;
+    /**
+     * Whether or not using video segmentation, e.g. background
+     * blur/replacement, to specify the effects, intended to be applied to the
+     * segment. Available effects are `none`, `blur`, `overlay` or `remove`
+     */
+    videoSegmentation?: ConstrainDOMString;
+    /**
+     * Segmentation model to be used for video segmentation, currently only
+     * supports `mediapipeSelfie` and `personify`
+     */
+    videoSegmentationModel?: ConstrainDOMString;
+    /**
+     * Whether or not using our own noise suppression
+     */
+    denoise?: ConstrainBoolean;
+    /**
+     * Voice Activity Detection
+     */
+    vad?: ConstrainBoolean;
+    /**
+     * Audio Signal Detection for the purpose of checking if the audio input is
+     * hardware muted or unusable
+     */
+    asd?: ConstrainBoolean;
+    /**
+     * Audio Signal Detection for the purpose of checking if the audio input is
+     * hardware muted or unusable
+     */
+    mixWithAdditionalMedia?: ConstrainBoolean;
+    /**
+     * Flip the video horizontally
+     */
+    flipHorizontal?: ConstrainBoolean;
+    /**
+     * Blur size/level parameter when using video segmentation with `blur`
+     * effects
+     */
+    backgroundBlurAmount?: ConstrainULong;
+    /**
+     * Blur amount applied to the segmented person's edge
+     */
+    edgeBlurAmount?: ConstrainULong;
+    /**
+     * Erode level for edge smoothing when using video segmentation
+     */
+    foregroundThreshold?: ConstrainDouble;
+    /**
+     * Image Url that is being used for video overlay effects
+     */
+    bgImageUrl?: ConstrainDOMString;
+    /**
+     * 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;
+}
+export type InputDeviceConstraint = DeviceConstraint | InputConstraintSet | boolean;
+/**
+ * The request constraints that applies to `getMediaStream`
+ *
+ * @beta
+ */
+export interface MediaDeviceRequest {
+    /**
+     * Either a Boolean (which indicates whether or not an audio track is
+     * requested) or a {@link MediaDeviceInfoLike} object providing a hint for the
+     * audio track included in the returned MediaStream
+     */
+    audio?: InputDeviceConstraint;
+    /**
+     * Either a Boolean (which indicates whether or not an video track is
+     * requested) or a {@link MediaDeviceInfoLike} object providing a hint for the
+     * video track included in the returned MediaStream
+     */
+    video?: InputDeviceConstraint;
+}
+export interface DeviceIdConstraints {
+    deviceId: ConstrainDOMString;
+}
+export interface MediaConstraintRequirement extends MediaDeviceRequest {
+    defaultConstraints: MediaStreamConstraints;
+}
+/**
+ * an enum of MediaDeviceKind which can be reused
+ *
+ * @beta
+ */
+export declare enum MediaDeviceKinds {
+    /** audio input */
+    AUDIOINPUT = "audioinput",
+    /** audio output */
+    AUDIOOUTPUT = "audiooutput",
+    /** video input */
+    VIDEOINPUT = "videoinput"
+}
+/**
+ * MediaTrackConstraints.facingMode
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/facingMode}
+ */
+export declare const FACING_MODE: readonly ["user", "environment", "left", "right"];
+export type FacingMode = (typeof FACING_MODE)[number];
+/**
+ * An enum of failure events for media device
+ *
+ * @beta
+ */
+export declare enum MediaDeviceFailure {
+    /**
+     * some problem (not user or permissions) occurred which prevented the device
+     * from being used.
+     */
+    AbortError = "AbortError",
+    /**
+     * Custom error for when selected audio and video device is not found
+     */
+    AudioAndVideoDeviceNotFoundError = "AudioAndVideoDeviceNotFoundError",
+    /**
+     * Custom error for selected audio device not found
+     */
+    AudioInputDeviceNotFoundError = "AudioInputDeviceNotFoundError",
+    /**
+     * Custom missing constraints error
+     */
+    MissingConstraintsError = "MissingConstraintsError",
+    /**
+     * user has blocked access
+     */
+    NotAllowedError = "NotAllowedError",
+    /**
+     * the media tracks doesn't match the constraints
+     */
+    NotFoundError = "NotFoundError",
+    /**
+     * hardware failure after user granted access
+     */
+    NotReadableError = "NotReadableError",
+    /**
+     * no devices met the criteria for the constraints
+     */
+    OverconstrainedError = "OverconstrainedError",
+    /**
+     * user has blocked access old chrome
+     */
+    PermissionDeniedError = "PermissionDeniedError",
+    /**
+     * User media support disabled by agent
+     */
+    SecurityError = "SecurityError",
+    /**
+     * when hardware in use old chrome win os
+     */
+    TrackStartError = "TrackStartError",
+    /**
+     * GetUserMedia invalid constraints error
+     */
+    TypeError = "TypeError",
+    /**
+     * Custom error for selected video device not found
+     */
+    VideoInputDeviceNotFoundError = "VideoInputDeviceNotFoundError",
+    /**
+     * action or function is not supported by the current platform
+     */
+    NotSupportedError = "NotSupportedError",
+    /**
+     * Canvas capture is not supported
+     */
+    StreamTrackNotFound = "StreamTrackNotFound"
+}
+/**
+ * Lesser strict type of `MediaStreamTrack`
+ *
+ * @beta
+ */
+export type MediaStreamTrackLike = Pick<MediaStreamTrack, 'id' | 'kind' | 'label' | 'getSettings' | 'stop'>;
+/**
+ * Union types of MediaDeviceInfoLike and MediaStreamTrackLike
+ */
+export type DeviceOrTrack = MediaDeviceInfoLike | MediaStreamTrackLike;
+/**
+ * Holds user media input devices
+ *
+ * @beta
+ */
+export interface MediaInput {
+    audioInput?: MediaDeviceInfoLike;
+    videoInput?: MediaDeviceInfoLike;
+}
+export type Unsubscribe = () => void;
+export type TrackEventCallback = (track: MediaStreamTrack) => void;
+/**
+ * An object contains the event handlers
+ */
+export interface StreamTrackEventHandlers {
+    ended?: TrackEventCallback;
+    mute?: TrackEventCallback;
+    unmute?: TrackEventCallback;
+}
+export 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}
+ */
+export interface DisplayMediaOptions extends DisplayMediaStreamOptions {
+    audio?: boolean | DisplayAudioTrackConstraints;
+    video?: boolean | DisplayVideoTrackConstraints;
+    selfBrowserSurface?: ConstrainDOMString;
+    systemAudio?: ConstrainDOMString;
+    surfaceSwitching?: ConstrainDOMString;
+    monitorTypeSurfaces?: ConstrainDOMString;
+}
+export {};

package/dist/types.js

@@ -0,0 +1,88 @@
+/**
+ * an enum of MediaDeviceKind which can be reused
+ *
+ * @beta
+ */
+export var MediaDeviceKinds;
+(function (MediaDeviceKinds) {
+    /** audio input */
+    MediaDeviceKinds["AUDIOINPUT"] = "audioinput";
+    /** audio output */
+    MediaDeviceKinds["AUDIOOUTPUT"] = "audiooutput";
+    /** video input */
+    MediaDeviceKinds["VIDEOINPUT"] = "videoinput";
+})(MediaDeviceKinds || (MediaDeviceKinds = {}));
+/**
+ * MediaTrackConstraints.facingMode
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/facingMode}
+ */
+export const FACING_MODE = ['user', 'environment', 'left', 'right'];
+/**
+ * An enum of failure events for media device
+ *
+ * @beta
+ */
+export var MediaDeviceFailure;
+(function (MediaDeviceFailure) {
+    /**
+     * some problem (not user or permissions) occurred which prevented the device
+     * from being used.
+     */
+    MediaDeviceFailure["AbortError"] = "AbortError";
+    /**
+     * Custom error for when selected audio and video device is not found
+     */
+    MediaDeviceFailure["AudioAndVideoDeviceNotFoundError"] = "AudioAndVideoDeviceNotFoundError";
+    /**
+     * Custom error for selected audio device not found
+     */
+    MediaDeviceFailure["AudioInputDeviceNotFoundError"] = "AudioInputDeviceNotFoundError";
+    /**
+     * Custom missing constraints error
+     */
+    MediaDeviceFailure["MissingConstraintsError"] = "MissingConstraintsError";
+    /**
+     * user has blocked access
+     */
+    MediaDeviceFailure["NotAllowedError"] = "NotAllowedError";
+    /**
+     * the media tracks doesn't match the constraints
+     */
+    MediaDeviceFailure["NotFoundError"] = "NotFoundError";
+    /**
+     * hardware failure after user granted access
+     */
+    MediaDeviceFailure["NotReadableError"] = "NotReadableError";
+    /**
+     * no devices met the criteria for the constraints
+     */
+    MediaDeviceFailure["OverconstrainedError"] = "OverconstrainedError";
+    /**
+     * user has blocked access old chrome
+     */
+    MediaDeviceFailure["PermissionDeniedError"] = "PermissionDeniedError";
+    /**
+     * User media support disabled by agent
+     */
+    MediaDeviceFailure["SecurityError"] = "SecurityError";
+    /**
+     * when hardware in use old chrome win os
+     */
+    MediaDeviceFailure["TrackStartError"] = "TrackStartError";
+    /**
+     * GetUserMedia invalid constraints error
+     */
+    MediaDeviceFailure["TypeError"] = "TypeError";
+    /**
+     * Custom error for selected video device not found
+     */
+    MediaDeviceFailure["VideoInputDeviceNotFoundError"] = "VideoInputDeviceNotFoundError";
+    /**
+     * action or function is not supported by the current platform
+     */
+    MediaDeviceFailure["NotSupportedError"] = "NotSupportedError";
+    /**
+     * Canvas capture is not supported
+     */
+    MediaDeviceFailure["StreamTrackNotFound"] = "StreamTrackNotFound";
+})(MediaDeviceFailure || (MediaDeviceFailure = {}));

package/dist/utils.d.ts

@@ -0,0 +1,37 @@
+import type { MediaDeviceInfoLike } from './types';
+import { MediaDeviceKinds } from './types';
+export declare const isSameDeviceKind: (kind: MediaDeviceKinds) => (device: MediaDeviceInfoLike) => boolean;
+export declare const isAudioInput: (device: MediaDeviceInfoLike) => boolean;
+export declare const isVideoInput: (device: MediaDeviceInfoLike) => boolean;
+export declare const isAudioOutput: (device: MediaDeviceInfoLike) => boolean;
+/**
+ * Check if provided device is a permission-granted device by inspecting the
+ * device label
+ *
+ * @param device - The device to check
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo/label#value}
+ **/
+export declare const isDeviceGranted: (device: MediaDeviceInfoLike) => boolean;
+export declare const not: <T = void>(fn: (arg: T) => boolean) => (arg: T) => boolean;
+/**
+ * Compare 2 devices to see if they are the same by `deviceId` or `label` as
+ * a fallback
+ *
+ * @beta
+ */
+export declare const compareDevices: (deviceInfo: MediaDeviceInfoLike, key?: Exclude<keyof MediaDeviceInfoLike, 'kind' | 'settings'>) => (anotherDeviceInfo: MediaDeviceInfoLike) => boolean;
+/**
+ * Lookup the the `device` from `devices` list
+ *
+ * @remarks
+ * When we cannot find the device by `deviceId`, we compare the label as last
+ * resort, and return the first one.
+ *
+ * @param deviceToFind - Provide a device info to be used for the searching
+ * @param useFallback - Whether to use `label` as a fallback when there is no
+ * match from using `deviceId`
+ *
+ * @beta
+ */
+export declare const findDevice: (deviceToFind: MediaDeviceInfoLike, useFallback?: boolean) => (devices: readonly MediaDeviceInfoLike[]) => MediaDeviceInfoLike | undefined;

package/dist/utils.js

@@ -0,0 +1,47 @@
+import { MediaDeviceKinds } from './types';
+export const isSameDeviceKind = (kind) => (device) => device.kind === kind;
+export const isAudioInput = isSameDeviceKind(MediaDeviceKinds.AUDIOINPUT);
+export const isVideoInput = isSameDeviceKind(MediaDeviceKinds.VIDEOINPUT);
+export const isAudioOutput = isSameDeviceKind(MediaDeviceKinds.AUDIOOUTPUT);
+/**
+ * Check if provided device is a permission-granted device by inspecting the
+ * device label
+ *
+ * @param device - The device to check
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo/label#value}
+ **/
+export const isDeviceGranted = (device) => Boolean(device.label);
+export const not = (fn) => (arg) => !fn(arg);
+/**
+ * Compare 2 devices to see if they are the same by `deviceId` or `label` as
+ * a fallback
+ *
+ * @beta
+ */
+export const compareDevices = (deviceInfo, key = 'deviceId') => (anotherDeviceInfo) => deviceInfo.kind === anotherDeviceInfo.kind &&
+    deviceInfo[key] === anotherDeviceInfo[key];
+/**
+ * Lookup the the `device` from `devices` list
+ *
+ * @remarks
+ * When we cannot find the device by `deviceId`, we compare the label as last
+ * resort, and return the first one.
+ *
+ * @param deviceToFind - Provide a device info to be used for the searching
+ * @param useFallback - Whether to use `label` as a fallback when there is no
+ * match from using `deviceId`
+ *
+ * @beta
+ */
+export const findDevice = (deviceToFind, useFallback = true) => (devices) => {
+    const compareIDTo = compareDevices(deviceToFind);
+    const found = devices.find((device) => compareIDTo(device));
+    if (found || !useFallback) {
+        return found;
+    }
+    // Fallback to use label for the comparison
+    // and return the first matched, otherwise `undefined`
+    const compareLabelTo = compareDevices(deviceToFind, 'label');
+    return devices.find((device) => compareLabelTo(device));
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pexip/media-control",
-  "version": "17.2.0",
+  "version": "17.4.0",
   "homepage": "https://gitlab.com/pexip/zoo",
   "bugs": "https://gitlab.com/pexip/zoo/issues",
   "repository": {
@@ -10,7 +10,7 @@
   },
   "license": "Apache-2.0",
   "author": "Pexip <pexip@pexip.com>",
-  "module": "dist/index.mjs",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
@@ -26,18 +26,18 @@
     "typecheck": "yarn tsc --noEmit -p tsconfig.build.json"
   },
   "dependencies": {
-    "@pexip/utils": "16.8.0"
+    "@pexip/utils": "16.10.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@pexip/bundler": "16.4.1",
+    "@jest/globals": "^29.7.0",
+    "@pexip/bundler": "16.6.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": "^3.0.3",
-    "typescript": "~5.0.0",
+    "prettier": "^3.2.5",
+    "typescript": "~5.3.0",
     "uuid": "^9.0.0"
   },
   "publishConfig": {