@webex/web-client-media-engine 3.1.0 → 3.3.0

package/dist/esm/index.js

@@ -482,6 +482,175 @@ var media = /*#__PURE__*/Object.freeze({
     ensureDevicePermissions: ensureDevicePermissions
 });
 
+var ErrorTypes;
+(function (ErrorTypes) {
+    ErrorTypes["DEVICE_PERMISSION_DENIED"] = "DEVICE_PERMISSION_DENIED";
+    ErrorTypes["CREATE_STREAM_FAILED"] = "CREATE_CAMERA_STREAM";
+})(ErrorTypes || (ErrorTypes = {}));
+/**
+ * Represents a WCME error, which contains error type and error message.
+ */
+class WcmeError {
+    /**
+     * Creates new error.
+     *
+     * @param type - Error type.
+     * @param message - Error message.
+     */
+    constructor(type, message = '') {
+        this.type = type;
+        this.message = message;
+    }
+}
+/**
+ * Creates a camera stream. Please note that the constraint params in second getUserMedia call would NOT take effect when:
+ *
+ * 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 constraints - Video device constraints.
+ * @returns A LocalCameraStream object or an error.
+ */
+function createCameraStream(constructor, constraints) {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        let stream;
+        try {
+            stream = yield getUserMedia({ video: Object.assign({}, constraints) });
+        }
+        catch (error) {
+            throw new WcmeError(ErrorTypes.CREATE_STREAM_FAILED, `Failed to create camera stream: ${error}`);
+        }
+        return new constructor(stream);
+    });
+}
+/**
+ * Creates a LocalMicrophoneStream with the given constraints.
+ *
+ * @param constructor - Constructor for the local microphone stream.
+ * @param constraints - Audio device constraints.
+ * @returns A LocalMicrophoneStream object or an error.
+ */
+function createMicrophoneStream(constructor, constraints) {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        let stream;
+        try {
+            stream = yield getUserMedia({ audio: Object.assign({}, constraints) });
+        }
+        catch (error) {
+            throw new WcmeError(ErrorTypes.CREATE_STREAM_FAILED, `Failed to create microphone stream: ${error}`);
+        }
+        return new constructor(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.
+ */
+function createDisplayStream(constructor, videoContentHint) {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        let stream;
+        try {
+            stream = yield getDisplayMedia({ video: true });
+        }
+        catch (error) {
+            throw new WcmeError(ErrorTypes.CREATE_STREAM_FAILED, `Failed to create display stream: ${error}`);
+        }
+        const localDisplayStream = new constructor(stream);
+        if (videoContentHint) {
+            localDisplayStream.contentHint = 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$1(this, void 0, void 0, function* () {
+        let stream;
+        try {
+            stream = yield getDisplayMedia({ video: true, audio: true });
+        }
+        catch (error) {
+            throw new WcmeError(ErrorTypes.CREATE_STREAM_FAILED, `Failed to create display and system audio streams: ${error}`);
+        }
+        // eslint-disable-next-line new-cap
+        const localDisplayStream = new displayStreamConstructor(new MediaStream(stream.getVideoTracks()));
+        if (videoContentHint) {
+            localDisplayStream.contentHint = videoContentHint;
+        }
+        let localSystemAudioStream = null;
+        if (stream.getAudioTracks().length > 0) {
+            // eslint-disable-next-line new-cap
+            localSystemAudioStream = new systemAudioStreamConstructor(new MediaStream(stream.getAudioTracks()));
+        }
+        return [localDisplayStream, localSystemAudioStream];
+    });
+}
+/**
+ * Enumerates the media input and output devices available.
+ *
+ * @param deviceKind - Optional filter to return a specific device kind.
+ * @returns List of media devices in an array of MediaDeviceInfo objects.
+ */
+function getDevices(deviceKind) {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        let devices;
+        try {
+            devices = yield ensureDevicePermissions([DeviceKind.AudioInput, DeviceKind.VideoInput], enumerateDevices);
+        }
+        catch (error) {
+            throw new WcmeError(ErrorTypes.DEVICE_PERMISSION_DENIED, 'Failed to ensure device permissions');
+        }
+        return devices.filter((v) => (deviceKind ? v.kind === deviceKind : true));
+    });
+}
+/**
+ * Helper function to get a list of microphone devices.
+ *
+ * @returns List of microphone devices in an array of MediaDeviceInfo objects.
+ */
+function getAudioInputDevices() {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        return getDevices(DeviceKind.AudioInput);
+    });
+}
+/**
+ * Helper function to get a list of speaker devices.
+ *
+ * @returns List of speaker devices in an array of MediaDeviceInfo objects.
+ */
+function getAudioOutputDevices() {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        return getDevices(DeviceKind.AudioOutput);
+    });
+}
+/**
+ * Helper function to get a list of camera devices.
+ *
+ * @returns List of camera devices in an array of MediaDeviceInfo objects.
+ */
+function getVideoInputDevices() {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        return getDevices(DeviceKind.VideoInput);
+    });
+}
+/**
+ * Export the setOnDeviceChangeHandler method directly from the core lib.
+ */
+const { setOnDeviceChangeHandler } = media;
+
 var events$1$1 = {exports: {}};
 
 var R$1$1 = typeof Reflect === 'object' ? Reflect : null;
