@stream-io/video-client 1.29.0 → 1.30.0

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.29.0",
+  "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/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,
 );