@webex/web-client-media-engine 3.27.0 → 3.28.1

package/dist/cjs/index.js

@@ -362,10 +362,11 @@ function getUserMedia(constraints) {
 }
 /**
  * Prompts the user for permission to use a user's display media and audio. If a video track is
- * absent from the constraints argument, one will still be provided.
+ * absent from the constraints argument, one will still be provided. Includes experimental options
+ * found in https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#options.
  *
  * @param constraints - A MediaStreamConstraints object specifying the types of media to request,
- *     along with any requirements for each type.
+ *     along with any requirements for each type, as well as experimental options.
  * @returns A Promise whose fulfillment handler receives a MediaStream object when the requested
  *     media has successfully been obtained.
  */
@@ -514,11 +515,11 @@ class WebrtcCoreError {
  * 1. Previous captured video stream from the same device is not stopped.
  * 2. Previous createCameraStream() call for the same device is in progress.
  *
- * @param constructor - Constructor for the local camera stream.
+ * @param cameraStreamConstructor - Constructor for the local camera stream.
  * @param constraints - Video device constraints.
  * @returns A LocalCameraStream object or an error.
  */
-function createCameraStream(constructor, constraints) {
+function createCameraStream(cameraStreamConstructor, constraints) {
     return __awaiter$2(this, void 0, void 0, function* () {
         let stream;
         try {
@@ -527,17 +528,18 @@ function createCameraStream(constructor, constraints) {
         catch (error) {
             throw new WebrtcCoreError(exports.WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create camera stream: ${error}`);
         }
-        return new constructor(stream);
+        // eslint-disable-next-line new-cap
+        return new cameraStreamConstructor(stream);
     });
 }
 /**
  * Creates a LocalMicrophoneStream with the given constraints.
  *
- * @param constructor - Constructor for the local microphone stream.
+ * @param microphoneStreamConstructor - Constructor for the local microphone stream.
  * @param constraints - Audio device constraints.
  * @returns A LocalMicrophoneStream object or an error.
  */
-function createMicrophoneStream(constructor, constraints) {
+function createMicrophoneStream(microphoneStreamConstructor, constraints) {
     return __awaiter$2(this, void 0, void 0, function* () {
         let stream;
         try {
@@ -546,64 +548,132 @@ function createMicrophoneStream(constructor, constraints) {
         catch (error) {
             throw new WebrtcCoreError(exports.WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create microphone stream: ${error}`);
         }
-        return new constructor(stream);
+        // eslint-disable-next-line new-cap
+        return new microphoneStreamConstructor(stream);
     });
 }
 /**
- * Creates a LocalDisplayStream with the given parameters.
- *
- * @param constructor - Constructor for the local display stream.
- * @param videoContentHint - An optional parameter to give a hint for the content of the stream.
- * @returns A Promise that resolves to a LocalDisplayStream or an error.
+ * Creates a LocalCameraStream and a LocalMicrophoneStream with the given constraints.
+ *
+ * @param cameraStreamConstructor - Constructor for the local camera stream.
+ * @param microphoneStreamConstructor - Constructor for the local microphone stream.
+ * @param constraints - Object containing video and audio device constraints.
+ * @param constraints.video - Video device constraints.
+ * @param constraints.audio - Audio device constraints.
+ * @returns A Promise that resolves to a LocalCameraStream and a LocalMicrophoneStream or an error.
  */
-function createDisplayStream(constructor, videoContentHint) {
+function createCameraAndMicrophoneStreams(cameraStreamConstructor, microphoneStreamConstructor, constraints) {
     return __awaiter$2(this, void 0, void 0, function* () {
         let stream;
         try {
-            stream = yield getDisplayMedia({ video: true });
+            stream = yield getUserMedia({
+                video: Object.assign({}, constraints === null || constraints === void 0 ? void 0 : constraints.video),
+                audio: Object.assign({}, constraints === null || constraints === void 0 ? void 0 : constraints.audio),
+            });
         }
         catch (error) {
-            throw new WebrtcCoreError(exports.WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create display stream: ${error}`);
-        }
-        const localDisplayStream = new constructor(stream);
-        if (videoContentHint) {
-            localDisplayStream.contentHint = videoContentHint;
+            throw new WebrtcCoreError(exports.WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create camera and microphone streams: ${error}`);
         }
-        return localDisplayStream;
+        // eslint-disable-next-line new-cap
+        const localCameraStream = new cameraStreamConstructor(new MediaStream(stream.getVideoTracks()));
+        // eslint-disable-next-line new-cap
+        const localMicrophoneStream = new microphoneStreamConstructor(new MediaStream(stream.getAudioTracks()));
+        return [localCameraStream, localMicrophoneStream];
     });
 }
 /**
  * Creates a LocalDisplayStream and a LocalSystemAudioStream with the given parameters.
  *
- * @param displayStreamConstructor - Constructor for the local display stream.
- * @param systemAudioStreamConstructor - Constructor for the local system audio stream.
- * @param videoContentHint - An optional parameter to give a hint for the content of the stream.
+ * This is a more advanced version of createDisplayStreamWithAudio that allows the user to specify
+ * additional display media options and constraints.
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#options.
+ *
+ * @param options - An object containing the options for creating the display and system audio streams.
+ * @param options.video - An object containing the video stream options.
+ * @param options.video.displayStreamConstructor - Constructor for the local display stream.
+ * @param options.video.constraints - Video device constraints.
+ * @param options.video.videoContentHint - A hint for the content of the stream.
+ * @param options.video.preferCurrentTab - Whether to offer the current tab as the most prominent capture source.
+ * @param options.video.selfBrowserSurface - Whether to allow the user to select the current tab for capture.
+ * @param options.video.surfaceSwitching - Whether to allow the user to dynamically switch the shared tab during screen-sharing.
+ * @param options.video.monitorTypeSurfaces - Whether to offer the user the option to choose display surfaces whose type is monitor.
+ * @param options.audio - An object containing the audio stream options. If present, a system audio stream will be created.
+ * @param options.audio.systemAudioStreamConstructor - Constructor for the local system audio stream.
+ * @param options.audio.constraints - Audio device constraints.
+ * @param options.audio.systemAudio - Whether to include the system audio among the possible audio sources offered to the user.
+ * @param options.controller - CaptureController to further manipulate the capture session.
  * @returns A Promise that resolves to a LocalDisplayStream and a LocalSystemAudioStream or an
  * error. If no system audio is available, the LocalSystemAudioStream will be resolved as null
  * instead.
  */
-function createDisplayStreamWithAudio(displayStreamConstructor, systemAudioStreamConstructor, videoContentHint) {
+function createDisplayMedia(options) {
     return __awaiter$2(this, void 0, void 0, function* () {
+        var _a, _b;
         let stream;
+        const videoConstraints = options.video.constraints || true;
+        const audioConstraints = ((_a = options.audio) === null || _a === void 0 ? void 0 : _a.constraints) || !!options.audio;
         try {
-            stream = yield getDisplayMedia({ video: true, audio: true });
+            stream = yield getDisplayMedia({
+                video: videoConstraints,
+                audio: audioConstraints,
+                controller: options.controller,
+                preferCurrentTab: options.video.preferCurrentTab,
+                selfBrowserSurface: options.video.selfBrowserSurface,
+                surfaceSwitching: options.video.surfaceSwitching,
+                systemAudio: (_b = options.audio) === null || _b === void 0 ? void 0 : _b.systemAudio,
+                monitorTypeSurfaces: options.video.monitorTypeSurfaces,
+            });
         }
         catch (error) {
-            throw new WebrtcCoreError(exports.WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create display and system audio streams: ${error}`);
+            throw new WebrtcCoreError(exports.WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create display and/or system audio streams: ${error}`);
         }
         // eslint-disable-next-line new-cap
-        const localDisplayStream = new displayStreamConstructor(new MediaStream(stream.getVideoTracks()));
-        if (videoContentHint) {
-            localDisplayStream.contentHint = videoContentHint;
+        const localDisplayStream = new options.video.displayStreamConstructor(new MediaStream(stream.getVideoTracks()));
+        if (options.video.videoContentHint) {
+            localDisplayStream.contentHint = options.video.videoContentHint;
         }
         let localSystemAudioStream = null;
-        if (stream.getAudioTracks().length > 0) {
+        if (options.audio && stream.getAudioTracks().length > 0) {
             // eslint-disable-next-line new-cap
-            localSystemAudioStream = new systemAudioStreamConstructor(new MediaStream(stream.getAudioTracks()));
+            localSystemAudioStream = new options.audio.systemAudioStreamConstructor(new MediaStream(stream.getAudioTracks()));
         }
         return [localDisplayStream, localSystemAudioStream];
     });
 }
+/**
+ * Creates a LocalDisplayStream with the given parameters.
+ *
+ * @param displayStreamConstructor - Constructor for the local display stream.
+ * @param videoContentHint - An optional parameter to give a hint for the content of the stream.
+ * @returns A Promise that resolves to a LocalDisplayStream or an error.
+ */
+function createDisplayStream(displayStreamConstructor, videoContentHint) {
+    return __awaiter$2(this, void 0, void 0, function* () {
+        const [localDisplayStream] = yield createDisplayMedia({
+            video: { displayStreamConstructor, videoContentHint },
+        });
+        return localDisplayStream;
+    });
+}
+/**
+ * Creates a LocalDisplayStream and a LocalSystemAudioStream with the given parameters.
+ *
+ * @param displayStreamConstructor - Constructor for the local display stream.
+ * @param systemAudioStreamConstructor - Constructor for the local system audio stream.
+ * @param videoContentHint - An optional parameter to give a hint for the content of the stream.
+ * @returns A Promise that resolves to a LocalDisplayStream and a LocalSystemAudioStream or an
+ * error. If no system audio is available, the LocalSystemAudioStream will be resolved as null
+ * instead.
+ */
+function createDisplayStreamWithAudio(displayStreamConstructor, systemAudioStreamConstructor, videoContentHint) {
+    return __awaiter$2(this, void 0, void 0, function* () {
+        return createDisplayMedia({
+            video: { displayStreamConstructor, videoContentHint },
+            audio: { systemAudioStreamConstructor },
+        });
+    });
+}
 /**
  * Enumerates the media input and output devices available.
  *
@@ -7496,6 +7566,8 @@ const maxFrameSizeToMaxBitrateMap = new Map([
     [3600, 2500000],
     [8160, 4000000],
 ]);
+const defaultVideoMainRtxTime = '300';
+const defaultVideoSlidesRtxTime = '1000';
 function areProfileLevelIdsCompatible(senderProfileLevelId, receiverProfileLevelId, levelAsymmetryAllowed) {
     const senderProfile = Number.parseInt(`0x${senderProfileLevelId}`, 16);
     const recvProfile = Number.parseInt(`0x${receiverProfileLevelId}`, 16);
@@ -9734,10 +9806,10 @@ function addVlaExtension(mediaDescription) {
         mediaDescription.addExtension({ uri: vlaExtensionUri });
     }
 }
-function applyFormatParameters(mediaDescription, paramsMap) {
+function applyFormatParameters(mediaDescription, codecs, paramsMap) {
     paramsMap.forEach((value, param) => {
         [...mediaDescription.codecs.values()]
-            .filter((ci) => ci.name === 'H264' || ci.name === 'opus')
+            .filter((ci) => ci.name && codecs.includes(ci.name))
             .forEach((ci) => {
             if (value === null) {
                 ci.fmtParams.delete(param);
@@ -9858,7 +9930,7 @@ class EgressSdpMunger {
         if (options.simulcastEnabled) {
             mediaDescription.addLine(new SsrcGroupLine('SIM', this.streamIds.map((streamId) => streamId.ssrc)));
         }
-        applyFormatParameters(mediaDescription, this.customCodecParameters);
+        applyFormatParameters(mediaDescription, ['H264', 'opus'], this.customCodecParameters);
         if (options.twccDisabled) {
             disableTwcc(mediaDescription);
         }
@@ -10386,6 +10458,7 @@ class EventEmitter$2 extends events$1.exports.EventEmitter {
 
 class IngressSdpMunger {
     constructor() {
+        this.customRtxCodecParameters = new Map();
         this.ssrc = generateSsrc();
     }
     getReceiverId() {
@@ -10397,6 +10470,7 @@ class IngressSdpMunger {
             logErrorAndThrow(exports.WcmeErrorType.SDP_MUNGE_MISSING_CODECS, `No codecs present in m-line with MID ${mediaDescription.mid} after filtering.`);
         }
         removeMidRidExtensions(mediaDescription);
+        applyFormatParameters(mediaDescription, ['rtx'], this.customRtxCodecParameters);
         if (options.twccDisabled) {
             disableTwcc(mediaDescription);
         }
@@ -10420,6 +10494,12 @@ class IngressSdpMunger {
         [...mediaDescription.codecs.values()].forEach((ci) => {
             ci.fmtParams.set('x-google-start-bitrate', '60000');
         });
+        applyFormatParameters(mediaDescription, ['rtx'], this.customRtxCodecParameters);
+    }
+    setRtxCodecParameters(parameters) {
+        Object.entries(parameters).forEach(([param, value]) => {
+            this.customRtxCodecParameters.set(param, value);
+        });
     }
     reset() {
         this.ssrc = generateSsrc();
@@ -10638,7 +10718,9 @@ class ReceiveOnlyTransceiver extends Transceiver {
         });
     }
     mungeLocalDescription(mediaDescription) {
-        this.munger.mungeLocalDescription(mediaDescription, { twccDisabled: this.twccDisabled });
+        this.munger.mungeLocalDescription(mediaDescription, {
+            twccDisabled: this.twccDisabled,
+        });
     }
     mungeRemoteDescription(mediaDescription) {
         this.munger.mungeRemoteDescription(mediaDescription);
@@ -10675,6 +10757,9 @@ class ReceiveOnlyTransceiver extends Transceiver {
             this.metadata.lastActiveSpeakerUpdateTimestamp = getCurrentTimestamp();
         }
     }
+    setRtxCodecParameters(parameters) {
+        this.munger.setRtxCodecParameters(parameters);
+    }
 }
 ReceiveOnlyTransceiver.rid = '1';
 
@@ -15231,6 +15316,11 @@ SCTP Max Message Size: ${maxMessageSize}`);
             mediaType,
             munger,
         });
+        if (getMediaFamily(mediaType) === exports.MediaFamily.Video) {
+            recvOnlyTransceiver.setRtxCodecParameters({
+                'rtx-time': mediaType === exports.MediaType.VideoMain ? defaultVideoMainRtxTime : defaultVideoSlidesRtxTime,
+            });
+        }
         recvOnlyTransceiver.twccDisabled =
             getMediaFamily(mediaType) === exports.MediaFamily.Audio ? this.options.disableAudioTwcc : false;
         this.recvTransceivers.set(mediaType, [
@@ -15710,7 +15800,9 @@ exports.WcmeError = WcmeError;
 exports.WebRtcCoreLogger = Logger$2;
 exports.WebrtcCoreError = WebrtcCoreError;
 exports.areReceiveSlotIdsEqual = areReceiveSlotIdsEqual;
+exports.createCameraAndMicrophoneStreams = createCameraAndMicrophoneStreams;
 exports.createCameraStream = createCameraStream;
+exports.createDisplayMedia = createDisplayMedia;
 exports.createDisplayStream = createDisplayStream;
 exports.createDisplayStreamWithAudio = createDisplayStreamWithAudio;
 exports.createMicrophoneStream = createMicrophoneStream;