@azure/communication-react 1.5.1-alpha-202304150013 → 1.5.1-alpha-202304180012

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 { CaptionsResultType } from '@azure/communication-calling';
 import { ChatClient } from '@azure/communication-chat';
 import { ChatClientOptions } from '@azure/communication-chat';
 import { ChatMessage as ChatMessage_2 } from '@azure/communication-chat';
@@ -88,6 +89,7 @@ import { RoomCallLocator } from '@azure/communication-calling';
 import { ScalingMode } from '@azure/communication-calling';
 import { SendMessageOptions } from '@azure/communication-chat';
 import { StartCallOptions } from '@azure/communication-calling';
+import { StartCaptionsOptions } from '@azure/communication-calling';
 import { TeamsCall } from '@azure/communication-calling';
 import { TeamsCallAgent } from '@azure/communication-calling';
 import { TeamsMeetingLinkLocator } from '@azure/communication-calling';
@@ -799,6 +801,25 @@ export declare interface CallAdapterCallOperations {
      * Continues into a call when the browser version is not supported.
      */
     allowUnsupportedBrowserVersion(): void;
+    /**
+     * Function to Start captions
+     * @param options - options for start captions
+     */
+    startCaptions(options?: StartCaptionsOptions): Promise<void>;
+    /**
+     * Function to set caption language
+     * @param language - language set for caption
+     */
+    setCaptionLanguage(language: string): Promise<void>;
+    /**
+     * Function to set spoken language
+     * @param language - spoken language
+     */
+    setSpokenLanguage(language: string): Promise<void>;
+    /**
+     * Funtion to stop captions
+     */
+    stopCaptions(): Promise<void>;
     /**
      * Start the blur video background effect.
      *
@@ -1037,6 +1058,14 @@ export declare interface CallAdapterSubscribers {
      * Subscribe function for 'error' event.
      */
     on(event: 'error', listener: (e: AdapterError) => void): void;
+    /**
+     * Subscribe function for 'captionsReceived' event.
+     */
+    on(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
+    /**
+     * Subscribe function for 'isCaptionsActiveChanged' event.
+     */
+    on(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
     /**
      * Unsubscribe function for 'participantsJoined' event.
      */
@@ -1085,6 +1114,14 @@ export declare interface CallAdapterSubscribers {
      * Unsubscribe function for 'error' event.
      */
     off(event: 'error', listener: (e: AdapterError) => void): void;
+    /**
+     * Unsubscribe function for 'captionsReceived' event.
+     */
+    off(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
+    /**
+     * Unsubscribe function for 'isCaptionsActiveChanged' event.
+     */
+    off(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
 }
 
 /**
@@ -1789,6 +1826,70 @@ export declare interface CallCompositeStrings {
      * string to be used to announce when multiple unnamed participants have left at the same time.
      */
     manyUnnamedParticipantsLeft: string;
+    /**
+     * string to be used to open live captions contextual menu
+     */
+    liveCaptionsLabel?: string;
+    /**
+     * label for opening captions setting modal
+     */
+    captionsSettingsLabel?: string;
+    /**
+     * string to be used to start captions
+     */
+    startCaptionsButtonOnLabel?: string;
+    /**
+     * string to be used to stop captions
+     */
+    startCaptionsButtonOffLabel?: string;
+    /**
+     * tooltip string to be used to show captions is on
+     */
+    startCaptionsButtonTooltipOnContent?: string;
+    /**
+     *tooltip string to be used to show captions is off
+     */
+    startCaptionsButtonTooltipOffContent?: string;
+    /**
+     * captions setting modal title
+     */
+    captionsSettingsModalTitle?: string;
+    /**
+     * label for dropdown inside captions setting modal
+     */
+    captionsSettingsDropdownLabel?: string;
+    /**
+     * text under captions setting dropdown indicating what the dropdown is for
+     */
+    captionsSettingsDropdownInfoText?: string;
+    /**
+     * confirm button label in captions setting modal
+     */
+    captionsSettingsConfirmButtonLabel?: string;
+    /**
+     * cancel button label in captions setting modal
+     */
+    captionsSettingsCancelButtonLabel?: string;
+    /**
+     * arial label for captions setting modal
+     */
+    captionsSettingsModalAriaLabel?: string;
+    /**
+     * arial label for captions setting modal close button
+     */
+    captionsSettingsCloseModalButtonAriaLabel?: string;
+    /**
+     * label for more button inside captions banner
+     */
+    captionsBannerMoreButtonCallingLabel?: string;
+    /**
+     * arial label for more button inside captions banner
+     */
+    captionsBannerMoreButtonTooltip?: string;
+    /**
+     * list of key value pairs that pairs language code to language names
+     */
+    captionsAvailableLanguageStrings?: CaptionsAvailableLanguageStrings;
 }
 
 /**
@@ -1873,7 +1974,7 @@ export declare type CallErrors = {
  *
  * @public
  */
-export declare type CallErrorTarget = 'Call.addParticipant' | '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' | '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';
+export declare type CallErrorTarget = 'Call.addParticipant' | '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' | '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' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admit' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.rejectParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admitAll';
 
 /**
  * Callback for {@link CallAdapterSubscribers} 'callIdChanged' event.
@@ -2049,6 +2150,10 @@ export declare interface CallState {
      * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.
      */
     transcription: TranscriptionCallFeature;
+    /**
+     * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.
+     */
+    captionsFeature: CaptionsCallFeatureState;
     /**
      * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.
      */
@@ -2370,6 +2475,25 @@ export declare interface CallWithChatAdapterManagement {
      * Continues into a call when the browser version is not supported.
      */
     allowUnsupportedBrowserVersion(): void;
+    /**
+     * Function to Start captions
+     * @param options - options for start captions
+     */
+    startCaptions(options?: StartCaptionsOptions): Promise<void>;
+    /**
+     * Function to set caption language
+     * @param language - language set for caption
+     */
+    setCaptionLanguage(language: string): Promise<void>;
+    /**
+     * Function to set spoken language
+     * @param language - spoken language
+     */
+    setSpokenLanguage(language: string): Promise<void>;
+    /**
+     * Funtion to stop captions
+     */
+    stopCaptions(): Promise<void>;
     /**
      * Start the blur video background effect.
      *
@@ -2429,6 +2553,8 @@ export declare interface CallWithChatAdapterSubscriptions {
     on(event: 'selectedMicrophoneChanged', listener: PropertyChangedEvent): void;
     on(event: 'selectedSpeakerChanged', listener: PropertyChangedEvent): void;
     on(event: 'callError', listener: (e: AdapterError) => void): void;
+    on(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
+    on(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
     off(event: 'callEnded', listener: CallEndedListener): void;
     off(event: 'isMutedChanged', listener: IsMutedChangedListener): void;
     off(event: 'callIdChanged', listener: CallIdChangedListener): void;
@@ -2440,6 +2566,8 @@ export declare interface CallWithChatAdapterSubscriptions {
     off(event: 'selectedMicrophoneChanged', listener: PropertyChangedEvent): void;
     off(event: 'selectedSpeakerChanged', listener: PropertyChangedEvent): void;
     off(event: 'callError', listener: (e: AdapterError) => void): void;
+    off(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
+    off(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
     on(event: 'messageReceived', listener: MessageReceivedListener): void;
     on(event: 'messageSent', listener: MessageSentListener): void;
     on(event: 'messageRead', listener: MessageReadListener): void;
@@ -2518,6 +2646,8 @@ export declare interface CallWithChatClientState {
     environmentInfo?: EnvironmentInfo;
     /** Default set of background images for background replacement effect */
     videoBackgroundImages?: VideoBackgroundImage[];
+    /** State to track the selected video background effect */
+    selectedVideoBackgroundEffect?: SelectedVideoBackgroundEffect;
 }
 
 /**
@@ -2754,6 +2884,18 @@ export declare interface CallWithChatCompositeStrings {
      * Only used with `mobileView` set to `true`.
      */
     moreDrawerSpeakerMenuTitle: string;
+    /**
+     * Title for the captions sub-menu in more button drawer.
+     *
+     * Only used with `mobileView` set to `true`.
+     */
+    moreDrawerCaptionsMenuTitle: string;
+    /**
+     * Title for the spoken language sub-menu in more button drawer.
+     *
+     * Only used with `mobileView` set to `true`.
+     */
+    moreDrawerSpokenLanguageMenuTitle: string;
     /**
      * {@Link CallWithChatComposite} control bar More button label
      */
@@ -2864,7 +3006,7 @@ export declare interface CallWithChatControlOptions extends CommonCallControlOpt
  *
  * @public
  */
-export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | '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' | 'messageReceived' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
 
 /**
  * @beta
@@ -3080,6 +3222,136 @@ export declare type CancelEditCallback = (messageId: string, metadata?: Record<s
     attachedFilesMetadata?: FileMetadata[];
 }) => void;
 
+/**
+ * @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;
+    '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;
+}
+
+/**
+ * @beta
+ */
+export declare interface CaptionsCallFeatureState {
+    /**
+     * supported spoken languages
+     */
+    supportedSpokenLanguages: string[];
+    /**
+     * array of received captions
+     */
+    captions: CaptionsInfo[];
+    /**
+     * whether captions is on/off
+     */
+    isCaptionsFeatureActive: boolean;
+    /**
+     * supported caption languages
+     */
+    supportedCaptionLanguages: string[];
+    /**
+     * current spoken language
+     */
+    currentSpokenLanguage: string;
+    /**
+     * current caption language
+     */
+    currentCaptionLanguage: string;
+}
+
+/**
+ * @beta
+ */
+export declare interface CaptionsInfo {
+    /**
+     * The state in which this caption data can be classified.
+     */
+    resultType: CaptionsResultType;
+    /**
+     * The information of the call participant who spoke the captioned text.
+     */
+    speaker: CallerInfo;
+    /**
+     * The language that the spoken words were interpretted as. Corresponds to the language specified in startCaptions / setSpokenLanguage.
+     */
+    spokenLanguage: string;
+    /**
+     * The caption text.
+     */
+    captionText: string;
+    /**
+     * Timestamp of when the captioned words were initially spoken.
+     */
+    timestamp: Date;
+    /**
+     * The language that the captions are presented in. Corresponds to the captionLanguage specified in startCaptions / setCaptionLanguage.
+     */
+    captionLanguage?: string;
+    /**
+     * The original spoken caption text prior to translating to subtitle language
+     */
+    spokenText?: string;
+}
+
+/**
+ * options bag to start captions
+ *
+ * @beta
+ */
+export declare type CaptionsOptions = {
+    spokenLanguage: string;
+};
+
+/**
+ * Callback for {@link CallAdapterSubscribers} 'captionsReceived' event.
+ *
+ * @beta
+ */
+export declare type CaptionsReceivedListener = (event: {
+    captionsInfo: CaptionsInfo;
+}) => void;
+
 /**
  * {@link ChatComposite} Adapter interface.
  *
@@ -3792,6 +4064,10 @@ export declare interface CommonCallingHandlers {
     onRemoveVideoBackgroundEffects: () => Promise<void>;
     onBlurVideoBackground: (backgroundBlurConfig?: BackgroundBlurConfig) => Promise<void>;
     onReplaceVideoBackground: (backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>;
+    onStartCaptions: (options?: CaptionsOptions) => Promise<void>;
+    onStopCaptions: () => Promise<void>;
+    onSetSpokenLanguage: (language: string) => Promise<void>;
+    onSetCaptionLanguage: (language: string) => Promise<void>;
 }
 
 /**
@@ -4785,6 +5061,10 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     VerticalGalleryLeftButton: JSX.Element;
     VerticalGalleryRightButton: JSX.Element;
     OptionsVideoBackgroundEffect: JSX.Element;
+    CaptionsIcon: JSX.Element;
+    CaptionsOffIcon: JSX.Element;
+    CaptionsSettingsIcon: JSX.Element;
+    ChangeSpokenLanguageIcon: JSX.Element;
 };
 
 /**
@@ -4896,6 +5176,10 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     VerticalGalleryLeftButton: JSX.Element;
     VerticalGalleryRightButton: JSX.Element;
     OptionsVideoBackgroundEffect: JSX.Element;
+    CaptionsIcon: JSX.Element;
+    CaptionsOffIcon: JSX.Element;
+    CaptionsSettingsIcon: JSX.Element;
+    ChangeSpokenLanguageIcon: JSX.Element;
 };
 
 /**
@@ -5964,6 +6248,15 @@ export declare interface IncomingCallState {
     endTime?: Date;
 }
 
+/**
+ * Callback for {@link CallAdapterSubscribers} 'isCaptionsActiveChanged' event.
+ *
+ * @beta
+ */
+export declare type IsCaptionsActiveChangedListener = (event: {
+    isActive: boolean;
+}) => void;
+
 /**
  * Callback for {@link CallAdapterSubscribers} 'isLocalScreenSharingActiveChanged' event.
  *
@@ -7381,7 +7674,7 @@ export declare interface RemoteVideoTileMenuOptions {
  * @beta
  * The role of a call participant.
  */
-export declare type Role = 'Presenter' | 'Attendee' | 'Consumer' | 'Organizer';
+export declare type Role = 'Presenter' | 'Attendee' | 'Consumer' | 'Organizer' | 'Co-organizer';
 
 /**
  * A button to start / stop screen sharing.