@stream-io/video-client 1.28.1 → 1.30.0

package/dist/src/devices/InputMediaDeviceManager.d.ts

@@ -41,6 +41,9 @@ export declare abstract class InputMediaDeviceManager<T extends InputMediaDevice
      * Stops or pauses the stream based on state.disableMode
      * @param {boolean} [forceStop=false] when true, stops the tracks regardless of the state.disableMode
      */
+    disable(options: {
+        forceStop?: boolean;
+    }): Promise<void>;
     disable(forceStop?: boolean): Promise<void>;
     /**
      * Returns a promise that resolves when all pe

package/dist/src/gen/video/sfu/event/events.d.ts

@@ -1,5 +1,5 @@
 import { MessageType } from '@protobuf-ts/runtime';
-import { CallEndedReason, CallGrants, CallState, ClientCapability, ClientDetails, Codec, ConnectionQuality, Error as Error$, GoAwayReason, ICETrickle as ICETrickle$, Participant, ParticipantCount, PeerType, Pin, PublishOption, SubscribeOption, TrackInfo, TrackType, TrackUnpublishReason, WebsocketReconnectStrategy } from '../models/models';
+import { CallEndedReason, CallGrants, CallState, ClientCapability, ClientDetails, Codec, ConnectionQuality, Error as Error$, GoAwayReason, ICETrickle as ICETrickle$, Participant, ParticipantCount, ParticipantSource, PeerType, Pin, PublishOption, SubscribeOption, TrackInfo, TrackType, TrackUnpublishReason, WebsocketReconnectStrategy } from '../models/models';
 import { TrackSubscriptionDetails } from '../signal_rpc/signal';
 /**
  * SFUEvent is a message that is sent from the SFU to the client.
@@ -472,6 +472,10 @@ export interface JoinRequest {
      * @generated from protobuf field: repeated stream.video.sfu.models.ClientCapability capabilities = 11;
      */
     capabilities: ClientCapability[];
+    /**
+     * @generated from protobuf field: stream.video.sfu.models.ParticipantSource source = 12;
+     */
+    source: ParticipantSource;
 }
 /**
  * @generated from protobuf message stream.video.sfu.event.ReconnectDetails

package/dist/src/gen/video/sfu/models/models.d.ts

@@ -133,6 +133,10 @@ export interface Participant {
      * @generated from protobuf field: repeated string roles = 13;
      */
     roles: string[];
+    /**
+     * @generated from protobuf field: stream.video.sfu.models.ParticipantSource source = 14;
+     */
+    source: ParticipantSource;
 }
 /**
  * @generated from protobuf message stream.video.sfu.models.StreamQuality
@@ -755,6 +759,37 @@ export declare enum TrackType {
      */
     SCREEN_SHARE_AUDIO = 4
 }
+/**
+ * must be aligned with kit
+ *
+ * @generated from protobuf enum stream.video.sfu.models.ParticipantSource
+ */
+export declare enum ParticipantSource {
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_SOURCE_WEBRTC_UNSPECIFIED = 0;
+     */
+    WEBRTC_UNSPECIFIED = 0,
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_SOURCE_RTMP = 1;
+     */
+    RTMP = 1,
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_SOURCE_WHIP = 2;
+     */
+    WHIP = 2,
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_SOURCE_SIP = 3;
+     */
+    SIP = 3,
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_SOURCE_RTSP = 4;
+     */
+    RTSP = 4,
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_SOURCE_SRT = 5;
+     */
+    SRT = 5
+}
 /**
  * @generated from protobuf enum stream.video.sfu.models.ErrorCode
  */

package/dist/src/sorting/participants.d.ts

@@ -1,5 +1,6 @@
 import { Comparator } from './';
 import { StreamVideoParticipant } from '../types';
+import { ParticipantSource } from '../gen/video/sfu/models/models';
 /**
  * A comparator which sorts participants by the fact that they are the dominant speaker or not.
  *
@@ -42,6 +43,13 @@ export declare const publishingAudio: Comparator<StreamVideoParticipant>;
  * @param b the second participant.
  */
 export declare const pinned: Comparator<StreamVideoParticipant>;
