@azure/communication-react 1.5.1-alpha-202306080014 → 1.5.1-alpha-202306100013

package/dist/communication-react.d.ts

@@ -788,17 +788,11 @@ export declare interface CallAdapterCallOperations {
      */
     stopCaptions(): Promise<void>;
     /**
-     * Start the blur video background effect.
+     * Start the video background effect.
      *
      * @beta
      */
-    blurVideoBackground(backgroundBlurConfig?: BackgroundBlurConfig): Promise<void>;
-    /**
-     * Start the video background replacement effect.
-     *
-     * @beta
-     */
-    replaceVideoBackground(backgroundReplacementConfig: BackgroundReplacementConfig): Promise<void>;
+    startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>;
     /**
      * Stop the video background effect.
      *
@@ -818,7 +812,7 @@ export declare interface CallAdapterCallOperations {
      *
      * @beta
      */
-    updateSelectedVideoBackgroundEffect(selectedVideoBackground: SelectedVideoBackgroundEffect): void;
+    updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
 }
 
 /**
@@ -863,7 +857,7 @@ export declare type CallAdapterClientState = {
     /**
      * State to track the selected video background effect.
      */
-    selectedVideoBackgroundEffect?: SelectedVideoBackgroundEffect;
+    selectedVideoBackgroundEffect?: VideoBackgroundEffect;
     /**
      * Call from transfer request accepted by local user
      */
@@ -1398,8 +1392,10 @@ export declare type CallCompositeOptions = {
     remoteVideoTileMenu?: RemoteVideoTileMenuOptions;
     /**
      * Options for controlling the local video tile.
+     *
+     * @remarks if 'false' the local video tile will not be rendered.
      */
-    localVideoTileOptions?: LocalVideoTileOptions;
+    localVideoTile?: boolean | LocalVideoTileOptions;
 };
 
 /**
@@ -1407,7 +1403,7 @@ export declare type CallCompositeOptions = {
  *
  * @public
  */
-export declare type CallCompositePage = 'accessDeniedTeamsMeeting' | 'call' | 'configuration' | /* @conditional-compile-remove(PSTN-calls) */ 'hold' | 'joinCallFailedDueToNoNetwork' | 'leftCall' | 'lobby' | /* @conditional-compile-remove(rooms) */ 'deniedPermissionToRoom' | 'removedFromCall' | /* @conditional-compile-remove(rooms) */ 'roomNotFound' | /* @conditional-compile-remove(unsupported-browser) */ 'unsupportedEnvironment' | /* @conditional-compile-remove(call-transfer) */ 'transferring';
+export declare type CallCompositePage = 'accessDeniedTeamsMeeting' | 'call' | 'configuration' | /* @conditional-compile-remove(PSTN-calls) */ 'hold' | 'joinCallFailedDueToNoNetwork' | 'leftCall' | 'leaving' | 'lobby' | /* @conditional-compile-remove(rooms) */ 'deniedPermissionToRoom' | 'removedFromCall' | /* @conditional-compile-remove(rooms) */ 'roomNotFound' | /* @conditional-compile-remove(unsupported-browser) */ 'unsupportedEnvironment' | /* @conditional-compile-remove(call-transfer) */ 'transferring';
 
 /**
  * Props for {@link CallComposite}.
@@ -1513,6 +1509,10 @@ export declare interface CallCompositeStrings {
      * More details text of the page shown to the user when joining a call fails due to a network problem.
      */
     failedToJoinCallDueToNoNetworkMoreDetails?: string;
+    /**
+     * Text to display on a leaving page.
+     */
+    leavingCallTitle?: string;
     /**
      * Title text of the page shown to the user when they leave a call in the call composite.
      */
@@ -2212,7 +2212,7 @@ export declare interface CallState {
     /**
      * Transfer state of call
      */
-    transferFeature: TransferFeature;
+    transfer: TransferFeature;
 }
 
 /**
@@ -2520,17 +2520,11 @@ export declare interface CallWithChatAdapterManagement {
      */
     stopCaptions(): Promise<void>;
     /**
-     * Start the blur video background effect.
-     *
-     * @beta
-     */
-    blurVideoBackground(backgroundBlurConfig?: BackgroundBlurConfig): Promise<void>;
-    /**
-     * Start the video background replacement effect.
+     * Start the video background effect.
      *
      * @beta
      */
