@stream-io/video-client 1.13.0 → 1.14.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.14.0](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.13.1...@stream-io/video-client-1.14.0) (2025-01-02)
+
+
+### Features
+
+* **closed captions:** Integration in the SDKs ([#1508](https://github.com/GetStream/stream-video-js/issues/1508)) ([bcb8589](https://github.com/GetStream/stream-video-js/commit/bcb85892c0dafcb03f9debf8d2fd361622224166))
+
+## [1.13.1](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.13.0...@stream-io/video-client-1.13.1) (2024-12-20)
+
+
+### Bug Fixes
+
+* **client:** fix the initial value of deviceState in clientDetails ([#1629](https://github.com/GetStream/stream-video-js/issues/1629)) ([afefb67](https://github.com/GetStream/stream-video-js/commit/afefb67a568899e2ce500e6dad36e64b6b0e5a3d))
+
 ## [1.13.0](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.12.4...@stream-io/video-client-1.13.0) (2024-12-20)
 
 

package/dist/index.browser.es.js

@@ -56,6 +56,48 @@ const ChannelConfigWithInfoBlocklistBehaviorEnum = {
     BLOCK: 'block',
     SHADOW_BLOCK: 'shadow_block',
 };
+/**
+ * All possibility of string to use
+ * @export
+ */
+const ChannelOwnCapability = {
+    BAN_CHANNEL_MEMBERS: 'ban-channel-members',
+    CAST_POLL_VOTE: 'cast-poll-vote',
+    CONNECT_EVENTS: 'connect-events',
+    CREATE_ATTACHMENT: 'create-attachment',
+    CREATE_CALL: 'create-call',
+    DELETE_ANY_MESSAGE: 'delete-any-message',
+    DELETE_CHANNEL: 'delete-channel',
+    DELETE_OWN_MESSAGE: 'delete-own-message',
+    FLAG_MESSAGE: 'flag-message',
+    FREEZE_CHANNEL: 'freeze-channel',
+    JOIN_CALL: 'join-call',
+    JOIN_CHANNEL: 'join-channel',
+    LEAVE_CHANNEL: 'leave-channel',
+    MUTE_CHANNEL: 'mute-channel',
+    PIN_MESSAGE: 'pin-message',
+    QUERY_POLL_VOTES: 'query-poll-votes',
+    QUOTE_MESSAGE: 'quote-message',
+    READ_EVENTS: 'read-events',
+    SEARCH_MESSAGES: 'search-messages',
+    SEND_CUSTOM_EVENTS: 'send-custom-events',
+    SEND_LINKS: 'send-links',
+    SEND_MESSAGE: 'send-message',
+    SEND_POLL: 'send-poll',
+    SEND_REACTION: 'send-reaction',
+    SEND_REPLY: 'send-reply',
+    SEND_TYPING_EVENTS: 'send-typing-events',
+    SET_CHANNEL_COOLDOWN: 'set-channel-cooldown',
+    SKIP_SLOW_MODE: 'skip-slow-mode',
+    SLOW_MODE: 'slow-mode',
+    TYPING_EVENTS: 'typing-events',
+    UPDATE_ANY_MESSAGE: 'update-any-message',
+    UPDATE_CHANNEL: 'update-channel',
+    UPDATE_CHANNEL_MEMBERS: 'update-channel-members',
+    UPDATE_OWN_MESSAGE: 'update-own-message',
+    UPDATE_THREAD: 'update-thread',
+    UPLOAD_FILE: 'upload-file',
+};
 /**
  * @export
  */
@@ -95,9 +137,11 @@ const OwnCapability = {
     SEND_AUDIO: 'send-audio',
     SEND_VIDEO: 'send-video',
     START_BROADCAST_CALL: 'start-broadcast-call',
+    START_CLOSED_CAPTIONS_CALL: 'start-closed-captions-call',
     START_RECORD_CALL: 'start-record-call',
     START_TRANSCRIPTION_CALL: 'start-transcription-call',
     STOP_BROADCAST_CALL: 'stop-broadcast-call',
+    STOP_CLOSED_CAPTIONS_CALL: 'stop-closed-captions-call',
     STOP_RECORD_CALL: 'stop-record-call',
     STOP_TRANSCRIPTION_CALL: 'stop-transcription-call',
     UPDATE_CALL: 'update-call',
@@ -128,6 +172,14 @@ const RecordSettingsRequestQualityEnum = {
     PORTRAIT_1080X1920: 'portrait-1080x1920',
     PORTRAIT_1440X2560: 'portrait-1440x2560',
 };
+/**
+ * @export
+ */
+const TranscriptionSettingsRequestClosedCaptionModeEnum = {
+    AVAILABLE: 'available',
+    DISABLED: 'disabled',
+    AUTO_ON: 'auto-on',
+};
 /**
  * @export
  */
@@ -136,6 +188,14 @@ const TranscriptionSettingsRequestModeEnum = {
     DISABLED: 'disabled',
     AUTO_ON: 'auto-on',
 };
+/**
+ * @export
+ */
+const TranscriptionSettingsResponseClosedCaptionModeEnum = {
+    AVAILABLE: 'available',
+    DISABLED: 'disabled',
+    AUTO_ON: 'auto-on',
+};
 /**
  * @export
  */
@@ -3299,7 +3359,7 @@ const retryable = async (rpc, signal) => {
     return result;
 };
 
-const version = "1.13.0";
+const version = "1.14.0";
 const [major, minor, patch] = version.split('.');
 let sdkInfo = {
     type: SdkType.PLAIN_JAVASCRIPT,
@@ -3310,7 +3370,7 @@ let sdkInfo = {
 let osInfo;
 let deviceInfo;
 let webRtcInfo;
-let deviceState;
+let deviceState = { oneofKind: undefined };
 const setSdkInfo = (info) => {
     sdkInfo = info;
 };
@@ -4101,6 +4161,24 @@ const setCurrentValue = (subject, update) => {
     subject.next(next);
     return next;
 };
+/**
+ * Updates the value of the provided Subject and returns the previous value
+ * and a function to roll back the update.
+ * This is useful when you want to optimistically update a value
+ * and roll back the update if an error occurs.
+ *
+ * @param subject the subject to update.
+ * @param update the update to apply to the subject.
+ */
+const updateValue = (subject, update) => {
+    const lastValue = subject.getValue();
+    const value = setCurrentValue(subject, update);
+    return {
+        lastValue,
+        value,
+        rollback: () => setCurrentValue(subject, lastValue),
+    };
+};
 /**
  * Creates a subscription and returns a function to unsubscribe.
  *
@@ -4134,7 +4212,8 @@ var rxUtils = /*#__PURE__*/Object.freeze({
     createSafeAsyncSubscription: createSafeAsyncSubscription,
     createSubscription: createSubscription,
     getCurrentValue: getCurrentValue,
-    setCurrentValue: setCurrentValue
+    setCurrentValue: setCurrentValue,
+    updateValue: updateValue
 });
 
 /**
@@ -4581,6 +4660,7 @@ class CallState {
         this.sessionSubject = new BehaviorSubject(undefined);
         this.settingsSubject = new BehaviorSubject(undefined);
         this.transcribingSubject = new BehaviorSubject(false);
+        this.captioningSubject = new BehaviorSubject(false);
         this.endedBySubject = new BehaviorSubject(undefined);
         this.thumbnailsSubject = new BehaviorSubject(undefined);
         this.membersSubject = new BehaviorSubject([]);
@@ -4591,6 +4671,7 @@ class CallState {
         this.anonymousParticipantCountSubject = new BehaviorSubject(0);
         this.participantsSubject = new BehaviorSubject([]);
         this.callStatsReportSubject = new BehaviorSubject(undefined);
+        this.closedCaptionsSubject = new BehaviorSubject([]);
         // These are tracks that were delivered to the Subscriber's onTrack event
         // that we couldn't associate with a participant yet.
         // This happens when the participantJoined event hasn't been received yet.
@@ -4599,10 +4680,18 @@ class CallState {
         this.logger = getLogger(['CallState']);
         /**
          * A list of comparators that are used to sort the participants.
-         *
-         * @private
          */
         this.sortParticipantsBy = defaultSortPreset;
+        this.closedCaptionsTasks = new Map();
+        /**
+         * Runs the cleanup tasks.
+         */
+        this.dispose = () => {
+            for (const [ccKey, taskId] of this.closedCaptionsTasks.entries()) {
+                clearTimeout(taskId);
+                this.closedCaptionsTasks.delete(ccKey);
+            }
+        };
         /**
          * Sets the list of criteria that are used to sort the participants.
          * To disable sorting, you can pass `noopComparator()`.
@@ -4651,6 +4740,15 @@ class CallState {
         this.setStartedAt = (startedAt) => {
             return this.setCurrentValue(this.startedAtSubject, startedAt);
         };
+        /**
+         * Sets the closed captioning state of the current call.
+         *
+         * @internal
+         * @param captioning the closed captioning state.
+         */
+        this.setCaptioning = (captioning) => {
+            return updateValue(this.captioningSubject, captioning);
+        };
         /**
          * Sets the number of anonymous participants in the current call.
          *
@@ -4749,7 +4847,6 @@ class CallState {
             }
             const thePatch = typeof patch === 'function' ? patch(participant) : patch;
             const updatedParticipant = {
-                // FIXME OL: this is not a deep merge, we might want to revisit this
                 ...participant,
                 ...thePatch,
             };
@@ -4811,7 +4908,6 @@ class CallState {
          *
          * @param trackType the kind of subscription to update.
          * @param changes the list of subscription changes to do.
-         * @param type the debounce type to use for the update.
          */
         this.updateParticipantTracks = (trackType, changes) => {
             return this.updateParticipants(Object.entries(changes).reduce((acc, [sessionId, change]) => {
@@ -4914,6 +5010,14 @@ class CallState {
             }
             return orphans;
         };
+        /**
+         * Updates the closed captions settings.
+         *
+         * @param config the new closed captions settings.
+         */
+        this.updateClosedCaptionSettings = (config) => {
+            this.closedCaptionsSettings = { ...this.closedCaptionsSettings, ...config };
+        };
         /**
          * Updates the call state with the data received from the server.
          *
@@ -4937,6 +5041,7 @@ class CallState {
             this.updateParticipantCountFromSession(s);
             this.setCurrentValue(this.settingsSubject, call.settings);
             this.setCurrentValue(this.transcribingSubject, call.transcribing);
+            this.setCurrentValue(this.captioningSubject, call.captioning);
             this.setCurrentValue(this.thumbnailsSubject, call.thumbnails);
         };
         /**
@@ -5128,6 +5233,35 @@ class CallState {
                 this.setCurrentValue(this.ownCapabilitiesSubject, event.own_capabilities);
             }
         };
+        this.updateFromClosedCaptions = (event) => {
+            this.setCurrentValue(this.closedCaptionsSubject, (queue) => {
+                const { closed_caption } = event;
+                const keyOf = (c) => `${c.speaker_id}/${c.start_time}`;
+                const currentKey = keyOf(closed_caption);
+                const duplicate = queue.some((caption) => keyOf(caption) === currentKey);
+                if (duplicate)
+                    return queue;
+                const nextQueue = [...queue, closed_caption];
+                const { visibilityDurationMs = 2700, maxVisibleCaptions = 2 } = this.closedCaptionsSettings || {};
+                // schedule the removal of the closed caption after the retention time
+                if (visibilityDurationMs > 0) {
+                    const taskId = setTimeout(() => {
+                        this.setCurrentValue(this.closedCaptionsSubject, (captions) => captions.filter((caption) => caption !== closed_caption));
+                        this.closedCaptionsTasks.delete(currentKey);
+                    }, visibilityDurationMs);
+                    this.closedCaptionsTasks.set(currentKey, taskId);
+                    // cancel the cleanup tasks for the closed captions that are no longer in the queue
+                    for (let i = 0; i < nextQueue.length - maxVisibleCaptions; i++) {
+                        const key = keyOf(nextQueue[i]);
+                        const task = this.closedCaptionsTasks.get(key);
+                        clearTimeout(task);
+                        this.closedCaptionsTasks.delete(key);
+                    }
+                }
+                // trim the queue
+                return nextQueue.slice(-maxVisibleCaptions);
+            });
+        };
         this.participants$ = this.participantsSubject.asObservable().pipe(
         // maintain stable-sort by mutating the participants stored
         // in the original subject
@@ -5154,6 +5288,7 @@ class CallState {
         this.settings$ = this.settingsSubject.asObservable();
         this.endedBy$ = this.endedBySubject.asObservable();
         this.thumbnails$ = this.thumbnailsSubject.asObservable();
+        this.closedCaptions$ = this.closedCaptionsSubject.asObservable();
         /**
          * Performs shallow comparison of two arrays.
          * Expects primitive values: [1, 2, 3] is equal to [2, 1, 3].
@@ -5183,9 +5318,9 @@ class CallState {
         this.participantCount$ = duc(this.participantCountSubject);
         this.recording$ = duc(this.recordingSubject);
         this.transcribing$ = duc(this.transcribingSubject);
+        this.captioning$ = duc(this.captioningSubject);
         this.eventHandlers = {
             // these events are not updating the call state:
-            'call.closed_caption': undefined,
             'call.deleted': undefined,
             'call.permission_request': undefined,
             'call.recording_ready': undefined,
@@ -5206,6 +5341,16 @@ class CallState {
             // events that update call state:
             'call.accepted': (e) => this.updateFromCallResponse(e.call),
             'call.blocked_user': this.blockUser,
+            'call.closed_caption': this.updateFromClosedCaptions,
+            'call.closed_captions_failed': () => {
+                this.setCurrentValue(this.captioningSubject, false);
+            },
+            'call.closed_captions_started': () => {
+                this.setCurrentValue(this.captioningSubject, true);
+            },
+            'call.closed_captions_stopped': () => {
+                this.setCurrentValue(this.captioningSubject, false);
+            },
             'call.created': (e) => this.updateFromCallResponse(e.call),
             'call.ended': (e) => {
                 this.updateFromCallResponse(e.call);
@@ -5263,6 +5408,12 @@ class CallState {
     get startedAt() {
         return this.getCurrentValue(this.startedAt$);
     }
+    /**
+     * Returns whether closed captions are enabled in the current call.
+     */
+    get captioning() {
+        return this.getCurrentValue(this.captioning$);
+    }
     /**
      * The server-side counted number of anonymous participants connected to the current call.
      * This number includes the anonymous participants as well.
@@ -5426,6 +5577,12 @@ class CallState {
     get thumbnails() {
         return this.getCurrentValue(this.thumbnails$);
     }
+    /**
+     * Returns the current queue of closed captions.
+     */
+    get closedCaptions() {
+        return this.getCurrentValue(this.closedCaptions$);
+    }
 }
 
 const getRtpMap = (line) => {
@@ -10203,6 +10360,7 @@ class Call {
                 this.sfuClient = undefined;
                 this.dynascaleManager.setSfuClient(undefined);
                 this.state.setCallingState(CallingState.LEFT);
+                this.state.dispose();
                 // Call all leave call hooks, e.g. to clean up global event handlers
                 this.leaveCallHooks.forEach((hook) => hook());
                 this.initialized = false;
@@ -11160,7 +11318,43 @@ class Call {
             return this.streamClient.post(`${this.streamClientBasePath}/stop_transcription`);
         };
         /**
-         * Sends a `call.permission_request` event to all users connected to the call. The call settings object contains infomration about which permissions can be requested during a call (for example a user might be allowed to request permission to publish audio, but not video).
+         * Starts the closed captions of the call.
+         */
+        this.startClosedCaptions = async (options) => {
+            const trx = this.state.setCaptioning(true); // optimistic update
+            try {
+                return await this.streamClient.post(`${this.streamClientBasePath}/start_closed_captions`, options);
+            }
+            catch (err) {
+                trx.rollback(); // revert the optimistic update
+                throw err;
+            }
+        };
+        /**
+         * Stops the closed captions of the call.
+         */
+        this.stopClosedCaptions = async (options) => {
+            const trx = this.state.setCaptioning(false); // optimistic update
+            try {
+                return await this.streamClient.post(`${this.streamClientBasePath}/stop_closed_captions`, options);
+            }
+            catch (err) {
+                trx.rollback(); // revert the optimistic update
+                throw err;
+            }
+        };
+        /**
+         * Updates the closed caption settings.
+         *
+         * @param config the closed caption settings to apply
+         */
+        this.updateClosedCaptionSettings = (config) => {
+            this.state.updateClosedCaptionSettings(config);
+        };
+        /**
+         * Sends a `call.permission_request` event to all users connected to the call.
+         * The call settings object contains information about which permissions can be requested during a call
+         * (for example, a user might be allowed to request permission to publish audio, but not video).
          */
         this.requestPermissions = async (data) => {
             const { permissions } = data;
@@ -12894,7 +13088,7 @@ class StreamClient {
             return await this.wsConnection.connect(this.defaultWSTimeout);
         };
         this.getUserAgent = () => {
-            const version = "1.13.0";
+            const version = "1.14.0";
             return (this.userAgent ||
                 `stream-video-javascript-client-${this.node ? 'node' : 'browser'}-${version}`);
         };
@@ -13403,5 +13597,5 @@ class StreamVideoClient {
 }
 StreamVideoClient._instanceMap = new Map();
 
-export { AudioSettingsRequestDefaultDeviceEnum, AudioSettingsResponseDefaultDeviceEnum, BlockListOptionsBehaviorEnum, browsers as Browsers, Call, CallState, CallType, CallTypes, CallingState, CameraManager, CameraManagerState, ChannelConfigWithInfoAutomodBehaviorEnum, ChannelConfigWithInfoAutomodEnum, ChannelConfigWithInfoBlocklistBehaviorEnum, CreateDeviceRequestPushProviderEnum, DebounceType, DynascaleManager, ErrorFromResponse, InputMediaDeviceManager, InputMediaDeviceManagerState, MicrophoneManager, MicrophoneManagerState, NoiseCancellationSettingsModeEnum, OwnCapability, RecordSettingsRequestModeEnum, RecordSettingsRequestQualityEnum, rxUtils as RxUtils, ScreenShareManager, ScreenShareState, events as SfuEvents, models as SfuModels, SpeakerManager, SpeakerState, StreamSfuClient, StreamVideoClient, StreamVideoReadOnlyStateStore, StreamVideoWriteableStateStore, TranscriptionSettingsRequestModeEnum, TranscriptionSettingsResponseModeEnum, VideoSettingsRequestCameraFacingEnum, VideoSettingsResponseCameraFacingEnum, ViewportTracker, VisibilityState, checkIfAudioOutputChangeSupported, combineComparators, conditional, createSoundDetector, defaultSortPreset, descending, deviceIds$, disposeOfMediaStream, dominantSpeaker, getAudioBrowserPermission, getAudioDevices, getAudioOutputDevices, getAudioStream, getClientDetails, getDeviceInfo, getDeviceState, getLogLevel, getLogger, getOSInfo, getScreenShareStream, getSdkInfo, getVideoBrowserPermission, getVideoDevices, getVideoStream, getWebRTCInfo, hasAudio, hasScreenShare, hasScreenShareAudio, hasVideo, isPinned, livestreamOrAudioRoomSortPreset, logLevels, logToConsole, name, noopComparator, paginatedLayoutSortPreset, pinned, publishingAudio, publishingVideo, reactionType, role, screenSharing, setDeviceInfo, setLogLevel, setLogger, setOSInfo, setPowerState, setSdkInfo, setThermalState, setWebRTCInfo, speakerLayoutSortPreset, speaking };
+export { AudioSettingsRequestDefaultDeviceEnum, AudioSettingsResponseDefaultDeviceEnum, BlockListOptionsBehaviorEnum, browsers as Browsers, Call, CallState, CallType, CallTypes, CallingState, CameraManager, CameraManagerState, ChannelConfigWithInfoAutomodBehaviorEnum, ChannelConfigWithInfoAutomodEnum, ChannelConfigWithInfoBlocklistBehaviorEnum, ChannelOwnCapability, CreateDeviceRequestPushProviderEnum, DebounceType, DynascaleManager, ErrorFromResponse, InputMediaDeviceManager, InputMediaDeviceManagerState, MicrophoneManager, MicrophoneManagerState, NoiseCancellationSettingsModeEnum, OwnCapability, RecordSettingsRequestModeEnum, RecordSettingsRequestQualityEnum, rxUtils as RxUtils, ScreenShareManager, ScreenShareState, events as SfuEvents, models as SfuModels, SpeakerManager, SpeakerState, StreamSfuClient, StreamVideoClient, StreamVideoReadOnlyStateStore, StreamVideoWriteableStateStore, TranscriptionSettingsRequestClosedCaptionModeEnum, TranscriptionSettingsRequestModeEnum, TranscriptionSettingsResponseClosedCaptionModeEnum, TranscriptionSettingsResponseModeEnum, VideoSettingsRequestCameraFacingEnum, VideoSettingsResponseCameraFacingEnum, ViewportTracker, VisibilityState, checkIfAudioOutputChangeSupported, combineComparators, conditional, createSoundDetector, defaultSortPreset, descending, deviceIds$, disposeOfMediaStream, dominantSpeaker, getAudioBrowserPermission, getAudioDevices, getAudioOutputDevices, getAudioStream, getClientDetails, getDeviceInfo, getDeviceState, getLogLevel, getLogger, getOSInfo, getScreenShareStream, getSdkInfo, getVideoBrowserPermission, getVideoDevices, getVideoStream, getWebRTCInfo, hasAudio, hasScreenShare, hasScreenShareAudio, hasVideo, isPinned, livestreamOrAudioRoomSortPreset, logLevels, logToConsole, name, noopComparator, paginatedLayoutSortPreset, pinned, publishingAudio, publishingVideo, reactionType, role, screenSharing, setDeviceInfo, setLogLevel, setLogger, setOSInfo, setPowerState, setSdkInfo, setThermalState, setWebRTCInfo, speakerLayoutSortPreset, speaking };
 //# sourceMappingURL=index.browser.es.js.map