@stream-io/video-client 1.13.1 → 1.15.0

package/dist/src/Call.d.ts

@@ -1,7 +1,7 @@
 import { Publisher, Subscriber } from './rtc';
 import { CallState } from './store';
-import type { AcceptCallResponse, BlockUserResponse, CallRingEvent, CollectUserFeedbackResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendCallEventResponse, SendReactionRequest, SendReactionResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopHLSBroadcastingResponse, StopLiveResponse, StopRecordingResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse, VideoResolution } from './gen/coordinator';
-import { AudioTrackType, CallConstructor, CallLeaveOptions, JoinCallData, PublishOptions, TrackMuteType, VideoTrackType } from './types';
+import type { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CollectUserFeedbackResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendCallEventResponse, SendReactionRequest, SendReactionResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopHLSBroadcastingResponse, StopLiveResponse, StopRecordingResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse, VideoDimension } from './gen/coordinator';
+import { AudioTrackType, CallConstructor, CallLeaveOptions, ClientPublishOptions, ClosedCaptionsSettings, JoinCallData, TrackMuteType, VideoTrackType } from './types';
 import { TrackType } from './gen/video/sfu/models/models';
 import { DynascaleManager } from './helpers/DynascaleManager';
 import { PermissionsContext } from './permissions';