-    replaceVideoBackground(backgroundReplacementConfig: BackgroundReplacementConfig): Promise<void>;
+    startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>;
     /**
      * Stop the video background effect.
      *
@@ -2550,7 +2544,7 @@ export declare interface CallWithChatAdapterManagement {
      *
      * @beta
      */
-    updateSelectedVideoBackgroundEffect(selectedVideoBackground: SelectedVideoBackgroundEffect): void;
+    updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
 }
 
 /**
@@ -2672,7 +2666,7 @@ export declare interface CallWithChatClientState {
     /** Default set of background images for background replacement effect */
     videoBackgroundImages?: VideoBackgroundImage[];
     /** State to track the selected video background effect */
-    selectedVideoBackgroundEffect?: SelectedVideoBackgroundEffect;
+    selectedVideoBackgroundEffect?: VideoBackgroundEffect;
 }
 
 /**
@@ -4161,6 +4155,13 @@ export declare type CommunicationParticipant = {
     displayName?: string;
 };
 
+/**
+ * Locale for Arabic (Saudi Arabia).
+ *
+ * @public
+ */
+export declare const COMPONENT_LOCALE_AR_SA: ComponentLocale;
+
 /**
  * Locale for  German (Germany).
  *
@@ -4189,6 +4190,13 @@ export declare const COMPONENT_LOCALE_EN_US: ComponentLocale;
  */
 export declare const COMPONENT_LOCALE_ES_ES: ComponentLocale;
 
+/**
+ * Locale for Finnish (Finland).
+ *
+ * @public
+ */
+export declare const COMPONENT_LOCALE_FI_FI: ComponentLocale;
+
 /**
  * Locale for French (France).
  *
@@ -4196,6 +4204,13 @@ export declare const COMPONENT_LOCALE_ES_ES: ComponentLocale;
  */
 export declare const COMPONENT_LOCALE_FR_FR: ComponentLocale;
 
+/**
+ * Locale for Hebrew (Israel).
+ *
+ * @public
+ */
+export declare const COMPONENT_LOCALE_HE_IL: ComponentLocale;
+
 /**
  * Locale for Italian (Italy).
  *
@@ -4217,6 +4232,13 @@ export declare const COMPONENT_LOCALE_JA_JP: ComponentLocale;
  */
 export declare const COMPONENT_LOCALE_KO_KR: ComponentLocale;
 
+/**
+ * Locale for Norwegian Bokmål (Norway) .
+ *
+ * @public
+ */
+export declare const COMPONENT_LOCALE_NB_NO: ComponentLocale;
+
 /**
  * Locale for Dutch (Netherlands).
  *
@@ -4224,6 +4246,13 @@ export declare const COMPONENT_LOCALE_KO_KR: ComponentLocale;
  */
 export declare const COMPONENT_LOCALE_NL_NL: ComponentLocale;
 
+/**
+ * Locale for Polish (Poland).
+ *
+ * @public
+ */
+export declare const COMPONENT_LOCALE_PL_PL: ComponentLocale;
+
 /**
  * Locale for Portuguese (Brazil).
  *
@@ -4238,6 +4267,13 @@ export declare const COMPONENT_LOCALE_PT_BR: ComponentLocale;
  */
 export declare const COMPONENT_LOCALE_RU_RU: ComponentLocale;
 
+/**
+ * Locale for Swedish (Sweden) .
+ *
+ * @public
+ */
+export declare const COMPONENT_LOCALE_SV_SE: ComponentLocale;
+
 /**
  * Locale for Turkish (Turkey).
  *
@@ -4378,6 +4414,13 @@ export declare interface ComponentStrings {
     VerticalGallery: VerticalGalleryStrings;
 }
 
+/**
+ * Locale for Arabic (Saudi Arabia)
+ *
+ * @public
+ */
+export declare const COMPOSITE_LOCALE_AR_SA: CompositeLocale;
+
 /**
  * Locale for German (Germany)
  *
@@ -4406,6 +4449,13 @@ export declare const COMPOSITE_LOCALE_EN_US: CompositeLocale;
  */
 export declare const COMPOSITE_LOCALE_ES_ES: CompositeLocale;
 