+/**
+ * A comparator creator which will set up a comparator which prioritizes
+ * participants who are from a specific source (e.g., WebRTC, RTMP, WHIP...).
+ *
+ * @param source the source to prioritize.
+ */
+export declare const withParticipantSource: (source: ParticipantSource) => Comparator<StreamVideoParticipant>;
 /**
  * A comparator creator which will set up a comparator which prioritizes
  * participants who have a specific reaction.

package/dist/src/store/CallState.d.ts

@@ -5,7 +5,7 @@ import { type ClosedCaptionsSettings, type StreamVideoParticipant, type StreamVi
 import { CallStatsReport } from '../stats';
 import { CallClosedCaption, CallIngressResponse, CallResponse, CallSessionResponse, CallSettingsResponse, EgressResponse, MemberResponse, OwnCapability, ThumbnailResponse, UserResponse, VideoEvent } from '../gen/coordinator';
 import { ReconnectDetails } from '../gen/video/sfu/event/events';
-import { CallState as SfuCallState, Pin, TrackType } from '../gen/video/sfu/models/models';
+import { CallState as SfuCallState, Pin, TrackType, CallGrants } from '../gen/video/sfu/models/models';
 import { Comparator } from '../sorting';
 type OrphanedTrack = {
     id: string;
@@ -45,6 +45,7 @@ export declare class CallState {
     private callStatsReportSubject;
     private closedCaptionsSubject;
     private orphanedTracks;
+    private callGrantsSubject;
     /**
      * The time the call session actually started.
      * Useful for displaying the call duration.
@@ -371,6 +372,13 @@ export declare class CallState {
      * @param capabilities the capabilities to set.
      */
     setOwnCapabilities: (capabilities: Patch<OwnCapability[]>) => OwnCapability[];
+    /**
+     * Sets the call grants (used for own capabilities).
+     *
+     * @internal
+     * @param grants the grants to set.
+     */
+    setCallGrants: (grants: Patch<CallGrants>) => CallGrants;
     /**
      * The backstage state.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.28.1",
+  "version": "1.30.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "browser": "dist/index.browser.es.js",

package/src/Call.ts

@@ -112,6 +112,7 @@ import {
   ClientCapability,
   ClientDetails,
   Codec,
+  ParticipantSource,
   PublishOption,
   SubscribeOption,
   TrackType,
@@ -1015,6 +1016,7 @@ export class Call {
             preferredPublishOptions,
             preferredSubscribeOptions,
             capabilities: Array.from(this.clientCapabilities),
+            source: ParticipantSource.WEBRTC_UNSPECIFIED,
           });
 
         this.currentPublishOptions = publishOptions;

package/src/__tests__/StreamVideoClient.api.test.ts

@@ -25,7 +25,7 @@ const tokenProvider = (userId: string) => {
   };
 };
 
-describe('StreamVideoClient - coordinator API', () => {
+describe.skip('StreamVideoClient - coordinator API', () => {
   let client: StreamVideoClient;
   const user = {
     id: 'sara',

package/src/coordinator/connection/client.ts

@@ -665,12 +665,19 @@ export class StreamClient {
       };
     }
 
+    const {
+      params: axiosConfigParams,
+      headers: axiosConfigHeaders,
+      ...axiosRequestConfig
+    } = this.options.axiosRequestConfig || {};
+
     return {
       params: {
         user_id: this.userID,
         connection_id: this._getConnectionID(),
         api_key: this.key,
         ...options.params,
+        ...axiosConfigParams,
       },
       headers: {
         ...authorization,
@@ -680,9 +687,10 @@ export class StreamClient {
             : this.getAuthType(),
         'X-Stream-Client': this.getUserAgent(),
         ...options.headers,
+        ...axiosConfigHeaders,
       },
       ...options.config,
-      ...this.options.axiosRequestConfig,
+      ...axiosRequestConfig,
     };
   };
 

package/src/devices/InputMediaDeviceManager.ts

@@ -111,7 +111,14 @@ export abstract class InputMediaDeviceManager<
    * Stops or pauses the stream based on state.disableMode
    * @param {boolean} [forceStop=false] when true, stops the tracks regardless of the state.disableMode
    */
