@azure/communication-react 1.16.0 → 1.17.0-alpha-202405150013

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

@@ -1,11 +1,16 @@
 import { AudioDeviceInfo, CallDirection, CallEndReason, CallerInfo, CallState as CallStatus, DeviceAccess, DominantSpeakersInfo, LatestMediaDiagnostics, LatestNetworkDiagnostics, MediaStreamType, ParticipantRole, RemoteParticipantState as RemoteParticipantStatus, ScalingMode, VideoDeviceInfo } from '@azure/communication-calling';
 import { TeamsCallInfo } from '@azure/communication-calling';
+import { CallInfo } from '@azure/communication-calling';
 import { CapabilitiesChangeInfo, ParticipantCapabilities } from '@azure/communication-calling';
 import { CaptionsResultType } from '@azure/communication-calling';
+import { CaptionsKind } from '@azure/communication-calling';
 import { VideoEffectName } from '@azure/communication-calling';
+import { CallKind } from '@azure/communication-calling';
+import { EnvironmentInfo } from '@azure/communication-calling';
 import { CommunicationIdentifierKind } from '@azure/communication-common';
 import { ReactionMessage } from '@azure/communication-calling';
 import { SpotlightedParticipant } from '@azure/communication-calling';
+import { LocalRecordingInfo, RecordingInfo } from '@azure/communication-calling';
 /**
  * State only version of {@link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of
  * {@link CallClientState} and not included here. The reason to have CallAgent's state proxied is to provide access to
@@ -85,6 +90,10 @@ export interface CaptionsCallFeatureState {
      * current caption language
      */
     currentCaptionLanguage: string;
+    /**
+     * current caption kind: teams or acs captions
+     */
+    captionsKind: CaptionsKind;
 }
 /**
  * State only version of {@link @azure/communication-calling#TranscriptionCallFeature}. {@link StatefulCallClient} will
@@ -155,6 +164,36 @@ export interface RecordingCallFeatureState {
      * Proxy of {@link @azure/communication-calling#RecordingCallFeature.isRecordingActive}.
      */
     isRecordingActive: boolean;
+    /**
+     * Contains list of information of started recordings
+     * Proxy of {@link @azure/communication-calling#RecordingCallFeature.recordings}.
+     */
+    activeRecordings?: RecordingInfo[];
+    /**
+     * Contains list of information of stopped recordings
+     */
+    lastStoppedRecording?: RecordingInfo[];
+}
+/**
+ * State only version of {@link @azure/communication-calling#LocalRecordingCallFeature}. {@link StatefulCallClient} will
+ * automatically listen for local recording state of the call and update the state exposed by {@link StatefulCallClient} accordingly.
+ *
+ * @beta
+ */
+export interface LocalRecordingCallFeatureState {
+    /**
+     * Proxy of {@link @azure/communication-calling#LocalRecordingCallFeature.isRecordingActive}.
+     */
+    isLocalRecordingActive: boolean;
+    /**
+     * Contains list of information of started recordings
+     * Proxy of {@link @azure/communication-calling#LocalRecordingCallFeature.recordings}.
+     */
+    activeLocalRecordings?: LocalRecordingInfo[];
+    /**
+     * Contains list of information of stopped recordings
+     */
+    lastStoppedLocalRecording?: LocalRecordingInfo[];
 }
 /**
  * State only version of {@link @azure/communication-calling#RaiseHandCallFeature}. {@link StatefulCallClient} will
@@ -386,6 +425,10 @@ export interface CallState {
      * Proxy of {@link @azure/communication-calling#Call.id}.
      */
     id: string;
+    /**
+     * Type of the call.
+     */
+    kind: CallKind;
     /**
      * Proxy of {@link @azure/communication-calling#Call.callerInfo}.
      */
@@ -452,6 +495,10 @@ export interface CallState {
      * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.
      */
     recording: RecordingCallFeatureState;
+    /**
+     * Proxy of {@link @azure/communication-calling#LocalRecordingCallFeature}.
+     */
+    localRecording: LocalRecordingCallFeatureState;
     /**
      * Proxy of {@link @azure/communication-calling#PPTLiveCallFeature}.
      *
@@ -508,6 +555,10 @@ export interface CallState {
      * Proxy of {@link @azure/communication-calling#Call.role}.
      */
     role?: ParticipantRole;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.totalParticipantCount}.
+     */
+    totalParticipantCount?: number;
     /**
      * Transfer state of call
      */
@@ -527,7 +578,7 @@ export interface CallState {
     /**
      * Proxy of {@link @azure/communication-calling#Call.info}.
      */
-    info?: TeamsCallInfo;
+    info?: TeamsCallInfo | /* @conditional-compile-remove(calling-beta-sdk) */ CallInfo;
 }
 /**
  * Transfer feature state
@@ -705,6 +756,16 @@ export interface CallClientState {
      * See documentation of {@Link CallErrors} for details.
      */
     latestErrors: CallErrors;
+    /**
+     * A phone number in E.164 format that will be used to represent callers identity.
+     * For example, using the alternateCallerId to add a participant using PSTN, this number will
+     * be used as the caller id in the PSTN call.
+     */
+    alternateCallerId?: string;
+    /**
+     * state to track the environment that the stateful client was made in is supported
+     */
+    environmentInfo?: EnvironmentInfo;
 }
 /**
  * Errors teed from API calls to the Calling SDK.
@@ -747,7 +808,7 @@ export declare class CallError extends Error {
  *
  * @public
  */