+/**
+ * Locale for Finnish (Finland)
+ *
+ * @public
+ */
+export declare const COMPOSITE_LOCALE_FI_FI: CompositeLocale;
+
 /**
  * Locale for French (France)
  *
@@ -4413,6 +4463,13 @@ export declare const COMPOSITE_LOCALE_ES_ES: CompositeLocale;
  */
 export declare const COMPOSITE_LOCALE_FR_FR: CompositeLocale;
 
+/**
+ * Locale for Hebrew (Israel)
+ *
+ * @public
+ */
+export declare const COMPOSITE_LOCALE_HE_IL: CompositeLocale;
+
 /**
  * Locale for Italian (Italy)
  *
@@ -4434,6 +4491,13 @@ export declare const COMPOSITE_LOCALE_JA_JP: CompositeLocale;
  */
 export declare const COMPOSITE_LOCALE_KO_KR: CompositeLocale;
 
+/**
+ * Locale for Norwegian Bokmål (Norway)
+ *
+ * @public
+ */
+export declare const COMPOSITE_LOCALE_NB_NO: CompositeLocale;
+
 /**
  * Locale for Dutch (Netherlands)
  *
@@ -4441,6 +4505,13 @@ export declare const COMPOSITE_LOCALE_KO_KR: CompositeLocale;
  */
 export declare const COMPOSITE_LOCALE_NL_NL: CompositeLocale;
 
+/**
+ * Locale for Polish (Poland)
+ *
+ * @public
+ */
+export declare const COMPOSITE_LOCALE_PL_PL: CompositeLocale;
+
 /**
  * Locale for Portuguese (Brazil)
  *
@@ -4455,6 +4526,13 @@ export declare const COMPOSITE_LOCALE_PT_BR: CompositeLocale;
  */
 export declare const COMPOSITE_LOCALE_RU_RU: CompositeLocale;
 
+/**
+ * Locale for Swedish (Sweden)
+ *
+ * @public
+ */
+export declare const COMPOSITE_LOCALE_SV_SE: CompositeLocale;
+
 /**
  * Locale for Turkish (Turkey)
  *
@@ -6456,7 +6534,7 @@ export declare interface LocalVideoTileOptions {
      * 'hidden' - local video tile will not be rendered.
      * This does not affect the Configuration screen or the side pane Picture in Picture in Picture view.
      */
-    position?: 'grid' | 'floating' | 'hidden';
+    position?: 'grid' | 'floating';
 }
 
 /**
@@ -7877,13 +7955,6 @@ export declare interface ScreenShareButtonStrings {
     tooltipOffContent?: string;
 }
 
-/**
- * Contains the attibutes of a selected video background effect
- *
- * @beta
- */
-export declare type SelectedVideoBackgroundEffect = VideoBackgroundNoEffect | VideoBackgroundBlurEffect | VideoBackgroundReplacementEffect;
-
 /**
  * An optimized selector that refines {@link ClientState} updates into props for React Components in this library.
  *
@@ -9009,13 +9080,20 @@ export declare interface VerticalGalleryStyles extends BaseCustomStyles {
  *
  * @beta
  */
-export declare interface VideoBackgroundBlurEffect {
+export declare interface VideoBackgroundBlurEffect extends BackgroundBlurConfig {
     /**
      * Name of effect to blur video background effect
      */
     effectName: 'blur';
 }
 
+/**
+ * Contains the attibutes of a selected video background effect
+ *
+ * @beta
+ */
+export declare type VideoBackgroundEffect = VideoBackgroundNoEffect | VideoBackgroundBlurEffect | VideoBackgroundReplacementEffect;
+
 /**
  * Contains the attibutes of a background image like url, name etc.
  *
@@ -9053,7 +9131,7 @@ export declare interface VideoBackgroundNoEffect {
  *
  * @beta
  */
-export declare interface VideoBackgroundReplacementEffect {
+export declare interface VideoBackgroundReplacementEffect extends BackgroundReplacementConfig {
     /**
      * Name of effect to replace video background effect
      */
@@ -9061,11 +9139,7 @@ export declare interface VideoBackgroundReplacementEffect {
     /**
      * key for unique identification of the custom background
      */
-    effectKey: string;
-    /**
-     * URL of the custom background image.
-     */
-    backgroundImageUrl: string;
+    key?: string;
 }
 
 /**