@azure/communication-react 1.19.0-alpha-202408270015 → 1.19.0-alpha-202408280014

package/dist/dist-esm/react-composites/src/composites/CallComposite/adapter/AzureCommunicationCallAdapter.d.ts

@@ -24,6 +24,7 @@ import { OnFetchProfileCallback } from './OnFetchProfileCallback';
 import { VideoBackgroundEffectsDependency } from "../../../../../calling-component-bindings/src";
 import { CallSurvey, CallSurveyResponse } from '@azure/communication-calling';
 import { CallingSounds } from './CallAdapter';
+import { DeepNoiseSuppressionEffectDependency } from "../../../../../calling-component-bindings/src";
 type CallTypeOf<AgentType extends CallAgent | TeamsCallAgent> = AgentType extends CallAgent ? Call : TeamsCall;
 /**
  * @private
@@ -48,6 +49,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private onClientStateChange;
     private originCall;
     private onResolveVideoBackgroundEffectsDependency?;
+    private onResolveDeepNoiseSuppressionDependency?;
     private get call();
     private set call(value);
     constructor(callClient: StatefulCallClient, locator: CallAdapterLocator, callAgent: AgentType, deviceManager: StatefulDeviceManager, options?: AzureCommunicationCallAdapterOptions | TeamsAdapterOptions);
@@ -84,6 +86,8 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     stopVideoBackgroundEffects(): Promise<void>;
     updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[]): void;
     updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
+    startNoiseSuppressionEffect(): Promise<void>;
+    stopNoiseSuppressionEffect(): Promise<void>;
     startCall(participants: string[] | (MicrosoftTeamsAppIdentifier | /* @conditional-compile-remove(PSTN-calls) */ PhoneNumberIdentifier | /* @conditional-compile-remove(one-to-n-calling) */ CommunicationUserIdentifier | /* @conditional-compile-remove(teams-adhoc-call) */ MicrosoftTeamsUserIdentifier | UnknownIdentifier)[], options?: StartCallOptions): CallTypeOf<AgentType> | undefined;
     private processNewCall;
     private isBlurEffect;
@@ -213,6 +217,12 @@ export type CommonCallAdapterOptions = {
         videoBackgroundImages?: VideoBackgroundImage[];
         onResolveDependency?: () => Promise<VideoBackgroundEffectsDependency>;
     };
+    /**
+     * `DeepNoiseSuppressionEffect` options to be used for noise suppression.
+     */
+    deepNoiseSuppressionOptions?: {
+        onResolveDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>;
+    };
     /**
      * Use this to fetch profile information which will override data in {@link CallAdapterState} like display name
      * The onFetchProfile is fetch-and-forget one time action for each user, once a user profile is updated, the value will be cached
@@ -228,6 +238,11 @@ export type CommonCallAdapterOptions = {
      * @beta
      */
     reactionResources?: ReactionResources;
+    /**
+     * A phone number in E.164 format procured using Azure Communication Services that will be used to represent callers identity.
+     * E.164 numbers are formatted as [+] [country code] [phone number including area code]. For example, +14255550123 for a US phone number.
+     */
+    alternateCallerId?: string;
 };
 /**
  * Optional parameters to create {@link AzureCommunicationCallAdapter}
@@ -247,11 +262,6 @@ export type AzureCommunicationCallAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAdapterLocator;
-    /**
-     * A phone number in E.164 format procured using Azure Communication Services that will be used to represent callers identity.
-     * E.164 numbers are formatted as [+] [country code] [phone number including area code]. For example, +14255550123 for a US phone number.
-     */
-    alternateCallerId?: string;
     /**
      * Optional parameters for the {@link AzureCommunicationCallAdapter} created
      */