-  async disable(forceStop: boolean = false) {
+  async disable(options: { forceStop?: boolean }): Promise<void>;
+  async disable(forceStop?: boolean): Promise<void>;
+  async disable(forceStopOrOptions?: boolean | { forceStop?: boolean }) {
+    const forceStop =
+      typeof forceStopOrOptions === 'boolean'
+        ? forceStopOrOptions
+        : (forceStopOrOptions?.forceStop ?? false);
+
     this.state.prevStatus = this.state.optimisticStatus;
     if (!forceStop && this.state.optimisticStatus === 'disabled') {
       return;

package/src/events/call-permissions.ts

@@ -1,6 +1,5 @@
 import { CallState } from '../store';
 import type { CallGrantsUpdated } from '../gen/video/sfu/event/events';
-import { OwnCapability } from '../gen/coordinator';
 
 /**
  * Event handler that watches for `callGrantsUpdated` events.
@@ -10,26 +9,9 @@ import { OwnCapability } from '../gen/coordinator';
 export const watchCallGrantsUpdated = (state: CallState) => {
   return function onCallGrantsUpdated(event: CallGrantsUpdated) {
     const { currentGrants } = event;
-    if (currentGrants) {
-      const { canPublishAudio, canPublishVideo, canScreenshare } =
-        currentGrants;
 
-      const update: Partial<Record<OwnCapability, boolean>> = {
-        [OwnCapability.SEND_AUDIO]: canPublishAudio,
-        [OwnCapability.SEND_VIDEO]: canPublishVideo,
-        [OwnCapability.SCREENSHARE]: canScreenshare,
-      };
+    if (!currentGrants) return;
 
-      const nextCapabilities = state.ownCapabilities.filter(
-        (capability) => update[capability] !== false,
-      );
-      Object.entries(update).forEach(([capability, value]) => {
-        if (value && !nextCapabilities.includes(capability as OwnCapability)) {
-          nextCapabilities.push(capability as OwnCapability);
-        }
-      });
-
-      state.setOwnCapabilities(nextCapabilities);
-    }
+    state.setCallGrants(currentGrants);
   };
 };

package/src/gen/video/sfu/event/events.ts

@@ -15,6 +15,7 @@ import {
   ICETrickle as ICETrickle$,
   Participant,
   ParticipantCount,
+  ParticipantSource,
   PeerType,
   Pin,
   PublishOption,
@@ -522,6 +523,10 @@ export interface JoinRequest {
    * @generated from protobuf field: repeated stream.video.sfu.models.ClientCapability capabilities = 11;
    */
   capabilities: ClientCapability[];
+  /**
+   * @generated from protobuf field: stream.video.sfu.models.ParticipantSource source = 12;
+   */
+  source: ParticipantSource;
 }
 /**
  * @generated from protobuf message stream.video.sfu.event.ReconnectDetails
@@ -1404,6 +1409,16 @@ class JoinRequest$Type extends MessageType<JoinRequest> {
           'CLIENT_CAPABILITY_',
         ],
       },
+      {
+        no: 12,
+        name: 'source',
+        kind: 'enum',
+        T: () => [
+          'stream.video.sfu.models.ParticipantSource',
+          ParticipantSource,
+          'PARTICIPANT_SOURCE_',
+        ],
+      },
     ]);
   }
 }

package/src/gen/video/sfu/models/models.ts

@@ -137,6 +137,10 @@ export interface Participant {
    * @generated from protobuf field: repeated string roles = 13;
    */
   roles: string[];
+  /**
+   * @generated from protobuf field: stream.video.sfu.models.ParticipantSource source = 14;
+   */
+  source: ParticipantSource;
 }
 /**
  * @generated from protobuf message stream.video.sfu.models.StreamQuality
@@ -759,6 +763,37 @@ export enum TrackType {
    */
   SCREEN_SHARE_AUDIO = 4,
 }