@@ -1231,6 +1400,26 @@ class _LocalStream extends Stream {
 _a$6 = LocalStreamEventNames.ConstraintsChange, _b = LocalStreamEventNames.OutputTrackChange;
 const LocalStream = AddEvents(_LocalStream);
 
+/**
+ * An audio LocalStream.
+ */
+class LocalAudioStream extends LocalStream {
+    /**
+     * Apply constraints to the stream.
+     *
+     * @param constraints - The constraints to apply.
+     * @returns A promise which resolves when the constraints have been successfully applied.
+     */
+    applyConstraints(constraints) {
+        return __awaiter$1(this, void 0, void 0, function* () {
+            logger$3.log(`Applying constraints to local track:`, constraints);
+            return this.inputTrack.applyConstraints(constraints).then(() => {
+                this[LocalStreamEventNames.ConstraintsChange].emit();
+            });
+        });
+    }
+}
+
 /**
  * A video LocalStream.
  */
@@ -1298,26 +1487,6 @@ class LocalCameraStream extends LocalVideoStream {
 class LocalDisplayStream extends LocalVideoStream {
 }
 
-/**
- * An audio LocalStream.
- */
-class LocalAudioStream extends LocalStream {
-    /**
-     * Apply constraints to the stream.
-     *
-     * @param constraints - The constraints to apply.
-     * @returns A promise which resolves when the constraints have been successfully applied.
-     */
-    applyConstraints(constraints) {
-        return __awaiter$1(this, void 0, void 0, function* () {
-            logger$3.log(`Applying constraints to local track:`, constraints);
-            return this.inputTrack.applyConstraints(constraints).then(() => {
-                this[LocalStreamEventNames.ConstraintsChange].emit();
-            });
-        });
-    }
-}
-
 /**
  * A local microphone stream.
  */
@@ -1330,156 +1499,6 @@ class LocalMicrophoneStream extends LocalAudioStream {
 class LocalSystemAudioStream extends LocalAudioStream {
 }
 
-var ErrorTypes;
-(function (ErrorTypes) {
-    ErrorTypes["DEVICE_PERMISSION_DENIED"] = "DEVICE_PERMISSION_DENIED";
-    ErrorTypes["CREATE_CAMERA_STREAM_FAILED"] = "CREATE_CAMERA_STREAM_FAILED";
-    ErrorTypes["CREATE_MICROPHONE_STREAM_FAILED"] = "CREATE_MICROPHONE_STREAM_FAILED";
-})(ErrorTypes || (ErrorTypes = {}));
-/**
- * Represents a WCME error, which contains error type and error message.
- */
-class WcmeError {
-    /**
-     * Creates new error.
-     *
-     * @param type - Error type.
-     * @param message - Error message.
-     */
-    constructor(type, message = '') {
-        this.type = type;
-        this.message = message;
-    }
-}
-/**
- * Creates a camera stream. Please note that the constraint params in second getUserMedia call would NOT take effect when:
- *
- * 1. Previous captured video stream from the same device is not stopped.
- * 2. Previous createCameraStream() call for the same device is in progress.
- *
- * @param constraints - Video device constraints.
- * @returns A LocalCameraStream object or an error.
- */
-function createCameraStream(constraints) {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        let stream;
-        try {
-            stream = yield getUserMedia({ video: Object.assign({}, constraints) });
-        }
-        catch (error) {
-            throw new WcmeError(ErrorTypes.CREATE_CAMERA_STREAM_FAILED, `Failed to create camera stream ${error}`);
-        }
-        return new LocalCameraStream(stream);
-    });
-}
-/**
- * Creates a LocalMicrophoneStream with the given constraints.
- *
- * @param constraints - Audio device constraints.
- * @returns A LocalMicrophoneStream object or an error.
- */
-function createMicrophoneStream(constraints) {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        let stream;
-        try {
-            stream = yield getUserMedia({ audio: Object.assign({}, constraints) });
-        }
-        catch (error) {
-            throw new WcmeError(ErrorTypes.CREATE_MICROPHONE_STREAM_FAILED, `Failed to create microphone stream ${error}`);
-        }
-        return new LocalMicrophoneStream(stream);
-    });
-}
-/**
- * Creates a LocalDisplayStream with the given parameters.
- *
- * @param videoContentHint - An optional parameter to give a hint for the content of the stream.
- * @returns A Promise that resolves to a LocalDisplayStream.
- */
-function createDisplayStream(videoContentHint) {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        const stream = yield getDisplayMedia({ video: true });
-        const localDisplayStream = new LocalDisplayStream(stream);
-        if (videoContentHint) {
-            localDisplayStream.contentHint = videoContentHint;
-        }
-        return localDisplayStream;
-    });
-}
-/**
- * Creates a LocalDisplayStream and a LocalSystemAudioStream with the given parameters.
- *
- * @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. If no system
- * audio is available, the LocalSystemAudioStream will be resolved as null instead.
- */
-function createDisplayStreamWithAudio(videoContentHint) {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        const stream = yield getDisplayMedia({ video: true, audio: true });
-        const localDisplayStream = new LocalDisplayStream(new MediaStream(stream.getVideoTracks()));
-        if (videoContentHint) {
-            localDisplayStream.contentHint = videoContentHint;
-        }
-        let localSystemAudioStream = null;
-        if (stream.getAudioTracks().length > 0) {
-            localSystemAudioStream = new LocalSystemAudioStream(new MediaStream(stream.getAudioTracks()));
-        }
-        return [localDisplayStream, localSystemAudioStream];
-    });
-}
-/**
- * Enumerates the media input and output devices available.
- *
- * @param deviceKind - Optional filter to return a specific device kind.
- * @returns List of media devices in an array of MediaDeviceInfo objects.
- */
-function getDevices(deviceKind) {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        let devices;
-        try {
-            devices = yield ensureDevicePermissions([DeviceKind.AudioInput, DeviceKind.VideoInput], enumerateDevices);
-        }
-        catch (error) {
-            throw new WcmeError(ErrorTypes.DEVICE_PERMISSION_DENIED, 'Failed to ensure device permissions');
-        }
-        return devices.filter((v) => (deviceKind ? v.kind === deviceKind : true));
-    });
-}
-/**
- * Helper function to get a list of microphone devices.
- *
- * @returns List of microphone devices in an array of MediaDeviceInfo objects.
- */
-function getAudioInputDevices() {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        return getDevices(DeviceKind.AudioInput);
-    });
-}
-/**
- * Helper function to get a list of speaker devices.
- *
- * @returns List of speaker devices in an array of MediaDeviceInfo objects.
- */
-function getAudioOutputDevices() {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        return getDevices(DeviceKind.AudioOutput);
-    });
-}
-/**
- * Helper function to get a list of camera devices.
- *
- * @returns List of camera devices in an array of MediaDeviceInfo objects.
- */
-function getVideoInputDevices() {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        return getDevices(DeviceKind.VideoInput);
-    });
-}
-/**
- * Export the setOnDeviceChangeHandler method directly from the core lib.
- */
-const { setOnDeviceChangeHandler } = media;
-
 /**
  * A stream originating from a remote peer.
  */