@@ -346,7 +356,7 @@ export declare function createAzureCommunicationCallAdapter(args: AzureCommunica
  *
  * @internal
  */
-export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displayName, credential, locator, targetCallees, alternateCallerId, options, telemetryImplementationHint }: {
+export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displayName, credential, locator, targetCallees, options, telemetryImplementationHint }: {
     userId: CommunicationUserIdentifier;
     displayName: string;
     credential: CommunicationTokenCredential;

package/dist/dist-esm/react-composites/src/composites/CallComposite/adapter/AzureCommunicationCallAdapter.js

@@ -35,7 +35,7 @@ import { CallingSoundSubscriber } from './CallingSoundSubscriber';
 /** Context of call, which is a centralized context for all state updates */
 class CallContext {
     constructor(clientState, isTeamsCall, isTeamsMeeting, isRoomsCall, options, targetCallees) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         this.emitter = new EventEmitter();
         this.state = {
             isLocalPreviewMicrophoneEnabled: false,
@@ -50,17 +50,19 @@ class CallContext {
             isTeamsCall,
             isTeamsMeeting,
             isRoomsCall,
-            /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId: clientState.alternateCallerId,
+            /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId: options === null || options === void 0 ? void 0 : options.alternateCallerId,
             /* @conditional-compile-remove(unsupported-browser) */ environmentInfo: clientState.environmentInfo,
             /* @conditional-compile-remove(unsupported-browser) */ unsupportedBrowserVersionsAllowed: false,
             videoBackgroundImages: (_b = options === null || options === void 0 ? void 0 : options.videoBackgroundOptions) === null || _b === void 0 ? void 0 : _b.videoBackgroundImages,
             onResolveVideoEffectDependency: (_c = options === null || options === void 0 ? void 0 : options.videoBackgroundOptions) === null || _c === void 0 ? void 0 : _c.onResolveDependency,
+            /* @conditional-compile-remove(DNS) */
+            onResolveDeepNoiseSuppressionDependency: (_d = options === null || options === void 0 ? void 0 : options.deepNoiseSuppressionOptions) === null || _d === void 0 ? void 0 : _d.onResolveDependency,
             selectedVideoBackgroundEffect: undefined,
             cameraStatus: undefined,
             sounds: options === null || options === void 0 ? void 0 : options.callingSounds,
             reactions: options === null || options === void 0 ? void 0 : options.reactionResources
         };
-        this.emitter.setMaxListeners((_d = options === null || options === void 0 ? void 0 : options.maxListeners) !== null && _d !== void 0 ? _d : 50);
+        this.emitter.setMaxListeners((_e = options === null || options === void 0 ? void 0 : options.maxListeners) !== null && _e !== void 0 ? _e : 50);
         this.bindPublicMethods();
         this.displayNameModifier = (options === null || options === void 0 ? void 0 : options.onFetchProfile)
             ? createProfileStateModifier(options.onFetchProfile, () => {
@@ -194,7 +196,7 @@ export class AzureCommunicationCallAdapter {
         this._call = newCall;
     }
     constructor(callClient, locatorOrTargetCalless, callAgent, deviceManager, options) {
-        var _a, _b;
+        var _a, _b, _c;
         this.participantSubscribers = new Map();
         this.emitter = new EventEmitter();
         this.isMyMutedChanged = () => {
@@ -225,6 +227,8 @@ export class AzureCommunicationCallAdapter {
         });
         const isRoomsCall = this.locator ? 'roomId' in this.locator : false;
         this.onResolveVideoBackgroundEffectsDependency = (_b = options === null || options === void 0 ? void 0 : options.videoBackgroundOptions) === null || _b === void 0 ? void 0 : _b.onResolveDependency;
+        /* @conditional-compile-remove(DNS) */
+        this.onResolveDeepNoiseSuppressionDependency = (_c = options === null || options === void 0 ? void 0 : options.deepNoiseSuppressionOptions) === null || _c === void 0 ? void 0 : _c.onResolveDependency;
         this.context = new CallContext(callClient.getState(), !!isTeamsCall, isTeamsMeeting, isRoomsCall, options, this.targetCallees);
         this.context.onCallEnded((endCallData) => this.emitter.emit('callEnded', endCallData));
         const onStateChange = (clientState) => {
@@ -256,7 +260,9 @@ export class AzureCommunicationCallAdapter {
             this.context.updateClientState(clientState);
         };
         this.handlers = createHandlers(callClient, callAgent, deviceManager, undefined, {
-            onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency
+            onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency,
+            /* @conditional-compile-remove(DNS) */
+            onResolveDeepNoiseSuppressionDependency: this.onResolveDeepNoiseSuppressionDependency
         });
         this.onClientStateChange = onStateChange;
         this.subscribeDeviceManagerEvents();
@@ -357,6 +363,10 @@ export class AzureCommunicationCallAdapter {
         this.startVideoBackgroundEffect.bind(this);
         this.stopVideoBackgroundEffects.bind(this);
         this.updateBackgroundPickerImages.bind(this);
+        /* @conditional-compile-remove(DNS) */
+        this.startNoiseSuppressionEffect.bind(this);
+        /* @conditional-compile-remove(DNS) */
+        this.stopNoiseSuppressionEffect.bind(this);
         this.submitSurvey.bind(this);
         this.startSpotlight.bind(this);
         this.stopSpotlight.bind(this);
@@ -544,7 +554,9 @@ export class AzureCommunicationCallAdapter {
             yield this.handlers.onHangUp(forEveryone);
             this.unsubscribeCallEvents();
             this.handlers = createHandlers(this.callClient, this.callAgent, this.deviceManager, this.call, {
-                onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency
+                onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency,
+                /* @conditional-compile-remove(DNS) */
+                onResolveDeepNoiseSuppressionDependency: this.onResolveDeepNoiseSuppressionDependency
             });
             // We set the adapter.call object to undefined immediately when a call is ended.
             // We do not set the context.callId to undefined because it is a part of the immutable data flow loop.
@@ -699,6 +711,18 @@ export class AzureCommunicationCallAdapter {
     updateSelectedVideoBackgroundEffect(selectedVideoBackground) {
         this.context.setSelectedVideoBackgroundEffect(selectedVideoBackground);
     }
+    /* @conditional-compile-remove(DNS) */
+    startNoiseSuppressionEffect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.handlers.onStartNoiseSuppressionEffect();
+        });
+    }
+    /* @conditional-compile-remove(DNS) */
+    stopNoiseSuppressionEffect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.handlers.onStopNoiseSuppressionEffect();
+        });
+    }
     startCall(participants, options) {
         var _a, _b;
         if (_isInCall((_b = (_a = this.getState().call) === null || _a === void 0 ? void 0 : _a.state) !== null && _b !== void 0 ? _b : 'None')) {
@@ -736,7 +760,9 @@ export class AzureCommunicationCallAdapter {
         // Resync state after callId is set
         this.context.updateClientState(this.callClient.getState());
         this.handlers = createHandlers(this.callClient, this.callAgent, this.deviceManager, this.call, {
-            onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency
+            onResolveVideoBackgroundEffectsDependency: this.onResolveVideoBackgroundEffectsDependency,
+            /* @conditional-compile-remove(DNS) */
+            onResolveDeepNoiseSuppressionDependency: this.onResolveDeepNoiseSuppressionDependency
         });
         this.subscribeCallEvents();
     }
@@ -1176,8 +1202,6 @@ export function createAzureCommunicationCallAdapter(args) {
             credential: args.credential,
             locator: args.locator,
             targetCallees: args.targetCallees,
-            /* @conditional-compile-remove(PSTN-calls) */
-            alternateCallerId: args.alternateCallerId,
             options: args.options
         });
     });
@@ -1187,15 +1211,12 @@ export function createAzureCommunicationCallAdapter(args) {
  *
  * @internal
  */
-export const _createAzureCommunicationCallAdapterInner = (_a) => __awaiter(void 0, [_a], void 0, function* ({ userId, displayName, credential, locator, targetCallees, 
-/* @conditional-compile-remove(PSTN-calls) */ alternateCallerId, options, telemetryImplementationHint = 'Call' }) {
+export const _createAzureCommunicationCallAdapterInner = (_a) => __awaiter(void 0, [_a], void 0, function* ({ userId, displayName, credential, locator, targetCallees, options, telemetryImplementationHint = 'Call' }) {
     if (!_isValidIdentifier(userId)) {
         throw new Error('Invalid identifier. Please provide valid identifier object.');
     }
     const callClient = _createStatefulCallClientInner({
-        userId,
-        /* @conditional-compile-remove(PSTN-calls) */
-        alternateCallerId
+        userId
     }, undefined, telemetryImplementationHint);
     const callAgent = yield callClient.createCallAgent(credential, {
         displayName
@@ -1239,8 +1260,6 @@ function useAzureCommunicationCallAdapterGeneric(args, adapterKind = 'AzureCommu
     const locator = 'locator' in args ? args.locator : undefined;
     const targetCallees = 'targetCallees' in args ? args.targetCallees : undefined;
     const displayName = 'displayName' in args ? args.displayName : undefined;
-    /* @conditional-compile-remove(PSTN-calls) */
-    const alternateCallerId = 'alternateCallerId' in args ? args.alternateCallerId : undefined;
     const options = 'options' in args ? args.options : undefined;
     // State update needed to rerender the parent component when a new adapter is created.
     const [adapter, setAdapter] = useState(undefined);
@@ -1292,7 +1311,6 @@ function useAzureCommunicationCallAdapterGeneric(args, adapterKind = 'AzureCommu
                         displayName: displayName,
                         locator,
                         userId: userId,
-                        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
                         options
                     }));
                 }
@@ -1302,7 +1320,6 @@ function useAzureCommunicationCallAdapterGeneric(args, adapterKind = 'AzureCommu
                         displayName: displayName,
                         targetCallees,
                         userId: userId,
-                        /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId,
                         options
                     }));
                 }
@@ -1356,8 +1373,6 @@ function useAzureCommunicationCallAdapterGeneric(args, adapterKind = 'AzureCommu
         locator,
         userId,
         displayName,
-        /* @conditional-compile-remove(PSTN-calls) */
-        alternateCallerId,
         options,
         targetCallees
     ]);