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

package/dist/esm/index.js

@@ -358,10 +358,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.
  */
@@ -510,11 +511,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 {
@@ -523,17 +524,18 @@ function createCameraStream(constructor, constraints) {
         catch (error) {
             throw new WebrtcCoreError(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 {
@@ -542,64 +544,132 @@ function createMicrophoneStream(constructor, constraints) {
         catch (error) {
             throw new WebrtcCoreError(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(WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create display stream: ${error}`);
-        }
-        const localDisplayStream = new constructor(stream);
-        if (videoContentHint) {
-            localDisplayStream.contentHint = videoContentHint;
+            throw new WebrtcCoreError(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(WebrtcCoreErrorType.CREATE_STREAM_FAILED, `Failed to create display and system audio streams: ${error}`);
+            throw new WebrtcCoreError(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.
  *
@@ -15684,5 +15754,5 @@ class StreamRequest {
 
 const { DeviceKind } = media;
 
-export { ActiveSpeakerInfo, CodecInfo$1 as CodecInfo, ConnectionState, DeviceKind, H264Codec, Logger$1 as JMPLogger, LocalCameraStream, LocalDisplayStream, LocalMicrophoneStream, LocalStream, LocalStreamEventNames, LocalSystemAudioStream, Logger, MediaCodecMimeType, MediaContent, MediaFamily, MediaStreamTrackKind, MediaType, MultistreamConnection, MultistreamConnectionEventNames, PeerConnection, Policy, ReceiveSlot, ReceiveSlotEvents, ReceiverSelectedInfo, RecommendedOpusBitrates, RemoteMediaState, RemoteStream, RemoteStreamEventNames, SendSlot, StreamEventNames, StreamRequest, WcmeError, WcmeErrorType, Logger$2 as WebRtcCoreLogger, WebrtcCoreError, WebrtcCoreErrorType, areReceiveSlotIdsEqual, createCameraStream, createDisplayStream, createDisplayStreamWithAudio, createMicrophoneStream, getAudioInputDevices, getAudioOutputDevices, getDevices, getLogLevel, getMediaContent, getMediaFamily, getMediaType, getRecommendedMaxBitrateForFrameSize, getVideoInputDevices, logErrorAndThrow, setLogHandler, setLogLevel, setOnDeviceChangeHandler };
+export { ActiveSpeakerInfo, CodecInfo$1 as CodecInfo, ConnectionState, DeviceKind, H264Codec, Logger$1 as JMPLogger, LocalCameraStream, LocalDisplayStream, LocalMicrophoneStream, LocalStream, LocalStreamEventNames, LocalSystemAudioStream, Logger, MediaCodecMimeType, MediaContent, MediaFamily, MediaStreamTrackKind, MediaType, MultistreamConnection, MultistreamConnectionEventNames, PeerConnection, Policy, ReceiveSlot, ReceiveSlotEvents, ReceiverSelectedInfo, RecommendedOpusBitrates, RemoteMediaState, RemoteStream, RemoteStreamEventNames, SendSlot, StreamEventNames, StreamRequest, WcmeError, WcmeErrorType, Logger$2 as WebRtcCoreLogger, WebrtcCoreError, WebrtcCoreErrorType, areReceiveSlotIdsEqual, createCameraAndMicrophoneStreams, createCameraStream, createDisplayMedia, createDisplayStream, createDisplayStreamWithAudio, createMicrophoneStream, getAudioInputDevices, getAudioOutputDevices, getDevices, getLogLevel, getMediaContent, getMediaFamily, getMediaType, getRecommendedMaxBitrateForFrameSize, getVideoInputDevices, logErrorAndThrow, setLogHandler, setLogLevel, setOnDeviceChangeHandler };
 //# sourceMappingURL=index.js.map