@stream-io/video-client 1.13.0 → 1.14.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, 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, ClosedCaptionsSettings, JoinCallData, PublishOptions, TrackMuteType, VideoTrackType } from './types';
 import { TrackType } from './gen/video/sfu/models/models';
 import { DynascaleManager } from './helpers/DynascaleManager';
 import { PermissionsContext } from './permissions';
@@ -424,7 +424,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>;
     /**
@@ -656,7 +672,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.