@@ -9844,6 +9863,11 @@ class TypedEvent {
     }
 }
 
+var OfferAnswerType;
+(function (OfferAnswerType) {
+    OfferAnswerType[OfferAnswerType["LocalOnly"] = 0] = "LocalOnly";
+    OfferAnswerType[OfferAnswerType["Remote"] = 1] = "Remote";
+})(OfferAnswerType || (OfferAnswerType = {}));
 class SendOnlyTransceiver extends Transceiver {
     constructor(rtcRtpTransceiver, mid, csi, signaler, mediaType) {
         super(rtcRtpTransceiver, mid);
@@ -9935,7 +9959,7 @@ class SendOnlyTransceiver extends Transceiver {
         this.direction = enabled ? 'sendrecv' : 'inactive';
         this._rtcRtpTransceiver.direction = this.direction;
         if (this._rtcRtpTransceiver.direction !== this._rtcRtpTransceiver.currentDirection) {
-            this.negotiationNeeded.emit();
+            this.negotiationNeeded.emit(OfferAnswerType.Remote);
         }
     }
     getStats() {
@@ -9991,9 +10015,11 @@ class SendOnlyTransceiver extends Transceiver {
     }
     setCodecParameters(parameters) {
         this.streamSignaler.setCodecParameters(parameters);
+        this.negotiationNeeded.emit(OfferAnswerType.LocalOnly);
     }
     deleteCodecParameters(parameters) {
         this.streamSignaler.deleteCodecParameters(parameters);
+        this.negotiationNeeded.emit(OfferAnswerType.LocalOnly);
     }
 }
 
@@ -10020,6 +10046,16 @@ class SendSlot {
     set active(active) {
         this.sendTransceiver.setActive(active);
     }
+    setCodecParameters(parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.sendTransceiver.setCodecParameters(parameters);
+        });
+    }
+    deleteCodecParameters(parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.sendTransceiver.deleteCodecParameters(parameters);
+        });
+    }
 }
 
 function generateSsrc() {
@@ -13895,15 +13931,20 @@ class MultistreamConnection extends EventEmitter$2 {
             this.sendSourceAdvertisement(mediaType);
             this.sendMediaRequestStatus(mediaType);
         });
