@stream-io/video-client 0.0.28 → 0.0.30

package/dist/src/rtc/{publisher.d.ts → Publisher.d.ts}

@@ -1,5 +1,5 @@
 import { StreamSfuClient } from '../StreamSfuClient';
-import { TrackType } from '../gen/video/sfu/models/models';
+import { TrackInfo, TrackType } from '../gen/video/sfu/models/models';
 import { CallState } from '../store';
 import { PublishOptions } from '../types';
 export type PublisherOpts = {
@@ -15,16 +15,37 @@ export type PublisherOpts = {
  * @internal
  */
 export declare class Publisher {
-    private readonly publisher;
-    private readonly sfuClient;
+    private pc;
     private readonly state;
     private readonly transceiverRegistry;
-    private readonly trackKindRegistry;
-    private isDtxEnabled;
-    private isRedEnabled;
-    private preferredVideoCodec?;
-    private logger?;
+    private readonly trackKindMapping;
+    private readonly trackLayersCache;
+    private readonly isDtxEnabled;
+    private readonly isRedEnabled;
+    private readonly preferredVideoCodec?;
+    private logger;
+    /**
+     * The SFU client instance to use for publishing and signaling.
+     */
+    sfuClient: StreamSfuClient;
+    /**
+     * Constructs a new `Publisher` instance.
+     *
+     * @param connectionConfig the connection configuration to use.
+     * @param sfuClient the SFU client to use.
+     * @param state the call state to use.
+     * @param isDtxEnabled whether DTX is enabled.
+     * @param isRedEnabled whether RED is enabled.
+     * @param preferredVideoCodec the preferred video codec.
+     */
     constructor({ connectionConfig, sfuClient, state, isDtxEnabled, isRedEnabled, preferredVideoCodec, }: PublisherOpts);
+    private createPeerConnection;
+    /**
+     * Closes the publisher PeerConnection and cleans up the resources.
+     */
+    close: ({ stopTracks }?: {
+        stopTracks?: boolean | undefined;
+    }) => void;
     /**
      * Starts publishing the given track of the given media stream.
      *
@@ -51,25 +72,38 @@ export declare class Publisher {
     private notifyTrackMuteStateChanged;
     /**
      * Stops publishing all tracks and stop all tracks.
-     *
-     * @param options - Options
-     * @param options.stopTracks - If `true` (default), all tracks will be stopped.
      */
-    stopPublishing: (options?: {
-        stopTracks?: boolean;
-    }) => void;
+    stopPublishing: () => void;
     updateVideoPublishQuality: (enabledRids: string[]) => Promise<void>;
     /**
      * Returns the result of the `RTCPeerConnection.getStats()` method
      * @param selector
      * @returns
      */
-    getStats(selector?: MediaStreamTrack | null | undefined): Promise<RTCStatsReport>;
+    getStats: (selector?: MediaStreamTrack | null | undefined) => Promise<RTCStatsReport>;
     private getCodecPreferences;
     private onIceCandidate;
+    /**
+     * Performs a migration of this publisher instance to a new SFU.
+     *
+     * Initiates a new `iceRestart` offer/answer exchange with the new SFU.
+     *
+     * @param sfuClient the new SFU client to migrate to.
+     * @param connectionConfig the new connection configuration to use.
+     */
+    migrateTo: (sfuClient: StreamSfuClient, connectionConfig?: RTCConfiguration) => Promise<void>;
     private onNegotiationNeeded;
+    /**
+     * Initiates a new offer/answer exchange with the currently connected SFU.
+     *
+     * @param options the optional offer options to use.
+     */
+    private negotiate;
+    private mungeCodecs;
+    getCurrentTrackInfos: (sdp?: string) => TrackInfo[];
     private onIceCandidateError;
     private onIceConnectionStateChange;
     private onIceGatheringStateChange;
+    private onSignalingStateChange;
     private ridToVideoQuality;
 }

package/dist/src/rtc/Subscriber.d.ts

@@ -0,0 +1,58 @@
+import { StreamSfuClient } from '../StreamSfuClient';
+import { Dispatcher } from './Dispatcher';
+import { CallState } from '../store';
+export type SubscriberOpts = {
+    sfuClient: StreamSfuClient;
+    dispatcher: Dispatcher;
+    state: CallState;
+    connectionConfig?: RTCConfiguration;
+};
+/**
+ * A wrapper around the `RTCPeerConnection` that handles the incoming
+ * media streams from the SFU.
+ */
+export declare class Subscriber {
+    private pc;
+    private readonly unregisterOnSubscriberOffer;
+    private sfuClient;
+    private dispatcher;
+    private state;
+    /**
+     * Constructs a new `Subscriber` instance.
+     *
+     * @param sfuClient the SFU client to use.
+     * @param dispatcher the dispatcher to use.
+     * @param state the state of the call.
+     * @param connectionConfig the connection configuration to use.
+     */
+    constructor({ sfuClient, dispatcher, state, connectionConfig, }: SubscriberOpts);
+    /**
+     * Creates a new `RTCPeerConnection` instance with the given configuration.
+     *
+     * @param connectionConfig the connection configuration to use.
+     */
+    private createPeerConnection;
+    /**
+     * Closes the `RTCPeerConnection` and unsubscribes from the dispatcher.
+     */
+    close: () => void;
+    /**
+     * Returns the result of the `RTCPeerConnection.getStats()` method
+     * @param selector
+     * @returns
+     */
+    getStats: (selector?: MediaStreamTrack | null | undefined) => Promise<RTCStatsReport>;
+    /**
+     * Migrates the subscriber to a new SFU client.
+     *
+     * @param sfuClient the new SFU client to migrate to.
+     * @param connectionConfig the new connection configuration to use.
+     */
+    migrateTo: (sfuClient: StreamSfuClient, connectionConfig?: RTCConfiguration) => void;
+    private handleOnTrack;
+    private onIceCandidate;
+    private negotiate;
+    private onIceConnectionStateChange;
+    private onIceGatheringStateChange;
+    private onIceCandidateError;
+}

package/dist/src/rtc/__tests__/Subscriber.test.d.ts

@@ -0,0 +1 @@
+import './mocks/webrtc.mocks';

package/dist/src/rtc/flows/join.d.ts

@@ -1,4 +1,4 @@
-import { JoinCallData } from '../../types';
+import { JoinCallData, StreamVideoLocalParticipant, StreamVideoParticipant } from '../../types';
 import { StreamClient } from '../../coordinator/connection/client';
 /**
  * Collects all necessary information to join a call, talks to the coordinator
@@ -17,3 +17,10 @@ export declare const join: (httpClient: StreamClient, type: string, id: string,
     members: import("../../gen/coordinator").MemberResponse[];
     ownCapabilities: import("../../gen/coordinator").OwnCapability[];
 }>;
+/**
+ * Reconciles the local state of the source participant into the target participant.
+ *
+ * @param target the participant to reconcile into.
+ * @param source the participant to reconcile from.
+ */
+export declare const reconcileParticipantLocalState: (target: StreamVideoParticipant | StreamVideoLocalParticipant, source?: StreamVideoParticipant | StreamVideoLocalParticipant) => StreamVideoParticipant | StreamVideoLocalParticipant;

package/dist/src/rtc/index.d.ts

@@ -1,7 +1,7 @@
 export * from './codecs';
 export * from './Dispatcher';
 export * from './IceTrickleBuffer';
-export * from './publisher';
-export * from './subscriber';
+export * from './Publisher';
+export * from './Subscriber';
 export * from './signal';
 export * from './videoLayers';

package/dist/src/rtc/signal.d.ts

@@ -1,3 +1,4 @@
+import WebSocket from 'isomorphic-ws';
 import { SfuEvent } from '../gen/video/sfu/event/events';
 export declare const createWebSocketSignalChannel: (opts: {
     endpoint: string;

package/dist/src/stats/state-store-stats-reporter.d.ts

@@ -1,12 +1,11 @@
 import type { StatsReport } from './types';
 import { CallState } from '../store';
-import { Publisher } from '../rtc';
+import { Publisher, Subscriber } from '../rtc';
 export type StatsReporterOpts = {
-    subscriber: RTCPeerConnection;
+    subscriber: Subscriber;
     publisher: Publisher;
     state: CallState;
     pollingIntervalInMs?: number;
-    edgeName?: string;
 };
 export type StatsReporter = {
     /**
@@ -44,7 +43,7 @@ export type StatsReporter = {
 /**
  * Creates a new StatsReporter instance that collects metrics about the ongoing call and reports them to the state store
  */
-export declare const createStatsReporter: ({ subscriber, publisher, state, edgeName, pollingIntervalInMs, }: StatsReporterOpts) => StatsReporter;
+export declare const createStatsReporter: ({ subscriber, publisher, state, pollingIntervalInMs, }: StatsReporterOpts) => StatsReporter;
 export type StatsTransformOpts = {
     /**
      * The kind of track we are transforming stats for.

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

@@ -38,6 +38,10 @@ export declare enum CallingState {
      * The call is in the process of reconnecting.
      */
     RECONNECTING = "reconnecting",
+    /**
+     * The call is in the process of migrating from one node to another.
+     */
+    MIGRATING = "migrating",
     /**
      * The call has failed to reconnect.
      */
@@ -393,6 +397,12 @@ export declare class CallState {
      * @returns the participant with the given sessionId or undefined if not found.
      */
     findParticipantBySessionId: (sessionId: string) => StreamVideoParticipant | undefined;
+    /**
+     * Returns a new lookup table of participants indexed by their session ID.
+     */
+    getParticipantLookupBySessionId: () => {
+        [sessionId: string]: StreamVideoParticipant | StreamVideoLocalParticipant | undefined;
+    };
     /**
      * Updates a participant in the current call identified by the given `sessionId`.
      * If the participant can't be found, this operation is no-op.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -36,6 +36,7 @@
     "isomorphic-ws": "^5.0.0",
     "jsonwebtoken": "^9.0.0",
     "rxjs": "~7.8.1",
+    "sdp-transform": "^2.14.1",
     "ua-parser-js": "^1.0.35",
     "webrtc-adapter": "^8.2.2",
     "ws": "^8.13.0"
@@ -46,6 +47,7 @@
     "@rollup/plugin-typescript": "^11.1.0",
     "@types/jsonwebtoken": "^9.0.1",
     "@types/rimraf": "^3.0.2",
+    "@types/sdp-transform": "^2.4.6",
     "@types/ua-parser-js": "^0.7.36",
     "@types/ws": "^8.5.4",
     "@vitest/coverage-c8": "^0.31.0",