-export type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | 'VideoEffectsFeature.startEffects' | 'Call.setConstraints';
+export type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | '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' | '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' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteAllRemoteParticipants' | 'Call.setConstraints';
 /**
  * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.
  *

package/dist/dist-esm/calling-stateful-client/src/CallClientState.js.map

@@ -1 +1 @@
-{"version":3,"file":"CallClientState.js","sourceRoot":"","sources":["../../../../preprocess-dist/calling-stateful-client/src/CallClientState.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA2vBlC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAalC,YAAY,MAAuB,EAAE,UAAiB,EAAE,SAAgB;QACtE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IAC9D,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { AudioDeviceInfo, CallDirection, CallEndReason, CallerInfo, CallState as CallStatus, DeviceAccess, DominantSpeakersInfo, LatestMediaDiagnostics, LatestNetworkDiagnostics, MediaStreamType, ParticipantRole, RemoteParticipantState as RemoteParticipantStatus, ScalingMode, VideoDeviceInfo } from '@azure/communication-calling';\n/* @conditional-compile-remove(meeting-id) */\nimport { TeamsCallInfo } from '@azure/communication-calling';\nimport { CapabilitiesChangeInfo, ParticipantCapabilities } from '@azure/communication-calling';\nimport { CaptionsResultType } from '@azure/communication-calling';\nimport { VideoEffectName } from '@azure/communication-calling';\nimport { CommunicationIdentifierKind } from '@azure/communication-common';\nimport { ReactionMessage } from '@azure/communication-calling';\n/* @conditional-compile-remove(spotlight) */\nimport { SpotlightedParticipant } from '@azure/communication-calling';\n/**\n * State only version of {@link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of\n * {@link CallClientState} and not included here. The reason to have CallAgent's state proxied is to provide access to\n * displayName. We don't flatten CallAgent.displayName and put it in CallClientState because it would be ambiguious that\n * displayName is actually reliant on the creation/existence of CallAgent to be available.\n *\n * @public\n */\nexport interface CallAgentState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.displayName}.\n   */\n  displayName?: string;\n}\n\n/**\n * @public\n */\nexport interface CaptionsInfo {\n  /**\n   * The state in which this caption data can be classified.\n   */\n  resultType: CaptionsResultType;\n  /**\n   * The information of the call participant who spoke the captioned text.\n   */\n  speaker: CallerInfo;\n  /**\n   * The language that the spoken words were interpretted as. Corresponds to the language specified in startCaptions / setSpokenLanguage.\n   */\n  spokenLanguage: string;\n  /**\n   * The caption text.\n   */\n  captionText: string;\n  /**\n   * Timestamp of when the captioned words were initially spoken.\n   */\n  timestamp: Date;\n  /**\n   * The language that the captions are presented in. Corresponds to the captionLanguage specified in startCaptions / setCaptionLanguage.\n   */\n  captionLanguage?: string;\n  /**\n   * The original spoken caption text prior to translating to subtitle language\n   */\n  spokenText?: string;\n}\n\n/**\n * @public\n */\nexport interface CaptionsCallFeatureState {\n  /**\n   * supported spoken languages\n   */\n  supportedSpokenLanguages: string[];\n  /**\n   * array of received captions\n   */\n  captions: CaptionsInfo[];\n  /**\n   * whether captions is on/off\n   */\n  isCaptionsFeatureActive: boolean;\n  /**\n   * whether start captions button is clicked or now\n   */\n  startCaptionsInProgress: boolean;\n  /**\n   * supported caption languages\n   */\n  supportedCaptionLanguages: string[];\n  /**\n   * current spoken language\n   */\n  currentSpokenLanguage: string;\n  /**\n   * current caption language\n   */\n  currentCaptionLanguage: string;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#TranscriptionCallFeature}. {@link StatefulCallClient} will\n * automatically listen for transcription state of the call and update the state exposed by {@link StatefulCallClient}\n * accordingly.\n *\n * @public\n */\nexport interface TranscriptionCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature.isTranscriptionActive}.\n   */\n  isTranscriptionActive: boolean;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#CapabilitiesFeature}\n *\n * @public\n */\nexport interface CapabilitiesFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CapabilitiesFeature.capabilities}.\n   */\n  capabilities: ParticipantCapabilities;\n  /**\n   * Proxy of the latest {@link @azure/communication-calling#CapabilitiesChangeInfo}\n   */\n  latestCapabilitiesChangeInfo: CapabilitiesChangeInfo;\n}\n\n/* @conditional-compile-remove(spotlight) */\n/**\n * State only version of {@link @azure/communication-calling#SpotlightCallFeature}\n *\n * @public\n */\nexport interface SpotlightCallFeatureState {\n  /**\n   * Ordered array of spotlighted participants in call\n   */\n  spotlightedParticipants: SpotlightedParticipant[];\n  /**\n   * Local participant spotlight\n   */\n  localParticipantSpotlight?: SpotlightState;\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.maxParticipantsToSpotlight}.\n   */\n  maxParticipantsToSpotlight: number;\n}\n\n/* @conditional-compile-remove(spotlight) */\n/**\n * Spotlight state with order\n *\n * @public\n */\nexport interface SpotlightState {\n  /**\n   * Order position of spotlight in call\n   */\n  spotlightedOrderPosition?: number;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RecordingCallFeature}. {@link StatefulCallClient} will\n * automatically listen for recording state of the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface RecordingCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature.isRecordingActive}.\n   */\n  isRecordingActive: boolean;\n}\n/**\n * State only version of {@link @azure/communication-calling#RaiseHandCallFeature}. {@link StatefulCallClient} will\n * automatically listen for raised hands on the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface RaiseHandCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.\n   */\n  raisedHands: RaisedHandState[];\n  /**\n   * Contains information for local participant from list {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.\n   */\n  localParticipantRaisedHand?: RaisedHandState;\n}\n\n/* @conditional-compile-remove(ppt-live) */\n/**\n * State only version of {@link @azure/communication-calling#PPTLiveCallFeature}. {@link StatefulCallClient} will\n * automatically listen for pptLive on the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface PPTLiveCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#PPTLiveCallFeature.isActive}.\n   */\n  isActive: boolean;\n}\n/**\n * Raised hand state with order\n *\n * @public\n */\nexport type RaisedHandState = {\n  raisedHandOrderPosition: number;\n};\n\n/**\n * State only version of {@link @azure/communication-calling#Call.ReactionMessage} with UI helper props receivedOn.\n * Reaction state with a timestamp which helps UI to decide to render the reaction accordingly.\n *\n * @public\n */\nexport type ReactionState = {\n  /**\n   * Reaction message from the meeting {@link @azure/communication-calling#Call.ReactionMessage}\n   */\n  reactionMessage: ReactionMessage;\n  /**\n   * Received timestamp of the reaction message in a meeting.\n   */\n  receivedOn: Date;\n};\n\n/**\n * State only version of {@link @azure/communication-calling#LocalVideoStream}.\n *\n * @public\n */\nexport interface LocalVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.source}.\n   */\n  source: VideoDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n\n  /**\n   * Stores the state of the video effects.\n   * @public\n   */\n  videoEffects?: LocalVideoStreamVideoEffectsState;\n}\n\n/**\n * State only version of a LocalVideoStream's {@link @azure/communication-calling#VideoEffectsFeature}.\n *\n * @public\n */\nexport interface LocalVideoStreamVideoEffectsState {\n  /**\n   * List of effects if any are active.\n   */\n  activeEffects?: VideoEffectName[];\n}\n\n/**\n * State only version of Optimal Video Count Feature {@link @azure/communication-calling#OptimalVideoCountCallFeature}.\n *\n * @public\n */\nexport interface OptimalVideoCountFeatureState {\n  /**\n   * State of the current optimal video count.\n   */\n  maxRemoteVideoStreams: number;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RemoteVideoStream}.\n *\n * @public\n */\nexport interface RemoteVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  id: number;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isAvailable}.\n   */\n  isAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isReceiving}.\n   * @public\n   */\n  /* @conditional-compile-remove(video-stream-is-receiving-flag) */\n  isReceiving: boolean;\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.size}.\n   */\n  streamSize?: {\n    width: number;\n    height: number;\n  };\n}\n\n/**\n * State only version of {@link @azure/communication-calling#VideoStreamRendererView}. This property is added to the state exposed\n * by {@link StatefulCallClient} by {@link StatefulCallClient.createView} and removed by {@link StatefulCallClient.disposeView}.\n *\n * @public\n */\nexport interface VideoStreamRendererViewState {\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.scalingMode}.\n   */\n  scalingMode: ScalingMode;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.isMirrored}.\n   */\n  isMirrored: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.target}.\n   */\n  target: HTMLElement;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RemoteParticipant}. {@link StatefulCallClient} will\n * automatically retrieve RemoteParticipants and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface RemoteParticipantState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.identifier}.\n   */\n  identifier: CommunicationIdentifierKind;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.displayName}.\n   */\n  displayName?: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.state}.\n   */\n  state: RemoteParticipantStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.videoStreams} as an object with\n   * {@link RemoteVideoStream} fields keyed by {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  videoStreams: {\n    [key: number]: RemoteVideoStreamState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isSpeaking}.\n   */\n  isSpeaking: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.role}.\n   */\n  role?: ParticipantRole;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.RaisedHand.raisedHands}.\n   */\n  raisedHand?: RaisedHandState;\n  /* @conditional-compile-remove(ppt-live) */\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.PPTLive.target}.\n   *\n   * @public\n   */\n  contentSharingStream?: HTMLElement;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.ReactionMessage} with\n   * UI helper props receivedOn which indicates the timestamp when the message was received.\n   *\n   * @public\n   */\n  reactionState?: ReactionState;\n  /* @conditional-compile-remove(spotlight) */\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.spotlightedParticipants}.\n   */\n  spotlight?: SpotlightState;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#Call}. {@link StatefulCallClient} will automatically\n * retrieve Call's state and add it to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface CallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.state}.\n   */\n  state: CallStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.direction}.\n   */\n  direction: CallDirection;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isScreenSharingOn}.\n   */\n  isScreenSharingOn: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DominantSpeakersInfo }.\n   */\n  dominantSpeakers?: DominantSpeakersInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.localVideoStreams}.\n   */\n  localVideoStreams: LocalVideoStreamState[];\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.remoteParticipants}.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipants: {\n    [keys: string]: RemoteParticipantState;\n  };\n  /**\n   * Stores remote participants that have left the call so that the callEndReason could be retrieved.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipantsEnded: {\n    [keys: string]: RemoteParticipantState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.\n   */\n  transcription: TranscriptionCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.\n   */\n  captionsFeature: CaptionsCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#OptimalVideoCountCallFeature}.\n   */\n  optimalVideoCount: OptimalVideoCountFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.\n   */\n  recording: RecordingCallFeatureState;\n  /* @conditional-compile-remove(ppt-live) */\n  /**\n   * Proxy of {@link @azure/communication-calling#PPTLiveCallFeature}.\n   *\n   *@public\n   */\n  pptLive: PPTLiveCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RaiseHandCallFeature}.\n   */\n  raiseHand: RaiseHandCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.ReactionMessage} with\n   * UI helper props receivedOn which indicates the timestamp when the message was received.\n   *\n   * @public\n   */\n  localParticipantReaction?: ReactionState;\n  /**\n   * Stores the currently active screenshare participant's key. If there is no screenshare active, then this will be\n   * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.\n   *\n   * Note this only applies to ScreenShare in RemoteParticipant. A local ScreenShare being active will not affect this\n   * property.\n   *\n   * This property is added by the stateful layer and is not a proxy of SDK state\n   */\n  screenShareRemoteParticipant?: string;\n  /* @conditional-compile-remove(ppt-live) */\n  /**\n   * Stores the currently active pptlive participant's key. Will be reused by White board etc. If there is no screenshare active, then this will be\n   * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.\n   *\n   * Note this only applies to PPTLive in RemoteParticipant.\n   *\n   * This property is added by the stateful layer and is not a proxy of SDK state\n   *\n   *@public\n   */\n  contentSharingRemoteParticipant?: string;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  endTime: Date | undefined;\n\n  /**\n   * Stores the latest call diagnostics.\n   */\n  diagnostics: DiagnosticsCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.role}.\n   */\n  role?: ParticipantRole;\n  /**\n   * Transfer state of call\n   */\n  transfer: TransferFeatureState;\n\n  /**\n   * Proxy of {@link @azure/communication-calling#CapabilitiesFeature}.\n   */\n  capabilitiesFeature?: CapabilitiesFeatureState;\n  /* @conditional-compile-remove(hide-attendee-name) */\n  /**\n   * Hide attendee names in teams meeting\n   */\n  hideAttendeeNames?: boolean;\n  /* @conditional-compile-remove(spotlight) */\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature}.\n   */\n  spotlight?: SpotlightCallFeatureState;\n  /* @conditional-compile-remove(meeting-id) */\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.info}.\n   */\n  info?: TeamsCallInfo;\n}\n\n/**\n * Transfer feature state\n *\n * @public\n */\nexport interface TransferFeatureState {\n  /**\n   * Accepted transfer requests\n   */\n  acceptedTransfers: {\n    [key: string]: AcceptedTransfer;\n  };\n}\n\n/**\n * Transfer feature state\n *\n * @public\n */\nexport interface AcceptedTransfer {\n  /**\n   * Stores call id of accepted transfer\n   */\n  callId: string;\n  /**\n   * Stores timestamp when transfer was accepted\n   */\n  timestamp: Date;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#IncomingCall}. {@link StatefulCallClient} will\n * automatically detect incoming calls and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface IncomingCallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Set to the state returned by 'callEnded' event on {@link @azure/communication-calling#IncomingCall} when received.\n   * This property is added by the stateful layer and is not a proxy of SDK state.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not a\n   * proxy of SDK state. It is undefined if the call is not ended yet.\n   */\n  endTime?: Date;\n}\n\n/**\n * This type is meant to encapsulate all the state inside {@link @azure/communication-calling#DeviceManager}. For\n * optional parameters they may not be available until permission is granted by the user. The cameras, microphones,\n * speakers, and deviceAccess states will be empty until the corresponding\n * {@link @azure/communication-calling#DeviceManager}'s getCameras, getMicrophones, getSpeakers, and askDevicePermission\n * APIs are called and completed.\n *\n * @public\n */\nexport type DeviceManagerState = {\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.isSpeakerSelectionAvailable}.\n   */\n  isSpeakerSelectionAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedMicrophone}.\n   */\n  selectedMicrophone?: AudioDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedSpeaker}.\n   */\n  selectedSpeaker?: AudioDeviceInfo;\n  /**\n   * Stores the selected camera device info. This is added by the stateful layer and does not exist in the Calling SDK.\n   * It is meant as a convenience to the developer. It must be explicitly set before it has any value and does not\n   * persist across instances of the {@link StatefulCallClient}. The developer controls entirely what this value holds\n   * at any time.\n   */\n  selectedCamera?: VideoDeviceInfo;\n  /**\n   * Stores any cameras data returned from {@link @azure/communication-calling#DeviceManager.getCameras}.\n   */\n  cameras: VideoDeviceInfo[];\n  /**\n   * Stores any microphones data returned from {@link @azure/communication-calling#DeviceManager.getMicrophones}.\n   */\n  microphones: AudioDeviceInfo[];\n  /**\n   * Stores any speakers data returned from {@link @azure/communication-calling#DeviceManager.getSpeakers}.\n   */\n  speakers: AudioDeviceInfo[];\n  /**\n   * Stores deviceAccess data returned from {@link @azure/communication-calling#DeviceManager.askDevicePermission}.\n   */\n  deviceAccess?: DeviceAccess;\n  /**\n   * Stores created views that are not associated with any CallState (when {@link StatefulCallClient.createView} is\n   * called with undefined callId, undefined participantId, and defined LocalVideoStream).\n   *\n   * The values in this array are generated internally when {@link StatefulCallClient.createView} is called and are\n   * considered immutable.\n   */\n  unparentedViews: LocalVideoStreamState[];\n};\n\n/**\n * Container for all of the state data proxied by {@link StatefulCallClient}. The calls, callsEnded, incomingCalls, and\n * incomingCallsEnded states will be automatically provided if a callAgent has been created. The deviceManager will be\n * empty initially until populated see {@link DeviceManagerState}. The userId state is provided as a convenience for the\n * developer and is completely controled and set by the developer.\n *\n * @public\n */\nexport interface CallClientState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.calls} as an object with CallState {@link CallState} fields.\n   * It is keyed by {@link @azure/communication-calling#Call.id}. Please note that\n   * {@link @azure/communication-calling#Call.id} could change. You should not cache the id itself but the entire\n   * {@link @azure/communication-calling#Call} and then use the id contained to look up data in this map.\n   */\n  calls: {\n    [key: string]: CallState;\n  };\n  /**\n   * Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an object with {@link @azure/communication-calling#Call.id} keys and {@link CallState} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  callsEnded: {\n    [key: string]: CallState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall} as an object with {@link IncomingCall} fields.\n   * It is keyed by {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  incomingCalls: {\n    [key: string]: IncomingCallState;\n  };\n  /**\n   * Incoming Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an as an object with {@link @azure/communication-calling#Call.id} keys and {@link IncomingCall} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  incomingCallsEnded: {\n    [key: string]: IncomingCallState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager}. Please review {@link DeviceManagerState}.\n   */\n  deviceManager: DeviceManagerState;\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent}. Please review {@link CallAgentState}.\n   */\n  callAgent?: CallAgentState;\n  /**\n   * Stores a userId. This is not used by the {@link StatefulCallClient} and is provided here as a convenience for the\n   * developer for easier access to userId. Must be passed in at initialization of the {@link StatefulCallClient}.\n   * Completely controlled by the developer.\n   */\n  userId: CommunicationIdentifierKind;\n  /**\n   * Stores the latest error for each API method.\n   *\n   * See documentation of {@Link CallErrors} for details.\n   */\n  latestErrors: CallErrors;\n}\n\n/**\n * Errors teed from API calls to the Calling SDK.\n *\n * Each property in the object stores the latest error for a particular SDK API method.\n *\n * Errors from this object can be cleared using the {@link newClearCallErrorsModifier}.\n * Additionally, errors are automatically cleared when:\n * - The state is cleared.\n * - Subsequent calls to related API methods succeed.\n * See documentation of individual stateful client methods for details on when errors may be automatically cleared.\n *\n * @public\n */\nexport type CallErrors = { [target in CallErrorTarget]: CallError };\n\n/**\n * Error thrown from failed stateful API methods.\n *\n * @public\n */\nexport class CallError extends Error {\n  /**\n   * The API method target that failed.\n   */\n  public target: CallErrorTarget;\n  /**\n   * Error thrown by the failed SDK method.\n   */\n  public innerError: Error;\n  /**\n   * Timestamp added to the error by the stateful layer.\n   */\n  public timestamp: Date;\n  constructor(target: CallErrorTarget, innerError: Error, timestamp?: Date) {\n    super();\n    this.target = target;\n    this.innerError = innerError;\n    // Testing note: It is easier to mock Date::now() than the Date() constructor.\n    this.timestamp = timestamp ?? new Date(Date.now());\n    this.name = 'CallError';\n    this.message = `${this.target}: ${this.innerError.message}`;\n  }\n}\n\n/**\n * String literal type for all permissible keys in {@Link CallErrors}.\n *\n * @public\n */\nexport type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | 'VideoEffectsFeature.startEffects' | 'Call.setConstraints';\n\n/**\n * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.\n *\n * @public\n */\nexport interface DiagnosticsCallFeatureState {\n  /**\n   * Stores diagnostics related to network conditions.\n   */\n  network: NetworkDiagnosticsState;\n\n  /**\n   * Stores diagnostics related to media quality.\n   */\n  media: MediaDiagnosticsState;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#NetworkDiagnostics}.\n *\n * @public\n */\nexport interface NetworkDiagnosticsState {\n  latest: LatestNetworkDiagnostics;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#MediaDiagnostics}.\n *\n * @public\n */\nexport interface MediaDiagnosticsState {\n  latest: LatestMediaDiagnostics;\n}"]}
+{"version":3,"file":"CallClientState.js","sourceRoot":"","sources":["../../../../../calling-stateful-client/src/CallClientState.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAy0BlC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAclC,YAAY,MAAuB,EAAE,UAAiB,EAAE,SAAgB;QACtE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IAC9D,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  AudioDeviceInfo,\n  CallDirection,\n  CallEndReason,\n  CallerInfo,\n  CallState as CallStatus,\n  DeviceAccess,\n  DominantSpeakersInfo,\n  LatestMediaDiagnostics,\n  LatestNetworkDiagnostics,\n  MediaStreamType,\n  ParticipantRole,\n  RemoteParticipantState as RemoteParticipantStatus,\n  ScalingMode,\n  VideoDeviceInfo\n} from '@azure/communication-calling';\n/* @conditional-compile-remove(meeting-id) */\nimport { TeamsCallInfo } from '@azure/communication-calling';\n/* @conditional-compile-remove(calling-beta-sdk) */\nimport { CallInfo } from '@azure/communication-calling';\n\nimport { CapabilitiesChangeInfo, ParticipantCapabilities } from '@azure/communication-calling';\nimport { CaptionsResultType } from '@azure/communication-calling';\n/* @conditional-compile-remove(acs-close-captions) */\nimport { CaptionsKind } from '@azure/communication-calling';\nimport { VideoEffectName } from '@azure/communication-calling';\n/* @conditional-compile-remove(teams-identity-support) */\nimport { CallKind } from '@azure/communication-calling';\n/* @conditional-compile-remove(unsupported-browser) */\nimport { EnvironmentInfo } from '@azure/communication-calling';\nimport { CommunicationIdentifierKind } from '@azure/communication-common';\nimport { ReactionMessage } from '@azure/communication-calling';\n/* @conditional-compile-remove(spotlight) */\nimport { SpotlightedParticipant } from '@azure/communication-calling';\n/* @conditional-compile-remove(local-recording-notification) */\nimport { LocalRecordingInfo, RecordingInfo } from '@azure/communication-calling';\n\n/**\n * State only version of {@link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of\n * {@link CallClientState} and not included here. The reason to have CallAgent's state proxied is to provide access to\n * displayName. We don't flatten CallAgent.displayName and put it in CallClientState because it would be ambiguious that\n * displayName is actually reliant on the creation/existence of CallAgent to be available.\n *\n * @public\n */\nexport interface CallAgentState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.displayName}.\n   */\n  displayName?: string;\n}\n\n/**\n * @public\n */\nexport interface CaptionsInfo {\n  /**\n   * The state in which this caption data can be classified.\n   */\n  resultType: CaptionsResultType;\n  /**\n   * The information of the call participant who spoke the captioned text.\n   */\n  speaker: CallerInfo;\n  /**\n   * The language that the spoken words were interpretted as. Corresponds to the language specified in startCaptions / setSpokenLanguage.\n   */\n  spokenLanguage: string;\n  /**\n   * The caption text.\n   */\n  captionText: string;\n  /**\n   * Timestamp of when the captioned words were initially spoken.\n   */\n  timestamp: Date;\n  /**\n   * The language that the captions are presented in. Corresponds to the captionLanguage specified in startCaptions / setCaptionLanguage.\n   */\n  captionLanguage?: string;\n  /**\n   * The original spoken caption text prior to translating to subtitle language\n   */\n  spokenText?: string;\n}\n\n/**\n * @public\n */\nexport interface CaptionsCallFeatureState {\n  /**\n   * supported spoken languages\n   */\n  supportedSpokenLanguages: string[];\n  /**\n   * array of received captions\n   */\n  captions: CaptionsInfo[];\n  /**\n   * whether captions is on/off\n   */\n  isCaptionsFeatureActive: boolean;\n  /**\n   * whether start captions button is clicked or now\n   */\n  startCaptionsInProgress: boolean;\n  /**\n   * supported caption languages\n   */\n  supportedCaptionLanguages: string[];\n  /**\n   * current spoken language\n   */\n  currentSpokenLanguage: string;\n  /**\n   * current caption language\n   */\n  currentCaptionLanguage: string;\n  /* @conditional-compile-remove(acs-close-captions) */\n  /**\n   * current caption kind: teams or acs captions\n   */\n  captionsKind: CaptionsKind;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#TranscriptionCallFeature}. {@link StatefulCallClient} will\n * automatically listen for transcription state of the call and update the state exposed by {@link StatefulCallClient}\n * accordingly.\n *\n * @public\n */\nexport interface TranscriptionCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature.isTranscriptionActive}.\n   */\n  isTranscriptionActive: boolean;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#CapabilitiesFeature}\n *\n * @public\n */\nexport interface CapabilitiesFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CapabilitiesFeature.capabilities}.\n   */\n  capabilities: ParticipantCapabilities;\n  /**\n   * Proxy of the latest {@link @azure/communication-calling#CapabilitiesChangeInfo}\n   */\n  latestCapabilitiesChangeInfo: CapabilitiesChangeInfo;\n}\n\n/* @conditional-compile-remove(spotlight) */\n/**\n * State only version of {@link @azure/communication-calling#SpotlightCallFeature}\n *\n * @public\n */\nexport interface SpotlightCallFeatureState {\n  /**\n   * Ordered array of spotlighted participants in call\n   */\n  spotlightedParticipants: SpotlightedParticipant[];\n  /**\n   * Local participant spotlight\n   */\n  localParticipantSpotlight?: SpotlightState;\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.maxParticipantsToSpotlight}.\n   */\n  maxParticipantsToSpotlight: number;\n}\n\n/* @conditional-compile-remove(spotlight) */\n/**\n * Spotlight state with order\n *\n * @public\n */\nexport interface SpotlightState {\n  /**\n   * Order position of spotlight in call\n   */\n  spotlightedOrderPosition?: number;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RecordingCallFeature}. {@link StatefulCallClient} will\n * automatically listen for recording state of the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface RecordingCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature.isRecordingActive}.\n   */\n  isRecordingActive: boolean;\n  /* @conditional-compile-remove(local-recording-notification) */\n  /**\n   * Contains list of information of started recordings\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature.recordings}.\n   */\n  activeRecordings?: RecordingInfo[];\n  /* @conditional-compile-remove(local-recording-notification) */\n  /**\n   * Contains list of information of stopped recordings\n   */\n  lastStoppedRecording?: RecordingInfo[];\n}\n\n/* @conditional-compile-remove(local-recording-notification) */\n/**\n * State only version of {@link @azure/communication-calling#LocalRecordingCallFeature}. {@link StatefulCallClient} will\n * automatically listen for local recording state of the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @beta\n */\nexport interface LocalRecordingCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalRecordingCallFeature.isRecordingActive}.\n   */\n  isLocalRecordingActive: boolean;\n  /**\n   * Contains list of information of started recordings\n   * Proxy of {@link @azure/communication-calling#LocalRecordingCallFeature.recordings}.\n   */\n  activeLocalRecordings?: LocalRecordingInfo[];\n  /**\n   * Contains list of information of stopped recordings\n   */\n  lastStoppedLocalRecording?: LocalRecordingInfo[];\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RaiseHandCallFeature}. {@link StatefulCallClient} will\n * automatically listen for raised hands on the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface RaiseHandCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.\n   */\n  raisedHands: RaisedHandState[];\n  /**\n   * Contains information for local participant from list {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.\n   */\n  localParticipantRaisedHand?: RaisedHandState;\n}\n\n/* @conditional-compile-remove(ppt-live) */\n/**\n * State only version of {@link @azure/communication-calling#PPTLiveCallFeature}. {@link StatefulCallClient} will\n * automatically listen for pptLive on the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface PPTLiveCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#PPTLiveCallFeature.isActive}.\n   */\n  isActive: boolean;\n}\n/**\n * Raised hand state with order\n *\n * @public\n */\nexport type RaisedHandState = {\n  raisedHandOrderPosition: number;\n};\n\n/**\n * State only version of {@link @azure/communication-calling#Call.ReactionMessage} with UI helper props receivedOn.\n * Reaction state with a timestamp which helps UI to decide to render the reaction accordingly.\n *\n * @public\n */\nexport type ReactionState = {\n  /**\n   * Reaction message from the meeting {@link @azure/communication-calling#Call.ReactionMessage}\n   */\n  reactionMessage: ReactionMessage;\n  /**\n   * Received timestamp of the reaction message in a meeting.\n   */\n  receivedOn: Date;\n};\n\n/**\n * State only version of {@link @azure/communication-calling#LocalVideoStream}.\n *\n * @public\n */\nexport interface LocalVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.source}.\n   */\n  source: VideoDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n\n  /**\n   * Stores the state of the video effects.\n   * @public\n   */\n  videoEffects?: LocalVideoStreamVideoEffectsState;\n}\n\n/**\n * State only version of a LocalVideoStream's {@link @azure/communication-calling#VideoEffectsFeature}.\n *\n * @public\n */\nexport interface LocalVideoStreamVideoEffectsState {\n  /**\n   * List of effects if any are active.\n   */\n  activeEffects?: VideoEffectName[];\n}\n\n/**\n * State only version of Optimal Video Count Feature {@link @azure/communication-calling#OptimalVideoCountCallFeature}.\n *\n * @public\n */\nexport interface OptimalVideoCountFeatureState {\n  /**\n   * State of the current optimal video count.\n   */\n  maxRemoteVideoStreams: number;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RemoteVideoStream}.\n *\n * @public\n */\nexport interface RemoteVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  id: number;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isAvailable}.\n   */\n  isAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isReceiving}.\n   * @public\n   */\n  /* @conditional-compile-remove(video-stream-is-receiving-flag) */\n  isReceiving: boolean;\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.size}.\n   */\n  streamSize?: { width: number; height: number };\n}\n\n/**\n * State only version of {@link @azure/communication-calling#VideoStreamRendererView}. This property is added to the state exposed\n * by {@link StatefulCallClient} by {@link StatefulCallClient.createView} and removed by {@link StatefulCallClient.disposeView}.\n *\n * @public\n */\nexport interface VideoStreamRendererViewState {\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.scalingMode}.\n   */\n  scalingMode: ScalingMode;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.isMirrored}.\n   */\n  isMirrored: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.target}.\n   */\n  target: HTMLElement;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RemoteParticipant}. {@link StatefulCallClient} will\n * automatically retrieve RemoteParticipants and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface RemoteParticipantState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.identifier}.\n   */\n  identifier: CommunicationIdentifierKind;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.displayName}.\n   */\n  displayName?: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.state}.\n   */\n  state: RemoteParticipantStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.videoStreams} as an object with\n   * {@link RemoteVideoStream} fields keyed by {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  videoStreams: { [key: number]: RemoteVideoStreamState };\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isSpeaking}.\n   */\n  isSpeaking: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.role}.\n   */\n  role?: ParticipantRole;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.RaisedHand.raisedHands}.\n   */\n  raisedHand?: RaisedHandState;\n  /* @conditional-compile-remove(ppt-live) */\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.PPTLive.target}.\n   *\n   * @public\n   */\n  contentSharingStream?: HTMLElement;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.ReactionMessage} with\n   * UI helper props receivedOn which indicates the timestamp when the message was received.\n   *\n   * @public\n   */\n  reactionState?: ReactionState;\n  /* @conditional-compile-remove(spotlight) */\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.spotlightedParticipants}.\n   */\n  spotlight?: SpotlightState;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#Call}. {@link StatefulCallClient} will automatically\n * retrieve Call's state and add it to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface CallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.id}.\n   */\n  id: string;\n  /* @conditional-compile-remove(teams-identity-support) */\n  /**\n   * Type of the call.\n   */\n  kind: CallKind;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.state}.\n   */\n  state: CallStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.direction}.\n   */\n  direction: CallDirection;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isScreenSharingOn}.\n   */\n  isScreenSharingOn: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DominantSpeakersInfo }.\n   */\n  dominantSpeakers?: DominantSpeakersInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.localVideoStreams}.\n   */\n  localVideoStreams: LocalVideoStreamState[];\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.remoteParticipants}.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipants: { [keys: string]: RemoteParticipantState };\n  /**\n   * Stores remote participants that have left the call so that the callEndReason could be retrieved.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipantsEnded: { [keys: string]: RemoteParticipantState };\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.\n   */\n  transcription: TranscriptionCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.\n   */\n  captionsFeature: CaptionsCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#OptimalVideoCountCallFeature}.\n   */\n  optimalVideoCount: OptimalVideoCountFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.\n   */\n  recording: RecordingCallFeatureState;\n  /* @conditional-compile-remove(local-recording-notification) */\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalRecordingCallFeature}.\n   */\n  localRecording: LocalRecordingCallFeatureState;\n  /* @conditional-compile-remove(ppt-live) */\n  /**\n   * Proxy of {@link @azure/communication-calling#PPTLiveCallFeature}.\n   *\n   *@public\n   */\n  pptLive: PPTLiveCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RaiseHandCallFeature}.\n   */\n  raiseHand: RaiseHandCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.ReactionMessage} with\n   * UI helper props receivedOn which indicates the timestamp when the message was received.\n   *\n   * @public\n   */\n  localParticipantReaction?: ReactionState;\n  /**\n   * Stores the currently active screenshare participant's key. If there is no screenshare active, then this will be\n   * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.\n   *\n   * Note this only applies to ScreenShare in RemoteParticipant. A local ScreenShare being active will not affect this\n   * property.\n   *\n   * This property is added by the stateful layer and is not a proxy of SDK state\n   */\n  screenShareRemoteParticipant?: string;\n  /* @conditional-compile-remove(ppt-live) */\n  /**\n   * Stores the currently active pptlive participant's key. Will be reused by White board etc. If there is no screenshare active, then this will be\n   * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.\n   *\n   * Note this only applies to PPTLive in RemoteParticipant.\n   *\n   * This property is added by the stateful layer and is not a proxy of SDK state\n   *\n   *@public\n   */\n  contentSharingRemoteParticipant?: string;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  endTime: Date | undefined;\n\n  /**\n   * Stores the latest call diagnostics.\n   */\n  diagnostics: DiagnosticsCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.role}.\n   */\n  role?: ParticipantRole;\n\n  /* @conditional-compile-remove(total-participant-count) */\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.totalParticipantCount}.\n   */\n  totalParticipantCount?: number;\n  /**\n   * Transfer state of call\n   */\n  transfer: TransferFeatureState;\n\n  /**\n   * Proxy of {@link @azure/communication-calling#CapabilitiesFeature}.\n   */\n  capabilitiesFeature?: CapabilitiesFeatureState;\n  /* @conditional-compile-remove(hide-attendee-name) */\n  /**\n   * Hide attendee names in teams meeting\n   */\n  hideAttendeeNames?: boolean;\n  /* @conditional-compile-remove(spotlight) */\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature}.\n   */\n  spotlight?: SpotlightCallFeatureState;\n  /* @conditional-compile-remove(meeting-id) */\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.info}.\n   */\n  info?: TeamsCallInfo | /* @conditional-compile-remove(calling-beta-sdk) */ CallInfo;\n}\n\n/**\n * Transfer feature state\n *\n * @public\n */\nexport interface TransferFeatureState {\n  /**\n   * Accepted transfer requests\n   */\n  acceptedTransfers: { [key: string]: AcceptedTransfer };\n}\n\n/**\n * Transfer feature state\n *\n * @public\n */\nexport interface AcceptedTransfer {\n  /**\n   * Stores call id of accepted transfer\n   */\n  callId: string;\n  /**\n   * Stores timestamp when transfer was accepted\n   */\n  timestamp: Date;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#IncomingCall}. {@link StatefulCallClient} will\n * automatically detect incoming calls and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface IncomingCallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Set to the state returned by 'callEnded' event on {@link @azure/communication-calling#IncomingCall} when received.\n   * This property is added by the stateful layer and is not a proxy of SDK state.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not a\n   * proxy of SDK state. It is undefined if the call is not ended yet.\n   */\n  endTime?: Date;\n}\n\n/**\n * This type is meant to encapsulate all the state inside {@link @azure/communication-calling#DeviceManager}. For\n * optional parameters they may not be available until permission is granted by the user. The cameras, microphones,\n * speakers, and deviceAccess states will be empty until the corresponding\n * {@link @azure/communication-calling#DeviceManager}'s getCameras, getMicrophones, getSpeakers, and askDevicePermission\n * APIs are called and completed.\n *\n * @public\n */\nexport type DeviceManagerState = {\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.isSpeakerSelectionAvailable}.\n   */\n  isSpeakerSelectionAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedMicrophone}.\n   */\n  selectedMicrophone?: AudioDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedSpeaker}.\n   */\n  selectedSpeaker?: AudioDeviceInfo;\n  /**\n   * Stores the selected camera device info. This is added by the stateful layer and does not exist in the Calling SDK.\n   * It is meant as a convenience to the developer. It must be explicitly set before it has any value and does not\n   * persist across instances of the {@link StatefulCallClient}. The developer controls entirely what this value holds\n   * at any time.\n   */\n  selectedCamera?: VideoDeviceInfo;\n  /**\n   * Stores any cameras data returned from {@link @azure/communication-calling#DeviceManager.getCameras}.\n   */\n  cameras: VideoDeviceInfo[];\n  /**\n   * Stores any microphones data returned from {@link @azure/communication-calling#DeviceManager.getMicrophones}.\n   */\n  microphones: AudioDeviceInfo[];\n  /**\n   * Stores any speakers data returned from {@link @azure/communication-calling#DeviceManager.getSpeakers}.\n   */\n  speakers: AudioDeviceInfo[];\n  /**\n   * Stores deviceAccess data returned from {@link @azure/communication-calling#DeviceManager.askDevicePermission}.\n   */\n  deviceAccess?: DeviceAccess;\n  /**\n   * Stores created views that are not associated with any CallState (when {@link StatefulCallClient.createView} is\n   * called with undefined callId, undefined participantId, and defined LocalVideoStream).\n   *\n   * The values in this array are generated internally when {@link StatefulCallClient.createView} is called and are\n   * considered immutable.\n   */\n  unparentedViews: LocalVideoStreamState[];\n};\n\n/**\n * Container for all of the state data proxied by {@link StatefulCallClient}. The calls, callsEnded, incomingCalls, and\n * incomingCallsEnded states will be automatically provided if a callAgent has been created. The deviceManager will be\n * empty initially until populated see {@link DeviceManagerState}. The userId state is provided as a convenience for the\n * developer and is completely controled and set by the developer.\n *\n * @public\n */\nexport interface CallClientState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.calls} as an object with CallState {@link CallState} fields.\n   * It is keyed by {@link @azure/communication-calling#Call.id}. Please note that\n   * {@link @azure/communication-calling#Call.id} could change. You should not cache the id itself but the entire\n   * {@link @azure/communication-calling#Call} and then use the id contained to look up data in this map.\n   */\n  calls: { [key: string]: CallState };\n  /**\n   * Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an object with {@link @azure/communication-calling#Call.id} keys and {@link CallState} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  callsEnded: { [key: string]: CallState };\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall} as an object with {@link IncomingCall} fields.\n   * It is keyed by {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  incomingCalls: { [key: string]: IncomingCallState };\n  /**\n   * Incoming Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an as an object with {@link @azure/communication-calling#Call.id} keys and {@link IncomingCall} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  incomingCallsEnded: { [key: string]: IncomingCallState };\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager}. Please review {@link DeviceManagerState}.\n   */\n  deviceManager: DeviceManagerState;\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent}. Please review {@link CallAgentState}.\n   */\n  callAgent?: CallAgentState;\n  /**\n   * Stores a userId. This is not used by the {@link StatefulCallClient} and is provided here as a convenience for the\n   * developer for easier access to userId. Must be passed in at initialization of the {@link StatefulCallClient}.\n   * Completely controlled by the developer.\n   */\n  userId: CommunicationIdentifierKind;\n  /**\n   * Stores the latest error for each API method.\n   *\n   * See documentation of {@Link CallErrors} for details.\n   */\n  latestErrors: CallErrors;\n  /* @conditional-compile-remove(PSTN-calls) */\n  /**\n   * A phone number in E.164 format that will be used to represent callers identity.\n   * For example, using the alternateCallerId to add a participant using PSTN, this number will\n   * be used as the caller id in the PSTN call.\n   */\n  alternateCallerId?: string;\n  /* @conditional-compile-remove(unsupported-browser) */\n  /**\n   * state to track the environment that the stateful client was made in is supported\n   */\n  environmentInfo?: EnvironmentInfo;\n}\n\n/**\n * Errors teed from API calls to the Calling SDK.\n *\n * Each property in the object stores the latest error for a particular SDK API method.\n *\n * Errors from this object can be cleared using the {@link newClearCallErrorsModifier}.\n * Additionally, errors are automatically cleared when:\n * - The state is cleared.\n * - Subsequent calls to related API methods succeed.\n * See documentation of individual stateful client methods for details on when errors may be automatically cleared.\n *\n * @public\n */\nexport type CallErrors = {\n  [target in CallErrorTarget]: CallError;\n};\n\n/**\n * Error thrown from failed stateful API methods.\n *\n * @public\n */\nexport class CallError extends Error {\n  /**\n   * The API method target that failed.\n   */\n  public target: CallErrorTarget;\n  /**\n   * Error thrown by the failed SDK method.\n   */\n  public innerError: Error;\n  /**\n   * Timestamp added to the error by the stateful layer.\n   */\n  public timestamp: Date;\n\n  constructor(target: CallErrorTarget, innerError: Error, timestamp?: Date) {\n    super();\n    this.target = target;\n    this.innerError = innerError;\n    // Testing note: It is easier to mock Date::now() than the Date() constructor.\n    this.timestamp = timestamp ?? new Date(Date.now());\n    this.name = 'CallError';\n    this.message = `${this.target}: ${this.innerError.message}`;\n  }\n}\n\n/**\n * String literal type for all permissible keys in {@Link CallErrors}.\n *\n * @public\n */\nexport type CallErrorTarget =\n  | 'Call.addParticipant'\n  | 'Call.dispose'\n  | 'Call.feature'\n  | 'Call.hangUp'\n  | 'Call.hold'\n  | 'Call.mute'\n  | 'Call.muteIncomingAudio'\n  | 'Call.off'\n  | 'Call.on'\n  | 'Call.removeParticipant'\n  | 'Call.resume'\n  | 'Call.sendDtmf'\n  | 'Call.startAudio'\n  | 'Call.startScreenSharing'\n  | 'Call.startVideo'\n  | 'Call.stopScreenSharing'\n  | 'Call.stopAudio'\n  | 'Call.stopVideo'\n  | 'Call.unmute'\n  | 'Call.unmuteIncomingAudio'\n  | 'CallAgent.dispose'\n  | 'CallAgent.feature'\n  | 'CallAgent.join'\n  | 'CallAgent.off'\n  | 'CallAgent.on'\n  | 'CallAgent.startCall'\n  | 'CallClient.createCallAgent'\n  | 'CallClient.createTeamsCallAgent'\n  | 'CallClient.feature'\n  | 'CallClient.getDeviceManager'\n  | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo'\n  | 'DeviceManager.askDevicePermission'\n  | 'DeviceManager.getCameras'\n  | 'DeviceManager.getMicrophones'\n  | 'DeviceManager.getSpeakers'\n  | 'DeviceManager.off'\n  | 'DeviceManager.on'\n  | 'DeviceManager.selectMicrophone'\n  | 'DeviceManager.selectSpeaker'\n  | 'IncomingCall.accept'\n  | 'IncomingCall.reject'\n  | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'TeamsCall.addParticipant'\n  | 'VideoEffectsFeature.startEffects'\n  | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallAgent.handlePushNotification'\n  | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admit'\n  | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.rejectParticipant'\n  | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admitAll'\n  | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteAllRemoteParticipants'\n  | 'Call.setConstraints';\n\n/**\n * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.\n *\n * @public\n */\nexport interface DiagnosticsCallFeatureState {\n  /**\n   * Stores diagnostics related to network conditions.\n   */\n  network: NetworkDiagnosticsState;\n\n  /**\n   * Stores diagnostics related to media quality.\n   */\n  media: MediaDiagnosticsState;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#NetworkDiagnostics}.\n *\n * @public\n */\nexport interface NetworkDiagnosticsState {\n  latest: LatestNetworkDiagnostics;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#MediaDiagnostics}.\n *\n * @public\n */\nexport interface MediaDiagnosticsState {\n  latest: LatestMediaDiagnostics;\n}\n"]}

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

@@ -3,12 +3,16 @@ import { AudioDeviceInfo, DeviceAccess, DominantSpeakersInfo, ParticipantRole, S
 import { RaisedHand } from '@azure/communication-calling';
 import { CapabilitiesChangeInfo, ParticipantCapabilities } from '@azure/communication-calling';
 import { TeamsCaptionsInfo } from '@azure/communication-calling';
+import { CaptionsKind, CaptionsInfo as AcsCaptionsInfo } from '@azure/communication-calling';
+import { EnvironmentInfo } 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';
+import { LocalRecordingInfo } from '@azure/communication-calling';
+import { RecordingInfo } from '@azure/communication-calling';
 /**
  * @private
  */
@@ -27,7 +31,7 @@ export declare class CallContext {
     private _atomicId;
     private _callIdHistory;
     private _timeOutId;
-    constructor(userId: CommunicationIdentifierKind, maxListeners?: number);
+    constructor(userId: CommunicationIdentifierKind, maxListeners?: number, alternateCallerId?: string);
     getState(): CallClientState;
     modifyState(modifier: (draft: CallClientState) => void): void;
     onStateChange(handler: (state: CallClientState) => void): void;
@@ -39,6 +43,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;
@@ -46,8 +51,12 @@ 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;
+    setCallRecordingInfos(callId: string, recordingInfosAdded: RecordingInfo[], lastStoppedRecording: RecordingInfo[]): void;
+    setCallLocalRecordingActive(callId: string, isRecordingActive: boolean): void;
+    setCallLocalRecordingInfos(callId: string, localRecordingInfosAdded: LocalRecordingInfo[], lastStoppedRecording: LocalRecordingInfo[]): void;
     setCallPPTLiveActive(callId: string, isActive: boolean): void;
     setCallParticipantPPTLive(callId: string, target: HTMLElement | undefined): void;
     setCallRaisedHands(callId: string, raisedHands: RaisedHand[]): void;
@@ -94,6 +103,8 @@ export declare class CallContext {
     getAndIncrementAtomicId(): number;
     private processNewCaption;
     addTeamsCaption(callId: string, caption: TeamsCaptionsInfo): void;
+    addCaption(callId: string, caption: AcsCaptionsInfo): void;
+    setCaptionsKind(callId: string, kind: CaptionsKind): void;
     clearCaptions(callId: string): void;
     setIsCaptionActive(callId: string, isCaptionsActive: boolean): void;
     setStartCaptionsInProgress(callId: string, startCaptionsInProgress: boolean): void;

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

@@ -17,6 +17,8 @@ import { CallError } from './CallClientState';
 import { callingStatefulLogger } from './Logger';
 import { CallIdHistory } from './CallIdHistory';
 import { convertFromTeamsSDKToCaptionInfoState } from './Converter';
+/* @conditional-compile-remove(acs-close-captions) */
+import { convertFromSDKToCaptionInfoState } from './Converter';
 import { convertFromSDKToRaisedHandState } from './Converter';
 enableMapSet();
 // Needed to generate state diff for verbose logging.
@@ -34,7 +36,8 @@ export const REACTION_ANIMATION_TIME_MS = 4133;
  * @private
  */
 export class CallContext {
-    constructor(userId, maxListeners = 50) {
+    constructor(userId, maxListeners = 50, 
+    /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId) {
         this._callIdHistory = new CallIdHistory();
         this._timeOutId = {};
         /**
@@ -66,6 +69,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();
@@ -130,6 +135,8 @@ export class CallContext {
                 existingCall.pptLive.isActive = call.pptLive.isActive;
                 existingCall.raiseHand.localParticipantRaisedHand = call.raiseHand.localParticipantRaisedHand;
                 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
                 existingCall.captionsFeature.currentSpokenLanguage = call.captionsFeature.currentSpokenLanguage;
                 existingCall.captionsFeature.currentCaptionLanguage = call.captionsFeature.currentCaptionLanguage;
@@ -182,6 +189,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)];
@@ -226,13 +239,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;
                     }
@@ -248,7 +261,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;
                 }
@@ -271,6 +284,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)];
@@ -287,6 +309,35 @@ export class CallContext {
             }
         });
     }
+    /* @conditional-compile-remove(local-recording-notification) */
+    setCallRecordingInfos(callId, recordingInfosAdded, lastStoppedRecording) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.recording.activeRecordings = recordingInfosAdded;
+                call.recording.lastStoppedRecording = lastStoppedRecording;
+            }
+        });
+    }
+    /* @conditional-compile-remove(local-recording-notification) */
+    setCallLocalRecordingActive(callId, isRecordingActive) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.localRecording.isLocalRecordingActive = isRecordingActive;
+            }
+        });
+    }
+    /* @conditional-compile-remove(local-recording-notification) */
+    setCallLocalRecordingInfos(callId, localRecordingInfosAdded, lastStoppedRecording) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.localRecording.activeLocalRecordings = localRecordingInfosAdded;
+                call.localRecording.lastStoppedLocalRecording = lastStoppedRecording;
+            }
+        });
+    }
     /* @conditional-compile-remove(ppt-live) */
     setCallPPTLiveActive(callId, isActive) {
         this.modifyState((draft) => {
@@ -313,10 +364,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);
                 }
@@ -345,10 +396,9 @@ export class CallContext {
             }
             clearTimeout(this._timeOutId[participantKey]);
             const participant = call.remoteParticipants[participantKey];
-            const newReactionState = reactionMessage ? {
-                reactionMessage: reactionMessage,
-                receivedOn: new Date()
-            } : undefined;
+            const newReactionState = reactionMessage
+                ? { reactionMessage: reactionMessage, receivedOn: new Date() }
+                : undefined;
             if (participantKey === toFlatCommunicationIdentifier(this._state.userId)) {
                 call.localParticipantReaction = newReactionState;
             }
@@ -374,10 +424,7 @@ 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 };
             }
         });
     }