-        transceiver.negotiationNeeded.on(() => {
-            this.emit(MultistreamConnectionEventNames.NegotiationNeeded);
+        transceiver.negotiationNeeded.on((offerAnswerType) => {
+            if (offerAnswerType === OfferAnswerType.Remote) {
+                this.emit(MultistreamConnectionEventNames.NegotiationNeeded);
+            }
+            else if (this.pc.getRemoteDescription()) {
+                this.queueLocalOfferAnswer();
+            }
         });
         this.sendTransceivers.set(mediaType, transceiver);
         this.createJmpSession(mediaType);
     }
-    createSendSlot(mediaType) {
+    createSendSlot(mediaType, active = true) {
         const transceiver = this.getSendTransceiverOrThrow(mediaType);
-        transceiver.setActive(true);
+        transceiver.setActive(active);
         return new SendSlot(transceiver);
     }
     createJmpSession(mediaType) {
@@ -14333,24 +14374,6 @@ class MultistreamConnection extends EventEmitter$2 {
         }
         return transceiver;
     }
-    setCodecParameters(mediaType, parameters) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const transceiver = this.sendTransceivers.get(mediaType);
-            transceiver === null || transceiver === void 0 ? void 0 : transceiver.setCodecParameters(parameters);
-            if (this.pc.getRemoteDescription()) {
-                yield this.queueLocalOfferAnswer();
-            }
-        });
-    }
-    deleteCodecParameters(mediaType, parameters) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const transceiver = this.sendTransceivers.get(mediaType);
-            transceiver === null || transceiver === void 0 ? void 0 : transceiver.deleteCodecParameters(parameters);
-            if (this.pc.getRemoteDescription()) {
-                yield this.queueLocalOfferAnswer();
-            }
-        });
-    }
     requestMedia(mediaType, streamRequests) {
         var _a;
         const task = () => {