@azure/communication-react 1.24.0-alpha-202501290016 → 1.24.0-alpha-202501300015

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

@@ -1 +1 @@
-{"version":3,"file":"CallClientState.js","sourceRoot":"","sources":["../../../../../calling-stateful-client/src/CallClientState.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA0gClC;;;;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  IncomingCallKind,\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(breakout-rooms) */\nimport { BreakoutRoom, BreakoutRoomsSettings } from '@azure/communication-calling';\n/* @conditional-compile-remove(remote-ufd) */\nimport type {\n  ServerDiagnosticType,\n  MediaDiagnosticType,\n  NetworkDiagnosticType,\n  DiagnosticValueType,\n  DiagnosticQuality,\n  DiagnosticFlag\n} from '@azure/communication-calling';\nimport { TeamsCallInfo } from '@azure/communication-calling';\nimport { CallInfo } from '@azure/communication-calling';\nimport { CapabilitiesChangeInfo, ParticipantCapabilities } from '@azure/communication-calling';\nimport { CaptionsResultType } from '@azure/communication-calling';\nimport { CaptionsKind } from '@azure/communication-calling';\nimport { VideoEffectName } from '@azure/communication-calling';\nimport { CallKind } from '@azure/communication-calling';\nimport { EnvironmentInfo } from '@azure/communication-calling';\nimport { CommunicationIdentifierKind } from '@azure/communication-common';\nimport { ReactionMessage } from '@azure/communication-calling';\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\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/**\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/**\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/* @conditional-compile-remove(breakout-rooms) */\n/**\n * Breakout rooms state\n *\n * @public\n */\nexport interface BreakoutRoomsState {\n  assignedBreakoutRoom?: BreakoutRoom;\n  breakoutRoomSettings?: BreakoutRoomsSettings;\n  breakoutRoomOriginCallId?: string;\n  breakoutRoomDisplayName?: string;\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(together-mode) */\n/**\n * Represents the name of the call feature stream\n * @beta\n */\nexport type CallFeatureStreamName = 'togetherMode';\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * State only version of {@link @azure/communication-calling#CallFeatureStream}.\n * Represents call feature stream state.\n * @beta\n */\nexport interface CallFeatureStreamState extends RemoteVideoStreamState {\n  feature?: CallFeatureStreamName;\n}\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * State only version of {@link @azure/communication-calling#TogetherModeSeatingMap}.\n * @beta\n *\n * Represents the seating position of a participant in Together Mode.\n */\nexport interface TogetherModeSeatingPositionState {\n  /* The top left offset from the top of the together mode view.*/\n  top: number;\n  /* The left offset position from the left of the together mode view. */\n  left: number;\n  /*  The width of the seating area */\n  width: number;\n  /* The height of the seating area. */\n  height: number;\n}\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * Represents the seating positions of participants in Together Mode.\n *\n * @beta\n */\nexport type TogetherModeParticipantSeatingState = Record<string, TogetherModeSeatingPositionState>;\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * Represents the streams in Together Mode.\n *\n * @beta\n */\nexport interface TogetherModeStreamsState {\n  mainVideoStream?: CallFeatureStreamState;\n}\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * State only version of {@link @azure/communication-calling#TogetherModeCallFeature}. {@link StatefulCallClient}.\n * Represents the state of the Together Mode feature.\n * @beta\n */\nexport interface TogetherModeCallFeatureState {\n  isActive: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature.togetherModeStream}.\n   */\n  streams: TogetherModeStreamsState;\n  /**\n   * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature.TogetherModeSeatingMap}.\n   */\n  seatingPositions: TogetherModeParticipantSeatingState;\n}\n\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  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 * Media access state\n * @public\n */\nexport interface MediaAccessState {\n  /**\n   * Whether the audio is forcibly muted\n   */\n  isAudioPermitted: boolean;\n  /**\n   * Whether the video is forcibly muted\n   */\n  isVideoPermitted: boolean;\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  /**\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  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.spotlightedParticipants}.\n   */\n  spotlight?: SpotlightState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.MediaAccessCallFeature.MediaAccess}.\n   */\n  mediaAccess?: MediaAccessState;\n  /* @conditional-compile-remove(remote-ufd) */\n  /**\n   * The diagnostic status of RemoteParticipant{@link @azure/communication-calling#RemoteDiagnostics}.\n   */\n  diagnostics?: Partial<Record<RemoteDiagnosticType, RemoteDiagnosticState>>;\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  /**\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  /**\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  /* @conditional-compile-remove(together-mode) */\n  /**\n   * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature}.\n   * @beta\n   */\n  togetherMode: TogetherModeCallFeatureState;\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  /**\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  /**\n   * Hide attendee names in teams meeting\n   */\n  hideAttendeeNames?: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature}.\n   */\n  spotlight?: SpotlightCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.info}.\n   */\n  info?: TeamsCallInfo | /* @conditional-compile-remove(calling-beta-sdk) */ CallInfo;\n\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsMeetingAudioConferencingCallFeature}.\n   */\n  meetingConference?: { conferencePhones: ConferencePhoneInfo[] };\n\n  /* @conditional-compile-remove(breakout-rooms) */\n  /**\n   * Proxy of {@link @azure/communication-calling#BreakoutRoomsFeature}.\n   */\n  breakoutRooms?: BreakoutRoomsState;\n\n  /**\n   * Proxy of {@link @azure/communication-calling#MediaAccessFeature}.\n   */\n  meetingMediaAccess?: MediaAccessState;\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 to track the types {@link CallInfo} and {@link TeamsCallInfo}\n * @public\n */\nexport interface CallInfoState {\n  /**\n   * GroupId of the call that you joined\n   */\n  groupId?: string;\n  /**\n   * The teams meeting thread id\n   */\n  threadId?: string;\n  /**\n   * participant id of the local user\n   */\n  participantId: string;\n  /**\n   * Differentiator between the Call and TeamsCall types\n   */\n  kind: IncomingCallKind;\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.callInfo}.\n   */\n  info: CallInfoState;\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 * State only version of {@link @azure/communication-calling#TeamsIncomingCall}\n * @public\n */\nexport interface TeamsIncomingCallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsIncomingCall.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsIncomingCall.teamsCallInfo}.\n   */\n  info: CallInfoState;\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsIncomingCall.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: {\n    [key: string]: IncomingCallState | TeamsIncomingCallState;\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 | TeamsIncomingCallState;\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   * Stores the latest notifications.\n   *\n   * See documentation of {@Link CallNotifications} for details.\n   */\n  latestNotifications: CallNotifications;\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  /**\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  | '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  | '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  | 'Call.mutedByOthers'\n  | 'Call.muteAllRemoteParticipants'\n  | 'Call.setConstraints';\n\n/**\n * @public\n */\nexport type CallNotifications = {\n  [target in NotificationTarget]: CallNotification;\n};\n\n/**\n * @public\n */\nexport interface CallNotification {\n  target: NotificationTarget;\n\n  timestamp: Date;\n}\n\n/** @public */\nexport type NotificationTarget =\n  | /* @conditional-compile-remove(breakout-rooms) */ 'assignedBreakoutRoomOpened'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'assignedBreakoutRoomOpenedPromptJoin'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'assignedBreakoutRoomChanged'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'breakoutRoomJoined'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'breakoutRoomClosingSoon'\n  | 'capabilityTurnVideoOnPresent'\n  | 'capabilityTurnVideoOnAbsent'\n  | 'capabilityUnmuteMicPresent'\n  | 'capabilityUnmuteMicAbsent'\n  | /* @conditional-compile-remove(together-mode) */ 'togetherModeStarted'\n  | /* @conditional-compile-remove(together-mode) */ 'togetherModeEnded';\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/* @conditional-compile-remove(remote-ufd) */\n/**\n * All type names for {@link @azure/communication-calling#RemoteDiagnosticState}.\n *\n * @beta\n */\nexport type RemoteDiagnosticType = NetworkDiagnosticType | MediaDiagnosticType | ServerDiagnosticType;\n\n/* @conditional-compile-remove(remote-ufd) */\n/**\n * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.\n *\n * @beta\n */\nexport declare type RemoteDiagnosticState = {\n  readonly diagnostic: RemoteDiagnosticType;\n  readonly value: DiagnosticQuality | DiagnosticFlag;\n  readonly valueType: DiagnosticValueType;\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\n/**\n * @public\n * Information for conference phone info\n */\nexport interface ConferencePhoneInfo {\n  /**\n   * Phone number for the conference\n   */\n  phoneNumber: string;\n  /**\n   * Conference id for the conference\n   */\n  conferenceId: string;\n  /**\n   * Is toll free phone number\n   */\n  isTollFree: boolean;\n  /**\n   * phone number country\n   */\n  country?: string;\n  /**\n   * phone number city\n   */\n  city?: string;\n}\n"]}
+{"version":3,"file":"CallClientState.js","sourceRoot":"","sources":["../../../../../calling-stateful-client/src/CallClientState.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA2kClC;;;;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  IncomingCallKind,\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(breakout-rooms) */\nimport { BreakoutRoom, BreakoutRoomsSettings } from '@azure/communication-calling';\n/* @conditional-compile-remove(remote-ufd) */\nimport type {\n  ServerDiagnosticType,\n  MediaDiagnosticType,\n  NetworkDiagnosticType,\n  DiagnosticValueType,\n  DiagnosticQuality,\n  DiagnosticFlag\n} from '@azure/communication-calling';\n/* @conditional-compile-remove(rtt) */\nimport { ParticipantInfo, RealTimeTextResultType } from '@azure/communication-calling';\nimport { TeamsCallInfo } from '@azure/communication-calling';\nimport { CallInfo } from '@azure/communication-calling';\nimport { CapabilitiesChangeInfo, ParticipantCapabilities } from '@azure/communication-calling';\nimport { CaptionsResultType } from '@azure/communication-calling';\nimport { CaptionsKind } from '@azure/communication-calling';\nimport { VideoEffectName } from '@azure/communication-calling';\nimport { CallKind } from '@azure/communication-calling';\nimport { EnvironmentInfo } from '@azure/communication-calling';\nimport { CommunicationIdentifierKind } from '@azure/communication-common';\nimport { ReactionMessage } from '@azure/communication-calling';\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   * Timestamp of when the captions were last updated.\n   */\n  lastUpdatedTimestamp?: 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/* @conditional-compile-remove(rtt) */\n/**\n * @beta\n */\nexport interface RealTimeTextInfo {\n  /**\n   * The sequence id of the real time text.\n   */\n  sequenceId: number;\n  /**\n   * The sender of the real time text.\n   */\n  sender: ParticipantInfo;\n  /**\n   * The real time text message.\n   */\n  message: string;\n  /**\n   * The result type of the real time text message.\n   */\n  resultType: RealTimeTextResultType;\n  /**\n   * The timestamp when the real time text message was created.\n   */\n  receivedTimestamp?: Date;\n  /**\n   * The timestamp when the real time text message was last updated.\n   */\n  updatedTimestamp?: Date;\n  /**\n   * If message originated from the local participant\n   * default is false\n   */\n  isMe?: boolean;\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   * current caption kind: teams or acs captions\n   */\n  captionsKind: CaptionsKind;\n}\n\n/* @conditional-compile-remove(rtt) */\n/**\n * @beta\n */\nexport interface RealTimeTextCallFeatureState {\n  /**\n   * array of received captions\n   */\n  realTimeTexts: {\n    completedMessages?: RealTimeTextInfo[];\n    currentInProgress?: RealTimeTextInfo[];\n    myInProgress?: RealTimeTextInfo;\n  };\n  /**\n   * whether real time text is on/off\n   */\n  isRealTimeTextFeatureActive?: boolean;\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/**\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/**\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/* @conditional-compile-remove(breakout-rooms) */\n/**\n * Breakout rooms state\n *\n * @public\n */\nexport interface BreakoutRoomsState {\n  assignedBreakoutRoom?: BreakoutRoom;\n  breakoutRoomSettings?: BreakoutRoomsSettings;\n  breakoutRoomOriginCallId?: string;\n  breakoutRoomDisplayName?: string;\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(together-mode) */\n/**\n * Represents the name of the call feature stream\n * @beta\n */\nexport type CallFeatureStreamName = 'togetherMode';\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * State only version of {@link @azure/communication-calling#CallFeatureStream}.\n * Represents call feature stream state.\n * @beta\n */\nexport interface CallFeatureStreamState extends RemoteVideoStreamState {\n  feature?: CallFeatureStreamName;\n}\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * State only version of {@link @azure/communication-calling#TogetherModeSeatingMap}.\n * @beta\n *\n * Represents the seating position of a participant in Together Mode.\n */\nexport interface TogetherModeSeatingPositionState {\n  /* The top left offset from the top of the together mode view.*/\n  top: number;\n  /* The left offset position from the left of the together mode view. */\n  left: number;\n  /*  The width of the seating area */\n  width: number;\n  /* The height of the seating area. */\n  height: number;\n}\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * Represents the seating positions of participants in Together Mode.\n *\n * @beta\n */\nexport type TogetherModeParticipantSeatingState = Record<string, TogetherModeSeatingPositionState>;\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * Represents the streams in Together Mode.\n *\n * @beta\n */\nexport interface TogetherModeStreamsState {\n  mainVideoStream?: CallFeatureStreamState;\n}\n\n/* @conditional-compile-remove(together-mode) */\n/**\n * State only version of {@link @azure/communication-calling#TogetherModeCallFeature}. {@link StatefulCallClient}.\n * Represents the state of the Together Mode feature.\n * @beta\n */\nexport interface TogetherModeCallFeatureState {\n  isActive: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature.togetherModeStream}.\n   */\n  streams: TogetherModeStreamsState;\n  /**\n   * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature.TogetherModeSeatingMap}.\n   */\n  seatingPositions: TogetherModeParticipantSeatingState;\n}\n\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  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 * Media access state\n * @public\n */\nexport interface MediaAccessState {\n  /**\n   * Whether the audio is forcibly muted\n   */\n  isAudioPermitted: boolean;\n  /**\n   * Whether the video is forcibly muted\n   */\n  isVideoPermitted: boolean;\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  /**\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  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.spotlightedParticipants}.\n   */\n  spotlight?: SpotlightState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.MediaAccessCallFeature.MediaAccess}.\n   */\n  mediaAccess?: MediaAccessState;\n  /* @conditional-compile-remove(remote-ufd) */\n  /**\n   * The diagnostic status of RemoteParticipant{@link @azure/communication-calling#RemoteDiagnostics}.\n   */\n  diagnostics?: Partial<Record<RemoteDiagnosticType, RemoteDiagnosticState>>;\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  /**\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#CaptionsCallFeature}.\n   */\n  captionsFeature: CaptionsCallFeatureState;\n  /* @conditional-compile-remove(rtt) */\n  /**\n   * Proxy of {@link @azure/communication-calling#RealTimeTextCallFeature}.\n   */\n  realTimeTextFeature: RealTimeTextCallFeatureState;\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  /**\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  /* @conditional-compile-remove(together-mode) */\n  /**\n   * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature}.\n   * @beta\n   */\n  togetherMode: TogetherModeCallFeatureState;\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  /**\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  /**\n   * Hide attendee names in teams meeting\n   */\n  hideAttendeeNames?: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#SpotlightCallFeature}.\n   */\n  spotlight?: SpotlightCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.info}.\n   */\n  info?: TeamsCallInfo | /* @conditional-compile-remove(calling-beta-sdk) */ CallInfo;\n\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsMeetingAudioConferencingCallFeature}.\n   */\n  meetingConference?: { conferencePhones: ConferencePhoneInfo[] };\n\n  /* @conditional-compile-remove(breakout-rooms) */\n  /**\n   * Proxy of {@link @azure/communication-calling#BreakoutRoomsFeature}.\n   */\n  breakoutRooms?: BreakoutRoomsState;\n\n  /**\n   * Proxy of {@link @azure/communication-calling#MediaAccessFeature}.\n   */\n  meetingMediaAccess?: MediaAccessState;\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 to track the types {@link CallInfo} and {@link TeamsCallInfo}\n * @public\n */\nexport interface CallInfoState {\n  /**\n   * GroupId of the call that you joined\n   */\n  groupId?: string;\n  /**\n   * The teams meeting thread id\n   */\n  threadId?: string;\n  /**\n   * participant id of the local user\n   */\n  participantId: string;\n  /**\n   * Differentiator between the Call and TeamsCall types\n   */\n  kind: IncomingCallKind;\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.callInfo}.\n   */\n  info: CallInfoState;\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 * State only version of {@link @azure/communication-calling#TeamsIncomingCall}\n * @public\n */\nexport interface TeamsIncomingCallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsIncomingCall.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsIncomingCall.teamsCallInfo}.\n   */\n  info: CallInfoState;\n  /**\n   * Proxy of {@link @azure/communication-calling#TeamsIncomingCall.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: {\n    [key: string]: IncomingCallState | TeamsIncomingCallState;\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 | TeamsIncomingCallState;\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   * Stores the latest notifications.\n   *\n   * See documentation of {@Link CallNotifications} for details.\n   */\n  latestNotifications: CallNotifications;\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  /**\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  | '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  | '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  | 'Call.mutedByOthers'\n  | 'Call.muteAllRemoteParticipants'\n  | 'Call.setConstraints';\n\n/**\n * @public\n */\nexport type CallNotifications = {\n  [target in NotificationTarget]: CallNotification;\n};\n\n/**\n * @public\n */\nexport interface CallNotification {\n  target: NotificationTarget;\n\n  timestamp: Date;\n}\n\n/** @public */\nexport type NotificationTarget =\n  | /* @conditional-compile-remove(breakout-rooms) */ 'assignedBreakoutRoomOpened'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'assignedBreakoutRoomOpenedPromptJoin'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'assignedBreakoutRoomChanged'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'breakoutRoomJoined'\n  | /* @conditional-compile-remove(breakout-rooms) */ 'breakoutRoomClosingSoon'\n  | 'capabilityTurnVideoOnPresent'\n  | 'capabilityTurnVideoOnAbsent'\n  | 'capabilityUnmuteMicPresent'\n  | 'capabilityUnmuteMicAbsent'\n  | /* @conditional-compile-remove(together-mode) */ 'togetherModeStarted'\n  | /* @conditional-compile-remove(together-mode) */ 'togetherModeEnded';\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/* @conditional-compile-remove(remote-ufd) */\n/**\n * All type names for {@link @azure/communication-calling#RemoteDiagnosticState}.\n *\n * @beta\n */\nexport type RemoteDiagnosticType = NetworkDiagnosticType | MediaDiagnosticType | ServerDiagnosticType;\n\n/* @conditional-compile-remove(remote-ufd) */\n/**\n * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.\n *\n * @beta\n */\nexport declare type RemoteDiagnosticState = {\n  readonly diagnostic: RemoteDiagnosticType;\n  readonly value: DiagnosticQuality | DiagnosticFlag;\n  readonly valueType: DiagnosticValueType;\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\n/**\n * @public\n * Information for conference phone info\n */\nexport interface ConferencePhoneInfo {\n  /**\n   * Phone number for the conference\n   */\n  phoneNumber: string;\n  /**\n   * Conference id for the conference\n   */\n  conferenceId: string;\n  /**\n   * Is toll free phone number\n   */\n  isTollFree: boolean;\n  /**\n   * phone number country\n   */\n  country?: string;\n  /**\n   * phone number city\n   */\n  city?: string;\n}\n"]}

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

