@stream-io/video-client 0.3.25 → 0.3.27

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

@@ -295,40 +295,40 @@ export interface BlockedUserEvent {
 /**
  *
  * @export
- * @interface BroadcastSettings
+ * @interface BroadcastSettingsRequest
  */
-export interface BroadcastSettings {
+export interface BroadcastSettingsRequest {
     /**
      *
      * @type {boolean}
-     * @memberof BroadcastSettings
+     * @memberof BroadcastSettingsRequest
      */
-    enabled: boolean;
+    enabled?: boolean;
     /**
      *
-     * @type {HLSSettings}
-     * @memberof BroadcastSettings
+     * @type {HLSSettingsRequest}
+     * @memberof BroadcastSettingsRequest
      */
-    hls: HLSSettings;
+    hls?: HLSSettingsRequest;
 }
 /**
  *
  * @export
- * @interface BroadcastSettingsRequest
+ * @interface BroadcastSettingsResponse
  */
-export interface BroadcastSettingsRequest {
+export interface BroadcastSettingsResponse {
     /**
      *
      * @type {boolean}
-     * @memberof BroadcastSettingsRequest
+     * @memberof BroadcastSettingsResponse
      */
-    enabled?: boolean;
+    enabled: boolean;
     /**
      *
-     * @type {HLSSettingsRequest}
-     * @memberof BroadcastSettingsRequest
+     * @type {HLSSettingsResponse}
+     * @memberof BroadcastSettingsResponse
      */
-    hls?: HLSSettingsRequest;
+    hls: HLSSettingsResponse;
 }
 /**
  * This event is sent when a user accepts a notification to join a call.
@@ -368,135 +368,135 @@ export interface CallAcceptedEvent {
     user: UserResponse;
 }
 /**
- * This event is sent when call broadcasting has started
+ * This event is sent when a call is created. Clients receiving this event should check if the ringing
+ * field is set to true and if so, show the call screen
  * @export
- * @interface CallBroadcastingStartedEvent
+ * @interface CallCreatedEvent
  */
-export interface CallBroadcastingStartedEvent {
+export interface CallCreatedEvent {
+    /**
+     *
+     * @type {CallResponse}
+     * @memberof CallCreatedEvent
+     */
+    call: CallResponse;
     /**
      *
      * @type {string}
-     * @memberof CallBroadcastingStartedEvent
+     * @memberof CallCreatedEvent
      */
     call_cid: string;
     /**
      *
      * @type {string}
-     * @memberof CallBroadcastingStartedEvent
+     * @memberof CallCreatedEvent
      */
     created_at: string;
     /**
-     *
-     * @type {string}
-     * @memberof CallBroadcastingStartedEvent
+     * the members added to this call
+     * @type {Array<MemberResponse>}
+     * @memberof CallCreatedEvent
      */
-    hls_playlist_url: string;
+    members: Array<MemberResponse>;
     /**
-     * The type of event: "call.broadcasting_started" in this case
+     * The type of event: "call.created" in this case
      * @type {string}
-     * @memberof CallBroadcastingStartedEvent
+     * @memberof CallCreatedEvent
      */
     type: string;
 }
 /**
- * This event is sent when call broadcasting has stopped
+ * This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen
  * @export
- * @interface CallBroadcastingStoppedEvent
+ * @interface CallEndedEvent
  */
-export interface CallBroadcastingStoppedEvent {
+export interface CallEndedEvent {
+    /**
+     *
+     * @type {CallResponse}
+     * @memberof CallEndedEvent
+     */
+    call: CallResponse;
     /**
      *
      * @type {string}
-     * @memberof CallBroadcastingStoppedEvent
+     * @memberof CallEndedEvent
      */
     call_cid: string;
     /**
      *
      * @type {string}
-     * @memberof CallBroadcastingStoppedEvent
+     * @memberof CallEndedEvent
      */
     created_at: string;
     /**
-     * The type of event: "call.broadcasting_stopped" in this case
+     * The type of event: "call.ended" in this case
      * @type {string}
-     * @memberof CallBroadcastingStoppedEvent
+     * @memberof CallEndedEvent
      */
     type: string;
+    /**
+     *
+     * @type {UserResponse}
+     * @memberof CallEndedEvent
+     */
+    user?: UserResponse;
 }
 /**
- * This event is sent when a call is created. Clients receiving this event should check if the ringing
- * field is set to true and if so, show the call screen
+ * This event is sent when HLS broadcasting has started
  * @export
- * @interface CallCreatedEvent
+ * @interface CallHLSBroadcastingStartedEvent
  */
-export interface CallCreatedEvent {
-    /**
-     *
-     * @type {CallResponse}
-     * @memberof CallCreatedEvent
-     */
-    call: CallResponse;
+export interface CallHLSBroadcastingStartedEvent {
     /**
      *
      * @type {string}
-     * @memberof CallCreatedEvent
+     * @memberof CallHLSBroadcastingStartedEvent
      */
     call_cid: string;
     /**
      *
      * @type {string}
-     * @memberof CallCreatedEvent
+     * @memberof CallHLSBroadcastingStartedEvent
      */
     created_at: string;
     /**
-     * the members added to this call
-     * @type {Array<MemberResponse>}
-     * @memberof CallCreatedEvent
+     *
+     * @type {string}
+     * @memberof CallHLSBroadcastingStartedEvent
      */
-    members: Array<MemberResponse>;
+    hls_playlist_url: string;
     /**
-     * The type of event: "call.created" in this case
+     * The type of event: "call.hls_broadcasting_started" in this case
      * @type {string}
-     * @memberof CallCreatedEvent
+     * @memberof CallHLSBroadcastingStartedEvent
      */
     type: string;
 }
 /**
- * This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen
+ * This event is sent when HLS broadcasting has stopped
  * @export
- * @interface CallEndedEvent
+ * @interface CallHLSBroadcastingStoppedEvent
  */
-export interface CallEndedEvent {
-    /**
-     *
-     * @type {CallResponse}
-     * @memberof CallEndedEvent
-     */
-    call: CallResponse;
+export interface CallHLSBroadcastingStoppedEvent {
     /**
      *
      * @type {string}
-     * @memberof CallEndedEvent
+     * @memberof CallHLSBroadcastingStoppedEvent
      */
     call_cid: string;
     /**
      *
      * @type {string}
-     * @memberof CallEndedEvent
+     * @memberof CallHLSBroadcastingStoppedEvent
      */
     created_at: string;
     /**
-     * The type of event: "call.ended" in this case
+     * The type of event: "call.hls_broadcasting_stopped" in this case
      * @type {string}
-     * @memberof CallEndedEvent
+     * @memberof CallHLSBroadcastingStoppedEvent
      */
     type: string;
-    /**
-     *
-     * @type {UserResponse}
-     * @memberof CallEndedEvent
-     */
-    user?: UserResponse;
 }
 /**
  *
@@ -1138,6 +1138,12 @@ export interface CallResponse {
      * @memberof CallResponse
      */
     team?: string;
+    /**
+     *
+     * @type {ThumbnailResponse}
+     * @memberof CallResponse
+     */
+    thumbnails?: ThumbnailResponse;
     /**
      *
      * @type {boolean}
@@ -1469,6 +1475,12 @@ export interface CallSettingsRequest {
      * @memberof CallSettingsRequest
      */
     screensharing?: ScreensharingSettingsRequest;
+    /**
+     *
+     * @type {ThumbnailsSettingsRequest}
+     * @memberof CallSettingsRequest
+     */
+    thumbnails?: ThumbnailsSettingsRequest;
     /**
      *
      * @type {TranscriptionSettingsRequest}
@@ -1502,10 +1514,10 @@ export interface CallSettingsResponse {
     backstage: BackstageSettings;
     /**
      *
-     * @type {BroadcastSettings}
+     * @type {BroadcastSettingsResponse}
      * @memberof CallSettingsResponse
      */
-    broadcasting: BroadcastSettings;
+    broadcasting: BroadcastSettingsResponse;
     /**
      *
      * @type {GeofenceSettings}
@@ -1514,10 +1526,10 @@ export interface CallSettingsResponse {
     geofencing: GeofenceSettings;
     /**
      *
-     * @type {RecordSettings}
+     * @type {RecordSettingsResponse}
      * @memberof CallSettingsResponse
      */
-    recording: RecordSettings;
+    recording: RecordSettingsResponse;
     /**
      *
      * @type {RingSettings}
@@ -1530,6 +1542,12 @@ export interface CallSettingsResponse {
      * @memberof CallSettingsResponse
      */
     screensharing: ScreensharingSettings;
+    /**
+     *
+     * @type {ThumbnailsSettings}
+     * @memberof CallSettingsResponse
+     */
+    thumbnails: ThumbnailsSettings;
     /**
      *
      * @type {TranscriptionSettings}
@@ -2514,52 +2532,64 @@ export interface GoLiveResponse {
 /**
  *
  * @export
- * @interface HLSSettings
+ * @interface HLSSettingsRequest
  */
-export interface HLSSettings {
+export interface HLSSettingsRequest {
     /**
      *
      * @type {boolean}
-     * @memberof HLSSettings
+     * @memberof HLSSettingsRequest
      */
-    auto_on: boolean;
+    auto_on?: boolean;
     /**
      *
      * @type {boolean}
-     * @memberof HLSSettings
+     * @memberof HLSSettingsRequest
      */
-    enabled: boolean;
+    enabled?: boolean;
+    /**
+     *
+     * @type {LayoutSettingsRequest}
+     * @memberof HLSSettingsRequest
+     */
+    layout?: LayoutSettingsRequest;
     /**
      *
      * @type {Array<string>}
-     * @memberof HLSSettings
+     * @memberof HLSSettingsRequest
      */
-    quality_tracks: Array<string>;
+    quality_tracks?: Array<string>;
 }
 /**
  *
  * @export
- * @interface HLSSettingsRequest
+ * @interface HLSSettingsResponse
  */
-export interface HLSSettingsRequest {
+export interface HLSSettingsResponse {
     /**
      *
      * @type {boolean}
-     * @memberof HLSSettingsRequest
+     * @memberof HLSSettingsResponse
      */
-    auto_on?: boolean;
+    auto_on: boolean;
     /**
      *
      * @type {boolean}
-     * @memberof HLSSettingsRequest
+     * @memberof HLSSettingsResponse
      */
-    enabled?: boolean;
+    enabled: boolean;
+    /**
+     *
+     * @type {LayoutSettings}
+     * @memberof HLSSettingsResponse
+     */
+    layout: LayoutSettings;
     /**
      *
      * @type {Array<string>}
-     * @memberof HLSSettingsRequest
+     * @memberof HLSSettingsResponse
      */
-    quality_tracks?: Array<string>;
+    quality_tracks: Array<string>;
 }
 /**
  *
@@ -2709,6 +2739,94 @@ export interface JoinCallResponse {
      */
     own_capabilities: Array<OwnCapability>;
 }
+/**
+ *
+ * @export
+ * @interface LayoutSettings
+ */
+export interface LayoutSettings {
+    /**
+     *
+     * @type {string}
+     * @memberof LayoutSettings
+     */
+    external_app_url: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LayoutSettings
+     */
+    external_css_url: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LayoutSettings
+     */
+    name: LayoutSettingsNameEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof LayoutSettings
+     */
+    options?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const LayoutSettingsNameEnum: {
+    readonly SPOTLIGHT: "spotlight";
+    readonly GRID: "grid";
+    readonly SINGLE_PARTICIPANT: "single-participant";
+    readonly MOBILE: "mobile";
+    readonly CUSTOM: "custom";
+};
+export type LayoutSettingsNameEnum = (typeof LayoutSettingsNameEnum)[keyof typeof LayoutSettingsNameEnum];
+/**
+ *
+ * @export
+ * @interface LayoutSettingsRequest
+ */
+export interface LayoutSettingsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LayoutSettingsRequest
+     */
+    external_app_url?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LayoutSettingsRequest
+     */
+    external_css_url?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LayoutSettingsRequest
+     */
+    name: LayoutSettingsRequestNameEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof LayoutSettingsRequest
+     */
+    options?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const LayoutSettingsRequestNameEnum: {
+    readonly SPOTLIGHT: "spotlight";
+    readonly GRID: "grid";
+    readonly SINGLE_PARTICIPANT: "single-participant";
+    readonly MOBILE: "mobile";
+    readonly CUSTOM: "custom";
+};
+export type LayoutSettingsRequestNameEnum = (typeof LayoutSettingsRequestNameEnum)[keyof typeof LayoutSettingsRequestNameEnum];
 /**
  *
  * @export
@@ -3347,95 +3465,85 @@ export interface ReactionResponse {
 /**
  *
  * @export
- * @interface RecordSettings
+ * @interface RecordSettingsRequest
  */
-export interface RecordSettings {
+export interface RecordSettingsRequest {
     /**
      *
      * @type {boolean}
-     * @memberof RecordSettings
+     * @memberof RecordSettingsRequest
      */
-    audio_only: boolean;
+    audio_only?: boolean;
+    /**
+     *
+     * @type {LayoutSettingsRequest}
+     * @memberof RecordSettingsRequest
+     */
+    layout?: LayoutSettingsRequest;
     /**
      *
      * @type {string}
-     * @memberof RecordSettings
+     * @memberof RecordSettingsRequest
      */
-    mode: RecordSettingsModeEnum;
+    mode: RecordSettingsRequestModeEnum;
     /**
      *
      * @type {string}
-     * @memberof RecordSettings
+     * @memberof RecordSettingsRequest
      */
-    quality: RecordSettingsQualityEnum;
+    quality?: RecordSettingsRequestQualityEnum;
 }
 /**
  * @export
  */
-export declare const RecordSettingsModeEnum: {
+export declare const RecordSettingsRequestModeEnum: {
     readonly AVAILABLE: "available";
     readonly DISABLED: "disabled";
     readonly AUTO_ON: "auto-on";
 };
-export type RecordSettingsModeEnum = (typeof RecordSettingsModeEnum)[keyof typeof RecordSettingsModeEnum];
+export type RecordSettingsRequestModeEnum = (typeof RecordSettingsRequestModeEnum)[keyof typeof RecordSettingsRequestModeEnum];
 /**
  * @export
  */
-export declare const RecordSettingsQualityEnum: {
-    readonly AUDIO_ONLY: "audio-only";
+export declare const RecordSettingsRequestQualityEnum: {
     readonly _360P: "360p";
     readonly _480P: "480p";
     readonly _720P: "720p";
     readonly _1080P: "1080p";
     readonly _1440P: "1440p";
 };
-export type RecordSettingsQualityEnum = (typeof RecordSettingsQualityEnum)[keyof typeof RecordSettingsQualityEnum];
+export type RecordSettingsRequestQualityEnum = (typeof RecordSettingsRequestQualityEnum)[keyof typeof RecordSettingsRequestQualityEnum];
 /**
  *
  * @export
- * @interface RecordSettingsRequest
+ * @interface RecordSettingsResponse
  */
-export interface RecordSettingsRequest {
+export interface RecordSettingsResponse {
     /**
      *
      * @type {boolean}
-     * @memberof RecordSettingsRequest
+     * @memberof RecordSettingsResponse
      */
-    audio_only?: boolean;
+    audio_only: boolean;
+    /**
+     *
+     * @type {LayoutSettings}
+     * @memberof RecordSettingsResponse
+     */
+    layout: LayoutSettings;
     /**
      *
      * @type {string}
-     * @memberof RecordSettingsRequest
+     * @memberof RecordSettingsResponse
      */
-    mode?: RecordSettingsRequestModeEnum;
+    mode: string;
     /**
      *
      * @type {string}
-     * @memberof RecordSettingsRequest
+     * @memberof RecordSettingsResponse
      */
-    quality?: RecordSettingsRequestQualityEnum;
+    quality: string;
 }
-/**
- * @export
- */
-export declare const RecordSettingsRequestModeEnum: {
-    readonly AVAILABLE: "available";
-    readonly DISABLED: "disabled";
-    readonly AUTO_ON: "auto-on";
-};
-export type RecordSettingsRequestModeEnum = (typeof RecordSettingsRequestModeEnum)[keyof typeof RecordSettingsRequestModeEnum];
-/**
- * @export
- */
-export declare const RecordSettingsRequestQualityEnum: {
-    readonly AUDIO_ONLY: "audio-only";
-    readonly _360P: "360p";
-    readonly _480P: "480p";
-    readonly _720P: "720p";
-    readonly _1080P: "1080p";
-    readonly _1440P: "1440p";
-};
-export type RecordSettingsRequestQualityEnum = (typeof RecordSettingsRequestQualityEnum)[keyof typeof RecordSettingsRequestQualityEnum];
 /**
  *
  * @export
@@ -3685,19 +3793,19 @@ export interface SortParamRequest {
 /**
  *
  * @export
- * @interface StartBroadcastingResponse
+ * @interface StartHLSBroadcastingResponse
  */
-export interface StartBroadcastingResponse {
+export interface StartHLSBroadcastingResponse {
     /**
      * Duration of the request in human-readable format
      * @type {string}
-     * @memberof StartBroadcastingResponse
+     * @memberof StartHLSBroadcastingResponse
      */
     duration: string;
     /**
      *
      * @type {string}
-     * @memberof StartBroadcastingResponse
+     * @memberof StartHLSBroadcastingResponse
      */
     playlist_url: string;
 }
@@ -3730,13 +3838,13 @@ export interface StartTranscriptionResponse {
 /**
  *
  * @export
- * @interface StopBroadcastingResponse
+ * @interface StopHLSBroadcastingResponse
  */
-export interface StopBroadcastingResponse {
+export interface StopHLSBroadcastingResponse {
     /**
      * Duration of the request in human-readable format
      * @type {string}
-     * @memberof StopBroadcastingResponse
+     * @memberof StopHLSBroadcastingResponse
      */
     duration: string;
 }
@@ -3835,6 +3943,45 @@ export interface TargetResolutionRequest {
      */
     width?: number;
 }
+/**
+ *
+ * @export
+ * @interface ThumbnailResponse
+ */
+export interface ThumbnailResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ThumbnailResponse
+     */
+    image_url: string;
+}
+/**
+ *
+ * @export
+ * @interface ThumbnailsSettings
+ */
+export interface ThumbnailsSettings {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ThumbnailsSettings
+     */
+    enabled: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ThumbnailsSettingsRequest
+ */
+export interface ThumbnailsSettingsRequest {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ThumbnailsSettingsRequest
+     */
+    enabled?: boolean;
+}
 /**
  *
  * @export
@@ -4354,14 +4501,14 @@ export type VideoEvent = ({
 } & CallAcceptedEvent) | ({
     type: 'call.blocked_user';
 } & BlockedUserEvent) | ({
-    type: 'call.broadcasting_started';
-} & CallBroadcastingStartedEvent) | ({
-    type: 'call.broadcasting_stopped';
-} & CallBroadcastingStoppedEvent) | ({
     type: 'call.created';
 } & CallCreatedEvent) | ({
     type: 'call.ended';
 } & CallEndedEvent) | ({
+    type: 'call.hls_broadcasting_started';
+} & CallHLSBroadcastingStartedEvent) | ({
+    type: 'call.hls_broadcasting_stopped';
+} & CallHLSBroadcastingStoppedEvent) | ({
     type: 'call.live_started';
 } & CallLiveStartedEvent) | ({
     type: 'call.member_added';