RemoteParticipantState interface

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>.
contentSharingStream	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.PPTLive.target>.
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>.
mediaAccess	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.MediaAccessCallFeature.MediaAccess>.
raisedHand	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.RaisedHand.raisedHands>.
reactionState	Proxy of <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> with UI helper props receivedOn which indicates the timestamp when the message was received.
role	Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteParticipant.role>.
spotlight	Proxy of <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature.spotlightedParticipants>.
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

contentSharingStream

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

public contentSharingStream?: HTMLElement

Property Value

HTMLElement

displayName

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

displayName?: string

Property Value

string

identifier

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

identifier: CommunicationIdentifierKind

Property Value

CommunicationIdentifierKind

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

mediaAccess

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

mediaAccess?: MediaAccessState

Property Value

MediaAccessState

raisedHand

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

raisedHand?: RaisedHandState

Property Value

RaisedHandState

reactionState

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

public reactionState?: ReactionState

Property Value

ReactionState

role

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

role?: ParticipantRole

Property Value

ParticipantRole

spotlight

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

spotlight?: SpotlightState

Property Value

SpotlightState

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}