@azure/communication-react 1.5.1-alpha-202303260014 → 1.5.1-alpha-202303290014

package/dist/communication-react.d.ts

@@ -713,6 +713,24 @@ export declare interface CallAdapterCallOperations {
      * Continues into a call when the browser version is not supported.
      */
     allowUnsupportedBrowserVersion(): void;
+    /**
+     * Start the blur video background effect.
+     *
+     * @beta
+     */
+    blurVideoBackground(bgBlurConfig?: BackgroundBlurConfig): Promise<void>;
+    /**
+     * Start the video background replacement effect.
+     *
+     * @beta
+     */
+    replaceVideoBackground(bgReplacementConfig: BackgroundReplacementConfig): Promise<void>;
+    /**
+     * Stop the video background effect.
+     *
+     * @beta
+     */
+    stopVideoBackgroundEffect(): Promise<void>;
 }
 
 /**
@@ -750,6 +768,10 @@ export declare type CallAdapterClientState = {
      * control bar with the CallComposite.
      */
     cameraStatus?: 'On' | 'Off';
+    /**
+     * Default set of background images for background replacement effect.
+     */
+    videoBackgroundImages?: VideoBackgroundImage[];
 };
 
 /**
@@ -1780,7 +1802,7 @@ export declare type CallErrors = {
  *
  * @public
  */
-export declare type CallErrorTarget = 'Call.addParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'TeamsCall.addParticipant' | /* @conditional-compile-remove(video-background-effects) */ 'VideoEffectsFeature.startEffects';
+export declare type CallErrorTarget = 'Call.addParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'TeamsCall.addParticipant' | /* @conditional-compile-remove(video-background-effects) */ 'VideoEffectsFeature.startEffects' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallAgent.handlePushNotification';
 
 /**
  * Callback for {@link CallAdapterSubscribers} 'callIdChanged' event.
@@ -2277,6 +2299,24 @@ export declare interface CallWithChatAdapterManagement {
      * Continues into a call when the browser version is not supported.
      */
     allowUnsupportedBrowserVersion(): void;
+    /**
+     * Start the blur video background effect.
+     *
+     * @beta
+     */
+    blurVideoBackground(bgBlurConfig?: BackgroundBlurConfig): Promise<void>;
+    /**
+     * Start the video background replacement effect.
+     *
+     * @beta
+     */
+    replaceVideoBackground(bgReplacementConfig: BackgroundReplacementConfig): Promise<void>;
+    /**
+     * Stop the video background effect.
+     *
+     * @beta
+     */
+    stopVideoBackgroundEffect(): Promise<void>;
 }
 
 /**
@@ -6660,7 +6700,7 @@ export declare interface OptionsDevice {
  *
  * @beta
  */
-export declare type OverflowGalleryLayout = 'HorizontalBottom' | 'VerticalRight';
+export declare type OverflowGalleryPosition = 'HorizontalBottom' | 'VerticalRight';
 
 /**
  * A system message notifying that a participant was added to the chat thread.
@@ -8337,6 +8377,26 @@ export declare interface VerticalGalleryStyles extends BaseCustomStyles {
     controlBar?: VerticalGalleryControlBarStyles;
 }
 
+/**
+ * Contains the attibutes of a background image like url, name etc.
+ *
+ * @beta
+ */
+export declare interface VideoBackgroundImage {
+    /**
+     * key for unique identification of the custom background
+     */
+    key: string;
+    /**
+     * URL of the uploaded background image.
+     */
+    url: string;
+    /**
+     * Image name to be displayed.
+     */
+    tooltipText?: 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.
@@ -8458,7 +8518,7 @@ export declare interface VideoGalleryProps {
      * Determines the layout of the overflowGallery inside the VideoGallery.
      * @defaultValue 'HorizontalBottom'
      */
-    overflowGalleryLayout?: OverflowGalleryLayout;
+    overflowGalleryPosition?: OverflowGalleryPosition;
 }
 
 /**