@@ -69,7 +69,8 @@ export declare class Call {
      * @private
      */
     private readonly dispatcher;
-    private publishOptions?;
+    private clientPublishOptions?;
+    private currentPublishOptions?;
     private statsReporter?;
     private sfuStatsReporter?;
     private dropTimeout;
@@ -210,6 +211,18 @@ export declare class Call {
      * @internal
      */
     private getReconnectDetails;
+    /**
+     * Prepares the preferred codec for the call.
+     * This is an experimental client feature and subject to change.
+     * @internal
+     */
+    private getPreferredPublishOptions;
+    /**
+     * Prepares the preferred options for subscribing to tracks.
+     * This is an experimental client feature and subject to change.
+     * @internal
+     */
+    private getPreferredSubscribeOptions;
     /**
      * Performs an ICE restart on both the Publisher and Subscriber Peer Connections.
      * Uses the provided SFU client to restore the ICE connection.
@@ -282,48 +295,47 @@ export declare class Call {
     private restoreSubscribedTracks;
     /**
      * Starts publishing the given video stream to the call.
-     * The stream will be stopped if the user changes an input device, or if the user leaves the call.
-     *
-     * Consecutive calls to this method will replace the previously published stream.
-     * The previous video stream will be stopped.
-     *
-     * @param videoStream the video stream to publish.
+     * @deprecated use `call.publish()`.
      */
     publishVideoStream: (videoStream: MediaStream) => Promise<void>;
     /**
      * Starts publishing the given audio stream to the call.
-     * The stream will be stopped if the user changes an input device, or if the user leaves the call.
-     *
-     * Consecutive calls to this method will replace the audio stream that is currently being published.
-     * The previous audio stream will be stopped.
-     *
-     * @param audioStream the audio stream to publish.
+     * @deprecated use `call.publish()`
      */
     publishAudioStream: (audioStream: MediaStream) => Promise<void>;
     /**
      * Starts publishing the given screen-share stream to the call.
-     *
-     * Consecutive calls to this method will replace the previous screen-share stream.
-     * The previous screen-share stream will be stopped.
-     *
-     * @param screenShareStream the screen-share stream to publish.
+     * @deprecated use `call.publish()`
      */
     publishScreenShareStream: (screenShareStream: MediaStream) => Promise<void>;
+    /**
+     * Publishes the given media stream.
+     *
+     * @param mediaStream the media stream to publish.
+     * @param trackType the type of the track to announce.
+     */
+    publish: (mediaStream: MediaStream, trackType: TrackType) => Promise<void>;
     /**
      * Stops publishing the given track type to the call, if it is currently being published.
-     * Underlying track will be stopped and removed from the publisher.
      *
-     * @param trackType the track type to stop publishing.
-     * @param stopTrack if `true` the track will be stopped, else it will be just disabled
+     * @param trackTypes the track types to stop publishing.
+     */
+    stopPublish: (...trackTypes: TrackType[]) => Promise<void>;
+    /**
+     * Updates the call state with the new stream.
+     *
+     * @param mediaStream the new stream to update the call state with.
+     * If undefined, the stream will be removed from the call state.
+     * @param trackTypes the track types to update the call state with.
      */
-    stopPublish: (trackType: TrackType, stopTrack?: boolean) => Promise<void>;
+    private updateLocalStreamState;
     /**
      * Updates the preferred publishing options
      *
      * @internal
      * @param options the options to use.
      */
-    updatePublishOptions(options: PublishOptions): void;
+    updatePublishOptions: (options: ClientPublishOptions) => void;
     /**
      * Notifies the SFU that a noise cancellation process has started.
      *
@@ -336,6 +348,11 @@ export declare class Call {
      * @internal
      */
     notifyNoiseCancellationStopped: () => Promise<void | import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<import("./gen/video/sfu/signal_rpc/signal").StopNoiseCancellationRequest, import("./gen/video/sfu/signal_rpc/signal").StopNoiseCancellationResponse> | undefined>;
+    /**
+     * Notifies the SFU about the mute state of the given track types.
+     * @internal
+     */
+    notifyTrackMuteState: (muted: boolean, ...trackTypes: TrackType[]) => Promise<void>;
     /**
      * Will enhance the reported stats with additional participant-specific information (`callStatsReport$` state [store variable](./StreamVideoClient.md/#readonlystatestore)).
      * This is usually helpful when detailed stats for a specific participant are needed.
@@ -424,7 +441,23 @@ export declare class Call {
      */
     stopTranscription: () => Promise<StopTranscriptionResponse>;
     /**
-     * Sends a `call.permission_request` event to all users connected to the call. The call settings object contains infomration about which permissions can be requested during a call (for example a user might be allowed to request permission to publish audio, but not video).
+     * Starts the closed captions of the call.
+     */
+    startClosedCaptions: (options?: StartClosedCaptionsRequest) => Promise<StartClosedCaptionsResponse>;
+    /**
+     * Stops the closed captions of the call.
+     */
+    stopClosedCaptions: (options?: StopClosedCaptionsRequest) => Promise<StopClosedCaptionsResponse>;
+    /**
+     * Updates the closed caption settings.
+     *
+     * @param config the closed caption settings to apply
+     */
+    updateClosedCaptionSettings: (config: Partial<ClosedCaptionsSettings>) => void;
+    /**
+     * Sends a `call.permission_request` event to all users connected to the call.
+     * The call settings object contains information about which permissions can be requested during a call
+     * (for example, a user might be allowed to request permission to publish audio, but not video).
      */
     requestPermissions: (data: RequestPermissionRequest) => Promise<RequestPermissionResponse>;
     /**
@@ -592,9 +625,7 @@ export declare class Call {
      *
      * @internal
      */
-    applyDeviceConfig: (status: boolean) => Promise<void>;
-    private initCamera;
-    private initMic;
+    applyDeviceConfig: (settings: CallSettingsResponse, publish: boolean) => Promise<void>;
     /**
      * Will begin tracking the given element for visibility changes within the
      * configured viewport element (`call.setViewport`).
@@ -656,7 +687,7 @@ export declare class Call {
      * @param sessionIds optionally specify session ids of the participants this
      * preference has effect on. Affects all participants by default.
      */
-    setPreferredIncomingVideoResolution: (resolution: VideoResolution | undefined, sessionIds?: string[]) => void;
+    setPreferredIncomingVideoResolution: (resolution: VideoDimension | undefined, sessionIds?: string[]) => void;
     /**
      * Enables or disables incoming video from all remote call participants,
      * and removes any preference for preferred resolution.

package/dist/src/StreamSfuClient.d.ts

@@ -1,7 +1,7 @@
 import { Dispatcher, IceTrickleBuffer } from './rtc';
 import { JoinRequest, JoinResponse } from './gen/video/sfu/event/events';
-import { ICERestartRequest, SendAnswerRequest, SendStatsRequest, SetPublisherRequest, TrackSubscriptionDetails, UpdateMuteStatesRequest } from './gen/video/sfu/signal_rpc/signal';
-import { ICETrickle, TrackType } from './gen/video/sfu/models/models';
+import { ICERestartRequest, SendAnswerRequest, SendStatsRequest, SetPublisherRequest, TrackMuteState, TrackSubscriptionDetails } from './gen/video/sfu/signal_rpc/signal';
+import { ICETrickle } from './gen/video/sfu/models/models';
 import { StreamClient } from './coordinator/connection/client';
 import { Credentials } from './gen/coordinator';
 export type StreamSfuClientConstructor = {
@@ -122,15 +122,14 @@ export declare class StreamSfuClient {
     get joinTask(): Promise<JoinResponse>;
     private handleWebSocketClose;
     close: (code?: number, reason?: string) => void;
-    dispose: () => void;
+    private dispose;
     leaveAndClose: (reason: string) => Promise<void>;
     updateSubscriptions: (tracks: TrackSubscriptionDetails[]) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<import("./gen/video/sfu/signal_rpc/signal").UpdateSubscriptionsRequest, import("./gen/video/sfu/signal_rpc/signal").UpdateSubscriptionsResponse>>;
     setPublisher: (data: Omit<SetPublisherRequest, "sessionId">) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<SetPublisherRequest, import("./gen/video/sfu/signal_rpc/signal").SetPublisherResponse>>;
     sendAnswer: (data: Omit<SendAnswerRequest, "sessionId">) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<SendAnswerRequest, import("./gen/video/sfu/signal_rpc/signal").SendAnswerResponse>>;
     iceTrickle: (data: Omit<ICETrickle, "sessionId">) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<ICETrickle, import("./gen/video/sfu/signal_rpc/signal").ICETrickleResponse>>;
     iceRestart: (data: Omit<ICERestartRequest, "sessionId">) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<ICERestartRequest, import("./gen/video/sfu/signal_rpc/signal").ICERestartResponse>>;
-    updateMuteState: (trackType: TrackType, muted: boolean) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<UpdateMuteStatesRequest, import("./gen/video/sfu/signal_rpc/signal").UpdateMuteStatesResponse>>;
-    updateMuteStates: (data: Omit<UpdateMuteStatesRequest, "sessionId">) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<UpdateMuteStatesRequest, import("./gen/video/sfu/signal_rpc/signal").UpdateMuteStatesResponse>>;
+    updateMuteStates: (muteStates: TrackMuteState[]) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<import("./gen/video/sfu/signal_rpc/signal").UpdateMuteStatesRequest, import("./gen/video/sfu/signal_rpc/signal").UpdateMuteStatesResponse>>;
     sendStats: (stats: Omit<SendStatsRequest, "sessionId">) => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<SendStatsRequest, import("./gen/video/sfu/signal_rpc/signal").SendStatsResponse>>;
     startNoiseCancellation: () => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<import("./gen/video/sfu/signal_rpc/signal").StartNoiseCancellationRequest, import("./gen/video/sfu/signal_rpc/signal").StartNoiseCancellationResponse>>;
     stopNoiseCancellation: () => Promise<import("@protobuf-ts/runtime-rpc").FinishedUnaryCall<import("./gen/video/sfu/signal_rpc/signal").StopNoiseCancellationRequest, import("./gen/video/sfu/signal_rpc/signal").StopNoiseCancellationResponse>>;

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

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import { Call } from '../Call';
 import { CameraDirection, CameraManagerState } from './CameraManagerState';
 import { InputMediaDeviceManager } from './InputMediaDeviceManager';
-import { PreferredCodec } from '../types';
+import { VideoSettingsResponse } from '../gen/coordinator';
 export declare class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
     private targetResolution;
     /**
@@ -33,15 +33,12 @@ export declare class CameraManager extends InputMediaDeviceManager<CameraManager
         height: number;
     }): Promise<void>;
     /**
-     * Sets the preferred codec for encoding the video.
+     * Applies the video settings to the camera.
      *
-     * @internal internal use only, not part of the public API.
-     * @deprecated use {@link call.updatePublishOptions} instead.
-     * @param codec the codec to use for encoding the video.
+     * @param settings the video settings to apply.
+     * @param publish whether to publish the stream after applying the settings.
      */
-    setPreferredCodec(codec: PreferredCodec | undefined): void;
+    apply(settings: VideoSettingsResponse, publish: boolean): Promise<void>;
     protected getDevices(): Observable<MediaDeviceInfo[]>;
     protected getStream(constraints: MediaTrackConstraints): Promise<MediaStream>;
-    protected publishStream(stream: MediaStream): Promise<void>;
-    protected stopPublishStream(stopTracks: boolean): Promise<void>;
 }

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

@@ -85,16 +85,16 @@ export declare abstract class InputMediaDeviceManager<T extends InputMediaDevice
     protected applySettingsToStream(): Promise<void>;
     protected abstract getDevices(): Observable<MediaDeviceInfo[]>;
     protected abstract getStream(constraints: C): Promise<MediaStream>;
-    protected abstract publishStream(stream: MediaStream): Promise<void>;
-    protected abstract stopPublishStream(stopTracks: boolean): Promise<void>;
+    protected publishStream(stream: MediaStream): Promise<void>;
+    protected stopPublishStream(): Promise<void>;
     protected getTracks(): MediaStreamTrack[];
     protected muteStream(stopTracks?: boolean): Promise<void>;
-    private muteTracks;
-    private unmuteTracks;
+    private disableTracks;
+    private enableTracks;
     private stopTracks;
     private muteLocalStream;
     protected unmuteStream(): Promise<void>;
     private get mediaDeviceKind();
     private handleDisconnectedOrReplacedDevices;
-    private findDeviceInList;
+    private findDevice;
 }

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

