@azure/communication-react 1.5.1-alpha-202304110013 → 1.5.1-alpha-202304130012

package/dist/communication-react.d.ts

@@ -217,6 +217,13 @@ export declare type AreParamEqual<A extends (props: any) => JSX.Element | undefi
  */
 export declare type AreTypeEqual<A, B> = A extends B ? (B extends A ? true : false) : false;
 
+/**
+ * @beta
+ */
+export declare interface AttachmentDownloadResult {
+    blobUrl: string;
+}
+
 /**
  * Custom data attributes for displaying avatar for a user.
  *
@@ -763,6 +770,12 @@ export declare interface CallAdapterCallOperations {
      * @beta
      */
     updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[]): void;
+    /**
+     * Update the selected video background effect.
+     *
+     * @beta
+     */
+    updateSelectedVideoBackgroundEffect(selectedVideoBackground: SelectedVideoBackgroundEffect): void;
 }
 
 /**
@@ -804,6 +817,10 @@ export declare type CallAdapterClientState = {
      * Default set of background images for background replacement effect.
      */
     videoBackgroundImages?: VideoBackgroundImage[];
+    /**
+     * State to track the selected video background effect.
+     */
+    selectedVideoBackgroundEffect?: SelectedVideoBackgroundEffect;
 };
 
 /**
@@ -2268,7 +2285,7 @@ export declare interface CallWithChatAdapterManagement {
     updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
     /** @beta */
     updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
-    downloadAuthenticatedAttachment?: (attachmentUrl: string) => Promise<string>;
+    downloadAuthenticatedAttachment?: (attachmentUrl: string) => Promise<AttachmentDownloadResult>;
     /**
      * Puts the Call in a Localhold.
      *
@@ -2324,6 +2341,12 @@ export declare interface CallWithChatAdapterManagement {
      * @beta
      */
     updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[]): void;
+    /**
+     * Update the selected video background effect
+     *
+     * @beta
+     */
+    updateSelectedVideoBackgroundEffect(selectedVideoBackground: SelectedVideoBackgroundEffect): void;
 }
 
 /**
@@ -3138,6 +3161,7 @@ export declare interface ChatAdapterThreadManagement {
      *
      */
     loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>;
+    downloadAuthenticatedAttachment?: (attachmentUrl: string) => Promise<AttachmentDownloadResult>;
 }
 
 /**
@@ -5503,7 +5527,6 @@ export declare interface FileUploadAdapter {
     updateFileUploadProgress: (id: string, progress: number) => void;
     updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
     updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
-    downloadAuthenticatedAttachment?: (attachmentUrl: string) => Promise<string>;
 }
 
 /**
@@ -6348,6 +6371,12 @@ export declare type MessageThreadProps = {
      * @beta
      */
     onRenderFileDownloads?: (userId: string, message: ChatMessage) => JSX.Element;
+    /**
+     * Optional callback to retrieve the inline image in a message.
+     * @param attachment - FileMetadata object we want to render
+     * @beta
+     */
+    onFetchAttachments?: (attachment: FileMetadata) => Promise<AttachmentDownloadResult>;
     /**
      * Optional callback to edit a message.
      *
@@ -7344,6 +7373,13 @@ export declare interface ScreenShareButtonStrings {
     tooltipOffContent?: string;
 }
 
+/**
+ * Contains the attibutes of a selected video background effect
+ *
+ * @beta
+ */
+export declare type SelectedVideoBackgroundEffect = VideoBackgroundNoneEffect | VideoBackgroundBlurEffect | VideoBackgroundReplacementEffect;
+
 /**
  * An optimized selector that refines {@link ClientState} updates into props for React Components in this library.
  *
@@ -8438,6 +8474,18 @@ export declare interface VerticalGalleryStyles extends BaseCustomStyles {
     controlBar?: VerticalGalleryControlBarStyles;
 }
 
+/**
+ * Contains the attibutes of the blur video background effect
+ *
+ * @beta
+ */
+export declare interface VideoBackgroundBlurEffect {
+    /**
+     * Name of effect to blur video background effect
+     */
+    effectName: 'blur';
+}
+
 /**
  * Contains the attibutes of a background image like url, name etc.
  *
@@ -8458,6 +8506,38 @@ export declare interface VideoBackgroundImage {
     tooltipText?: string;
 }
 
+/**
+ * Contains the attibutes to remove video background effect
+ *
+ * @beta
+ */
+export declare interface VideoBackgroundNoneEffect {
+    /**
+     * Name of effect to remove video background effect
+     */
+    effectName: 'none';
+}
+
+/**
+ * Contains the attibutes of a selected replacement video background effect
+ *
+ * @beta
+ */
+export declare interface VideoBackgroundReplacementEffect {
+    /**
+     * Name of effect to replace video background effect
+     */
+    effectName: 'replacement';
+    /**
+     * key for unique identification of the custom background
+     */
+    effectKey: string;
+    /**
+     * URL of the custom background image.
+     */
+    backgroundImageUrl: string;
+}
+
 /**
  * VideoGallery represents a layout of video tiles for a specific call.
  * It displays a {@link VideoTile} for the local user as well as for each remote participant who has joined the call.