@stream-io/video-client 1.57.0 → 1.59.0

package/dist/src/Call.d.ts

@@ -1,7 +1,8 @@
-import { Publisher, Subscriber, TrackPublishOptions } from './rtc';
+import { type CallMediaEngine, Publisher, Subscriber, TrackPublishOptions } from './rtc';
+import type { E2EEManager } from './rtc/e2ee/E2EEManager';
 import { CallState } from './store';
 import { ScopedLogger } from './logger';
-import type { 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, SendReactionRequest, SendReactionResponse, 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, 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';
@@ -84,6 +85,7 @@ export declare class Call {
     readonly blockedAudioTracker: BlockedAudioTracker;
     subscriber?: Subscriber;
     publisher?: Publisher;
+    e2eeManager?: E2EEManager;
     /**
      * Flag telling whether this call is a "ringing" call.
      */
@@ -132,6 +134,8 @@ export declare class Call {
     private allowOwnTracksLoopback;
     private hasJoinedOnce;
     private deviceSettingsAppliedOnce;
+    private callManagerStarted;
+    private leaveGeneration;
     private credentials?;
     private initialized;
     private readonly acceptRejectConcurrencyTag;
@@ -148,6 +152,13 @@ export declare class Call {
      * A list of capabilities that the client supports and are enabled.
      */
     private clientCapabilities;
+    /**
+     * The in-flight per-call media engine. On web/React this resolves to a thin
+     * globals-backed engine (no provider registered); React Native registers a
+     * provider that owns a per-call native factory.
+     * @internal
+     */
+    private mediaEnginePromise?;
     /**
      * Constructs a new `Call` instance.
      *
@@ -212,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.
      *
@@ -275,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.
@@ -325,10 +343,26 @@ export declare class Call {
      * Retrieves credentials for joining the call.
      *
      * @internal
-     *
      * @param data the join call data.
      */
     doJoinRequest: (data?: JoinCallData) => Promise<JoinCallResponse>;
+    /**
+     * Whether the per-call media engine currently exists. True from join until leave.
+     *
+     * @internal an internal getter and should not be used outside the SDK.
+     */
+    get hasMediaEngine(): boolean;
+    /**
+     * Ensures a {@link CallMediaEngine} exists for this call's media session and
+     * returns it. Idempotent: the engine is created once via the registered
+     * provider (see `setCallMediaEngineProvider`) and cached until `leave()`
+     * disposes it. Concurrent callers (e.g. camera + microphone enabling in
+     * parallel) share the same engine because the in-flight creation promise is
+     * cached, never the unresolved result.
+     *
+     * @internal
+     */
+    ensureMediaFactory: () => Promise<CallMediaEngine>;
     /**
      * Handles the closing of the SFU signal connection.
      *
@@ -433,6 +467,25 @@ export declare class Call {
      * @param options the options to use.
      */
     updatePublishOptions: (options: ClientPublishOptions) => void;
+    /**
+     * Set the E2EE (end-to-end encryption) manager for this call.
+     *
+     * Must be called before {@link join} so the RTCPeerConnection can be
+     * configured for E2EE.
+     *
+     * The manager is kept across {@link leave} so a rejoin of this same instance
+     * stays encrypted: do not dispose it while this call may be joined again.
+     * A disposed manager throws from `encrypt`/`decrypt` rather than silently
+     * publishing nothing, so re-attach a fresh one instead of reusing it.
+     *
+     * @param e2ee - Any `E2EEManager`. Use `EncryptionManager.create()` for the
+     *         built-in AES-GCM scheme, or pass your own implementation.
+     * @throws if called after the peer connections have been built (i.e. after
+     *         `join`): those PCs were already configured without an encryptor, so
+     *         adopting a manager now would silently publish/receive cleartext for
+     *         the live session.
+     */
+    setE2EEManager: (e2ee: E2EEManager) => void;
     /**
      * Notifies the SFU that a noise cancellation process has started.
      *
@@ -491,7 +544,7 @@ export declare class Call {
      *
      * @param reaction the reaction to send.
      */
-    sendReaction: (reaction: SendReactionRequest) => Promise<SendReactionResponse>;
+    sendReaction: (reaction: SendVideoReactionRequest) => Promise<SendVideoReactionResponse>;
     /**
      * Blocks the user with the given `userId`.
      *
@@ -584,7 +637,7 @@ export declare class Call {
      * @param userId the id of the user to grant permissions to.
      * @param permissions the permissions to grant.
      */
-    grantPermissions: (userId: string, permissions: string[]) => Promise<UpdateUserPermissionsResponse>;
+    grantPermissions: (userId: string, permissions: string[] | UpdateUserPermissionsRequestGrantPermissionsEnum[]) => Promise<UpdateUserPermissionsResponse>;
     /**
      * Allows you to revoke certain permissions from a user in a call.
      * The permissions are specific to the call experience and do not survive the call itself.
@@ -597,7 +650,7 @@ export declare class Call {
      * @param userId the id of the user to revoke permissions from.
      * @param permissions the permissions to revoke.
      */
-    revokePermissions: (userId: string, permissions: string[]) => Promise<UpdateUserPermissionsResponse>;
+    revokePermissions: (userId: string, permissions: string[] | UpdateUserPermissionsRequestRevokePermissionsEnum[]) => Promise<UpdateUserPermissionsResponse>;
     /**
      * Allows you to grant or revoke a specific permission to a user in a call. The permissions are specific to the call experience and do not survive the call itself.
      * When revoking a permission, this endpoint will also mute the relevant track from the user. This is similar to muting a user with the difference that the user will not be able to unmute afterwards.
@@ -822,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/connection.d.ts

@@ -1,7 +1,7 @@
 import { StreamClient } from './client';
 import type { UR, WSConnectionError } from './types';
 import type { LogLevel } from '@stream-io/logger';
-import type { ConnectedEvent } from '../../gen/coordinator';
+import { ConnectedEvent } from '../../gen/coordinator';
 /**
  * StableWSConnection - A WS connection that reconnects upon failure.
  * - the browser will sometimes report that you're online or offline

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

@@ -37,13 +37,20 @@ export declare class CameraManager extends DeviceManager<CameraManagerState> {
         width: number;
         height: number;
     }): Promise<void>;
+    enable(): Promise<void>;
+    disable(options: {
+        forceStop?: boolean;
+    }): Promise<void>;
+    disable(forceStop?: boolean): Promise<void>;
+    toggle(): Promise<void>;
     /**
      * Applies the video settings to the camera.
      *
      * @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

@@ -118,6 +118,7 @@ export declare abstract class DeviceManager<S extends DeviceManagerState<C>, C =
     protected stopPublishStream(): Promise<void>;
     protected getTracks(): MediaStreamTrack[];
     protected muteStream(stopTracks?: boolean): Promise<void>;
+    protected reconcileOptimisticStatus: () => Promise<void>;
     private disableTracks;
     private enableTracks;
     private stopTracks;
@@ -129,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

@@ -20,6 +20,12 @@ export declare class MicrophoneManager extends AudioDeviceManager<MicrophoneMana
     private silenceThresholdMs;
     constructor(call: Call, devicePersistence: Required<DevicePersistenceOptions>, disableMode?: TrackDisableMode);
     setup(): void;
+    enable(): Promise<void>;
+    disable(options: {
+        forceStop?: boolean;
+    }): Promise<void>;
+    disable(forceStop?: boolean): Promise<void>;
+    toggle(): Promise<void>;
     /**
      * Enables noise cancellation for the microphone.
      *
@@ -63,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/devices/SpeakerManager.d.ts

@@ -10,7 +10,7 @@ export declare class SpeakerManager {
     private defaultDevice?;
     private readonly devicePersistence;
     constructor(call: Call, devicePreferences: Required<DevicePersistenceOptions>);
-    apply(settings: CallSettingsResponse): void;
+    apply(settings: CallSettingsResponse): Promise<void>;
     private applyWeb;
     private applyRN;
     setup(): void;
@@ -51,5 +51,6 @@ export declare class SpeakerManager {
      * @param volume a number between 0 and 1. Set it to `undefined` to use the default volume.
      */
     setParticipantVolume(sessionId: string, volume: number | undefined): void;
+    private findDevice;
     private persistSpeakerDevicePreference;
 }

package/dist/src/events/participant.d.ts

@@ -1,9 +1,15 @@
 import type { ParticipantJoined, ParticipantLeft, ParticipantUpdated, TrackPublished, TrackUnpublished } from '../gen/video/sfu/event/events';
 import { CallState } from '../store';
+import type { E2EEManager } from '../rtc/e2ee/E2EEManager';
+/**
+ * Reads the call's current encryption manager. Deliberately not the manager
+ * itself: `Call.setE2EEManager` may be called after these handlers are wired up.
+ */
+type GetE2EEManager = () => E2EEManager | undefined;
 /**
  * An event responder which handles the `participantJoined` event.
  */
-export declare const watchParticipantJoined: (state: CallState) => (e: ParticipantJoined) => void;
+export declare const watchParticipantJoined: (state: CallState, e2ee?: GetE2EEManager | undefined) => (e: ParticipantJoined) => void;
 /**
  * An event responder which handles the `participantLeft` event.
  */
@@ -16,9 +22,10 @@ export declare const watchParticipantUpdated: (state: CallState) => (e: Particip
  * An event responder which handles the `trackPublished` event.
  * The SFU will send this event when a participant publishes a track.
  */
-export declare const watchTrackPublished: (state: CallState) => (e: TrackPublished) => void;
+export declare const watchTrackPublished: (state: CallState, e2ee?: GetE2EEManager | undefined) => (e: TrackPublished) => void;
 /**
  * An event responder which handles the `trackUnpublished` event.
  * The SFU will send this event when a participant unpublishes a track.
  */
-export declare const watchTrackUnpublished: (state: CallState) => (e: TrackUnpublished) => void;
+export declare const watchTrackUnpublished: (state: CallState, e2ee?: GetE2EEManager | undefined) => (e: TrackUnpublished) => void;
+export {};