@webex/web-client-media-engine 1.40.3 → 1.40.5

package/dist/esm/index.js

@@ -477,6 +477,134 @@ var media = /*#__PURE__*/Object.freeze({
     ensureDevicePermissions: ensureDevicePermissions
 });
 
+var ErrorTypes;
+(function (ErrorTypes) {
+    ErrorTypes["DEVICE_PERMISSION_DENIED"] = "DEVICE_PERMISSION_DENIED";
+    ErrorTypes["CREATE_CAMERA_TRACK_FAILED"] = "CREATE_CAMERA_TRACK_FAILED";
+    ErrorTypes["CREATE_MICROPHONE_TRACK_FAILED"] = "CREATE_MICROPHONE_TRACK_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 video track. Please note that the constraint params in second getUserMedia call would NOT take effect when:
+ *
+ * 1. Previous captured video track from the same device is not stopped .
+ * 2. Previous createCameraTrack() call for the same device is in progress.
+ *
+ * @param constructor - Constructor for the local camera track.
+ * @param constraints - Video device constraints.
+ * @returns A LocalTrack object or an error.
+ */
+function createCameraTrack(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_CAMERA_TRACK_FAILED, `Failed to create camera track ${error}`);
+        }
+        return new constructor(stream);
+    });
+}
+/**
+ * Creates a microphone audio track.
+ *
+ * @param constructor - Constructor for the local microphone track.
+ * @param constraints - Audio device constraints.
+ * @returns A LocalTrack object or an error.
+ */
+function createMicrophoneTrack(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_MICROPHONE_TRACK_FAILED, `Failed to create microphone track ${error}`);
+        }
+        return new constructor(stream);
+    });
+}
+/**
+ * Creates a display video track.
+ *
+ * @param constructor - Constructor for the local display track.
+ * @param videoContentHint - An optional parameters to give a hint for the content of the track.
+ * @returns A Promise that resolves to a LocalDisplayTrack.
+ */
+function createDisplayTrack(constructor, videoContentHint) {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        const stream = yield getDisplayMedia({ video: true });
+        return new constructor(stream, videoContentHint);
+    });
+}
+/**
+ * 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 = {exports: {}};
 
 var R$1 = typeof Reflect === 'object' ? Reflect : null;
@@ -1227,6 +1355,25 @@ class LocalCameraTrack extends LocalTrack {
  * Represents a local track for a display source.
  */
 class LocalDisplayTrack extends LocalTrack {
+    /**
+     * Create a LocalDisplayTrack from the given values.
+     *
+     * @param stream - The MediaStream for this track.
+     * @param videoContentHint - An optional content hint, describing the content of the track.
+     */
+    constructor(stream, videoContentHint) {
+        super(stream);
+        this._videoContentHint = videoContentHint;
+        this.underlyingTrack.contentHint = videoContentHint || '';
+    }
+    /**
+     * Get the VideoContentHint for this track.
+     *
+     * @returns The VideoContentHint for this track.
+     */
+    get videoContentHint() {
+        return this._videoContentHint;
+    }
 }
 
 /**
@@ -1235,130 +1382,6 @@ class LocalDisplayTrack extends LocalTrack {
 class LocalMicrophoneTrack extends LocalTrack {
 }
 
-var ErrorTypes;
-(function (ErrorTypes) {
-    ErrorTypes["DEVICE_PERMISSION_DENIED"] = "DEVICE_PERMISSION_DENIED";
-    ErrorTypes["CREATE_CAMERA_TRACK_FAILED"] = "CREATE_CAMERA_TRACK_FAILED";
-    ErrorTypes["CREATE_MICROPHONE_TRACK_FAILED"] = "CREATE_MICROPHONE_TRACK_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 video track. Please note that the constraint params in second getUserMedia call would NOT take effect when:
- *
- * 1. Previous captured video track from the same device is not stopped .
- * 2. Previous createCameraTrack() call for the same device is in progress.
- *
- * @param constraints - Video device constraints.
- * @returns A LocalTrack object or an error.
- */
-function createCameraTrack(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_TRACK_FAILED, `Failed to create camera track ${error}`);
-        }
-        return new LocalCameraTrack(stream);
-    });
-}
-/**
- * Creates a microphone audio track.
- *
- * @param constraints - Audio device constraints.
- * @returns A LocalTrack object or an error.
- */
-function createMicrophoneTrack(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_TRACK_FAILED, `Failed to create microphone track ${error}`);
-        }
-        return new LocalMicrophoneTrack(stream);
-    });
-}
-/**
- * Creates a display video track.
- *
- * @returns A Promise that resolves to a LocalDisplayTrack.
- */
-function createDisplayTrack() {
-    return __awaiter$1(this, void 0, void 0, function* () {
-        const stream = yield getDisplayMedia({ video: true });
-        return new LocalDisplayTrack(stream);
-    });
-}
-/**
- * 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;
-
 // Overall connection state (based on the ICE and DTLS connection states)
 var ConnectionState;
 (function (ConnectionState) {
@@ -5702,11 +5725,12 @@ function compareStreamIds(id1, id2) {
 }
 
 class SourceIndicationMsg {
-    constructor(seqNum, numTotalSources, numLiveSources, sources) {
+    constructor(seqNum, numTotalSources, numLiveSources, sources, videoContentHint) {
         this.seqNum = seqNum;
         this.numTotalSources = numTotalSources;
         this.numLiveSources = numLiveSources;
         this.sources = sources;
+        this.videoContentHint = videoContentHint;
     }
     sourcesToString() {
         return this.sources
@@ -5802,13 +5826,13 @@ class JmpSession extends EventEmitter$3 {
             this.logger.warn(`Retransmits for message expired: ${expiredJmpMsg}`);
         });
     }
-    updateSourceIndication(numTotalSources, numLiveSources, sources) {
+    updateSourceIndication(numTotalSources, numLiveSources, sources, videoContentHint) {
         var _a;
         const filteredSources = sources.filter((source) => {
             var _a;
             return (_a = this.lastReceivedScr) === null || _a === void 0 ? void 0 : _a.requests.some((req) => req.ids.find((streamId) => compareStreamIds(streamId, source.id)));
         });
-        const sourceIndicationMsg = new SourceIndicationMsg(this.currSourceIndicationSeqNum++, numTotalSources, numLiveSources, filteredSources);
+        const sourceIndicationMsg = new SourceIndicationMsg(this.currSourceIndicationSeqNum++, numTotalSources, numLiveSources, filteredSources, videoContentHint);
         const jmpMsg = new JmpMsg(this.mediaFamily, this.mediaContent, {
             msgType: JmpMsgType.SourceIndication,
             payload: sourceIndicationMsg,
@@ -9194,23 +9218,58 @@ class SsrcEgressStreamSignaler {
         this.streamIds = [];
     }
     signalStreams(simulcastEnabled, rtxEnabled, mLine) {
+        var _a;
         mLine.rids = [];
         mLine.simulcast = undefined;
-        mLine.ssrcs = [];
-        mLine.ssrcGroups = [];
         mLine.extMaps = mLine.extMaps.filter((extMapLine) => !/^urn:ietf:params:rtp-hdrext:sdes:(?:mid|rtp-stream-id|repaired-rtp-stream-id)$/.test(extMapLine.uri));
-        if (this.streamIds.length === 0) {
-            const numStreams = simulcastEnabled ? 3 : 1;
-            [...Array(numStreams).keys()].forEach(() => {
-                const newStreamId = {
-                    ssrc: generateSsrc(),
-                };
-                if (rtxEnabled) {
-                    newStreamId.rtxSsrc = generateSsrc();
+        const numStreams = simulcastEnabled ? 3 : 1;
+        if (!this.streamIds.length) {
+            if (mLine.ssrcs.length) {
+                const ssrcs = [...new Set(mLine.ssrcs.map((ssrcLine) => ssrcLine.ssrcId))];
+                mLine.ssrcGroups.forEach((sg) => {
+                    if (!sg.ssrcs.every((ssrc) => ssrcs.includes(ssrc))) {
+                        throw new Error('SSRC present in SSRC groups is missing from SSRC lines');
+                    }
+                });
+                const rtxSsrcGroups = mLine.ssrcGroups.filter((sg) => sg.semantics === 'FID');
+                if (rtxSsrcGroups.length && rtxSsrcGroups.length !== numStreams) {
+                    throw new Error(`Expect ${numStreams} RTX SSRC groups, got ${rtxSsrcGroups.length}`);
                 }
-                this.streamIds.push(newStreamId);
-            });
+                rtxSsrcGroups.forEach((sg) => {
+                    this.streamIds.push({
+                        ssrc: sg.ssrcs[0],
+                        rtxSsrc: sg.ssrcs[1],
+                    });
+                });
+                const simulcastSsrcs = (_a = mLine.ssrcGroups.find((sg) => sg.semantics === 'SIM')) === null || _a === void 0 ? void 0 : _a.ssrcs;
+                if (simulcastSsrcs) {
+                    if (simulcastSsrcs.length !== numStreams ||
+                        !this.streamIds.every((streamId) => simulcastSsrcs.includes(streamId.ssrc))) {
+                        throw new Error('SSRCs in simulcast SSRC group do not match primary SSRCs in RTX SSRC groups');
+                    }
+                    this.streamIds.sort((a, b) => simulcastSsrcs.indexOf(a.ssrc) - simulcastSsrcs.indexOf(b.ssrc));
+                }
+                else if (rtxSsrcGroups.length > 1) {
+                    throw new Error('Multiple RTX SSRC groups but no simulcast SSRC group found');
+                }
+                if (!this.streamIds.length) {
+                    this.streamIds.push({ ssrc: ssrcs[0] });
+                }
+            }
+            else {
+                [...Array(numStreams).keys()].forEach(() => {
+                    const newStreamId = {
+                        ssrc: generateSsrc(),
+                    };
+                    if (rtxEnabled) {
+                        newStreamId.rtxSsrc = generateSsrc();
+                    }
+                    this.streamIds.push(newStreamId);
+                });
+            }
         }
+        mLine.ssrcs = [];
+        mLine.ssrcGroups = [];
         this.streamIds.forEach((streamId) => {
             const rtpSsrc = streamId.ssrc;
             mLine.addLine(new SsrcLine(rtpSsrc, 'cname', `${rtpSsrc}-cname`));
@@ -9678,6 +9737,15 @@ function toMediaStreamTrackKind(mediaType) {
         ? MediaStreamTrackKind.Video
         : MediaStreamTrackKind.Audio;
 }
+function webRtcVideoContentHintToJmpVideoContentHint(hint) {
+    if (hint === 'motion') {
+        return 'motion';
+    }
+    if (hint === 'detail') {
+        return 'sharpness';
+    }
+    return undefined;
+}
 function toMediaFamily(kind) {
     if (kind === MediaStreamTrackKind.Video) {
         return MediaFamily.Video;
@@ -9926,24 +9994,8 @@ class MultistreamConnection extends EventEmitter {
         const dataChannel = this.pc.createDataChannel('datachannel', {});
         dataChannel.onopen = (e) => {
             logger.info('DataChannel opened: ', e);
-            this.sendTransceivers.forEach((transceiver, mediaType) => {
-                const track = transceiver.publishedTrack;
-                if (track) {
-                    if (getMediaFamily(mediaType) === MediaFamily.Audio) {
-                        this.sendSourceIndication(mediaType, +!track.muted);
-                    }
-                    else {
-                        const signaler = this.streamSignalerManager.getEgressStreamSignalerOrThrow(transceiver.mid);
-                        const state = track.muted ? 'avatar' : 'live';
-                        const sources = signaler
-                            .getSenderIds()
-                            .map((id) => ({ id, state, csi: transceiver.csi }));
-                        this.sendSourceIndication(mediaType, +!track.muted, sources);
-                    }
-                }
-                else {
-                    this.sendSourceIndication(mediaType, 0);
-                }
+            [...this.sendTransceivers.keys()].forEach((mediaType) => {
+                this.maybeSendSourceIndication(mediaType);
             });
             logger.info(`Flushing pending JMP task queue`);
             this.pendingJmpTasks.forEach((t) => t());
@@ -9992,11 +10044,31 @@ class MultistreamConnection extends EventEmitter {
         });
         this.pc.close();
     }
-    sendSourceIndication(mediaType, numLiveSources, sources = []) {
+    maybeSendSourceIndication(mediaType) {
+        var _a;
+        const transceiver = this.getSendTransceiverOrThrow(mediaType);
+        const numLiveSources = ((_a = transceiver.publishedTrack) === null || _a === void 0 ? void 0 : _a.muted) === false ? 1 : 0;
+        if (getMediaFamily(mediaType) === MediaFamily.Video) {
+            const sources = this.getVideoSources(mediaType);
+            if (sources === null) {
+                return;
+            }
+            let webRtcVideoContentHint;
+            if (transceiver.publishedTrack instanceof LocalDisplayTrack) {
+                webRtcVideoContentHint = transceiver.publishedTrack.videoContentHint;
+            }
+            this.sendSourceIndication(mediaType, numLiveSources, sources, webRtcVideoContentHintToJmpVideoContentHint(webRtcVideoContentHint));
+        }
+        else {
+            this.sendSourceIndication(mediaType, numLiveSources);
+        }
+    }
+    sendSourceIndication(mediaType, numLiveSources, sources = [], videoContentHint = undefined) {
         var _a;
         const task = () => {
             var _a;
-            (_a = this.jmpSessions.get(mediaType)) === null || _a === void 0 ? void 0 : _a.updateSourceIndication(1, numLiveSources, sources);
+            (_a = this.jmpSessions
+                .get(mediaType)) === null || _a === void 0 ? void 0 : _a.updateSourceIndication(1, numLiveSources, sources, videoContentHint);
         };
         if (((_a = this.dataChannel) === null || _a === void 0 ? void 0 : _a.readyState) === 'open') {
             task();
@@ -10041,24 +10113,9 @@ class MultistreamConnection extends EventEmitter {
         });
     }
     addTrackListeners(mediaType, track) {
-        const onTrackResolutionChange = () => {
-            const sources = this.getVideoSources(mediaType);
-            if (sources != null) {
-                this.sendSourceIndication(mediaType, 1, sources);
-            }
-        };
+        const onTrackResolutionChange = () => this.maybeSendSourceIndication(mediaType);
         track.on(LocalTrack.Events.TrackConstraintsChange, onTrackResolutionChange);
-        const onTrackMute = (event) => {
-            if (getMediaFamily(mediaType) === MediaFamily.Audio) {
-                this.sendSourceIndication(mediaType, +!event.trackState.muted);
-            }
-            else {
-                const sources = this.getVideoSources(mediaType);
-                if (sources != null) {
-                    this.sendSourceIndication(mediaType, +!event.trackState.muted, sources);
-                }
-            }
-        };
+        const onTrackMute = () => this.maybeSendSourceIndication(mediaType);
         track.on(LocalTrack.Events.Muted, onTrackMute);
         const onTrackPublish = (event) => {
             if (!event.isPublished) {
@@ -10066,14 +10123,8 @@ class MultistreamConnection extends EventEmitter {
                 track.off(LocalTrack.Events.PublishedStateUpdate, onTrackPublish);
                 track.off(LocalTrack.Events.TrackConstraintsChange, onTrackResolutionChange);
             }
-            if (getMediaFamily(mediaType) === MediaFamily.Audio) {
-                this.sendSourceIndication(mediaType, +event.isPublished);
-            }
-            else {
-                const sources = this.getVideoSources(mediaType);
-                if (sources != null) {
-                    this.sendSourceIndication(mediaType, +event.isPublished, sources);
-                }
+            if (!track.muted) {
+                this.maybeSendSourceIndication(mediaType);
             }
         };
         track.on(LocalTrack.Events.PublishedStateUpdate, onTrackPublish);
@@ -10365,7 +10416,7 @@ class MultistreamConnection extends EventEmitter {
     }
     renewPeerConnection(userOptions) {
         if (userOptions) {
-            this.options = Object.assign(Object.assign({}, defaultMultistreamConnectionOptions), userOptions);
+            this.options = Object.assign(Object.assign({}, this.options), userOptions);
         }
         logger.info(`Renewing multistream connection with options ${JSON.stringify(this.options)}`);
         this.clearMids();