@stream-io/video-client 1.58.0 → 2.0.0-beta.0

package/dist/src/Call.d.ts

@@ -2,7 +2,7 @@ import { type CallMediaEngine, Publisher, Subscriber, TrackPublishOptions } from
 import type { E2EEManager } from './rtc/e2ee/E2EEManager';
 import { CallState } from './store';
 import { ScopedLogger } from './logger';
-import { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteTranscriptionResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetCallSessionParticipantStatsDetailsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, KickUserRequest, KickUserResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallParticipantsRequest, QueryCallParticipantsResponse, QueryCallSessionParticipantStatsResponse, QueryCallSessionParticipantStatsTimelineResponse, QueryCallStatsMapResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, RingCallRequest, RingCallResponse, SendCallEventResponse, SendVideoReactionRequest, SendVideoReactionResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRecordingResponse, StopRTMPBroadcastsResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsRequestGrantPermissionsEnum, UpdateUserPermissionsRequestRevokePermissionsEnum, UpdateUserPermissionsResponse } from './gen/coordinator';
+import { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CallStateResponseFields, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteTranscriptionResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetCallSessionParticipantStatsDetailsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, KickUserRequest, KickUserResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallParticipantsRequest, QueryCallParticipantsResponse, QueryCallSessionParticipantStatsResponse, QueryCallSessionParticipantStatsTimelineResponse, QueryCallStatsMapResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, RingCallRequest, RingCallResponse, SendCallEventResponse, SendVideoReactionRequest, SendVideoReactionResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRecordingResponse, StopRTMPBroadcastsResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsRequestGrantPermissionsEnum, UpdateUserPermissionsRequestRevokePermissionsEnum, UpdateUserPermissionsResponse } from './gen/coordinator';
 import { AudioTrackType, CallConstructor, CallLeaveOptions, CallRecordingType, ClientPublishOptions, ClosedCaptionsSettings, JoinCallData, StartCallRecordingFnType, TrackMuteType, VideoTrackType } from './types';
 import { ClientCapability, TrackType, VideoDimension } from './gen/video/sfu/models/models';
 import { Tracer } from './stats';