@@ -387,7 +434,10 @@ export class CallContext {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (capabilitiesChangeInfo.oldValue.viewAttendeeNames !== capabilitiesChangeInfo.newValue.viewAttendeeNames) {
                 const viewAttendeeNames = capabilitiesChangeInfo.newValue.viewAttendeeNames;
-                if (call && viewAttendeeNames && !viewAttendeeNames.isPresent && viewAttendeeNames.reason === 'MeetingRestricted') {
+                if (call &&
+                    viewAttendeeNames &&
+                    !viewAttendeeNames.isPresent &&
+                    viewAttendeeNames.reason === 'MeetingRestricted') {
                     call.hideAttendeeNames = true;
                 }
                 else {
@@ -401,8 +451,7 @@ export class CallContext {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
-                call.spotlight = Object.assign(Object.assign({}, call.spotlight), { spotlightedParticipants,
-                    maxParticipantsToSpotlight });
+                call.spotlight = Object.assign(Object.assign({}, call.spotlight), { spotlightedParticipants, maxParticipantsToSpotlight });
             }
         });
     }
@@ -413,14 +462,12 @@ export class CallContext {
             if (call) {
                 const participant = call.remoteParticipants[toFlatCommunicationIdentifier(spotlightedParticipant.identifier)];
                 if (participant) {
-                    participant.spotlight = {
-                        spotlightedOrderPosition: spotlightedParticipant.order
-                    };
+                    participant.spotlight = { spotlightedOrderPosition: spotlightedParticipant.order };
                 }
-                else if (call.spotlight && toFlatCommunicationIdentifier(draft.userId) === toFlatCommunicationIdentifier(spotlightedParticipant.identifier)) {
-                    call.spotlight.localParticipantSpotlight = {
-                        spotlightedOrderPosition: spotlightedParticipant.order
-                    };
+                else if (call.spotlight &&
+                    toFlatCommunicationIdentifier(draft.userId) ===
+                        toFlatCommunicationIdentifier(spotlightedParticipant.identifier)) {
+                    call.spotlight.localParticipantSpotlight = { spotlightedOrderPosition: spotlightedParticipant.order };
                 }
             }
         });
@@ -434,7 +481,9 @@ export class CallContext {
                 if (participant) {
                     participant.spotlight = undefined;
                 }
-                else if (call.spotlight && toFlatCommunicationIdentifier(draft.userId) === toFlatCommunicationIdentifier(spotlightedParticipant.identifier)) {
+                else if (call.spotlight &&
+                    toFlatCommunicationIdentifier(draft.userId) ===
+                        toFlatCommunicationIdentifier(spotlightedParticipant.identifier)) {
                     call.spotlight.localParticipantSpotlight = undefined;
                 }
             }
@@ -452,7 +501,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;
                 }
@@ -701,7 +750,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;
@@ -733,7 +782,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);
             }
@@ -741,7 +790,7 @@ export class CallContext {
     }
     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;
             }
@@ -787,12 +836,32 @@ 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, convertFromTeamsSDKToCaptionInfoState(caption));
                 }
             }
         });
     }
+    /* @conditional-compile-remove(acs-close-captions) */
+    addCaption(callId, caption) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                this.processNewCaption(call.captionsFeature.captions, convertFromSDKToCaptionInfoState(caption));
+            }
+        });
+    }
+    /* @conditional-compile-remove(acs-close-captions) */
+    setCaptionsKind(callId, kind) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.captionsFeature.captionsKind = kind;
+            }
+        });
+    }
     clearCaptions(callId) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];