Class RemoteParticipant
- Object
-
- RemoteParticipant
-
public final class RemoteParticipant extends ObjectDescribes a remote participant on a call
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddOnDisplayNameChangedListener(PropertyChangedListener listener)Adds the specified listener to receive OnDisplayNameChanged events.voidaddOnIsMutedChangedListener(PropertyChangedListener listener)Adds the specified listener to receive OnIsMutedChanged events.voidaddOnIsSpeakingChangedListener(PropertyChangedListener listener)Adds the specified listener to receive OnIsSpeakingChanged events.voidaddOnRoleChangedListener(PropertyChangedListener listener)Adds the specified listener to receive OnRoleChanged events.voidaddOnStateChangedListener(PropertyChangedListener listener)Adds the specified listener to receive OnStateChanged events.voidaddOnVideoStreamStateChangedListener(VideoStreamStateChangedListener listener)Adds the specified listener to receive OnVideoStreamStateChanged events.voidaddOnVideoStreamsUpdatedListener(RemoteVideoStreamsUpdatedListener listener)Deprecated.Use OnVideoStreamStateChanged instead RemoteVideoStreamsUpdated Event.protected voidfinalize()Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.CallEndReasongetCallEndReason()Reason why participant left the call, contains code/subcode.CallParticipantRolegetCallParticipantRole()Role of the remote participantStringgetDisplayName()Private Preview Only: Display Name of the remote participantCommunicationIdentifiergetIdentifier()Get the remote participant identifier informationList<IncomingVideoStream>getIncomingVideoStreams()Get a list of incoming streams in the current call.ParticipantStategetState()Current state of the remote participantList<RemoteVideoStream>getVideoStreams()Deprecated.Use getIncomingVideoStreams insteadbooleanisMuted()True if the remote participant is mutedbooleanisSpeaking()True if the remote participant is speaking.CompletableFuture<Void>mute()Mute remote participant audiovoidremoveOnDisplayNameChangedListener(PropertyChangedListener listener)Removes the specified listener to receive OnDisplayNameChanged events.voidremoveOnIsMutedChangedListener(PropertyChangedListener listener)Removes the specified listener to receive OnIsMutedChanged events.voidremoveOnIsSpeakingChangedListener(PropertyChangedListener listener)Removes the specified listener to receive OnIsSpeakingChanged events.voidremoveOnRoleChangedListener(PropertyChangedListener listener)Removes the specified listener to receive OnRoleChanged events.voidremoveOnStateChangedListener(PropertyChangedListener listener)Removes the specified listener to receive OnStateChanged events.voidremoveOnVideoStreamStateChangedListener(VideoStreamStateChangedListener listener)Removes the specified listener to receive OnVideoStreamStateChanged events.voidremoveOnVideoStreamsUpdatedListener(RemoteVideoStreamsUpdatedListener listener)Deprecated.Use OnVideoStreamStateChanged instead RemoteVideoStreamsUpdated Event.
-
-
-
Method Detail
-
finalize
protected void finalize()
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.- Overrides:
finalizein classObject
-
getCallParticipantRole
public CallParticipantRole getCallParticipantRole()
Role of the remote participant
-
getDisplayName
public String getDisplayName()
Private Preview Only: Display Name of the remote participant
-
isMuted
public boolean isMuted()
True if the remote participant is muted
-
isSpeaking
public boolean isSpeaking()
True if the remote participant is speaking. Only applicable to multi-party calls
-
getCallEndReason
public CallEndReason getCallEndReason()
Reason why participant left the call, contains code/subcode.
-
getState
public ParticipantState getState()
Current state of the remote participant
-
getVideoStreams
@Deprecated public List<RemoteVideoStream> getVideoStreams()
Deprecated.Use getIncomingVideoStreams insteadRemote Video streams part of the current call
-
getIncomingVideoStreams
public List<IncomingVideoStream> getIncomingVideoStreams()
Get a list of incoming streams in the current call.
-
addOnStateChangedListener
public void addOnStateChangedListener(PropertyChangedListener listener)
Adds the specified listener to receive OnStateChanged events. PropertyChanged Event. Occurs when the remote participant state changes
-
removeOnStateChangedListener
public void removeOnStateChangedListener(PropertyChangedListener listener)
Removes the specified listener to receive OnStateChanged events. PropertyChanged Event. Occurs when the remote participant state changes
-
addOnIsMutedChangedListener
public void addOnIsMutedChangedListener(PropertyChangedListener listener)
Adds the specified listener to receive OnIsMutedChanged events. PropertyChanged Event. Occurs when the remote participant's IsMuted changes
-
removeOnIsMutedChangedListener
public void removeOnIsMutedChangedListener(PropertyChangedListener listener)
Removes the specified listener to receive OnIsMutedChanged events. PropertyChanged Event. Occurs when the remote participant's IsMuted changes
-
addOnIsSpeakingChangedListener
public void addOnIsSpeakingChangedListener(PropertyChangedListener listener)
Adds the specified listener to receive OnIsSpeakingChanged events. PropertyChanged Event. Occurs when the remote participant is an active speaker in a multi-party calls
-
removeOnIsSpeakingChangedListener
public void removeOnIsSpeakingChangedListener(PropertyChangedListener listener)
Removes the specified listener to receive OnIsSpeakingChanged events. PropertyChanged Event. Occurs when the remote participant is an active speaker in a multi-party calls
-
addOnDisplayNameChangedListener
public void addOnDisplayNameChangedListener(PropertyChangedListener listener)
Adds the specified listener to receive OnDisplayNameChanged events. PropertyChanged Event. Occurs when the remote participant's displayName changes
-
removeOnDisplayNameChangedListener
public void removeOnDisplayNameChangedListener(PropertyChangedListener listener)
Removes the specified listener to receive OnDisplayNameChanged events. PropertyChanged Event. Occurs when the remote participant's displayName changes
-
addOnRoleChangedListener
public void addOnRoleChangedListener(PropertyChangedListener listener)
Adds the specified listener to receive OnRoleChanged events. PropertyChanged Event. Occurs when the remote participant's role changes
-
removeOnRoleChangedListener
public void removeOnRoleChangedListener(PropertyChangedListener listener)
Removes the specified listener to receive OnRoleChanged events. PropertyChanged Event. Occurs when the remote participant's role changes
-
addOnVideoStreamsUpdatedListener
@Deprecated public void addOnVideoStreamsUpdatedListener(RemoteVideoStreamsUpdatedListener listener)
Deprecated.Use OnVideoStreamStateChanged instead RemoteVideoStreamsUpdated Event. Occurs when remote video streams are added or removedAdds the specified listener to receive OnVideoStreamsUpdated events.
-
removeOnVideoStreamsUpdatedListener
@Deprecated public void removeOnVideoStreamsUpdatedListener(RemoteVideoStreamsUpdatedListener listener)
Deprecated.Use OnVideoStreamStateChanged instead RemoteVideoStreamsUpdated Event. Occurs when remote video streams are added or removedRemoves the specified listener to receive OnVideoStreamsUpdated events.
-
addOnVideoStreamStateChangedListener
public void addOnVideoStreamStateChangedListener(VideoStreamStateChangedListener listener)
Adds the specified listener to receive OnVideoStreamStateChanged events. Listener used to know the video stream state
-
removeOnVideoStreamStateChangedListener
public void removeOnVideoStreamStateChangedListener(VideoStreamStateChangedListener listener)
Removes the specified listener to receive OnVideoStreamStateChanged events. Listener used to know the video stream state
-
mute
public CompletableFuture<Void> mute()
Mute remote participant audio
-
getIdentifier
public CommunicationIdentifier getIdentifier()
Get the remote participant identifier information- Returns:
- a CommunicationIdentifier object representing the remote participant
-
-