RemoteParticipantState interface

  • Reference
Package:
@azure/communication-react

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

Properties

callEndReason

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

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteParticipant.displayName>.
identifier

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

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

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

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

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteParticipant.videoStreams> as an object with <xref:RemoteVideoStream> fields keyed by <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.id>.

Property Details

callEndReason

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

callEndReason?: CallEndReason

Property Value

CallEndReason

displayName

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

displayName?: string

Property Value

string

identifier

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

identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind

Property Value

CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind

isMuted

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

isMuted: boolean

Property Value

boolean

isSpeaking

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

isSpeaking: boolean

Property Value

boolean

state

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

state: RemoteParticipantState

Property Value

RemoteParticipantState

videoStreams

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteParticipant.videoStreams> as an object with <xref:RemoteVideoStream> fields keyed by <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.id>.

videoStreams: {[key: number]: RemoteVideoStreamState}

Property Value

{[key: number]: RemoteVideoStreamState}