CallState interface

Package:

@azure/communication-react

State only version of <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient will automatically retrieve Call's state and add it to the state exposed by StatefulCallClient.

Properties

breakoutRooms	Proxy of <xref:%40azure%2Fcommunication-calling%23BreakoutRoomsFeature>.
callEndReason	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.callEndReason>.
callerInfo	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.callerInfo>.
capabilitiesFeature	Proxy of <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature>.
captionsFeature	Proxy of <xref:%40azure%2Fcommunication-calling%23CaptionsCallFeature>.
contentSharingRemoteParticipant	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 undefined. You can use this key to access the remoteParticipant data in remoteParticipants object. Note this only applies to PPTLive in RemoteParticipant. This property is added by the stateful layer and is not a proxy of SDK state
diagnostics	Stores the latest call diagnostics.
direction	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.direction>.
dominantSpeakers	Proxy of <xref:%40azure%2Fcommunication-calling%23DominantSpeakersInfo>.
endTime	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.
hideAttendeeNames	Hide attendee names in teams meeting
id	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.id>.
info	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.info>.
isMuted	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.isMuted>.
isScreenSharingOn	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.isScreenSharingOn>.
kind	Type of the call.
localParticipantReaction	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> with UI helper props receivedOn which indicates the timestamp when the message was received.
localVideoStreams	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams>.
meetingConference	Proxy of <xref:%40azure%2Fcommunication-calling%23TeamsMeetingAudioConferencingCallFeature>.
meetingMediaAccess	Proxy of <xref:%40azure%2Fcommunication-calling%23MediaAccessFeature>.
optimalVideoCount	Proxy of <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>.
pptLive	Proxy of <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>.
raiseHand	Proxy of <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>.
realTimeTextFeature	Proxy of <xref:%40azure%2Fcommunication-calling%23RealTimeTextCallFeature>.
recording	Proxy of <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>.
remoteParticipants	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.remoteParticipants>. Object with VideoGalleryRemoteParticipant fields keyed by flattened identifier. To obtain a flattened identifier, use <xref:%40azure%2Fcommunication-react%23toFlatCommunicationIdentifier>.
remoteParticipantsEnded	Stores remote participants that have left the call so that the callEndReason could be retrieved. Object with VideoGalleryRemoteParticipant fields keyed by flattened identifier. To obtain a flattened identifier, use <xref:%40azure%2Fcommunication-react%23toFlatCommunicationIdentifier>.
role	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.role>.
screenShareRemoteParticipant	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 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
spotlight	Proxy of <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature>.
startTime	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.
state	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.state>.
togetherMode	Proxy of <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>.
transcription	Proxy of <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>.
transfer	Transfer state of call

Property Details

breakoutRooms

Proxy of <xref:%40azure%2Fcommunication-calling%23BreakoutRoomsFeature>.

breakoutRooms?: BreakoutRoomsState

Property Value

BreakoutRoomsState

callEndReason

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.callEndReason>.

callEndReason?: CallEndReason

Property Value

CallEndReason

callerInfo

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.callerInfo>.

callerInfo: CallerInfo

Property Value

CallerInfo

capabilitiesFeature

Proxy of <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature>.

capabilitiesFeature?: CapabilitiesFeatureState

Property Value

CapabilitiesFeatureState

captionsFeature

Proxy of <xref:%40azure%2Fcommunication-calling%23CaptionsCallFeature>.

captionsFeature: CaptionsCallFeatureState

Property Value

CaptionsCallFeatureState

contentSharingRemoteParticipant

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 undefined. You can use this key to access the remoteParticipant data in remoteParticipants object.

Note this only applies to PPTLive in RemoteParticipant.

This property is added by the stateful layer and is not a proxy of SDK state

public contentSharingRemoteParticipant?: string

Property Value

string

diagnostics

Stores the latest call diagnostics.

diagnostics: DiagnosticsCallFeatureState

Property Value

DiagnosticsCallFeatureState

direction

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.direction>.

