@stream-io/video-client 0.7.7 → 0.7.8

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+### [0.7.8](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-0.7.7...@stream-io/video-client-0.7.8) (2024-04-25)
+
+
+### Features
+
+* Noise Cancellation ([#1321](https://github.com/GetStream/stream-video-js/issues/1321)) ([9144385](https://github.com/GetStream/stream-video-js/commit/91443852986ad7453d82efb900626266d8df0e96))
+
 ### [0.7.7](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-0.7.6...@stream-io/video-client-0.7.7) (2024-04-23)
 
 

package/dist/index.browser.es.js

@@ -33,6 +33,22 @@ const CreateDeviceRequestPushProviderEnum = {
     HUAWEI: 'huawei',
     XIAOMI: 'xiaomi',
 };
+/**
+ * @export
+ */
+const NoiseCancellationSettingsModeEnum = {
+    AVAILABLE: 'available',
+    DISABLED: 'disabled',
+    AUTO_ON: 'auto-on',
+};
+/**
+ * @export
+ */
+const NoiseCancellationSettingsRequestModeEnum = {
+    AVAILABLE: 'available',
+    DISABLED: 'disabled',
+    AUTO_ON: 'auto-on',
+};
 /**
  * All possibility of string to use
  * @export
@@ -41,6 +57,7 @@ const OwnCapability = {
     BLOCK_USERS: 'block-users',
     CREATE_CALL: 'create-call',
     CREATE_REACTION: 'create-reaction',
+    ENABLE_NOISE_CANCELLATION: 'enable-noise-cancellation',
     END_CALL: 'end-call',
     JOIN_BACKSTAGE: 'join-backstage',
     JOIN_CALL: 'join-call',
@@ -2422,10 +2439,196 @@ var models = /*#__PURE__*/Object.freeze({
 });
 
 /* eslint-disable */
-// @generated by protobuf-ts 2.9.3 with parameter long_type_string,client_generic,server_none,eslint_disable
+// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable
 // @generated from protobuf file "video/sfu/signal_rpc/signal.proto" (package "stream.video.sfu.signal", syntax proto3)
 // tslint:disable
 // @generated message type with reflection information, may provide speed optimized methods
+class StartNoiseCancellationRequest$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.StartNoiseCancellationRequest', [
+            { no: 1, name: 'session_id', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+        ]);
+    }
+    create(value) {
+        const message = globalThis.Object.create(this.messagePrototype);
+        message.sessionId = '';
+        if (value !== undefined)
+            reflectionMergePartial(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader, length, options, target) {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* string session_id */ 1:
+                    message.sessionId = reader.string();
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === 'throw')
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message, writer, options) {
+        /* string session_id = 1; */
+        if (message.sessionId !== '')
+            writer.tag(1, WireType.LengthDelimited).string(message.sessionId);
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.StartNoiseCancellationRequest
+ */
+const StartNoiseCancellationRequest = new StartNoiseCancellationRequest$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class StartNoiseCancellationResponse$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.StartNoiseCancellationResponse', [
+            { no: 1, name: 'error', kind: 'message', T: () => Error$2 },
+        ]);
+    }
+    create(value) {
+        const message = globalThis.Object.create(this.messagePrototype);
+        if (value !== undefined)
+            reflectionMergePartial(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader, length, options, target) {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* stream.video.sfu.models.Error error */ 1:
+                    message.error = Error$2.internalBinaryRead(reader, reader.uint32(), options, message.error);
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === 'throw')
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message, writer, options) {
+        /* stream.video.sfu.models.Error error = 1; */
+        if (message.error)
+            Error$2.internalBinaryWrite(message.error, writer.tag(1, WireType.LengthDelimited).fork(), options).join();
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.StartNoiseCancellationResponse
+ */
+const StartNoiseCancellationResponse = new StartNoiseCancellationResponse$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class StopNoiseCancellationRequest$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.StopNoiseCancellationRequest', [
+            { no: 1, name: 'session_id', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+        ]);
+    }
+    create(value) {
+        const message = globalThis.Object.create(this.messagePrototype);
+        message.sessionId = '';
+        if (value !== undefined)
+            reflectionMergePartial(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader, length, options, target) {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* string session_id */ 1:
+                    message.sessionId = reader.string();
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === 'throw')
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message, writer, options) {
+        /* string session_id = 1; */
+        if (message.sessionId !== '')
+            writer.tag(1, WireType.LengthDelimited).string(message.sessionId);
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.StopNoiseCancellationRequest
+ */
+const StopNoiseCancellationRequest = new StopNoiseCancellationRequest$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class StopNoiseCancellationResponse$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.StopNoiseCancellationResponse', [
+            { no: 1, name: 'error', kind: 'message', T: () => Error$2 },
+        ]);
+    }
+    create(value) {
+        const message = globalThis.Object.create(this.messagePrototype);
+        if (value !== undefined)
+            reflectionMergePartial(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader, length, options, target) {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* stream.video.sfu.models.Error error */ 1:
+                    message.error = Error$2.internalBinaryRead(reader, reader.uint32(), options, message.error);
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === 'throw')
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message, writer, options) {
+        /* stream.video.sfu.models.Error error = 1; */
+        if (message.error)
+            Error$2.internalBinaryWrite(message.error, writer.tag(1, WireType.LengthDelimited).fork(), options).join();
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.StopNoiseCancellationResponse
+ */
+const StopNoiseCancellationResponse = new StopNoiseCancellationResponse$Type();
+// @generated message type with reflection information, may provide speed optimized methods
 class SendStatsRequest$Type extends MessageType {
     constructor() {
         super('stream.video.sfu.signal.SendStatsRequest', [
@@ -3475,6 +3678,18 @@ const SignalServer = new ServiceType('stream.video.sfu.signal.SignalServer', [
         I: SendStatsRequest,
         O: SendStatsResponse,
     },
+    {
+        name: 'StartNoiseCancellation',
+        options: {},
+        I: StartNoiseCancellationRequest,
+        O: StartNoiseCancellationResponse,
+    },
+    {
+        name: 'StopNoiseCancellation',
+        options: {},
+        I: StopNoiseCancellationRequest,
+        O: StopNoiseCancellationResponse,
+    },
 ]);
 
 /**
@@ -5777,6 +5992,20 @@ class SignalServerClient {
         const method = this.methods[6], opt = this._transport.mergeOptions(options);
         return stackIntercept('unary', this._transport, method, opt, input);
     }
+    /**
+     * @generated from protobuf rpc: StartNoiseCancellation(stream.video.sfu.signal.StartNoiseCancellationRequest) returns (stream.video.sfu.signal.StartNoiseCancellationResponse);
+     */
+    startNoiseCancellation(input, options) {
+        const method = this.methods[7], opt = this._transport.mergeOptions(options);
+        return stackIntercept('unary', this._transport, method, opt, input);
+    }
+    /**
+     * @generated from protobuf rpc: StopNoiseCancellation(stream.video.sfu.signal.StopNoiseCancellationRequest) returns (stream.video.sfu.signal.StopNoiseCancellationResponse);
+     */
+    stopNoiseCancellation(input, options) {
+        const method = this.methods[8], opt = this._transport.mergeOptions(options);
+        return stackIntercept('unary', this._transport, method, opt, input);
+    }
 }
 
 const defaultOptions = {
@@ -8674,6 +8903,16 @@ class StreamSfuClient {
                 sessionId: this.sessionId,
             }), this.logger);
         };
+        this.startNoiseCancellation = async () => {
+            return retryable(() => this.rpc.startNoiseCancellation({
+                sessionId: this.sessionId,
+            }), this.logger);
+        };
+        this.stopNoiseCancellation = async () => {
+            return retryable(() => this.rpc.stopNoiseCancellation({
+                sessionId: this.sessionId,
+            }), this.logger);
+        };
         this.join = async (data) => {
             const joinRequest = JoinRequest.create({
                 ...data,
@@ -11006,7 +11245,9 @@ const createSoundDetector = (audioStream, onSoundDetectedStateChanged, options =
         // clean-up the AudioContext elements
         microphone.disconnect();
         analyser.disconnect();
-        await audioContext.close();
+        if (audioContext.state !== 'closed') {
+            await audioContext.close();
+        }
         // stop the stream
         if (destroyStreamOnStop) {
             audioStream.getTracks().forEach((track) => {
@@ -11137,6 +11378,99 @@ class MicrophoneManager extends InputMediaDeviceManager {
                 await this.stopSpeakingWhileMutedDetection();
             }
         });
+        this.subscriptions.push(createSubscription(this.call.state.callingState$, (callingState) => {
+            // do nothing when noise filtering isn't turned on
+            if (!this.noiseCancellationRegistration || !this.noiseCancellation)
+                return;
+            const autoOn = this.call.state.settings?.audio.noise_cancellation?.mode ===
+                NoiseCancellationSettingsModeEnum.AUTO_ON;
+            if (autoOn && callingState === CallingState.JOINED) {
+                this.noiseCancellationRegistration
+                    .then(() => this.noiseCancellation?.enable())
+                    .catch((err) => {
+                    this.logger('warn', `Failed to enable noise cancellation`, err);
+                    return this.call.notifyNoiseCancellationStopped();
+                });
+            }
+            else if (callingState === CallingState.LEFT) {
+                this.noiseCancellationRegistration
+                    .then(() => this.noiseCancellation?.disable())
+                    .catch((err) => {
+                    this.logger('warn', `Failed to disable noise cancellation`, err);
+                });
+            }
+        }));
+    }
+    /**
+     * Enables noise cancellation for the microphone.
+     *
+     * Note: not supported in React Native.
+     * @param noiseCancellation - a noise cancellation instance to use.
+     */
+    async enableNoiseCancellation(noiseCancellation) {
+        if (isReactNative()) {
+            throw new Error('Noise cancellation is not supported in React Native');
+        }
+        const { ownCapabilities, settings } = this.call.state;
+        const hasNoiseCancellationCapability = ownCapabilities.includes(OwnCapability.ENABLE_NOISE_CANCELLATION);
+        if (!hasNoiseCancellationCapability) {
+            throw new Error('Noise cancellation is not available.');
+        }
+        const noiseCancellationSettings = settings?.audio.noise_cancellation;
+        if (!noiseCancellationSettings ||
+            noiseCancellationSettings.mode ===
+                NoiseCancellationSettingsModeEnum.DISABLED) {
+            throw new Error('Noise cancellation is disabled for this call type.');
+        }
+        try {
+            this.noiseCancellation = noiseCancellation;
+            // listen for change events and notify the SFU
+            this.noiseCancellationChangeUnsubscribe = this.noiseCancellation.on('change', (enabled) => {
+                if (enabled) {
+                    this.call.notifyNoiseCancellationStarting().catch((err) => {
+                        this.logger('warn', `notifyNoiseCancellationStart failed`, err);
+                    });
+                }
+                else {
+                    this.call.notifyNoiseCancellationStopped().catch((err) => {
+                        this.logger('warn', `notifyNoiseCancellationStop failed`, err);
+                    });
+                }
+            });
+            this.noiseCancellationRegistration = this.registerFilter(noiseCancellation.toFilter());
+            await this.noiseCancellationRegistration;
+            // handles an edge case where a noise cancellation is enabled after
+            // the participant as joined the call -> we immediately enable NC
+            if (noiseCancellationSettings.mode ===
+                NoiseCancellationSettingsModeEnum.AUTO_ON &&
+                this.call.state.callingState === CallingState.JOINED) {
+                noiseCancellation.enable();
+            }
+        }
+        catch (e) {
+            this.logger('warn', 'Failed to enable noise cancellation', e);
+            await this.disableNoiseCancellation().catch((err) => {
+                this.logger('warn', 'Failed to disable noise cancellation', err);
+            });
+        }
+    }
+    /**
+     * Disables noise cancellation for the microphone.
+     *
+     * Note: not supported in React Native.
+     */
+    async disableNoiseCancellation() {
+        if (isReactNative()) {
+            throw new Error('Noise cancellation is not supported in React Native');
+        }
+        await this.noiseCancellationRegistration
+            ?.then((unregister) => unregister())
+            .then(() => this.noiseCancellation?.disable())
+            .then(() => this.noiseCancellationChangeUnsubscribe?.())
+            .catch((err) => {
+            this.logger('warn', 'Failed to unregister noise cancellation', err);
+        });
+        await this.call.notifyNoiseCancellationStopped();
     }
     getDevices() {
         return getAudioDevices();
@@ -12163,6 +12497,26 @@ class Call {
             this.logger('info', `stopPublish ${TrackType[trackType]}, stop tracks: ${stopTrack}`);
             await this.publisher?.unpublishStream(trackType, stopTrack);
         };
+        /**
+         * Notifies the SFU that a noise cancellation process has started.
+         *
+         * @internal
+         */
+        this.notifyNoiseCancellationStarting = async () => {
+            return this.sfuClient?.startNoiseCancellation().catch((err) => {
+                this.logger('warn', 'Failed to notify start of noise cancellation', err);
+            });
+        };
+        /**
+         * Notifies the SFU that a noise cancellation process has stopped.
+         *
+         * @internal
+         */
+        this.notifyNoiseCancellationStopped = async () => {
+            return this.sfuClient?.stopNoiseCancellation().catch((err) => {
+                this.logger('warn', 'Failed to notify stop of noise cancellation', err);
+            });
+        };
         /**
          * Update track subscription configuration for one or more participants.
          * You have to create a subscription for each participant for all the different kinds of tracks you want to receive.
@@ -14482,7 +14836,7 @@ class StreamClient {
             });
         };
         this.getUserAgent = () => {
-            const version = "0.7.7" ;
+            const version = "0.7.8" ;
             return (this.userAgent ||
                 `stream-video-javascript-client-${this.node ? 'node' : 'browser'}-${version}`);
         };
@@ -14958,5 +15312,5 @@ class StreamVideoClient {
     }
 }
 
-export { AudioSettingsDefaultDeviceEnum, AudioSettingsRequestDefaultDeviceEnum, browsers as Browsers, Call, CallState, CallType, CallTypes, CallingState, CameraManager, CameraManagerState, CreateDeviceRequestPushProviderEnum, DebounceType, DynascaleManager, ErrorFromResponse, InputMediaDeviceManager, InputMediaDeviceManagerState, MicrophoneManager, MicrophoneManagerState, OwnCapability, RecordSettingsRequestModeEnum, RecordSettingsRequestQualityEnum, rxUtils as RxUtils, ScreenShareManager, ScreenShareState, events as SfuEvents, models as SfuModels, SpeakerManager, SpeakerState, StreamSfuClient, StreamVideoClient, StreamVideoReadOnlyStateStore, StreamVideoWriteableStateStore, TranscriptionSettingsModeEnum, TranscriptionSettingsRequestModeEnum, VideoSettingsCameraFacingEnum, VideoSettingsRequestCameraFacingEnum, ViewportTracker, VisibilityState, checkIfAudioOutputChangeSupported, combineComparators, conditional, createSoundDetector, defaultSortPreset, descending, deviceIds$, disposeOfMediaStream, dominantSpeaker, getAudioDevices, getAudioOutputDevices, getAudioStream, getClientDetails, getDeviceInfo, getLogger, getOSInfo, getScreenShareStream, getSdkInfo, getVideoDevices, getVideoStream, getWebRTCInfo, livestreamOrAudioRoomSortPreset, logLevels, logToConsole, name, noopComparator, paginatedLayoutSortPreset, pinned, publishingAudio, publishingVideo, reactionType, role, screenSharing, setDeviceInfo, setLogLevel, setLogger, setOSInfo, setSdkInfo, setWebRTCInfo, speakerLayoutSortPreset, speaking };
+export { AudioSettingsDefaultDeviceEnum, AudioSettingsRequestDefaultDeviceEnum, browsers as Browsers, Call, CallState, CallType, CallTypes, CallingState, CameraManager, CameraManagerState, CreateDeviceRequestPushProviderEnum, DebounceType, DynascaleManager, ErrorFromResponse, InputMediaDeviceManager, InputMediaDeviceManagerState, MicrophoneManager, MicrophoneManagerState, NoiseCancellationSettingsModeEnum, NoiseCancellationSettingsRequestModeEnum, OwnCapability, RecordSettingsRequestModeEnum, RecordSettingsRequestQualityEnum, rxUtils as RxUtils, ScreenShareManager, ScreenShareState, events as SfuEvents, models as SfuModels, SpeakerManager, SpeakerState, StreamSfuClient, StreamVideoClient, StreamVideoReadOnlyStateStore, StreamVideoWriteableStateStore, TranscriptionSettingsModeEnum, TranscriptionSettingsRequestModeEnum, VideoSettingsCameraFacingEnum, VideoSettingsRequestCameraFacingEnum, ViewportTracker, VisibilityState, checkIfAudioOutputChangeSupported, combineComparators, conditional, createSoundDetector, defaultSortPreset, descending, deviceIds$, disposeOfMediaStream, dominantSpeaker, getAudioDevices, getAudioOutputDevices, getAudioStream, getClientDetails, getDeviceInfo, getLogger, getOSInfo, getScreenShareStream, getSdkInfo, getVideoDevices, getVideoStream, getWebRTCInfo, livestreamOrAudioRoomSortPreset, logLevels, logToConsole, name, noopComparator, paginatedLayoutSortPreset, pinned, publishingAudio, publishingVideo, reactionType, role, screenSharing, setDeviceInfo, setLogLevel, setLogger, setOSInfo, setSdkInfo, setWebRTCInfo, speakerLayoutSortPreset, speaking };
 //# sourceMappingURL=index.browser.es.js.map