@stream-io/video-client 1.19.2 → 1.20.0

package/dist/src/Call.d.ts

@@ -1,6 +1,6 @@
 import { Publisher, Subscriber } from './rtc';
 import { CallState } from './store';
-import type { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendCallEventResponse, SendReactionRequest, SendReactionResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRecordingResponse, StopRTMPBroadcastsResponse, StopTranscriptionResponse, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse, VideoDimension } from './gen/coordinator';
+import type { AcceptCallResponse, BlockUserResponse, CallRingEvent, CallSettingsResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, JoinCallResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersResponse, PinRequest, PinResponse, QueryCallMembersRequest, QueryCallMembersResponse, RejectCallResponse, RequestPermissionRequest, RequestPermissionResponse, SendCallEventResponse, SendReactionRequest, SendReactionResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRecordingRequest, StartRecordingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRecordingResponse, StopRTMPBroadcastsResponse, 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';
@@ -8,6 +8,7 @@ import { PermissionsContext } from './permissions';
 import { StreamClient } from './coordinator/connection/client';
 import { AllCallEvents, CallEventListener, Logger, RejectReason } from './coordinator/connection/types';
 import { CameraManager, MicrophoneManager, ScreenShareManager, SpeakerManager } from './devices';
+import { GetCallStatsResponse } from './gen/shims';
 /**
  * An object representation of a `Call`.
  */
@@ -109,7 +110,12 @@ export declare class Call {
      * method to construct a `Call` instance.
      */
     constructor({ type, id, streamClient, members, ownCapabilities, sortParticipantsBy, clientStore, ringing, watching, }: CallConstructor);
-    private setup;
+    /**
+     * Sets up the call instance.
+     *
+     * @internal an internal method and should not be used outside the SDK.
+     */
+    setup: () => Promise<void>;
     private registerEffects;
     private handleOwnCapabilitiesUpdated;
     /**
@@ -635,8 +641,19 @@ export declare class Call {
      *
      * @param callSessionID the call session ID to retrieve statistics for.
      * @returns The call stats.
+     * @deprecated use `call.getCallReport` instead.
+     * @internal
      */
     getCallStats: (callSessionID: string) => Promise<GetCallStatsResponse>;
+    /**
+     * Retrieve call report. If the `callSessionID` is not specified, then the
+     * report for the latest call session is retrieved. If it is specified, then
+     * the report for that particular session is retrieved if it exists.
+     *
+     * @param callSessionID the optional call session ID to retrieve statistics for
+     * @returns the call report
+     */
+    getCallReport: (callSessionID?: string) => Promise<GetCallReportResponse>;
     /**
      * Submit user feedback for the call
      *

package/dist/src/StreamSfuClient.d.ts

@@ -70,6 +70,10 @@ export declare class StreamSfuClient {
      * This is set to `true` when the user initiates the leave process.
      */
     isLeaving: boolean;
+    /**
+     * Flag to indicate if the client is in the process of closing the connection.
+     */
+    isClosing: boolean;
     private readonly rpc;
     private keepAliveInterval?;
     private connectionCheckTimeout?;