+/**
+ * must be aligned with kit
+ *
+ * @generated from protobuf enum stream.video.sfu.models.ParticipantSource
+ */
+export enum ParticipantSource {
+  /**
+   * @generated from protobuf enum value: PARTICIPANT_SOURCE_WEBRTC_UNSPECIFIED = 0;
+   */
+  WEBRTC_UNSPECIFIED = 0,
+  /**
+   * @generated from protobuf enum value: PARTICIPANT_SOURCE_RTMP = 1;
+   */
+  RTMP = 1,
+  /**
+   * @generated from protobuf enum value: PARTICIPANT_SOURCE_WHIP = 2;
+   */
+  WHIP = 2,
+  /**
+   * @generated from protobuf enum value: PARTICIPANT_SOURCE_SIP = 3;
+   */
+  SIP = 3,
+  /**
+   * @generated from protobuf enum value: PARTICIPANT_SOURCE_RTSP = 4;
+   */
+  RTSP = 4,
+  /**
+   * @generated from protobuf enum value: PARTICIPANT_SOURCE_SRT = 5;
+   */
+  SRT = 5,
+}
 /**
  * @generated from protobuf enum stream.video.sfu.models.ErrorCode
  */
@@ -1211,6 +1246,16 @@ class Participant$Type extends MessageType<Participant> {
         repeat: 2 /*RepeatType.UNPACKED*/,
         T: 9 /*ScalarType.STRING*/,
       },
+      {
+        no: 14,
+        name: 'source',
+        kind: 'enum',
+        T: () => [
+          'stream.video.sfu.models.ParticipantSource',
+          ParticipantSource,
+          'PARTICIPANT_SOURCE_',
+        ],
+      },
     ]);
   }
 }

package/src/sorting/participants.ts

@@ -1,5 +1,6 @@
 import { Comparator } from './';
 import { StreamVideoParticipant } from '../types';
