@azure/communication-react 1.7.1-alpha-202308240011 → 1.7.1-alpha-202308260012

package/dist/communication-react.d.ts

@@ -30,6 +30,7 @@ import { CallEndReason } from '@azure/communication-calling';
 import { CallerInfo } from '@azure/communication-calling';
 import { CallKind } from '@azure/communication-calling';
 import { CallState as CallState_2 } from '@azure/communication-calling';
+import type { CapabilitiesChangeInfo } from '@azure/communication-calling';
 import { CaptionsResultType } from '@azure/communication-calling';
 import { ChatClient } from '@azure/communication-chat';
 import { ChatClientOptions } from '@azure/communication-chat';
@@ -1121,10 +1122,22 @@ export declare interface CallAdapterSubscribers {
      * Subscribe function for 'isCaptionsActiveChanged' event.
      */
     on(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
+    /**
+     * Subscribe function for 'isCaptionLanguageChanged' event.
+     */
+    on(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
+    /**
+     * Subscribe function for 'isSpokenLanguageChanged' event.
+     */
+    on(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
     /**
      * Subscribe function for 'transferRequested' event.
      */
     on(event: 'transferRequested', listener: TransferRequestedListener): void;
+    /**
+     * Unsubscribe function for 'capabilitiesChanged' event.
+     */
+    on(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
     /**
      * Unsubscribe function for 'participantsJoined' event.
      */
@@ -1181,10 +1194,22 @@ export declare interface CallAdapterSubscribers {
      * Unsubscribe function for 'isCaptionsActiveChanged' event.
      */
     off(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
+    /**
+     * Unsubscribe function for 'isCaptionLanguageChanged' event.
+     */
+    off(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
+    /**
+     * Unsubscribe function for 'isSpokenLanguageChanged' event.
+     */
+    off(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
     /**
      * Unsubscribe function for 'transferRequested' event.
      */
     off(event: 'transferRequested', listener: TransferRequestedListener): void;
+    /**
+     * Unsubscribe function for 'capabilitiesChanged' event.
+     */
+    off(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
 }
 
 /**
@@ -1967,13 +1992,21 @@ export declare interface CallCompositeStrings {
      */
     captionsSettingsModalTitle?: string;
     /**
-     * label for dropdown inside captions setting modal
+     * label for spoken language dropdown inside captions setting modal
      */
-    captionsSettingsDropdownLabel?: string;
+    captionsSettingsSpokenLanguageDropdownLabel?: string;
+    /**
+     * label for captions language inside captions setting modal
+     */
+    captionsSettingsCaptionLanguageDropdownLabel?: string;
     /**
      * text under captions setting dropdown indicating what the dropdown is for
      */
-    captionsSettingsDropdownInfoText?: string;
+    captionsSettingsSpokenLanguageDropdownInfoText?: string;
+    /**
+     * text under captions setting dropdown indicating what the dropdown is for
+     */
+    captionsSettingsCaptionLanguageDropdownInfoText?: string;
     /**
      * confirm button label in captions setting modal
      */
@@ -1999,9 +2032,13 @@ export declare interface CallCompositeStrings {
      */
     captionsBannerMoreButtonTooltip?: string;
     /**
-     * list of key value pairs that pairs language code to language names
+     * list of key value pairs that pairs spoken language code to language names
+     */
+    spokenLanguageStrings?: SpokenLanguageStrings;
+    /**
+     * list of key value pairs that pairs caption language code to language names
      */
-    captionsAvailableLanguageStrings?: CaptionsAvailableLanguageStrings;
+    captionLanguageStrings?: CaptionLanguageStrings;
     /**
      * captions banner loading spinner label
      */
@@ -2816,6 +2853,8 @@ export declare interface CallWithChatAdapterSubscriptions {
     on(event: 'callError', listener: (e: AdapterError) => void): void;
     on(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
     on(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
+    on(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
+    on(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
     off(event: 'callEnded', listener: CallEndedListener): void;
     off(event: 'isMutedChanged', listener: IsMutedChangedListener): void;
     off(event: 'callIdChanged', listener: CallIdChangedListener): void;
@@ -2829,6 +2868,8 @@ export declare interface CallWithChatAdapterSubscriptions {
     off(event: 'callError', listener: (e: AdapterError) => void): void;
     off(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
     off(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
+    off(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
+    off(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
     on(event: 'messageReceived', listener: MessageReceivedListener): void;
     on(event: 'messageSent', listener: MessageSentListener): void;
     on(event: 'messageRead', listener: MessageReadListener): void;
@@ -3174,6 +3215,12 @@ export declare interface CallWithChatCompositeStrings {
      * Only used with `mobileView` set to `true`.
      */
     moreDrawerSpokenLanguageMenuTitle: string;
+    /**
+     * Title for the caption language sub-menu in more button drawer.
+     *
+     * Only used with `mobileView` set to `true`.
+     */
+    moreDrawerCaptionLanguageMenuTitle: string;
     /**
      * {@Link CallWithChatComposite} control bar More button label
      */
@@ -3284,7 +3331,7 @@ export declare interface CallWithChatControlOptions extends CommonCallControlOpt
  *
  * @public
  */
-export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | /* @conditional-compile-remove(close-captions) */ 'isCaptionsActiveChanged' | /* @conditional-compile-remove(close-captions) */ 'captionsReceived' | 'messageReceived' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
+export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | /* @conditional-compile-remove(close-captions) */ 'isCaptionsActiveChanged' | /* @conditional-compile-remove(close-captions) */ 'captionsReceived' | /* @conditional-compile-remove(close-captions) */ 'isCaptionLanguageChanged' | /* @conditional-compile-remove(close-captions) */ 'isSpokenLanguageChanged' | 'messageReceived' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
 
 /**
  * @beta
@@ -3515,51 +3562,49 @@ export declare interface CapabilitiesCallFeature {
 }
 
 /**
+ * Callback for {@link CallAdapterSubscribers} 'capabilitiesChanged' event.
+ *
  * @beta
- * strings for captions setting modal
  */
-export declare interface CaptionsAvailableLanguageStrings {
-    'ar-ae': string;
-    'ar-sa': string;
-    'da-dk': string;
-    'de-de': string;
-    'en-au': string;
-    'en-ca': string;
-    'en-gb': string;
-    'en-in': string;
-    'en-nz': string;
-    'en-us': string;
-    'es-es': string;
-    'es-mx': string;
-    'fi-fi': string;
+export declare type CapabilitiesChangedListener = (data: CapabilitiesChangeInfo) => void;
+
+/**
+ * @beta
+ * caption language strings for captions setting modal
+ */
+export declare interface CaptionLanguageStrings {
+    ar: string;
+    da: string;
+    de: string;
+    en: string;
+    es: string;
+    fi: string;
+    fr: string;
     'fr-ca': string;
-    'fr-fr': string;
-    'hi-in': string;
-    'it-it': string;
-    'ja-jp': string;
-    'ko-kr': string;
-    'nb-no': string;
-    'nl-be': string;
-    'nl-nl': string;
-    'pl-pl': string;
-    'pt-br': string;
-    'ru-ru': string;
-    'sv-se': string;
-    'zh-cn': string;
-    'zh-hk': string;
-    'cs-cz': string;
+    hi: string;
+    it: string;
+    ja: string;
+    ko: string;
+    nb: string;
+    nl: string;
+    pl: string;
+    pt: string;
+    ru: string;
+    sv: string;
+    'zh-Hans': string;
+    'zh-Hant': string;
+    cs: string;
     'pt-pt': string;
-    'tr-tr': string;
-    'vi-vn': string;
-    'th-th': string;
-    'he-il': string;
-    'cy-gb': string;
-    'uk-ua': string;
-    'el-gr': string;
-    'hu-hu': string;
-    'ro-ro': string;
-    'sk-sk': string;
-    'zh-tw': string;
+    tr: string;
+    vi: string;
+    th: string;
+    he: string;
+    cy: string;
+    uk: string;
+    el: string;
+    hu: string;
+    ro: string;
+    sk: string;
 }
 
 /**
@@ -5531,6 +5576,7 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     CaptionsOffIcon: JSX.Element;
     CaptionsSettingsIcon: JSX.Element;
     ChangeSpokenLanguageIcon: JSX.Element;
+    ChangeCaptionLanguageIcon: JSX.Element;
     ContextMenuCameraIcon: JSX.Element;
     ContextMenuMicIcon: JSX.Element;
     ContextMenuSpeakerIcon: JSX.Element;
@@ -5660,6 +5706,7 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     CaptionsOffIcon: JSX.Element;
     CaptionsSettingsIcon: JSX.Element;
     ChangeSpokenLanguageIcon: JSX.Element;
+    ChangeCaptionLanguageIcon: JSX.Element;
     ContextMenuCameraIcon: JSX.Element;
     ContextMenuMicIcon: JSX.Element;
     ContextMenuSpeakerIcon: JSX.Element;
@@ -6810,6 +6857,15 @@ export declare interface IncomingCallState {
     endTime?: Date;
 }
 
+/**
+ * Callback for {@link CallAdapterSubscribers} 'isCaptionLanguageChanged' event.
+ *
+ * @beta
+ */
+export declare type IsCaptionLanguageChangedListener = (event: {
+    activeCaptionLanguage: string;
+}) => void;
+
 /**
  * Callback for {@link CallAdapterSubscribers} 'isCaptionsActiveChanged' event.
  *
@@ -6848,6 +6904,15 @@ export declare type IsSpeakingChangedListener = (event: {
     isSpeaking: boolean;
 }) => void;
 
+/**
+ * Callback for {@link CallAdapterSubscribers} 'isSpokenLanguageChanged' event.
+ *
+ * @beta
+ */
+export declare type IsSpokenLanguageChangedListener = (event: {
+    activeSpokenLanguage: string;
+}) => void;
+
 /**
  * Options for setting microphone and camera state when joining a call
  * true = turn on the device when joining call
@@ -8767,6 +8832,54 @@ export declare interface SitePermissionsStyles extends BaseCustomStyles {
     troubleshootingLink?: ILinkStyles;
 }
 
+/**
+ * @beta
+ * spoken language strings for captions setting modal
+ */
+export declare interface SpokenLanguageStrings {
+    'ar-ae': string;
+    'ar-sa': string;
+    'da-dk': string;
+    'de-de': string;
+    'en-au': string;
+    'en-ca': string;
+    'en-gb': string;
+    'en-in': string;
+    'en-nz': string;
+    'en-us': string;
+    'es-es': string;
+    'es-mx': string;
+    'fi-fi': string;
+    'fr-ca': string;
+    'fr-fr': string;
+    'hi-in': string;
+    'it-it': string;
+    'ja-jp': string;
+    'ko-kr': string;
+    'nb-no': string;
+    'nl-be': string;
+    'nl-nl': string;
+    'pl-pl': string;
+    'pt-br': string;
+    'ru-ru': string;
+    'sv-se': string;
+    'zh-cn': string;
+    'zh-hk': string;
+    'cs-cz': string;
+    'pt-pt': string;
+    'tr-tr': string;
+    'vi-vn': string;
+    'th-th': string;
+    'he-il': string;
+    'cy-gb': string;
+    'uk-ua': string;
+    'el-gr': string;
+    'hu-hu': string;
+    'ro-ro': string;
+    'sk-sk': string;
+    'zh-tw': string;
+}
+
 /**
  * Defines the methods that allow CallClient {@link @azure/communication-calling#CallClient} to be used statefully.
  * The interface provides access to proxied state and also allows registering a handler for state change events. For
@@ -10145,7 +10258,7 @@ export declare interface VideoTileProps {
     noVideoAvailableAriaLabel?: string;
     /** Whether the participant in the videoTile is speaking. Shows a speaking indicator (border). */
     isSpeaking?: boolean;
-    /** Whether the participant is raised hand. Show a indicator (border) and order icon */
+    /** Whether the participant is raised hand. Show a indicator (border) and icon with order */
     raisedHand?: RaisedHand;
     /**
      * The call connection state of the participant.