direction: CallDirection

Property Value

CallDirection

dominantSpeakers

Proxy of <xref:%40azure%2Fcommunication-calling%23DominantSpeakersInfo>.

dominantSpeakers?: DominantSpeakersInfo

Property Value

DominantSpeakersInfo

endTime

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: undefined | Date

Property Value

undefined | Date

hideAttendeeNames

Hide attendee names in teams meeting

hideAttendeeNames?: boolean

Property Value

boolean

id

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.id>.

id: string

Property Value

string

info

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.info>.

info?: TeamsCallInfo

Property Value

TeamsCallInfo

isMuted

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.isMuted>.

isMuted: boolean

Property Value

boolean

isScreenSharingOn

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.isScreenSharingOn>.

isScreenSharingOn: boolean

Property Value

boolean

kind

Type of the call.

kind: CallKind

Property Value

CallKind

localParticipantReaction

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> with UI helper props receivedOn which indicates the timestamp when the message was received.

public localParticipantReaction?: ReactionState

Property Value

ReactionState

localVideoStreams

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams>.

localVideoStreams: LocalVideoStreamState[]

Property Value

LocalVideoStreamState[]

meetingConference

Proxy of <xref:%40azure%2Fcommunication-calling%23TeamsMeetingAudioConferencingCallFeature>.

meetingConference?: { conferencePhones: ConferencePhoneInfo[] }

Property Value

{ conferencePhones: ConferencePhoneInfo[] }

meetingMediaAccess

Proxy of <xref:%40azure%2Fcommunication-calling%23MediaAccessFeature>.

meetingMediaAccess?: MediaAccessState

Property Value

MediaAccessState

optimalVideoCount

Proxy of <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>.

optimalVideoCount: OptimalVideoCountFeatureState

Property Value

OptimalVideoCountFeatureState

pptLive

Proxy of <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>.

public pptLive: PPTLiveCallFeatureState

Property Value

PPTLiveCallFeatureState

raiseHand

Proxy of <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>.

raiseHand: RaiseHandCallFeature

Property Value

RaiseHandCallFeature

realTimeTextFeature

Proxy of <xref:%40azure%2Fcommunication-calling%23RealTimeTextCallFeature>.

realTimeTextFeature: RealTimeTextCallFeatureState

Property Value

RealTimeTextCallFeatureState

recording

Proxy of <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>.

recording: RecordingCallFeature

Property Value

RecordingCallFeature

remoteParticipants

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.remoteParticipants>. Object with VideoGalleryRemoteParticipant fields keyed by flattened identifier. To obtain a flattened identifier, use <xref:%40azure%2Fcommunication-react%23toFlatCommunicationIdentifier>.

remoteParticipants: {[keys: string]: RemoteParticipantState}

Property Value

{[keys: string]: RemoteParticipantState}

remoteParticipantsEnded

Stores remote participants that have left the call so that the callEndReason could be retrieved. Object with VideoGalleryRemoteParticipant fields keyed by flattened identifier. To obtain a flattened identifier, use <xref:%40azure%2Fcommunication-react%23toFlatCommunicationIdentifier>.

remoteParticipantsEnded: {[keys: string]: RemoteParticipantState}

Property Value

{[keys: string]: RemoteParticipantState}

role

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.role>.

role?: ParticipantRole

Property Value

ParticipantRole

screenShareRemoteParticipant

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 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

Property Value

string

spotlight

Proxy of <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature>.

spotlight?: SpotlightCallFeatureState

Property Value

SpotlightCallFeatureState

startTime

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

Property Value

Date

state

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.state>.

state: CallState

Property Value

CallState

togetherMode

Proxy of <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>.

togetherMode: TogetherModeCallFeatureState

Property Value

TogetherModeCallFeatureState

transcription

Proxy of <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>.

transcription: TranscriptionCallFeature

Property Value

TranscriptionCallFeature

transfer

Transfer state of call

transfer: TransferFeature

Property Value

TransferFeature