@azure/communication-react 1.0.0-beta.1 → 1.0.0-beta.5

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

@@ -1,396 +1,483 @@
-import { AudioDeviceInfo, CallDirection, CallEndReason, CallerInfo, CallState as CallStatus, DeviceAccess, MediaStreamType, RemoteParticipantState as RemoteParticipantStatus, ScalingMode, TransferErrorCode, TransferState, VideoDeviceInfo } from '@azure/communication-calling';
-import { CommunicationUserIdentifier, CommunicationUserKind, MicrosoftTeamsUserKind, PhoneNumberIdentifier, PhoneNumberKind, UnknownIdentifierKind } from '@azure/communication-common';
-/**
- * State only version of {@Link @azure/communication-calling#TransferRequestedEventArgs}. At the time of writing
- * Transfer Call is experimental. Not tested and not ready for consumption.
- */
-export interface TransferRequest {
-    targetParticipant: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind;
-}
-/**
- * State only version of {@Link @azure/communication-calling#Transfer}. At the time of writing Transfer Call is
- * experimental. Not tested and not ready for consumption.
- */
-export interface Transfer {
-    /**
-     * Added by Declarative and used internally.
-     */
-    id: number;
-    /**
-     * Added by {@Link StatefulClientClient}, stores the targetParticipant passed to
-     * {@Link @azure/communication-calling#TransferCallFeature.transfer}
-     */
-    targetParticipant: CommunicationUserIdentifier | PhoneNumberIdentifier;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Transfer.state}.
-     */
-    state: TransferState;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Transfer.error}.
-     */
-    error?: TransferErrorCode;
-}
-/**
- * Holds all the state found in {@Link @azure/communication-calling#TransferCallFeature} and
- * {@Link @azure/communication-calling#Transfer}. At the time of writing Transfer Call is experimental. Not tested and
- * not ready for consumption.
- */
-export interface TransferCallFeature {
-    /**
-     * These are requests received in the {@Link @azure/communication-calling#TransferCallFeature}'s 'transferRequested'
-     * event. Only MAX_TRANSFER_REQUEST_LENGTH number of TransferRequest are kept in this array with the older ones being
-     * replaced by newer ones. To accept/reject a transfer request, the {@Link @azure/communication-calling#Call} must be
-     * used (TODO: do we want to provide an API?).
-     */
-    receivedTransferRequests: TransferRequest[];
-    /**
-     * These are requests initiated by the local user using {@Link StatefulCallClient.transfer}. Only
-     * MAX_TRANSFER_REQUEST_LENGTH number of TransferRequest are kept in this array with the older ones being replaced by
-     * newer ones.
-     */
-    requestedTransfers: Transfer[];
-}
-/**
- * State only version of {@Link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of
- * {@Link CallClientState} and not included here. The reason to have CallAgent's state proxied is to provide access to
- * displayName. We don't flatten CallAgent.displayName and put it in CallClientState because it would be ambiguious that
- * displayName is actually reliant on the creation/existence of CallAgent to be available.
- */
-export interface CallAgentState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#CallAgent.displayName}.
-     */
-    displayName?: string;
-}
-/**
- * State only version of {@Link @azure/communication-calling#TranscriptionCallFeature}. {@Link StatefulCallClient} will
- * automatically listen for transcription state of the call and update the state exposed by {@Link StatefulCallClient}
- * accordingly.
- */
-export interface TranscriptionCallFeature {
-    /**
-     * Proxy of {@Link @azure/communication-calling#TranscriptionCallFeature.isTranscriptionActive}.
-     */
-    isTranscriptionActive: boolean;
-}
-/**
- * State only version of {@Link @azure/communication-calling#RecordingCallFeature}. {@Link StatefulCallClient} will
- * automatically listen for recording state of the call and update the state exposed by {@Link StatefulCallClient} accordingly.
- */
-export interface RecordingCallFeature {
-    /**
-     * Proxy of {@Link @azure/communication-calling#RecordingCallFeature.isRecordingActive}.
-     */
-    isRecordingActive: boolean;
-}
-/**
- * State only version of {@Link @azure/communication-calling#LocalVideoStream}.
- */
-export interface LocalVideoStreamState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#LocalVideoStream.source}.
-     */
-    source: VideoDeviceInfo;
-    /**
-     * Proxy of {@Link @azure/communication-calling#LocalVideoStream.mediaStreamType}.
-     */
-    mediaStreamType: MediaStreamType;
-    /**
-     * {@Link VideoStreamRendererView} that is managed by createView/disposeView in {@Link StatefulCallClient}
-     * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.
-     */
-    view?: VideoStreamRendererViewState;
-}
-/**
- * State only version of {@Link @azure/communication-calling#RemoteVideoStream}.
- */
-export interface RemoteVideoStreamState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteVideoStream.id}.
-     */
-    id: number;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteVideoStream.mediaStreamType}.
-     */
-    mediaStreamType: MediaStreamType;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteVideoStream.isAvailable}.
-     */
-    isAvailable: boolean;
-    /**
-     * {@Link VideoStreamRendererView} that is managed by createView/disposeView in {@Link StatefulCallClient}
-     * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.
-     */
-    view?: VideoStreamRendererViewState;
-}
-/**
- * State only version of {@Link @azure/communication-calling#VideoStreamRendererView}. Currently no API is provided to
- * modify scalingMode after the stream as been rendered by {@Link StatefulCallClient}. In order to change scalingMode
- * stop rendering the stream and re-start it using the desired scalingMode. This property is added to the state exposed
- * by {@Link StatefulCallClient} by {@Link StatefulCallClient.createView} and removed by
- * {@Link StatefulCallClient.disposeView}.
- */
-export interface VideoStreamRendererViewState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#VideoStreamRendererView.scalingMode}.
-     */
-    scalingMode: ScalingMode;
-    /**
-     * Proxy of {@Link @azure/communication-calling#VideoStreamRendererView.isMirrored}.
-     */
-    isMirrored: boolean;
-    /**
-     * Proxy of {@Link @azure/communication-calling#VideoStreamRendererView.target}.
-     */
-    target: HTMLElement;
-}
-/**
- * State only version of {@Link @azure/communication-calling#RemoteParticipant}. {@Link StatefulCallClient} will
- * automatically retrieve RemoteParticipants and add their state to the state exposed by {@Link StatefulCallClient}.
- */
-export interface RemoteParticipantState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteParticipant.identifier}.
-     */
-    identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteParticipant.displayName}.
-     */
-    displayName?: string;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteParticipant.state}.
-     */
-    state: RemoteParticipantStatus;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteParticipant.callEndReason}.
-     */
-    callEndReason?: CallEndReason;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteParticipant.videoStreams} as a map of
-     * {@Link @azure/communication-calling#RemoteVideoStream.id} to {@Link RemoteVideoStream}.
-     */
-    videoStreams: Map<number, RemoteVideoStreamState>;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteParticipant.isMuted}.
-     */
-    isMuted: boolean;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RemoteParticipant.isSpeaking}.
-     */
-    isSpeaking: boolean;
-}
-/**
- * State only version of {@Link @azure/communication-calling#Call}. {@Link StatefulCallClient} will automatically
- * retrieve Call's state and add it to the state exposed by {@Link StatefulCallClient}.
- */
-export interface CallState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.id}.
-     */
-    id: string;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.callerInfo}.
-     */
-    callerInfo: CallerInfo;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.state}.
-     */
-    state: CallStatus;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.callEndReason}.
-     */
-    callEndReason?: CallEndReason;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.direction}.
-     */
-    direction: CallDirection;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.isMuted}.
-     */
-    isMuted: boolean;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.isScreenSharingOn}.
-     */
-    isScreenSharingOn: boolean;
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.localVideoStreams}.
-     */
-    localVideoStreams: LocalVideoStreamState[];
-    /**
-     * Proxy of {@Link @azure/communication-calling#Call.remoteParticipants}. Map of flattened
-     * {@Link RemoteParticipantState.identifier} to {@Link RemoteParticipant}. To obtain a flattened
-     * {@Link RemoteParticipantState.identifier}, use {@Link @azure/communication-react#toFlatCommunicationIdentifier}.
-     */
-    remoteParticipants: Map<string, RemoteParticipantState>;
-    /**
-     * Stores remote participants that have left the call so that the callEndReason could be retrieved. Map of flattened
-     * {@Link RemoteParticipantState.identifier} to {@Link RemoteParticipant}. To obtain a flattened
-     * {@Link RemoteParticipantState.identifier}, use {@Link @azure/communication-react#toFlatCommunicationIdentifier}.
-     */
-    remoteParticipantsEnded: Map<string, RemoteParticipantState>;
-    /**
-     * Proxy of {@Link @azure/communication-calling#TranscriptionCallFeature}.
-     */
-    transcription: TranscriptionCallFeature;
-    /**
-     * Proxy of {@Link @azure/communication-calling#RecordingCallFeature}.
-     */
-    recording: RecordingCallFeature;
-    /**
-     * Proxy of {@Link @azure/communication-calling#TransferCallFeature} with some differences see
-     * {@Link TransferCallFeature} for details.
-     */
-    transfer: TransferCallFeature;
-    /**
-     * Stores the currently active screenshare participant's key. If there is no screenshare active, then this will be
-     * undefined. You can use this key to access the remoteParticipant data in {@Link CallState.remoteParticipants} map.
-     *
-     * Note this only applies to ScreenShare in RemoteParticipant. A local ScreenShare being active will not affect this
-     * property.
-     *
-     * This property is added by the stateful layer and is not a proxy of SDK state
-     */
-    screenShareRemoteParticipant: string | undefined;
-    /**
-     * Stores the local date when the call started on the client. This property is added by the stateful layer and is not
-     * a proxy of SDK state.
-     */
-    startTime: Date;
-    /**
-     * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not
-     * a proxy of SDK state.
-     */
-    endTime: Date | undefined;
-}
-/**
- * State only version of {@Link @azure/communication-calling#IncomingCall}. {@Link StatefulCallClient} will
- * automatically detect incoming calls and add their state to the state exposed by {@Link StatefulCallClient}.
- */
-export interface IncomingCallState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#IncomingCall.id}.
-     */
-    id: string;
-    /**
-     * Proxy of {@Link @azure/communication-calling#IncomingCall.callerInfo}.
-     */
-    callerInfo: CallerInfo;
-    /**
-     * Set to the state returned by 'callEnded' event on {@Link @azure/communication-calling#IncomingCall} when received.
-     * This property is added by the stateful layer and is not a proxy of SDK state.
-     */
-    callEndReason?: CallEndReason;
-    /**
-     * Stores the local date when the call started on the client. This property is added by the stateful layer and is not
-     * a proxy of SDK state.
-     */
-    startTime: Date;
-    /**
-     * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not a
-     * proxy of SDK state. It is undefined if the call is not ended yet.
-     */
-    endTime: Date | undefined;
-}
-/**
- * This type is meant to encapsulate all the state inside {@Link @azure/communication-calling#DeviceManager}. For
- * optional parameters they may not be available until permission is granted by the user. The cameras, microphones,
- * speakers, and deviceAccess states will be empty until the corresponding
- * {@Link @azure/communication-calling#DeviceManager}'s getCameras, getMicrophones, getSpeakers, and askDevicePermission
- * APIs are called and completed.
- */
-export declare type DeviceManagerState = {
-    /**
-     * Proxy of {@Link @azure/communication-calling#DeviceManager.isSpeakerSelectionAvailable}.
-     */
-    isSpeakerSelectionAvailable: boolean;
-    /**
-     * Proxy of {@Link @azure/communication-calling#DeviceManager.selectedMicrophone}.
-     */
-    selectedMicrophone?: AudioDeviceInfo;
-    /**
-     * Proxy of {@Link @azure/communication-calling#DeviceManager.selectedSpeaker}.
-     */
-    selectedSpeaker?: AudioDeviceInfo;
-    /**
-     * Stores the selected camera device info. This is added by the stateful layer and does not exist in the Calling SDK.
-     * It is meant as a convenience to the developer. It must be explicitly set before it has any value and does not
-     * persist across instances of the {@Link StatefulCallClient}. The developer controls entirely what this value holds
-     * at any time.
-     */
-    selectedCamera?: VideoDeviceInfo;
-    /**
-     * Stores any cameras data returned from {@Link @azure/communication-calling#DeviceManager.getCameras}.
-     */
-    cameras: VideoDeviceInfo[];
-    /**
-     * Stores any microphones data returned from {@Link @azure/communication-calling#DeviceManager.getMicrophones}.
-     */
-    microphones: AudioDeviceInfo[];
-    /**
-     * Stores any speakers data returned from {@Link @azure/communication-calling#DeviceManager.getSpeakers}.
-     */
-    speakers: AudioDeviceInfo[];
-    /**
-     * Stores deviceAccess data returned from {@Link @azure/communication-calling#DeviceManager.askDevicePermission}.
-     */
-    deviceAccess?: DeviceAccess;
-    /**
-     * Stores created views that are not associated with any CallState (when {@Link StatefulCallClient.createView} is
-     * called with undefined callId, undefined participantId, and defined LocalVideoStream). The key in this map will be
-     * the original reference that {@Link StatefulCallClient.createView} is called with. The value will be a new
-     * LocalVideoStream different than the one used. The value in the map will contain the rendered view. The value in the
-     * map is also considered immutable.
-     */
-    unparentedViews: Map<LocalVideoStreamState, LocalVideoStreamState>;
-};
-/**
- * Container for all of the state data proxied by {@Link StatefulCallClient}. The calls, callsEnded, incomingCalls, and
- * incomingCallsEnded states will be automatically provided if a callAgent has been created. The deviceManager will be
- * empty initially until populated see {@Link DeviceManagerState}. The userId state is provided as a convenience for the
- * developer and is completely controled and set by the developer.
- */
-export interface CallClientState {
-    /**
-     * Proxy of {@Link @azure/communication-calling#CallAgent.calls} as a map of CallState {@Link CallState}. It is keyed
-     * by {@Link @azure/communication-calling#Call.id}. Please note that {@Link @azure/communication-calling#Call.id}
-     * could change. You should not cache the id itself but the entire {@Link @azure/communication-calling#Call} and then
-     * use the id contained to look up data in this map.
-     */
-    calls: Map<string, CallState>;
-    /**
-     * Calls that have ended are stored here so the callEndReason could be checked. It is an array of CallState
-     * {@Link CallState}. Calls are pushed on to the array as they end, meaning this is sorted by endTime ascending. Only
-     * {@Link MAX_CALL_HISTORY_LENGTH} number of Calls are kept in this array with the older ones being replaced by newer
-     * ones.
-     */
-    callsEnded: CallState[];
-    /**
-     * Proxy of {@Link @azure/communication-calling#IncomingCall} as a map of IncomingCall {@Link IncomingCall} received
-     * in the event 'incomingCall' emitted by {@Link @azure/communication-calling#CallAgent}. It is keyed by
-     * {@Link @azure/communication-calling#IncomingCall.id}.
-     */
-    incomingCalls: Map<string, IncomingCallState>;
-    /**
-     * Incoming Calls that have ended are stored here so the callEndReason could be checked. It is a array of IncomingCall
-     * {@Link IncomingCall} received in the event 'incomingCall' emitted by
-     * {@Link @azure/communication-calling#CallAgent}. IncomingCalls are pushed on to the array as they end, meaning this
-     * is sorted by endTime ascending. Only MAX_CALL_HISTORY_LENGTH number of IncomingCalls are kept in this array with
-     * the older ones being replaced by newer ones.
-     */
-    incomingCallsEnded: IncomingCallState[];
-    /**
-     * Proxy of {@Link @azure/communication-calling#DeviceManager}. Please review {@Link DeviceManagerState}.
-     */
-    deviceManager: DeviceManagerState;
-    /**
-     * Proxy of {@Link @azure/communication-calling#CallAgent}. Please review {@Link CallAgentState}.
-     */
-    callAgent: CallAgentState | undefined;
-    /**
-     * Stores a userId. This is not used by the {@Link StatefulCallClient} and is provided here as a convenience for the
-     * developer for easier access to userId. Must be passed in at initialization of the {@Link StatefulCallClient}.
-     * Completely controled by the developer.
-     */
-    userId: string;
-}
+import { AudioDeviceInfo, CallDirection, CallEndReason, CallerInfo, CallState as CallStatus, DeviceAccess, DominantSpeakersInfo, LatestMediaDiagnostics, LatestNetworkDiagnostics, MediaStreamType, RemoteParticipantState as RemoteParticipantStatus, ScalingMode, TransferErrorCode, TransferState, VideoDeviceInfo } from '@azure/communication-calling';
+import { CommunicationUserIdentifier, CommunicationUserKind, MicrosoftTeamsUserKind, PhoneNumberIdentifier, PhoneNumberKind, UnknownIdentifierKind } from '@azure/communication-common';
+/**
+ * State only version of {@link @azure/communication-calling#TransferRequestedEventArgs}. At the time of writing
+ * Transfer Call is experimental. Not tested and not ready for consumption.
+ */
+export interface TransferRequest {
+    targetParticipant: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind;
+}
+/**
+ * State only version of {@link @azure/communication-calling#Transfer}. At the time of writing Transfer Call is
+ * experimental. Not tested and not ready for consumption.
+ * @experimental
+ */
+export interface Transfer {
+    /**
+     * Added by Declarative and used internally.
+     */
+    id: number;
+    /**
+     * Added by {@link StatefulClientClient}, stores the targetParticipant passed to
+     * {@link @azure/communication-calling#TransferCallFeature.transfer}
+     */
+    targetParticipant: CommunicationUserIdentifier | PhoneNumberIdentifier;
+    /**
+     * Proxy of {@link @azure/communication-calling#Transfer.state}.
+     */
+    state: TransferState;
+    /**
+     * Proxy of {@link @azure/communication-calling#Transfer.error}.
+     */
+    error?: TransferErrorCode;
+}
+/**
+ * Holds all the state found in {@link @azure/communication-calling#TransferCallFeature} and
+ * {@link @azure/communication-calling#Transfer}. At the time of writing Transfer Call is experimental. Not tested and
+ * not ready for consumption.
+ */
+export interface TransferCallFeature {
+    /**
+     * These are requests received in the {@link @azure/communication-calling#TransferCallFeature}'s 'transferRequested'
+     * event. Only MAX_TRANSFER_REQUEST_LENGTH number of TransferRequest are kept in this array with the older ones being
+     * replaced by newer ones. To accept/reject a transfer request, the {@link @azure/communication-calling#Call} must be
+     * used (TODO: do we want to provide an API?).
+     */
+    receivedTransferRequests: TransferRequest[];
+    /**
+     * These are requests initiated by the local user using {@link StatefulCallClient.transfer}. Only
+     * MAX_TRANSFER_REQUEST_LENGTH number of TransferRequest are kept in this array with the older ones being replaced by
+     * newer ones.
+     */
+    requestedTransfers: Transfer[];
+}
+/**
+ * State only version of {@link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of
+ * {@link CallClientState} and not included here. The reason to have CallAgent's state proxied is to provide access to
+ * displayName. We don't flatten CallAgent.displayName and put it in CallClientState because it would be ambiguious that
+ * displayName is actually reliant on the creation/existence of CallAgent to be available.
+ */
+export interface CallAgentState {
+    /**
+     * Proxy of {@link @azure/communication-calling#CallAgent.displayName}.
+     */
+    displayName?: string;
+}
+/**
+ * State only version of {@link @azure/communication-calling#TranscriptionCallFeature}. {@link StatefulCallClient} will
+ * automatically listen for transcription state of the call and update the state exposed by {@link StatefulCallClient}
+ * accordingly.
+ */
+export interface TranscriptionCallFeature {
+    /**
+     * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature.isTranscriptionActive}.
+     */
+    isTranscriptionActive: boolean;
+}
+/**
+ * State only version of {@link @azure/communication-calling#RecordingCallFeature}. {@link StatefulCallClient} will
+ * automatically listen for recording state of the call and update the state exposed by {@link StatefulCallClient} accordingly.
+ */
+export interface RecordingCallFeature {
+    /**
+     * Proxy of {@link @azure/communication-calling#RecordingCallFeature.isRecordingActive}.
+     */
+    isRecordingActive: boolean;
+}
+/**
+ * State only version of {@link @azure/communication-calling#LocalVideoStream}.
+ */
+export interface LocalVideoStreamState {
+    /**
+     * Proxy of {@link @azure/communication-calling#LocalVideoStream.source}.
+     */
+    source: VideoDeviceInfo;
+    /**
+     * Proxy of {@link @azure/communication-calling#LocalVideoStream.mediaStreamType}.
+     */
+    mediaStreamType: MediaStreamType;
+    /**
+     * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}
+     * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.
+     */
+    view?: VideoStreamRendererViewState;
+}
+/**
+ * State only version of {@link @azure/communication-calling#RemoteVideoStream}.
+ */
+export interface RemoteVideoStreamState {
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteVideoStream.id}.
+     */
+    id: number;
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteVideoStream.mediaStreamType}.
+     */
+    mediaStreamType: MediaStreamType;
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isAvailable}.
+     */
+    isAvailable: boolean;
+    /**
+     * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}
+     * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.
+     */
+    view?: VideoStreamRendererViewState;
+}
+/**
+ * State only version of {@link @azure/communication-calling#VideoStreamRendererView}. Currently no API is provided to
+ * modify scalingMode after the stream as been rendered by {@link StatefulCallClient}. In order to change scalingMode
+ * stop rendering the stream and re-start it using the desired scalingMode. This property is added to the state exposed
+ * by {@link StatefulCallClient} by {@link StatefulCallClient.createView} and removed by
+ * {@link StatefulCallClient.disposeView}.
+ */
+export interface VideoStreamRendererViewState {
+    /**
+     * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.scalingMode}.
+     */
+    scalingMode: ScalingMode;
+    /**
+     * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.isMirrored}.
+     */
+    isMirrored: boolean;
+    /**
+     * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.target}.
+     */
+    target: HTMLElement;
+}
+/**
+ * State only version of {@link @azure/communication-calling#RemoteParticipant}. {@link StatefulCallClient} will
+ * automatically retrieve RemoteParticipants and add their state to the state exposed by {@link StatefulCallClient}.
+ */
+export interface RemoteParticipantState {
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteParticipant.identifier}.
+     */
+    identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind;
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteParticipant.displayName}.
+     */
+    displayName?: string;
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteParticipant.state}.
+     */
+    state: RemoteParticipantStatus;
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteParticipant.callEndReason}.
+     */
+    callEndReason?: CallEndReason;
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteParticipant.videoStreams} as an object with
+     * {@link RemoteVideoStream} fields keyed by {@link @azure/communication-calling#RemoteVideoStream.id}.
+     */
+    videoStreams: {
+        [key: number]: RemoteVideoStreamState;
+    };
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteParticipant.isMuted}.
+     */
+    isMuted: boolean;
+    /**
+     * Proxy of {@link @azure/communication-calling#RemoteParticipant.isSpeaking}.
+     */
+    isSpeaking: boolean;
+}
+/**
+ * State only version of {@link @azure/communication-calling#Call}. {@link StatefulCallClient} will automatically
+ * retrieve Call's state and add it to the state exposed by {@link StatefulCallClient}.
+ */
+export interface CallState {
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.id}.
+     */
+    id: string;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.callerInfo}.
+     */
+    callerInfo: CallerInfo;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.state}.
+     */
+    state: CallStatus;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.callEndReason}.
+     */
+    callEndReason?: CallEndReason;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.direction}.
+     */
+    direction: CallDirection;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.isMuted}.
+     */
+    isMuted: boolean;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.isScreenSharingOn}.
+     */
+    isScreenSharingOn: boolean;
+    /**
+     * Proxy of {@link @azure/communication-calling#DominantSpeakersInfo }.
+     */
+    dominantSpeakers?: DominantSpeakersInfo;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.localVideoStreams}.
+     */
+    localVideoStreams: LocalVideoStreamState[];
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.remoteParticipants}.
+     * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.
+     * To obtain a flattened {@link RemoteParticipantState.identifier}, use
+     * {@link @azure/communication-react#toFlatCommunicationIdentifier}.
+     */
+    remoteParticipants: {
+        [keys: string]: RemoteParticipantState;
+    };
+    /**
+     * Stores remote participants that have left the call so that the callEndReason could be retrieved.
+     * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.
+     * To obtain a flattened {@link RemoteParticipantState.identifier}, use
+     * {@link @azure/communication-react#toFlatCommunicationIdentifier}.
+     */
+    remoteParticipantsEnded: {
+        [keys: string]: RemoteParticipantState;
+    };
+    /**
+     * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.
+     */
+    transcription: TranscriptionCallFeature;
+    /**
+     * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.
+     */
+    recording: RecordingCallFeature;
+    /**
+     * Proxy of {@link @azure/communication-calling#TransferCallFeature} with some differences see
+     * {@link TransferCallFeature} for details.
+     */
+    transfer: TransferCallFeature;
+    /**
+     * Stores the currently active screenshare participant's key. If there is no screenshare active, then this will be
+     * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.
+     *
+     * Note this only applies to ScreenShare in RemoteParticipant. A local ScreenShare being active will not affect this
+     * property.
+     *
+     * This property is added by the stateful layer and is not a proxy of SDK state
+     */
+    screenShareRemoteParticipant: string | undefined;
+    /**
+     * Stores the local date when the call started on the client. This property is added by the stateful layer and is not
+     * a proxy of SDK state.
+     */
+    startTime: Date;
+    /**
+     * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not
+     * a proxy of SDK state.
+     */
+    endTime: Date | undefined;
+    /**
+     * Stores the latest call diagnostics.
+     */
+    diagnostics: DiagnosticsCallFeatureState;
+}
+/**
+ * State only version of {@link @azure/communication-calling#IncomingCall}. {@link StatefulCallClient} will
+ * automatically detect incoming calls and add their state to the state exposed by {@link StatefulCallClient}.
+ */
+export interface IncomingCallState {
+    /**
+     * Proxy of {@link @azure/communication-calling#IncomingCall.id}.
+     */
+    id: string;
+    /**
+     * Proxy of {@link @azure/communication-calling#IncomingCall.callerInfo}.
+     */
+    callerInfo: CallerInfo;
+    /**
+     * Set to the state returned by 'callEnded' event on {@link @azure/communication-calling#IncomingCall} when received.
+     * This property is added by the stateful layer and is not a proxy of SDK state.
+     */
+    callEndReason?: CallEndReason;
+    /**
+     * Stores the local date when the call started on the client. This property is added by the stateful layer and is not
+     * a proxy of SDK state.
+     */
+    startTime: Date;
+    /**
+     * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not a
+     * proxy of SDK state. It is undefined if the call is not ended yet.
+     */
+    endTime: Date | undefined;
+}
+/**
+ * This type is meant to encapsulate all the state inside {@link @azure/communication-calling#DeviceManager}. For
+ * optional parameters they may not be available until permission is granted by the user. The cameras, microphones,
+ * speakers, and deviceAccess states will be empty until the corresponding
+ * {@link @azure/communication-calling#DeviceManager}'s getCameras, getMicrophones, getSpeakers, and askDevicePermission
+ * APIs are called and completed.
+ */
+export declare type DeviceManagerState = {
+    /**
+     * Proxy of {@link @azure/communication-calling#DeviceManager.isSpeakerSelectionAvailable}.
+     */
+    isSpeakerSelectionAvailable: boolean;
+    /**
+     * Proxy of {@link @azure/communication-calling#DeviceManager.selectedMicrophone}.
+     */
+    selectedMicrophone?: AudioDeviceInfo;
+    /**
+     * Proxy of {@link @azure/communication-calling#DeviceManager.selectedSpeaker}.
+     */
+    selectedSpeaker?: AudioDeviceInfo;
+    /**
+     * Stores the selected camera device info. This is added by the stateful layer and does not exist in the Calling SDK.
+     * It is meant as a convenience to the developer. It must be explicitly set before it has any value and does not
+     * persist across instances of the {@link StatefulCallClient}. The developer controls entirely what this value holds
+     * at any time.
+     */
+    selectedCamera?: VideoDeviceInfo;
+    /**
+     * Stores any cameras data returned from {@link @azure/communication-calling#DeviceManager.getCameras}.
+     */
+    cameras: VideoDeviceInfo[];
+    /**
+     * Stores any microphones data returned from {@link @azure/communication-calling#DeviceManager.getMicrophones}.
+     */
+    microphones: AudioDeviceInfo[];
+    /**
+     * Stores any speakers data returned from {@link @azure/communication-calling#DeviceManager.getSpeakers}.
+     */
+    speakers: AudioDeviceInfo[];
+    /**
+     * Stores deviceAccess data returned from {@link @azure/communication-calling#DeviceManager.askDevicePermission}.
+     */
+    deviceAccess?: DeviceAccess;
+    /**
+     * Stores created views that are not associated with any CallState (when {@link StatefulCallClient.createView} is
+     * called with undefined callId, undefined participantId, and defined LocalVideoStream).
+     *
+     * The values in this array are generated internally when {@link StatefulCallClient.createView} is called and are
+     * considered immutable.
+     */
+    unparentedViews: LocalVideoStreamState[];
+};
+/**
+ * Container for all of the state data proxied by {@link StatefulCallClient}. The calls, callsEnded, incomingCalls, and
+ * incomingCallsEnded states will be automatically provided if a callAgent has been created. The deviceManager will be
+ * empty initially until populated see {@link DeviceManagerState}. The userId state is provided as a convenience for the
+ * developer and is completely controled and set by the developer.
+ */
+export interface CallClientState {
+    /**
+     * Proxy of {@link @azure/communication-calling#CallAgent.calls} as an object with CallState {@link CallState} fields.
+     * It is keyed by {@link @azure/communication-calling#Call.id}. Please note that
+     * {@link @azure/communication-calling#Call.id} could change. You should not cache the id itself but the entire
+     * {@link @azure/communication-calling#Call} and then use the id contained to look up data in this map.
+     */
+    calls: {
+        [key: string]: CallState;
+    };
+    /**
+     * Calls that have ended are stored here so the callEndReason could be checked. It is an array of CallState
+     * {@link CallState}. Calls are pushed on to the array as they end, meaning this is sorted by endTime ascending. Only
+     * {@link MAX_CALL_HISTORY_LENGTH} number of Calls are kept in this array with the older ones being replaced by newer
+     * ones.
+     */
+    callsEnded: CallState[];
+    /**
+     * Proxy of {@link @azure/communication-calling#IncomingCall} as an object with IncomingCall {@link IncomingCall} fields.
+     * It is keyed by {@link @azure/communication-calling#IncomingCall.id}.
+     */
+    incomingCalls: {
+        [key: string]: IncomingCallState;
+    };
+    /**
+     * Incoming Calls that have ended are stored here so the callEndReason could be checked. It is a array of IncomingCall
+     * {@link IncomingCall} received in the event 'incomingCall' emitted by
+     * {@link @azure/communication-calling#CallAgent}. IncomingCalls are pushed on to the array as they end, meaning this
+     * is sorted by endTime ascending. Only MAX_CALL_HISTORY_LENGTH number of IncomingCalls are kept in this array with
+     * the older ones being replaced by newer ones.
+     */
+    incomingCallsEnded: IncomingCallState[];
+    /**
+     * Proxy of {@link @azure/communication-calling#DeviceManager}. Please review {@link DeviceManagerState}.
+     */
+    deviceManager: DeviceManagerState;
+    /**
+     * Proxy of {@link @azure/communication-calling#CallAgent}. Please review {@link CallAgentState}.
+     */
+    callAgent?: CallAgentState;
+    /**
+     * Stores a userId. This is not used by the {@link StatefulCallClient} and is provided here as a convenience for the
+     * developer for easier access to userId. Must be passed in at initialization of the {@link StatefulCallClient}.
+     * Completely controlled by the developer.
+     */
+    userId: CommunicationUserKind;
+    /**
+     * Stores the latest error for each API method.
+     *
+     * See documentation of {@Link CallErrors} for details.
+     */
+    latestErrors: CallErrors;
+}
+/**
+ * Errors teed from API calls to the Calling SDK.
+ *
+ * Each property in the object stores the latest error for a particular SDK API method.
+ *
+ * Errors from this object can be cleared using the {@link newClearCallErrorsModifier}.
+ * Additionally, errors are automatically cleared when:
+ * - The state is cleared.
+ * - Subsequent calls to related API methods succeed.
+ * See documentation of individual stateful client methods for details on when errors may be automatically cleared.
+ */
+export declare type CallErrors = {
+    [target in CallErrorTarget]: CallError;
+};
+/**
+ * Error thrown from failed stateful API methods.
+ */
+export declare class CallError extends Error {
+    /**
+     * The API method target that failed.
+     */
+    target: CallErrorTarget;
+    /**
+     * Error thrown by the failed SDK method.
+     */
+    inner: Error;
+    /**
+     * Timestamp added to the error by the stateful layer.
+     */
+    timestamp: Date;
+    constructor(target: CallErrorTarget, inner: Error, timestamp?: Date);
+}
+/**
+ * String literal type for all permissible keys in {@Link CallErrors}.
+ */
+export declare type CallErrorTarget = 'Call.addParticipant' | 'Call.api' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopVideo' | 'Call.unmute' | 'CallAgent.dispose' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.getDeviceManager' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker';
+/**
+ * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.
+ */
+export interface DiagnosticsCallFeatureState {
+    /**
+     * Stores diagnostics related to network conditions.
+     */
+    network: NetworkDiagnosticsState;
+    /**
+     * Stores diagnostics related to media quality.
+     */
+    media: MediaDiagnosticsState;
+}
+/**
+ * State only proxy for {@link @azure/communication-calling#NetworkDiagnostics}.
+ */
+export interface NetworkDiagnosticsState {
+    latest: LatestNetworkDiagnostics;
+}
+/**
+ * State only proxy for {@link @azure/communication-calling#MediaDiagnostics}.
+ */
+export interface MediaDiagnosticsState {
+    latest: LatestMediaDiagnostics;
+}
 //# sourceMappingURL=CallClientState.d.ts.map