@azure/communication-react 1.12.0 → 1.12.1-alpha-202401190013

package/dist/dist-esm/calling-stateful-client/src/CallContext.d.ts

@@ -3,10 +3,14 @@ import { AudioDeviceInfo, DeviceAccess, DominantSpeakersInfo, ScalingMode, Video
 import { RaisedHand } from '@azure/communication-calling';
 import { CapabilitiesChangeInfo, ParticipantCapabilities } from '@azure/communication-calling';
 import { TeamsCaptionsInfo } from '@azure/communication-calling';
+import { EnvironmentInfo } from '@azure/communication-calling';
 import { ParticipantRole } from '@azure/communication-calling';
 import { CallEndReason, CallState as CallStatus, RemoteParticipantState as RemoteParticipantStatus } from '@azure/communication-calling';
 import { CallState, CallClientState, LocalVideoStreamState, RemoteParticipantState, RemoteVideoStreamState, IncomingCallState, VideoStreamRendererViewState, CallAgentState, CallErrorTarget } from './CallClientState';
+import { AcceptedTransfer } from './CallClientState';
 import { LocalVideoStreamVideoEffectsState } from './CallClientState';
+import { ReactionMessage } from '@azure/communication-calling';
+import { SpotlightedParticipant } from '@azure/communication-calling';
 /**
  * @private
  */
@@ -20,7 +24,8 @@ export declare class CallContext {
     private _emitter;
     private _atomicId;
     private _callIdHistory;
-    constructor(userId: CommunicationIdentifierKind, maxListeners?: number);
+    private _timeOutId;
+    constructor(userId: CommunicationIdentifierKind, maxListeners?: number, alternateCallerId?: string);
     getState(): CallClientState;
     modifyState(modifier: (draft: CallClientState) => void): void;
     onStateChange(handler: (state: CallClientState) => void): void;
@@ -32,6 +37,7 @@ export declare class CallContext {
     setCallEnded(callId: string, callEndReason: CallEndReason | undefined): void;
     setCallState(callId: string, state: CallStatus): void;
     setCallId(newCallId: string, oldCallId: string): void;
+    setEnvironmentInfo(envInfo: EnvironmentInfo): void;
     setCallIsScreenSharingOn(callId: string, isScreenSharingOn: boolean): void;
     setCallRemoteParticipants(callId: string, addRemoteParticipant: RemoteParticipantState[], removeRemoteParticipant: string[]): void;
     setCallRemoteParticipantsEnded(callId: string, addRemoteParticipant: RemoteParticipantState[], removeRemoteParticipant: string[]): void;
@@ -39,12 +45,16 @@ export declare class CallContext {
     setCallLocalVideoStreamVideoEffects(callId: string, videoEffects: LocalVideoStreamVideoEffectsState): void;
     setCallIsMicrophoneMuted(callId: string, isMicrophoneMuted: boolean): void;
     setRole(callId: string, role: ParticipantRole): void;
+    setTotalParticipantCount(callId: string, totalParticipantCount: number): void;
     setCallDominantSpeakers(callId: string, dominantSpeakers: DominantSpeakersInfo): void;
     setCallRecordingActive(callId: string, isRecordingActive: boolean): void;
     setCallRaisedHands(callId: string, raisedHands: RaisedHand[]): void;
     setParticipantIsRaisedHand(callId: string, participantKey: string, raisedHand: RaisedHand | undefined): void;
+    setReceivedReactionFromParticipant(callId: string, participantKey: string, reactionMessage: ReactionMessage | null): void;
     setCallTranscriptionActive(callId: string, isTranscriptionActive: boolean): void;
     setCapabilities(callId: string, capabilities: ParticipantCapabilities, capabilitiesChangeInfo: CapabilitiesChangeInfo): void;
+    setSpotlight(callId: string, spotlightedParticipants: SpotlightedParticipant[]): void;
+    setParticipantSpotlighted(callId: string, spotlightedParticipant: SpotlightedParticipant): void;
     setCallScreenShareParticipant(callId: string, participantKey: string | undefined): void;
     setLocalVideoStreamRendererView(callId: string, localVideoMediaStreamType: string, view: VideoStreamRendererViewState | undefined): void;
     setParticipantState(callId: string, participantKey: string, state: RemoteParticipantStatus): void;
@@ -55,6 +65,7 @@ export declare class CallContext {
     setParticipantIsSpeaking(callId: string, participantKey: string, isSpeaking: boolean): void;
     setParticipantVideoStream(callId: string, participantKey: string, stream: RemoteVideoStreamState): void;
     setRemoteVideoStreamIsAvailable(callId: string, participantKey: string, streamId: number, isAvailable: boolean): void;
+    setRemoteVideoStreamIsReceiving(callId: string, participantKey: string, streamId: number, isReceiving: boolean): void;
     setRemoteVideoStreamSize(callId: string, participantKey: string, streamId: number, size: {
         width: number;
         height: number;
@@ -86,6 +97,7 @@ export declare class CallContext {
     setSelectedCaptionLanguage(callId: string, captionLanguage: string): void;
     setAvailableCaptionLanguages(callId: string, captionLanguages: string[]): void;
     setAvailableSpokenLanguages(callId: string, spokenLanguages: string[]): void;
+    setAcceptedTransfer(callId: string, acceptedTransfer: AcceptedTransfer): void;
     /**
      * Tees any errors encountered in an async function to the state.
      *

package/dist/dist-esm/calling-stateful-client/src/CallContext.js

@@ -32,8 +32,11 @@ export const MAX_CALL_HISTORY_LENGTH = 10;
  * @private
  */
 export class CallContext {
-    constructor(userId, maxListeners = 50) {
+    constructor(userId, maxListeners = 50, 
+    /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId) {
         this._callIdHistory = new CallIdHistory();
+        /* @conditional-compile-remove(reaction) */
+        this._timeOutId = {};
         /**
          * Tees direct errors to state.
          * @remarks
@@ -63,6 +66,8 @@ export class CallContext {
             },
             callAgent: undefined,
             userId: userId,
+            /* @conditional-compile-remove(unsupported-browser) */ environmentInfo: undefined,
+            /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId: alternateCallerId,
             latestErrors: {}
         };
         this._emitter = new EventEmitter();
@@ -129,6 +134,8 @@ export class CallContext {
                 existingCall.raiseHand.localParticipantRaisedHand = call.raiseHand.localParticipantRaisedHand;
                 /* @conditional-compile-remove(rooms) */
                 existingCall.role = call.role;
+                /* @conditional-compile-remove(total-participant-count) */
+                existingCall.totalParticipantCount = call.totalParticipantCount;
                 // We don't update the startTime and endTime if we are updating an existing active call
                 /* @conditional-compile-remove(close-captions) */
                 existingCall.captionsFeature.currentSpokenLanguage = call.captionsFeature.currentSpokenLanguage;
@@ -181,6 +188,12 @@ export class CallContext {
             }
         });
     }
+    /* @conditional-compile-remove(unsupported-browser) */
+    setEnvironmentInfo(envInfo) {
+        this.modifyState((draft) => {
+            draft.environmentInfo = envInfo;
+        });
+    }
     setCallIsScreenSharingOn(callId, isScreenSharingOn) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -220,13 +233,13 @@ export class CallContext {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
                 for (const removedStream of streamsRemoved) {
-                    const index = call.localVideoStreams.findIndex(i => i.mediaStreamType === removedStream.mediaStreamType);
+                    const index = call.localVideoStreams.findIndex((i) => i.mediaStreamType === removedStream.mediaStreamType);
                     if (index > -1) {
                         call.localVideoStreams.splice(index, 1);
                     }
                 }
                 for (const addedStream of streamsAdded) {
-                    const index = call.localVideoStreams.findIndex(i => i.mediaStreamType === addedStream.mediaStreamType);
+                    const index = call.localVideoStreams.findIndex((i) => i.mediaStreamType === addedStream.mediaStreamType);
                     if (index > -1) {
                         call.localVideoStreams[index] = addedStream;
                     }
@@ -243,7 +256,7 @@ export class CallContext {
             var _a;
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
-                const stream = (_a = call.localVideoStreams) === null || _a === void 0 ? void 0 : _a.find(i => i.mediaStreamType === 'Video');
+                const stream = (_a = call.localVideoStreams) === null || _a === void 0 ? void 0 : _a.find((i) => i.mediaStreamType === 'Video');
                 if (stream) {
                     stream.videoEffects = videoEffects;
                 }
@@ -267,6 +280,15 @@ export class CallContext {
             }
         });
     }
+    /* @conditional-compile-remove(total-participant-count) */
+    setTotalParticipantCount(callId, totalParticipantCount) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.totalParticipantCount = totalParticipantCount;
+            }
+        });
+    }
     setCallDominantSpeakers(callId, dominantSpeakers) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -288,10 +310,10 @@ export class CallContext {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
-                call.raiseHand.raisedHands = raisedHands.map(raisedHand => {
+                call.raiseHand.raisedHands = raisedHands.map((raisedHand) => {
                     return convertFromSDKToRaisedHandState(raisedHand);
                 });
-                const raisedHand = raisedHands.find(raisedHand => toFlatCommunicationIdentifier(raisedHand.identifier) === toFlatCommunicationIdentifier(this._state.userId));
+                const raisedHand = raisedHands.find((raisedHand) => toFlatCommunicationIdentifier(raisedHand.identifier) === toFlatCommunicationIdentifier(this._state.userId));
                 if (raisedHand) {
                     call.raiseHand.localParticipantRaisedHand = convertFromSDKToRaisedHandState(raisedHand);
                 }
@@ -313,6 +335,31 @@ export class CallContext {
             }
         });
     }
+    /* @conditional-compile-remove(reaction) */
+    setReceivedReactionFromParticipant(callId, participantKey, reactionMessage) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (!call) {
+                return;
+            }
+            clearTimeout(this._timeOutId[participantKey]);
+            const participant = call.remoteParticipants[participantKey];
+            const newReactionState = reactionMessage
+                ? { reactionMessage: reactionMessage, receivedAt: new Date() }
+                : undefined;
+            if (participantKey === toFlatCommunicationIdentifier(this._state.userId)) {
+                call.localParticipantReaction = newReactionState;
+            }
+            else {
+                participant.reactionState = newReactionState;
+            }
+            if (reactionMessage) {
+                this._timeOutId[participantKey] = setTimeout(() => {
+                    clearParticipantReactionState(this, callId, participantKey);
+                }, 5120);
+            }
+        });
+    }
     setCallTranscriptionActive(callId, isTranscriptionActive) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -326,10 +373,28 @@ export class CallContext {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
-                call.capabilitiesFeature = {
-                    capabilities,
-                    latestCapabilitiesChangeInfo: capabilitiesChangeInfo
-                };
+                call.capabilitiesFeature = { capabilities, latestCapabilitiesChangeInfo: capabilitiesChangeInfo };
+            }
+        });
+    }
+    /* @conditional-compile-remove(spotlight) */
+    setSpotlight(callId, spotlightedParticipants) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.spotlight = { spotlightedParticipants };
+            }
+        });
+    }
+    /* @conditional-compile-remove(spotlight) */
+    setParticipantSpotlighted(callId, spotlightedParticipant) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                const participant = call.remoteParticipants[toFlatCommunicationIdentifier(spotlightedParticipant.identifier)];
+                if (participant) {
+                    participant.spotlighted = { spotlightedOrderPosition: spotlightedParticipant.order };
+                }
             }
         });
     }
