@stream-io/video-client 0.3.19 → 0.3.21

package/dist/src/gen/coordinator/index.d.ts

@@ -810,7 +810,7 @@ export interface CallReactionEvent {
     type: string;
 }
 /**
- *
+ * CallRecording represents a recording of a call.
  * @export
  * @interface CallRecording
  */
@@ -840,6 +840,62 @@ export interface CallRecording {
      */
     url: string;
 }
+/**
+ * This event is sent when call recording has failed
+ * @export
+ * @interface CallRecordingFailedEvent
+ */
+export interface CallRecordingFailedEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CallRecordingFailedEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallRecordingFailedEvent
+     */
+    created_at: string;
+    /**
+     * The type of event: "call.recording_failed" in this case
+     * @type {string}
+     * @memberof CallRecordingFailedEvent
+     */
+    type: string;
+}
+/**
+ * This event is sent when call recording is ready
+ * @export
+ * @interface CallRecordingReadyEvent
+ */
+export interface CallRecordingReadyEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CallRecordingReadyEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {CallRecording}
+     * @memberof CallRecordingReadyEvent
+     */
+    call_recording: CallRecording;
+    /**
+     *
+     * @type {string}
+     * @memberof CallRecordingReadyEvent
+     */
+    created_at: string;
+    /**
+     * The type of event: "call.recording_ready" in this case
+     * @type {string}
+     * @memberof CallRecordingReadyEvent
+     */
+    type: string;
+}
 /**
  * This event is sent when call recording has started
  * @export
@@ -1493,12 +1549,6 @@ export interface CallSettingsResponse {
  * @interface CallStateResponseFields
  */
 export interface CallStateResponseFields {
-    /**
-     *
-     * @type {Array<UserResponse>}
-     * @memberof CallStateResponseFields
-     */
-    blocked_users: Array<UserResponse>;
     /**
      *
      * @type {CallResponse}
@@ -2242,12 +2292,6 @@ export interface GeofenceSettingsRequest {
  * @interface GetCallResponse
  */
 export interface GetCallResponse {
-    /**
-     *
-     * @type {Array<UserResponse>}
-     * @memberof GetCallResponse
-     */
-    blocked_users: Array<UserResponse>;
     /**
      *
      * @type {CallResponse}
@@ -2386,12 +2430,6 @@ export interface GetOrCreateCallRequest {
  * @interface GetOrCreateCallResponse
  */
 export interface GetOrCreateCallResponse {
-    /**
-     *
-     * @type {Array<UserResponse>}
-     * @memberof GetOrCreateCallResponse
-     */
-    blocked_users: Array<UserResponse>;
     /**
      *
      * @type {CallResponse}
@@ -2628,12 +2666,6 @@ export interface JoinCallRequest {
  * @interface JoinCallResponse
  */
 export interface JoinCallResponse {
-    /**
-     *
-     * @type {Array<UserResponse>}
-     * @memberof JoinCallResponse
-     */
-    blocked_users: Array<UserResponse>;
     /**
      *
      * @type {CallResponse}
@@ -4020,12 +4052,6 @@ export interface UpdateCallRequest {
  * @interface UpdateCallResponse
  */
 export interface UpdateCallResponse {
-    /**
-     *
-     * @type {Array<UserResponse>}
-     * @memberof UpdateCallResponse
-     */
-    blocked_users: Array<UserResponse>;
     /**
      *
      * @type {CallResponse}
@@ -4354,6 +4380,10 @@ export type VideoEvent = ({
 } & UpdatedCallPermissionsEvent) | ({
     type: 'call.reaction_new';
 } & CallReactionEvent) | ({
+    type: 'call.recording_failed';
+} & CallRecordingFailedEvent) | ({
+    type: 'call.recording_ready';
+} & CallRecordingReadyEvent) | ({
     type: 'call.recording_started';
 } & CallRecordingStartedEvent) | ({
     type: 'call.recording_stopped';

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.3.19";
+export declare const version = "0.3.21";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "0.3.19",
+  "version": "0.3.21",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/__tests__/server-side/call-types.test.ts

@@ -3,7 +3,11 @@ import { beforeAll, describe, expect, it } from 'vitest';
 import { StreamVideoServerClient } from '../../StreamVideoServerClient';
 import { generateUUIDv4 } from '../../coordinator/connection/utils';
 import { LogLevel } from '../../coordinator/connection/types';
-import { OwnCapability, RecordSettingsModeEnum } from '../../gen/coordinator';
+import {
+  OwnCapability,
+  RecordSettingsModeEnum,
+  RecordSettingsQualityEnum,
+} from '../../gen/coordinator';
 
 const apiKey = process.env.STREAM_API_KEY!;
 const secret = process.env.STREAM_SECRET!;
@@ -95,6 +99,9 @@ describe('call types CRUD API', () => {
         audio: { mic_default_on: false, default_device: 'earpiece' },
         recording: {
           mode: RecordSettingsModeEnum.DISABLED,
+          // FIXME OL: these props shouldn't be required to be set when recording is disabled
+          audio_only: false,
+          quality: RecordSettingsQualityEnum._1080P,
         },
       },
     });

package/src/__tests__/server-side/call.test.ts

@@ -122,6 +122,7 @@ describe('call API', () => {
           recording: {
             audio_only: false,
             quality: RecordSettingsRequestQualityEnum._1080P,
+            mode: RecordSettingsRequestModeEnum.AUTO_ON,
           },
         },
       });

package/src/gen/coordinator/index.ts

@@ -814,7 +814,7 @@ export interface CallReactionEvent {
   type: string;
 }
 /**
- *
+ * CallRecording represents a recording of a call.
  * @export
  * @interface CallRecording
  */
@@ -844,6 +844,62 @@ export interface CallRecording {
    */
   url: string;
 }
+/**
+ * This event is sent when call recording has failed
+ * @export
+ * @interface CallRecordingFailedEvent
+ */
+export interface CallRecordingFailedEvent {
+  /**
+   *
+   * @type {string}
+   * @memberof CallRecordingFailedEvent
+   */
+  call_cid: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallRecordingFailedEvent
+   */
+  created_at: string;
+  /**
+   * The type of event: "call.recording_failed" in this case
+   * @type {string}
+   * @memberof CallRecordingFailedEvent
+   */
+  type: string;
+}
+/**
+ * This event is sent when call recording is ready
+ * @export
+ * @interface CallRecordingReadyEvent
+ */
+export interface CallRecordingReadyEvent {
+  /**
+   *
+   * @type {string}
+   * @memberof CallRecordingReadyEvent
+   */
+  call_cid: string;
+  /**
+   *
+   * @type {CallRecording}
+   * @memberof CallRecordingReadyEvent
+   */
+  call_recording: CallRecording;
+  /**
+   *
+   * @type {string}
+   * @memberof CallRecordingReadyEvent
+   */
+  created_at: string;
+  /**
+   * The type of event: "call.recording_ready" in this case
+   * @type {string}
+   * @memberof CallRecordingReadyEvent
+   */
+  type: string;
+}
 /**
  * This event is sent when call recording has started
  * @export
@@ -1487,12 +1543,6 @@ export interface CallSettingsResponse {
  * @interface CallStateResponseFields
  */
 export interface CallStateResponseFields {
-  /**
-   *
-   * @type {Array<UserResponse>}
-   * @memberof CallStateResponseFields
-   */
-  blocked_users: Array<UserResponse>;
   /**
    *
    * @type {CallResponse}
@@ -2227,12 +2277,6 @@ export interface GeofenceSettingsRequest {
  * @interface GetCallResponse
  */
 export interface GetCallResponse {
-  /**
-   *
-   * @type {Array<UserResponse>}
-   * @memberof GetCallResponse
-   */
-  blocked_users: Array<UserResponse>;
   /**
    *
    * @type {CallResponse}
@@ -2369,12 +2413,6 @@ export interface GetOrCreateCallRequest {
  * @interface GetOrCreateCallResponse
  */
 export interface GetOrCreateCallResponse {
-  /**
-   *
-   * @type {Array<UserResponse>}
-   * @memberof GetOrCreateCallResponse
-   */
-  blocked_users: Array<UserResponse>;
   /**
    *
    * @type {CallResponse}
@@ -2611,12 +2649,6 @@ export interface JoinCallRequest {
  * @interface JoinCallResponse
  */
 export interface JoinCallResponse {
-  /**
-   *
-   * @type {Array<UserResponse>}
-   * @memberof JoinCallResponse
-   */
-  blocked_users: Array<UserResponse>;
   /**
    *
    * @type {CallResponse}
@@ -4001,12 +4033,6 @@ export interface UpdateCallRequest {
  * @interface UpdateCallResponse
  */
 export interface UpdateCallResponse {
-  /**
-   *
-   * @type {Array<UserResponse>}
-   * @memberof UpdateCallResponse
-   */
-  blocked_users: Array<UserResponse>;
   /**
    *
    * @type {CallResponse}
@@ -4314,6 +4340,8 @@ export type VideoEvent =
   | ({ type: 'call.permission_request' } & PermissionRequestEvent)
   | ({ type: 'call.permissions_updated' } & UpdatedCallPermissionsEvent)
   | ({ type: 'call.reaction_new' } & CallReactionEvent)
+  | ({ type: 'call.recording_failed' } & CallRecordingFailedEvent)
+  | ({ type: 'call.recording_ready' } & CallRecordingReadyEvent)
   | ({ type: 'call.recording_started' } & CallRecordingStartedEvent)
   | ({ type: 'call.recording_stopped' } & CallRecordingStoppedEvent)
   | ({ type: 'call.rejected' } & CallRejectedEvent)

package/src/helpers/DynascaleManager.ts

@@ -152,6 +152,14 @@ export class DynascaleManager {
       debounceType: DebounceType,
       dimension: VideoDimension | undefined,
     ) => {
+      if (dimension && (dimension.width === 0 || dimension.height === 0)) {
+        // ignore 0x0 dimensions. this can happen when the video element
+        // is not visible (e.g., has display: none).
+        // we treat this as "unsubscription" as we don't want to keep
+        // consuming bandwidth for a video that is not visible on the screen.
+        this.logger('debug', `Ignoring 0x0 dimension`, boundParticipant);
+        dimension = undefined;
+      }
       this.call.updateSubscriptionsPartial(
         trackType,
         { [sessionId]: { dimension } },
@@ -171,6 +179,12 @@ export class DynascaleManager {
       shareReplay(1),
     );
 
+    /**
+     * Since the video elements are now being removed from the DOM (React SDK) upon
+     * visibility change, this subscription is not in use an stays here only for the
+     * plain JS integrations where integrators might choose not to remove the video
+     * elements from the DOM.
+     */
     // keep copy for resize observer handler
     let viewportVisibilityState: VisibilityState | undefined;
     const viewportVisibilityStateSubscription =
@@ -231,6 +245,8 @@ export class DynascaleManager {
         });
     resizeObserver?.observe(videoElement);
 
+    // element renders and gets bound - track subscription gets
+    // triggered first other ones get skipped on initial subscriptions
     const publishedTracksSubscription = boundParticipant.isLocalParticipant
       ? null
       : participant$
@@ -248,13 +264,13 @@ export class DynascaleManager {
           .subscribe((isPublishing) => {
             if (isPublishing) {
               // the participant just started to publish a track
-              requestTrackWithDimensions(DebounceType.IMMEDIATE, {
+              requestTrackWithDimensions(DebounceType.FAST, {
                 width: videoElement.clientWidth,
                 height: videoElement.clientHeight,
               });
             } else {
               // the participant just stopped publishing a track
-              requestTrackWithDimensions(DebounceType.IMMEDIATE, undefined);
+              requestTrackWithDimensions(DebounceType.FAST, undefined);
             }
           });
 
@@ -286,7 +302,7 @@ export class DynascaleManager {
     videoElement.muted = true;
 
     return () => {
-      requestTrackWithDimensions(DebounceType.IMMEDIATE, undefined);
+      requestTrackWithDimensions(DebounceType.FAST, undefined);
       viewportVisibilityStateSubscription?.unsubscribe();
       publishedTracksSubscription?.unsubscribe();
       streamSubscription.unsubscribe();

package/src/helpers/__tests__/DynascaleManager.test.ts

@@ -4,7 +4,7 @@
 
 import '../../rtc/__tests__/mocks/webrtc.mocks';
 
-import { Mock, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, Mock, vi } from 'vitest';
 import { DynascaleManager } from '../DynascaleManager';
 import { Call } from '../../Call';
 import { StreamClient } from '../../coordinator/connection/client';
@@ -195,7 +195,7 @@ describe('DynascaleManager', () => {
       expect(updateSubscription).toHaveBeenCalledWith(
         'videoTrack',
         { 'session-id': { dimension: undefined } },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
 
       call.state.updateParticipant('session-id', {
@@ -212,7 +212,7 @@ describe('DynascaleManager', () => {
             },
           },
         },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
 
       call.state.updateParticipant('session-id', {
@@ -222,7 +222,7 @@ describe('DynascaleManager', () => {
       expect(updateSubscription).toHaveBeenCalledWith(
         'videoTrack',
         { 'session-id': { dimension: undefined } },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
 
       cleanup?.();
@@ -230,7 +230,7 @@ describe('DynascaleManager', () => {
       expect(updateSubscription).toHaveBeenCalledWith(
         'videoTrack',
         { 'session-id': { dimension: undefined } },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
     });
 
@@ -271,7 +271,7 @@ describe('DynascaleManager', () => {
             },
           },
         },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
       expect(play).toHaveBeenCalled();
       expect(videoElement.srcObject).toBe(mediaStream);
@@ -281,7 +281,7 @@ describe('DynascaleManager', () => {
       expect(updateSubscription).toHaveBeenCalledWith(
         'videoTrack',
         { 'session-id': { dimension: undefined } },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
     });
 
@@ -308,7 +308,7 @@ describe('DynascaleManager', () => {
       expect(updateSubscription).toHaveBeenCalledWith(
         'videoTrack',
         { 'session-id': { dimension: undefined } },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
 
       call.state.updateParticipant('session-id', {
@@ -369,7 +369,7 @@ describe('DynascaleManager', () => {
       expect(updateSubscription).toHaveBeenCalledWith(
         'videoTrack',
         { 'session-id': { dimension: undefined } },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
     });
 
@@ -417,7 +417,7 @@ describe('DynascaleManager', () => {
             },
           },
         },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
       );
 
       // @ts-ignore simulate resize
@@ -439,7 +439,47 @@ describe('DynascaleManager', () => {
       expect(updateSubscription).toHaveBeenCalledWith(
         'videoTrack',
         { 'session-id': { dimension: undefined } },
-        DebounceType.IMMEDIATE,
+        DebounceType.FAST,
+      );
+    });
+
+    it('video: should unsubscribe when element dimensions are zero', () => {
+      // @ts-ignore
+      call.state.updateOrAddParticipant('session-id', {
+        userId: 'user-id',
+        sessionId: 'session-id',
+        publishedTracks: [TrackType.VIDEO],
+        viewportVisibilityState: {
+          videoTrack: VisibilityState.VISIBLE,
+          screenShareTrack: VisibilityState.UNKNOWN,
+        },
+      });
+
+      let updateSubscription = vi.spyOn(call, 'updateSubscriptionsPartial');
+
+      // @ts-ignore simulate resize
+      videoElement.clientHeight = 0;
+      // @ts-ignore simulate resize
+      videoElement.clientWidth = 0;
+
+      const cleanup = dynascaleManager.bindVideoElement(
+        videoElement,
+        'session-id',
+        'videoTrack',
+      );
+
+      expect(updateSubscription).toHaveBeenCalledWith(
+        'videoTrack',
+        { 'session-id': { dimension: undefined } },
+        DebounceType.FAST,
+      );
+
+      cleanup?.();
+
+      expect(updateSubscription).toHaveBeenLastCalledWith(
+        'videoTrack',
+        { 'session-id': { dimension: undefined } },
+        DebounceType.FAST,
       );
     });
   });

package/src/store/CallState.ts

@@ -382,6 +382,8 @@ export class CallState {
       'connection.error': undefined,
       'connection.ok': undefined,
       'health.check': undefined,
+      'call.recording_failed': undefined,
+      'call.recording_ready': undefined,
       custom: undefined,
 
       // events that update call state: