@stream-io/video-client 1.33.0 → 1.33.1

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

@@ -47,9 +47,12 @@ 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.
+ * The priority of a source is determined by the order of the sources passed in.
+ * e.g. [SRT, RTMP, WHIP] will prioritize SRT sources first, then RTMP, then WHIP.
+ *
+ * @param sources the sources to prioritize.
  */
-export declare const withParticipantSource: (source: ParticipantSource) => Comparator<StreamVideoParticipant>;
+export declare const withParticipantSource: (...sources: 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.33.0",
+  "version": "1.33.1",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "browser": "dist/index.browser.es.js",

package/src/sorting/__tests__/sorting.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it } from 'vitest';
+import { ParticipantSource } from '../../gen/video/sfu/models/models';
 import {
   combineComparators,
   Comparator,
@@ -8,6 +9,7 @@ import {
   publishingAudio,
   publishingVideo,
   screenSharing,
+  withParticipantSource,
 } from '../index';
 import * as TestData from './participant-data';
 
@@ -43,4 +45,108 @@ describe('Sorting', () => {
     const disableComparator = conditional<number>(() => false);
     expect([...input].sort(disableComparator(byValue))).toEqual([2, 3, 1]);
   });
+
+  it('withParticipantSource', () => {
+    expect(
+      withParticipantSource(ParticipantSource.SRT)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.WEBRTC_UNSPECIFIED }, // -1
+        { source: ParticipantSource.SRT }, // 0
+      ),
+    ).toEqual(1);
+    expect(
+      withParticipantSource(ParticipantSource.RTMP)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.WEBRTC_UNSPECIFIED },
+        { source: ParticipantSource.SIP },
+      ),
+    ).toEqual(0);
+    expect(
+      withParticipantSource(ParticipantSource.RTMP)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.RTMP },
+        { source: ParticipantSource.SIP },
+      ),
+    ).toEqual(-1);
+    expect(
+      withParticipantSource(ParticipantSource.RTMP)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.SIP },
+        { source: ParticipantSource.RTMP },
+      ),
+    ).toEqual(1);
+    expect(
+      withParticipantSource(ParticipantSource.RTMP)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.WEBRTC_UNSPECIFIED },
+        { source: ParticipantSource.RTMP },
+      ),
+    ).toEqual(1);
+
+    expect(
+      withParticipantSource(ParticipantSource.SRT, ParticipantSource.RTMP)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.RTMP },
+        { source: ParticipantSource.SRT },
+      ),
+    ).toEqual(1);
+
+    expect(
+      withParticipantSource(ParticipantSource.RTMP, ParticipantSource.SRT)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.RTMP },
+        { source: ParticipantSource.SRT },
+      ),
+    ).toEqual(-1);
+    expect(
+      withParticipantSource(ParticipantSource.RTMP, ParticipantSource.SRT)(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.WHIP },
+        { source: ParticipantSource.SRT },
+      ),
+    ).toEqual(1);
+
+    expect(
+      withParticipantSource(
+        ParticipantSource.WHIP,
+        ParticipantSource.RTMP,
+        ParticipantSource.SRT,
+      )(
+        // @ts-expect-error incomplete data
+        { source: ParticipantSource.WHIP },
+        { source: ParticipantSource.SRT },
+      ),
+    ).toEqual(-1);
+  });
+
+  it('withParticipantSources with multiple participants', () => {
+    const participants = [
+      { source: ParticipantSource.WEBRTC_UNSPECIFIED },
+      { source: ParticipantSource.SRT },
+      { source: ParticipantSource.RTMP },
+      { source: ParticipantSource.SIP },
+      { source: ParticipantSource.RTSP },
+      { source: ParticipantSource.WHIP },
+    ];
+
+    const sorted = [...participants].sort(
+      withParticipantSource(
+        ParticipantSource.RTMP,
+        ParticipantSource.SRT,
+        ParticipantSource.WHIP,
+        ParticipantSource.RTSP,
+        ParticipantSource.SIP,
+        ParticipantSource.WEBRTC_UNSPECIFIED,
+      ),
+    );
+
+    expect(sorted).toEqual([
+      { source: ParticipantSource.RTMP },
+      { source: ParticipantSource.SRT },
+      { source: ParticipantSource.WHIP },
+      { source: ParticipantSource.RTSP },
+      { source: ParticipantSource.SIP },
+      { source: ParticipantSource.WEBRTC_UNSPECIFIED },
+    ]);
+  });
 });

package/src/sorting/participants.ts

@@ -38,8 +38,10 @@ export const speaking: Comparator<StreamVideoParticipant> = (a, b) => {
  * @param b the second participant.
  */
 export const screenSharing: Comparator<StreamVideoParticipant> = (a, b) => {
-  if (hasScreenShare(a) && !hasScreenShare(b)) return -1;
-  if (!hasScreenShare(a) && hasScreenShare(b)) return 1;
+  const hasA = hasScreenShare(a);
+  const hasB = hasScreenShare(b);
+  if (hasA && !hasB) return -1;
+  if (!hasA && hasB) return 1;
   return 0;
 };
 
@@ -50,8 +52,10 @@ export const screenSharing: Comparator<StreamVideoParticipant> = (a, b) => {
  * @param b the second participant.
  */
 export const publishingVideo: Comparator<StreamVideoParticipant> = (a, b) => {
-  if (hasVideo(a) && !hasVideo(b)) return -1;
-  if (!hasVideo(a) && hasVideo(b)) return 1;
+  const hasA = hasVideo(a);
+  const hasB = hasVideo(b);
+  if (hasA && !hasB) return -1;
+  if (!hasA && hasB) return 1;
   return 0;
 };
 
@@ -62,8 +66,10 @@ export const publishingVideo: Comparator<StreamVideoParticipant> = (a, b) => {
  * @param b the second participant.
  */
 export const publishingAudio: Comparator<StreamVideoParticipant> = (a, b) => {
-  if (hasAudio(a) && !hasAudio(b)) return -1;
-  if (!hasAudio(a) && hasAudio(b)) return 1;
+  const hasA = hasAudio(a);
+  const hasB = hasAudio(b);
+  if (hasA && !hasB) return -1;
+  if (!hasA && hasB) return 1;
   return 0;
 };
 
@@ -91,15 +97,23 @@ export const pinned: Comparator<StreamVideoParticipant> = (a, b) => {
  * 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.
+ * The priority of a source is determined by the order of the sources passed in.
+ * e.g. [SRT, RTMP, WHIP] will prioritize SRT sources first, then RTMP, then WHIP.
+ *
+ * @param sources the sources 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;
+export const withParticipantSource = (
+  ...sources: ParticipantSource[]
+): Comparator<StreamVideoParticipant> => {
+  const priority = (i: number) => (i === -1 ? Number.MAX_SAFE_INTEGER : i);
+  return (a, b) => {
+    const priorityA = priority(sources.indexOf(a.source));
+    const priorityB = priority(sources.indexOf(b.source));
+    if (priorityA < priorityB) return -1;
+    if (priorityA > priorityB) return 1;
     return 0;
   };
+};
 
 /**
  * A comparator creator which will set up a comparator which prioritizes
@@ -126,8 +140,10 @@ export const reactionType = (
 export const role =
   (...roles: string[]): Comparator<StreamVideoParticipant> =>
   (a, b) => {
-    if (hasAnyRole(a, roles) && !hasAnyRole(b, roles)) return -1;
-    if (!hasAnyRole(a, roles) && hasAnyRole(b, roles)) return 1;
+    const hasA = hasAnyRole(a, roles);
+    const hasB = hasAnyRole(b, roles);
+    if (hasA && !hasB) return -1;
+    if (!hasA && hasB) return 1;
     return 0;
   };
 

package/src/sorting/presets.ts

@@ -1,6 +1,6 @@
-import { ParticipantSource } from '../gen/video/sfu/models/models';
 import { StreamVideoParticipant, VisibilityState } from '../types';
 import { combineComparators, conditional } from './comparator';
+import { ParticipantSource } from '../gen/video/sfu/models/models';
 import {
   dominantSpeaker,
   pinned,
@@ -35,6 +35,16 @@ const ifInvisibleOrUnknownBy = conditional(
     b.viewportVisibilityState?.videoTrack === VisibilityState.UNKNOWN,
 );
 
+/**
+ * A comparator that prioritizes participants with video ingress sources.
+ */
+const withVideoIngressSource = withParticipantSource(
+  ParticipantSource.RTMP,
+  ParticipantSource.SRT,
+  ParticipantSource.WHIP,
+  ParticipantSource.RTSP,
+);
+
 /**
  * The default sorting preset.
  */
@@ -63,6 +73,7 @@ export const speakerLayoutSortPreset = combineComparators(
     combineComparators(
       speaking,
       reactionType('raised-hand'),
+      withVideoIngressSource,
       publishingVideo,
       publishingAudio,
     ),
@@ -80,6 +91,7 @@ export const paginatedLayoutSortPreset = combineComparators(
       dominantSpeaker,
       speaking,
       reactionType('raised-hand'),
+      withVideoIngressSource,
       publishingVideo,
       publishingAudio,
     ),
@@ -95,7 +107,7 @@ export const livestreamOrAudioRoomSortPreset = combineComparators(
       dominantSpeaker,
       speaking,
       reactionType('raised-hand'),
-      withParticipantSource(ParticipantSource.RTMP),
+      withVideoIngressSource,
       publishingVideo,
       publishingAudio,
     ),