@@ -4,6 +4,7 @@ import { Call } from '../Call';
 import { InputMediaDeviceManager } from './InputMediaDeviceManager';
 import { MicrophoneManagerState } from './MicrophoneManagerState';
 import { TrackDisableMode } from './InputMediaDeviceManagerState';
+import { AudioSettingsResponse } from '../gen/coordinator';
 export declare class MicrophoneManager extends InputMediaDeviceManager<MicrophoneManagerState> {
     private speakingWhileMutedNotificationEnabled;
     private soundDetectorConcurrencyTag;
@@ -35,10 +36,14 @@ export declare class MicrophoneManager extends InputMediaDeviceManager<Microphon
      * Disables speaking while muted notification.
      */
     disableSpeakingWhileMutedNotification(): Promise<void>;
+    /**
+     * 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.
+     */
+    apply(settings: AudioSettingsResponse, publish: boolean): Promise<void>;
     protected getDevices(): Observable<MediaDeviceInfo[]>;
     protected getStream(constraints: MediaTrackConstraints): Promise<MediaStream>;
-    protected publishStream(stream: MediaStream): Promise<void>;
-    protected stopPublishStream(stopTracks: boolean): Promise<void>;
     private startSpeakingWhileMutedDetection;
     private stopSpeakingWhileMutedDetection;
 }

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

@@ -28,8 +28,7 @@ export declare class ScreenShareManager extends InputMediaDeviceManager<ScreenSh
     setSettings(settings: ScreenShareSettings | undefined): void;
     protected getDevices(): Observable<MediaDeviceInfo[]>;
     protected getStream(constraints: DisplayMediaStreamOptions): Promise<MediaStream>;
-    protected publishStream(stream: MediaStream): Promise<void>;
-    protected stopPublishStream(stopTracks: boolean): Promise<void>;
+    protected stopPublishStream(): Promise<void>;
     /**
      * Overrides the default `select` method to throw an error.
      *