+import { ParticipantSource } from '../gen/video/sfu/models/models';
 import {
   hasAudio,
   hasScreenShare,
@@ -86,6 +87,20 @@ export const pinned: Comparator<StreamVideoParticipant> = (a, b) => {
   return 0;
 };
 
+/**
+ * A comparator creator which will set up a comparator which prioritizes
+ * participants who are from a specific source (e.g., WebRTC, RTMP, WHIP...).
+ *
+ * @param source the source to prioritize.
+ */
+export const withParticipantSource =
+  (source: ParticipantSource): Comparator<StreamVideoParticipant> =>
+  (a, b) => {
+    if (a.source === source && b.source !== source) return -1;
+    if (a.source !== source && b.source === source) return 1;
+    return 0;
+  };
+
 /**
  * A comparator creator which will set up a comparator which prioritizes
  * participants who have a specific reaction.

package/src/sorting/presets.ts

@@ -1,3 +1,4 @@
+import { ParticipantSource } from '../gen/video/sfu/models/models';
 import { StreamVideoParticipant, VisibilityState } from '../types';
 import { combineComparators, conditional } from './comparator';
 import {
@@ -9,6 +10,7 @@ import {
   role,
   screenSharing,
   speaking,
+  withParticipantSource,
 } from './participants';
 
 // a comparator decorator which applies the decorated comparator only if the
@@ -48,7 +50,6 @@ export const defaultSortPreset = combineComparators(
       publishingAudio,
     ),
   ),
-  // ifInvisibleBy(name),
 );
 
 /**
@@ -66,7 +67,6 @@ export const speakerLayoutSortPreset = combineComparators(
       publishingAudio,
     ),
   ),
-  // ifInvisibleBy(name),
 );
 
 /**
@@ -84,7 +84,6 @@ export const paginatedLayoutSortPreset = combineComparators(
       publishingAudio,
     ),
   ),
-  // ifInvisibleOrUnknownBy(name),
 );
 
 /**
@@ -96,10 +95,10 @@ export const livestreamOrAudioRoomSortPreset = combineComparators(
       dominantSpeaker,
       speaking,
       reactionType('raised-hand'),
+      withParticipantSource(ParticipantSource.RTMP),
       publishingVideo,
       publishingAudio,
     ),
   ),
   role('admin', 'host', 'speaker'),
-  // name,
 );

package/src/store/CallState.ts

@@ -1,9 +1,12 @@
 import {
   BehaviorSubject,
+  combineLatest,
   distinctUntilChanged,
   map,
   Observable,
+  ReplaySubject,
   shareReplay,
+  startWith,
 } from 'rxjs';
 import type { Patch } from './rxUtils';
 import * as RxUtils from './rxUtils';
@@ -49,6 +52,7 @@ import {
   CallState as SfuCallState,
   Pin,
   TrackType,
+  CallGrants,
 } from '../gen/video/sfu/models/models';
 import { Comparator, defaultSortPreset } from '../sorting';
 import { getLogger } from '../logger';
@@ -128,6 +132,8 @@ export class CallState {
   // We keep these tracks around until we can associate them with a participant.
   private orphanedTracks: OrphanedTrack[] = [];
 
+  private callGrantsSubject = new ReplaySubject<CallGrants>(1);
+
   // Derived state
 
   /**
@@ -394,8 +400,12 @@ export class CallState {
      */
     const isShallowEqual = <T>(a: Array<T>, b: Array<T>): boolean => {
       if (a.length !== b.length) return false;
-      for (const item of a) if (!b.includes(item)) return false;
-      for (const item of b) if (!a.includes(item)) return false;
+      for (const item of a) {
+        if (!b.includes(item)) return false;
+      }
+      for (const item of b) {
+        if (!a.includes(item)) return false;
+      }
       return true;
     };
 
@@ -406,8 +416,7 @@ export class CallState {
     const duc = <T>(
       subject: BehaviorSubject<T>,
       comparator?: (a: T, b: T) => boolean,
-    ): Observable<T> =>
-      subject.asObservable().pipe(distinctUntilChanged(comparator));
+    ): Observable<T> => subject.pipe(distinctUntilChanged(comparator));
 
     // primitive values should only emit once the value they hold changes
     this.anonymousParticipantCount$ = duc(
@@ -416,7 +425,41 @@ export class CallState {
     this.blockedUserIds$ = duc(this.blockedUserIdsSubject, isShallowEqual);
     this.backstage$ = duc(this.backstageSubject);
     this.callingState$ = duc(this.callingStateSubject);
-    this.ownCapabilities$ = duc(this.ownCapabilitiesSubject, isShallowEqual);
+    this.ownCapabilities$ = combineLatest([
+      this.ownCapabilitiesSubject,
+      this.callGrantsSubject.pipe(startWith(undefined)),
+    ]).pipe(
+      map(([capabilities, grants]) => {
+        if (!grants) return capabilities;
+
+        const { canPublishAudio, canPublishVideo, canScreenshare } = grants;
+
+        const update = {
+          [OwnCapability.SEND_AUDIO]: canPublishAudio,
+          [OwnCapability.SEND_VIDEO]: canPublishVideo,
+          [OwnCapability.SCREENSHARE]: canScreenshare,
+        } as const;
+
+        const nextCapabilities = [...capabilities];
+
+        for (const _capability in update) {
+          const capability = _capability as keyof typeof update;
+          const allowed = update[capability];
+
+          // grants take precedence over capabilities, reconstruct the capabilities
+          if (allowed && !nextCapabilities.includes(capability)) {
+            nextCapabilities.push(capability);
+          } else if (!allowed && nextCapabilities.includes(capability)) {
+            const index = nextCapabilities.indexOf(capability);
+            nextCapabilities.splice(index, 1);
+          }
+        }
+
+        return nextCapabilities;
+      }),
+      distinctUntilChanged(isShallowEqual),
+      shareReplay({ bufferSize: 1, refCount: true }),
+    );
     this.participantCount$ = duc(this.participantCountSubject);
     this.recording$ = duc(this.recordingSubject);
     this.transcribing$ = duc(this.transcribingSubject);
@@ -767,6 +810,16 @@ export class CallState {
     return this.setCurrentValue(this.ownCapabilitiesSubject, capabilities);
   };
 
+  /**
+   * Sets the call grants (used for own capabilities).
+   *
+   * @internal
+   * @param grants the grants to set.
+   */
+  setCallGrants = (grants: Patch<CallGrants>) => {
+    return this.setCurrentValue(this.callGrantsSubject, grants);
+  };
+
   /**
    * The backstage state.
    */
@@ -1412,7 +1465,7 @@ export class CallState {
 
   private updateOwnCapabilities = (event: UpdatedCallPermissionsEvent) => {
     if (event.user.id === this.localParticipant?.userId) {
-      this.setCurrentValue(this.ownCapabilitiesSubject, event.own_capabilities);
+      this.setOwnCapabilities(event.own_capabilities);
     }
   };