@@ -345,7 +410,7 @@ export class CallContext {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
-                const localVideoStream = call.localVideoStreams.find(localVideoStream => localVideoStream.mediaStreamType === localVideoMediaStreamType);
+                const localVideoStream = call.localVideoStreams.find((localVideoStream) => localVideoStream.mediaStreamType === localVideoMediaStreamType);
                 if (localVideoStream) {
                     localVideoStream.view = view;
                 }
@@ -428,6 +493,8 @@ export class CallContext {
                     const existingStream = participant.videoStreams[stream.id];
                     if (existingStream) {
                         existingStream.isAvailable = stream.isAvailable;
+                        /* @conditional-compile-remove(video-stream-is-receiving-flag) */
+                        existingStream.isReceiving = stream.isReceiving;
                         existingStream.mediaStreamType = stream.mediaStreamType;
                     }
                     else {
@@ -451,6 +518,21 @@ export class CallContext {
             }
         });
     }
+    /* @conditional-compile-remove(video-stream-is-receiving-flag) */
+    setRemoteVideoStreamIsReceiving(callId, participantKey, streamId, isReceiving) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                const participant = call.remoteParticipants[participantKey];
+                if (participant) {
+                    const stream = participant.videoStreams[streamId];
+                    if (stream) {
+                        stream.isReceiving = isReceiving;
+                    }
+                }
+            }
+        });
+    }
     /* @conditional-compile-remove(pinned-participants) */
     setRemoteVideoStreamSize(callId, participantKey, streamId, size) {
         this.modifyState((draft) => {
@@ -482,6 +564,8 @@ export class CallContext {
                         if (stream) {
                             stream.mediaStreamType = newStream.mediaStreamType;
                             stream.isAvailable = newStream.isAvailable;
+                            /* @conditional-compile-remove(video-stream-is-receiving-flag) */
+                            stream.isReceiving = newStream.isReceiving;
                         }
                         else {
                             participant.videoStreams[newStream.id] = newStream;
@@ -578,7 +662,7 @@ export class CallContext {
              * camera permissions are granted. So selectedCamera will have this value before the actual cameras are obtained. Therefore we should reset
              * selectedCamera to the first camera when there are cameras AND when current selectedCamera does not exist in the new array of cameras *
              */
-            if (cameras.length > 0 && !cameras.some(camera => { var _a; return camera.id === ((_a = draft.deviceManager.selectedCamera) === null || _a === void 0 ? void 0 : _a.id); })) {
+            if (cameras.length > 0 && !cameras.some((camera) => { var _a; return camera.id === ((_a = draft.deviceManager.selectedCamera) === null || _a === void 0 ? void 0 : _a.id); })) {
                 draft.deviceManager.selectedCamera = cameras[0];
             }
             draft.deviceManager.cameras = cameras;
@@ -610,7 +694,7 @@ export class CallContext {
     }
     deleteDeviceManagerUnparentedView(localVideoStream) {
         this.modifyState((draft) => {
-            const foundIndex = draft.deviceManager.unparentedViews.findIndex(stream => stream.mediaStreamType === localVideoStream.mediaStreamType);
+            const foundIndex = draft.deviceManager.unparentedViews.findIndex((stream) => stream.mediaStreamType === localVideoStream.mediaStreamType);
             if (foundIndex !== -1) {
                 draft.deviceManager.unparentedViews.splice(foundIndex, 1);
             }
@@ -619,7 +703,7 @@ export class CallContext {
     /* @conditional-compile-remove(video-background-effects) */
     setDeviceManagerUnparentedViewVideoEffects(localVideoStream, videoEffects) {
         this.modifyState((draft) => {
-            const foundIndex = draft.deviceManager.unparentedViews.findIndex(stream => stream.mediaStreamType === localVideoStream.mediaStreamType);
+            const foundIndex = draft.deviceManager.unparentedViews.findIndex((stream) => stream.mediaStreamType === localVideoStream.mediaStreamType);
             if (foundIndex !== -1) {
                 draft.deviceManager.unparentedViews[foundIndex].videoEffects = videoEffects;
             }
@@ -635,7 +719,12 @@ export class CallContext {
         // going through current captions to find the last caption said by the same speaker, remove that caption if it's partial and replace with the new caption
         for (let index = captions.length - 1; index >= 0; index--) {
             const currentCaption = captions[index];
-            if (currentCaption && currentCaption.resultType !== 'Final' && currentCaption.speaker.identifier && newCaption.speaker.identifier && toFlatCommunicationIdentifier(currentCaption.speaker.identifier) === toFlatCommunicationIdentifier(newCaption.speaker.identifier)) {
+            if (currentCaption &&
+                currentCaption.resultType !== 'Final' &&
+                currentCaption.speaker.identifier &&
+                newCaption.speaker.identifier &&
+                toFlatCommunicationIdentifier(currentCaption.speaker.identifier) ===
+                    toFlatCommunicationIdentifier(newCaption.speaker.identifier)) {
                 captions.splice(index, 1);
                 break;
             }
@@ -652,7 +741,9 @@ export class CallContext {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
                 const currentCaptionLanguage = call.captionsFeature.currentCaptionLanguage;
-                if (caption.captionLanguage.toUpperCase() === currentCaptionLanguage.toUpperCase() || currentCaptionLanguage === '' || currentCaptionLanguage === undefined) {
+                if (caption.captionLanguage.toUpperCase() === currentCaptionLanguage.toUpperCase() ||
+                    currentCaptionLanguage === '' ||
+                    currentCaptionLanguage === undefined) {
                     this.processNewCaption(call.captionsFeature.captions, convertFromSDKToCaptionInfoState(caption));
                 }
             }
@@ -721,6 +812,15 @@ export class CallContext {
             }
         });
     }
+    /* @conditional-compile-remove(call-transfer) */
+    setAcceptedTransfer(callId, acceptedTransfer) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.transfer.acceptedTransfers[acceptedTransfer.callId] = acceptedTransfer;
+            }
+        });
+    }
     /**
      * Tees any errors encountered in an async function to the state.
      *
@@ -791,4 +891,8 @@ const findOldestCallEnded = (calls) => {
     }
     return oldestCallId;
 };
+/* @conditional-compile-remove(reaction) */
+function clearParticipantReactionState(callContext, callId, participantKey) {
+    callContext.setReceivedReactionFromParticipant(callId, participantKey, null);
+}
 //# sourceMappingURL=CallContext.js.map