CallState interface

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

callEndReason

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

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.callerInfo>.
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.
id

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

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

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

Proxy of <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams>.
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>.
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
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>.
transcription

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

Property Details

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

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

id

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

id: string

Property Value

string

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

localVideoStreams

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

localVideoStreams: LocalVideoStreamState[]

Property Value

LocalVideoStreamState[]

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}

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

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

transcription

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

transcription: TranscriptionCallFeature

Property Value

TranscriptionCallFeature