@@ -1,5 +1,6 @@
 import { CommunicationIdentifierKind } from '@azure/communication-common';
 import { AudioDeviceInfo, DeviceAccess, DominantSpeakersInfo, ParticipantRole, ScalingMode, VideoDeviceInfo } from '@azure/communication-calling';
+import { RealTimeTextInfo as AcsRealTimeTextInfo } from '@azure/communication-calling';
 import { RaisedHand, MediaAccess, MeetingMediaAccess } from '@azure/communication-calling';
 import { BreakoutRoom, BreakoutRoomsSettings } from '@azure/communication-calling';
 import { TeamsMeetingAudioConferencingDetails } from '@azure/communication-calling';
@@ -123,12 +124,16 @@ export declare class CallContext {
     deleteDeviceManagerUnparentedView(localVideoStream: LocalVideoStreamState): void;
     setDeviceManagerUnparentedViewVideoEffects(localVideoStream: LocalVideoStreamState, videoEffects: LocalVideoStreamVideoEffectsState): void;
     getAndIncrementAtomicId(): number;
+    private processNewRealTimeText;
+    private findTimeoutRealTimeText;
     private processNewCaption;
     addTeamsCaption(callId: string, caption: TeamsCaptionsInfo): void;
     addCaption(callId: string, caption: AcsCaptionsInfo): void;
+    addRealTimeText(callId: string, realTimeText: AcsRealTimeTextInfo): void;
     setCaptionsKind(callId: string, kind: CaptionsKind): void;
     clearCaptions(callId: string): void;
     setIsCaptionActive(callId: string, isCaptionsActive: boolean): void;
+    setIsRealTimeTextActive(callId: string, isRealTimeTextActive: boolean): void;
     setStartCaptionsInProgress(callId: string, startCaptionsInProgress: boolean): void;
     setSelectedSpokenLanguage(callId: string, spokenLanguage: string): void;
     setSelectedCaptionLanguage(callId: string, captionLanguage: string): void;

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

@@ -10,6 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { convertConferencePhoneInfo } from './Converter';
+/* @conditional-compile-remove(rtt) */
+import { convertFromSDKRealTimeTextToRealTimeTextInfoState } from './Converter';
 import { createClientLogger, getLogLevel } from '@azure/logger';
 import { EventEmitter } from 'events';
 import { enableMapSet, enablePatches, produce } from 'immer';
@@ -961,10 +963,92 @@ export class CallContext {
         this._atomicId++;
         return id;
     }
+    /* @conditional-compile-remove(rtt) */
+    processNewRealTimeText(realTimeTexts, newRealTimeText) {
+        var _a, _b, _c, _d, _e;
+        // if the new message is final, push it to completed messages
+        if (newRealTimeText.resultType === 'Final') {
+            if (!realTimeTexts.completedMessages) {
+                realTimeTexts.completedMessages = [];
+            }
+            (_a = realTimeTexts.completedMessages) === null || _a === void 0 ? void 0 : _a.push(newRealTimeText);
+            // clear the corresponding in progress message
+            if (newRealTimeText.isMe) {
+                realTimeTexts.myInProgress = undefined;
+            }
+            else {
+                realTimeTexts.currentInProgress = (_b = realTimeTexts.currentInProgress) === null || _b === void 0 ? void 0 : _b.filter((message) => message.sequenceId !== newRealTimeText.sequenceId);
+            }
+        }
+        else {
+            // if receive partial real time text
+            // if message is from me, assign it to myInProgress
+            if (newRealTimeText.isMe) {
+                realTimeTexts.myInProgress = newRealTimeText;
+            }
+            // if message is from others, assign it to currentInProgress
+            else {
+                if (!realTimeTexts.currentInProgress) {
+                    realTimeTexts.currentInProgress = [];
+                    realTimeTexts.currentInProgress.push(newRealTimeText);
+                    return;
+                }
+                // find the index of the existing in progress message
+                // replace the existing in progress message with the new one
+                const existingIndex = (_c = realTimeTexts.currentInProgress) === null || _c === void 0 ? void 0 : _c.findIndex((message) => message.sequenceId === newRealTimeText.sequenceId);
+                if (existingIndex === -1) {
+                    (_d = realTimeTexts.currentInProgress) === null || _d === void 0 ? void 0 : _d.push(newRealTimeText);
+                }
+                else {
+                    realTimeTexts.currentInProgress[existingIndex] = newRealTimeText;
+                }
+            }
+        }
+        // edge case check for in progress messages time out
+        if (!realTimeTexts.completedMessages) {
+            realTimeTexts.completedMessages = [];
+        }
+        this.findTimeoutRealTimeText(realTimeTexts.currentInProgress, realTimeTexts.completedMessages);
+        this.findTimeoutRealTimeText(realTimeTexts.myInProgress, realTimeTexts.completedMessages);
+        // we only want to store up to 50 finalized messages
+        if (realTimeTexts.completedMessages && ((_e = realTimeTexts.completedMessages) === null || _e === void 0 ? void 0 : _e.length) > 50) {
+            realTimeTexts.completedMessages.shift();
+        }
+    }
+    /* @conditional-compile-remove(rtt) */
+    findTimeoutRealTimeText(inProgressRealTimeTexts, completedRealTimeTexts) {
+        // if inProgressRealTimeTexts is an array
+        if (inProgressRealTimeTexts && Array.isArray(inProgressRealTimeTexts)) {
+            // find the in progress real time text that has not been updated for 5 seconds
+            inProgressRealTimeTexts.forEach((realTimeText, index) => {
+                if (realTimeText.updatedTimestamp && Date.now() - realTimeText.updatedTimestamp.getTime() > 5000) {
+                    // turn the in progress real time text to final
+                    realTimeText.resultType = 'Final';
+                    // move the in progress real time text to completed
+                    completedRealTimeTexts.push(realTimeText);
+                    // remove the in progress real time text from in progress
+                    inProgressRealTimeTexts && inProgressRealTimeTexts.splice(index, 1);
+                }
+            });
+        }
+        else {
+            // if inProgressRealTimeTexts is a single object
+            if (inProgressRealTimeTexts &&
+                inProgressRealTimeTexts.updatedTimestamp &&
+                Date.now() - inProgressRealTimeTexts.updatedTimestamp.getTime() > 5000) {
+                // turn the in progress real time text to final
+                inProgressRealTimeTexts.resultType = 'Final';
+                // move the in progress real time text to completed
+                completedRealTimeTexts.push(inProgressRealTimeTexts);
+                // remove the in progress real time text from in progress
+                inProgressRealTimeTexts = undefined;
+            }
+        }
+    }
     processNewCaption(captions, newCaption) {
         var _a;
         // time stamp when new caption comes in
-        newCaption.timestamp = new Date();
+        newCaption.lastUpdatedTimestamp = new Date();
         // if this is the first caption, push it in
         if (captions.length === 0) {
             captions.push(newCaption);
@@ -985,8 +1069,8 @@ export class CallContext {
             }
             // if different speaker, ignore the interjector until the current speaker finishes
             // edge case: if we dont receive the final caption from the current speaker for 5 secs, we turn the current speaker caption to final and push in the new interjector
-            else if (lastCaption) {
-                if (Date.now() - lastCaption.timestamp.getTime() > 5000) {
+            else if (lastCaption === null || lastCaption === void 0 ? void 0 : lastCaption.lastUpdatedTimestamp) {
+                if (Date.now() - lastCaption.lastUpdatedTimestamp.getTime() > 5000) {
                     lastCaption.resultType = 'Final';
                     captions.push(newCaption);
                 }
@@ -999,22 +1083,33 @@ export class CallContext {
     }
     addTeamsCaption(callId, caption) {
         this.modifyState((draft) => {
+            var _a;
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
                 const currentCaptionLanguage = call.captionsFeature.currentCaptionLanguage;
                 if (caption.captionLanguage.toUpperCase() === currentCaptionLanguage.toUpperCase() ||
                     currentCaptionLanguage === '' ||
                     currentCaptionLanguage === undefined) {
-                    this.processNewCaption(call.captionsFeature.captions, convertFromTeamsSDKToCaptionInfoState(caption));
+                    this.processNewCaption((_a = call === null || call === void 0 ? void 0 : call.captionsFeature.captions) !== null && _a !== void 0 ? _a : [], convertFromTeamsSDKToCaptionInfoState(caption));
                 }
             }
         });
     }
     addCaption(callId, caption) {
         this.modifyState((draft) => {
+            var _a;
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
-                this.processNewCaption(call.captionsFeature.captions, convertFromSDKToCaptionInfoState(caption));
+                this.processNewCaption((_a = call === null || call === void 0 ? void 0 : call.captionsFeature.captions) !== null && _a !== void 0 ? _a : [], convertFromSDKToCaptionInfoState(caption));
+            }
+        });
+    }
+    /* @conditional-compile-remove(rtt) */
+    addRealTimeText(callId, realTimeText) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                this.processNewRealTimeText(call.realTimeTextFeature.realTimeTexts, convertFromSDKRealTimeTextToRealTimeTextInfoState(realTimeText));
             }
         });
     }
@@ -1030,7 +1125,7 @@ export class CallContext {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
             if (call) {
-                call.captionsFeature.captions = [];
+                call.captionsFeature.captions = call.captionsFeature.captions.filter((c) => 'message' in c);
             }
         });
     }
@@ -1042,6 +1137,15 @@ export class CallContext {
             }
         });
     }
+    /* @conditional-compile-remove(rtt) */
+    setIsRealTimeTextActive(callId, isRealTimeTextActive) {
+        this.modifyState((draft) => {
+            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
+            if (call) {
+                call.realTimeTextFeature.isRealTimeTextFeatureActive = isRealTimeTextActive;
+            }
+        });
+    }
     setStartCaptionsInProgress(callId, startCaptionsInProgress) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];