Class RemoteParticipant


  • public final class RemoteParticipant
    extends Object
    Describes a remote participant on a call
    • 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:
        finalize in class Object
      • 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 instead
        Remote 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 removed
        Adds 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 removed
        Removes 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