@@ -223,6 +223,13 @@ export declare class Call {
      * @internal
      */
     updateFromRingingEvent: (event: CallRingEvent) => Promise<void>;
+    /**
+     * Applies a backend-provided call state snapshot
+     * (call, members, own capabilities) to this instance.
+     *
+     * @internal an internal method and should not be used outside the SDK.
+     */
+    updateFromCallStateResponse: (response: CallStateResponseFields) => void;
     /**
      * Loads the information about the call.
      *
@@ -286,12 +293,12 @@ export declare class Call {
      *
      * @returns a promise which resolves once the call join-flow has finished.
      */
-    join: ({ maxJoinRetries, joinResponseTimeout, rpcRequestTimeout, allowOwnTracksLoopback, ...data }?: JoinCallData & {
+    join: (args_0?: (JoinCallData & {
         maxJoinRetries?: number;
         joinResponseTimeout?: number;
         rpcRequestTimeout?: number;
         allowOwnTracksLoopback?: boolean;
-    }) => Promise<void>;
+    }) | undefined) => Promise<void>;
     /**
      * Will make a single attempt to watch for call related WebSocket events
      * and initiate a call session with the server.
@@ -868,7 +875,11 @@ export declare class Call {
      *
      * @internal
      */
-    applyDeviceConfig: (settings: CallSettingsResponse, publish: boolean, skipSpeakerApply: boolean) => Promise<void>;
+    applyDeviceConfig: (settings: CallSettingsResponse, opts: {
+        publish: boolean;
+        skipSpeakerApply?: boolean;
+        withDisabledDevices?: boolean;
+    }) => Promise<void>;
     /**
      * Will begin tracking the given element for visibility changes within the
      * configured viewport element (`call.setViewport`).

package/dist/src/StreamVideoClient.d.ts

@@ -50,6 +50,11 @@ export declare class StreamVideoClient {
      * @param e the event.
      */
     private initCallFromEvent;
+    /**
+     * Queries the API for calls matching the given filters.
+     * @param data the query data.
+     */
+    private doQueryCalls;
     /**
      * Rewatches the given calls with retry logic.
      * @param callsToReWatch array of call IDs to rewatch
@@ -110,8 +115,11 @@ export declare class StreamVideoClient {
      * Will query the API for calls matching the given filters.
      *
      * @param data the query data.
+     * @param opts additional options, for tweaking the API behavior.
      */
-    queryCalls: (data?: QueryCallsRequest) => Promise<{
+    queryCalls: (data?: QueryCallsRequest, opts?: {
+        withDisabledDevices?: boolean;
+    }) => Promise<{
         calls: Call[];
         duration: string;
         next?: string;

package/dist/src/coordinator/connection/utils.d.ts

@@ -1,6 +1,7 @@
 import type { AxiosResponse } from 'axios';
 import type { APIErrorResponse } from './types';
 import type { ConnectionErrorEvent } from '../../gen/coordinator';
+import type { ScopedLogger } from '../../logger';
 export declare const sleep: (m: number) => Promise<unknown>;
 export declare const timeboxed: <T extends Promise<unknown>[]>(promises: [...T], ms: number) => Promise<{ [K in keyof T]: Awaited<T[K]>; }>;
 export declare function isFunction<T>(value: Function | T): value is Function;
@@ -25,3 +26,12 @@ export declare function addConnectionEventListeners(cb: (e: Event) => void): voi
 export declare function removeConnectionEventListeners(cb: (e: Event) => void): void;
 export declare function isErrorResponse(res: AxiosResponse<unknown>): res is AxiosResponse<APIErrorResponse>;
 export declare function isCloseEvent(res: CloseEvent | ConnectionErrorEvent): res is CloseEvent;
+/**
+ * Invokes a single event listener in isolation, so that a faulty listener
+ * cannot abort the dispatch loop nor the bookkeeping that follows it.
+ *
+ * @param listener the listener to invoke.
+ * @param event the event to pass to the listener.
+ * @param logger the logger to report listener failures with.
+ */
+export declare const invokeEventListener: <T>(listener: (event: T) => unknown, event: T, logger: ScopedLogger) => void;

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

@@ -48,8 +48,9 @@ export declare class CameraManager extends DeviceManager<CameraManagerState> {
      *
      * @param settings the video settings to apply.
      * @param publish whether to publish the stream after applying the settings.
+     * @param forceDisabled whether to keep the camera disabled, regardless of server-side or local preferences.
      */
-    apply(settings: VideoSettingsResponse, publish: boolean): Promise<void>;
+    apply(settings: VideoSettingsResponse, publish: boolean, forceDisabled?: boolean): Promise<void>;
     protected getDevices(): Observable<MediaDeviceInfo[]>;
     protected getResolvedConstraints(constraints: MediaTrackConstraints): MediaTrackConstraints;
     protected getStream(constraints: MediaTrackConstraints): Promise<MediaStream>;

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

@@ -130,6 +130,6 @@ export declare abstract class DeviceManager<S extends DeviceManagerState<C>, C =
     protected findDevice(devices: MediaDeviceInfo[], deviceId: string): MediaDeviceInfo | undefined;
     private dispatchDeviceDisconnectedEvent;
     private persistPreference;
-    protected applyPersistedPreferences(enabledInCallType: boolean): Promise<boolean>;
+    protected applyPersistedPreferences(enabledInCallType: boolean, forceDisabled?: boolean): Promise<boolean>;
     private applyMutedState;
 }

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

@@ -69,8 +69,9 @@ export declare class MicrophoneManager extends AudioDeviceManager<MicrophoneMana
      * Applies the audio settings to the microphone.
      * @param settings the audio settings to apply.
      * @param publish whether to publish the stream after applying the settings.
+     * @param forceDisabled whether to keep the mic disabled, regardless of server-side or local preferences.
      */
-    apply(settings: AudioSettingsResponse, publish: boolean): Promise<void>;
+    apply(settings: AudioSettingsResponse, publish: boolean, forceDisabled?: boolean): Promise<void>;
     protected getDevices(): Observable<MediaDeviceInfo[]>;
     protected getStream(constraints: MediaTrackConstraints): Promise<MediaStream>;
     protected doSetAudioBitrateProfile(profile: AudioBitrateProfile): void;

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

@@ -8481,6 +8481,32 @@ export interface ReportByHistogramBucket {
      */
     upper_bound?: Bound;
 }
+/**
+ * Reports a batch of client-side telemetry events. Each event is validated and processed independently; one invalid event does not block the rest of the batch.
+ * @export
+ * @interface ReportClientEventRequest
+ */
+export interface ReportClientEventRequest {
+    /**
+     * Client-side events to report (1-100 per request)
+     * @type {Array<ClientEvent>}
+     * @memberof ReportClientEventRequest
+     */
+    events: Array<ClientEvent>;
+}
+/**
+ * Response for reporting client-side telemetry events
+ * @export
+ * @interface ReportClientEventResponse
+ */
+export interface ReportClientEventResponse {
+    /**
+     * Duration of the request in milliseconds
+     * @type {string}
+     * @memberof ReportClientEventResponse
+     */
+    duration: string;
+}
 /**
  *
  * @export

package/dist/src/helpers/MediaStreamRecorder.d.ts

@@ -0,0 +1,26 @@
+export type MediaStreamRecorderOptions = {
+    /** Auto-stop after this many milliseconds. */
+    maxDurationMs?: number;
+};
+export type MediaRecordingResult = {
+    blob: Blob;
+};
+/** Single-use `MediaRecorder` wrapper that returns an in-memory blob. */
+export declare class MediaStreamRecorder {
+    private recording;
+    private logger;
+    private chunks;
+    private timeoutId;
+    private recorder;
+    private readonly tracks;
+    private readonly maxDurationMs;
+    constructor(stream: MediaStream, options?: MediaStreamRecorderOptions);
+    /** Starts recording and resolves when recording stops. */
+    start: () => Promise<MediaRecordingResult | null>;
+    /** Stops recording early. */
+    stop: () => void;
+    private isSettled;
+    private detach;
+    private handleStop;
+    private handleError;
+}

package/dist/src/helpers/concurrency.d.ts

@@ -27,6 +27,14 @@ export declare const withoutConcurrency: <T>(tag: TagKey, cb: () => Promise<T>)
  * it's up to the function to decide how to react to cancelation.
  */
 export declare const withCancellation: <T>(tag: TagKey, cb: (signal: AbortSignal) => Promise<T | "canceled">) => Promise<T | "canceled">;
+/**
+ * Wraps an async function so concurrent calls share the in-flight promise
+ * instead of queueing another execution.
+ *
+ * @param cb Async function to wrap.
+ * @returns Wrapped async function.
+ */
+export declare function singleFlight<P extends unknown[], T>(cb: (...args: P) => Promise<T>): (...args: P) => Promise<T>;
 export declare function hasPending(tag: TagKey): boolean;
 export declare function settled(tag: TagKey): Promise<void>;
 export {};

package/dist/src/helpers/loopback.d.ts

@@ -0,0 +1,55 @@
+import type { Call } from '../Call';
+import type { StreamVideoParticipant } from '../types';
+/** Default loopback stream wait timeout. */
+export declare const LOOPBACK_STREAMS_WAIT_TIMEOUT_MS: number;
+/** Default loopback recording duration. */
+export declare const DEFAULT_LOOPBACK_RECORDING_DURATION_MS: number;
+/** Shortest permitted loopback recording duration. */
+export declare const MIN_LOOPBACK_RECORDING_DURATION_MS: number;
+/** Longest permitted loopback recording duration. */
+export declare const MAX_LOOPBACK_RECORDING_DURATION_MS: number;
+/** SFU-echoed streams on the local participant. */
+export type LoopbackStreams = {
+    loopbackVideoStream?: MediaStream;
+    loopbackAudioStream?: MediaStream;
+};
+/** SFU-echoed tracks on the local participant. */
+export type LoopbackTracks = {
+    audioTrack?: MediaStreamTrack;
+    videoTrack?: MediaStreamTrack;
+};
+/** Thrown when loopback tracks do not arrive in time. */
+export declare class LoopbackStreamsTimeoutError extends Error {
+    constructor();
+}
+/**
+ * Returns the streams on the given participant that the SFU echoed back to us,
+ * ignoring the local capture streams the publishing path writes to the same
+ * fields.
+ */
+export declare const getLoopbackStreams: (call: Call | undefined, participant: StreamVideoParticipant | undefined) => LoopbackStreams;
+/**
+ * Returns loopback tracks when all required tracks are present.
+ *
+ * Prefer {@link waitForLoopbackStreams}, which observes call state until the
+ * tracks arrive. This is the synchronous snapshot it is built from.
+ *
+ * @internal
+ */
+export declare const getLoopbackTracks: (call: Call | undefined, participant: StreamVideoParticipant | undefined, includeVideo: boolean) => LoopbackTracks | undefined;
+export type WaitForLoopbackStreamsOptions = {
+    /** Whether video is required. Audio is always required. */
+    includeVideo: boolean;
+    /** Aborts the wait. */
+    signal: AbortSignal;
+    /** Defaults to {@link LOOPBACK_STREAMS_WAIT_TIMEOUT_MS}. */
+    timeoutMs?: number;
+};
+/** Waits for the requested loopback tracks. */
+export declare const waitForLoopbackStreams: (call: Call, opts: WaitForLoopbackStreamsOptions) => Promise<LoopbackTracks | null>;
+/** Enables loopback audio while `fn` runs, then restores it. */
+export declare const withLoopbackAudioEnabled: <T>(tracks: LoopbackTracks, fn: () => Promise<T>) => Promise<T>;
+/** Enables loopback audio and returns a restore function. */
+export declare const enableLoopbackAudio: (tracks: LoopbackTracks) => (() => void);
+/** Clamps and rounds a loopback recording duration. */
+export declare const clampLoopbackRecordingDuration: (durationMs: number) => number;

package/dist/src/reporting/ClientEventReporter.d.ts

@@ -12,7 +12,6 @@ export type CallReportContext = {
     callId: string;
     getSfuId: () => string;
     getCallSessionId: () => string;
-    getUserSessionId: () => string;
 };
 export type ClientEventReporterOptions = {
     streamClient: StreamClient;
@@ -79,7 +78,6 @@ export declare class ClientEventReporter {
     private emitPeerConnectionSuccess;
     private emitPeerConnectionFailure;
     private getSfuId;
-    private getUserSessionId;
     private sessionIdField;
     private buildCommon;
     private send;

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

@@ -29,6 +29,11 @@ export declare class Subscriber extends BasePeerConnection {
      * Restarts the ICE connection and renegotiates with the SFU.
      */
     restartIce: () => Promise<void>;
+    /**
+     * Whether the given stream is one the SFU echoed back to us
+     * (`allowOwnTracksLoopback`) rather than a local capture stream.
+     */
+    isSelfSubscribedStream: (stream: MediaStream | undefined) => boolean;
     private handleOnTrack;
     private setRemoteTrackInterrupted;
     private negotiate;

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

@@ -36,6 +36,19 @@ export declare const publishingVideo: Comparator<StreamVideoParticipant>;
  * @param b the second participant.
  */
 export declare const publishingAudio: Comparator<StreamVideoParticipant>;
+/**
+ * A comparator which prioritizes participants who are publishing any track
+ * over participants who are not publishing at all.
+ *
+ * Unlike `publishingVideo` and `publishingAudio`, this comparator does not
+ * distinguish between track types. Muting the microphone or turning off the
+ * camera does not change a participant's rank as long as they still publish
+ * something, which keeps the ordering stable across ordinary device toggles.
+ *
+ * @param a the first participant.
+ * @param b the second participant.
+ */
+export declare const publishing: Comparator<StreamVideoParticipant>;
 /**
  * A comparator which prioritizes participants who are pinned.
  *

package/index.ts

@@ -23,6 +23,8 @@ export * from './src/helpers/humanize';
 export * from './src/helpers/DynascaleManager';
 export * from './src/helpers/ViewportTracker';
 export * from './src/helpers/sound-detector';
+export * from './src/helpers/loopback';
+export * from './src/helpers/MediaStreamRecorder';
 export * from './src/helpers/participantUtils';
 export * from './src/rtc/e2ee/E2EEManager';
 export * from './src/rtc/e2ee/EncryptionManager';

package/package.json

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