Package org.linphone.core

Interface ParticipantDevice

public interface ParticipantDevice
This object represents a unique device for a member of a Conference or
ChatRoom.

Devices are identified by the gruu parameter inside the Address which
can be obtained by getAddress(). It is specially usefull to know the
security level of each device inside an end-to-end encrypted ChatRoom.
You can get a list of all ParticipantDevice using Participant.getDevices()
.

  • Method Details

    • getAddress

      @NonNull Address getAddress()
      Get the address of a participant's device.

      Returns:
      The Address of the participant's device

    • getDisconnectionMethod

      ParticipantDevice.DisconnectionMethod getDisconnectionMethod()
      Get the disconnection method.

      Returns:
      disconnection method ParticipantDevice.DisconnectionMethod

    • getDisconnectionReason

      @Nullable String getDisconnectionReason()
      Get the disconnection reason.

      Returns:
      disconnection reason

    • isInConference

      boolean isInConference()
      Return whether the participant device is in a conference or not.

      Returns:
      a boolean to state whether the device is in a conference

    • getIsMuted

      boolean getIsMuted()
      Return whether the participant device is muted or not.

      Returns:
      true if the participant device is muted, false otherwise.

    • getIsSpeaking

      boolean getIsSpeaking()
      Return whether the participant device is speaking or not.

      Returns:
      true if the participant device is speaking, false otherwise.

    • getJoiningMethod

      ParticipantDevice.JoiningMethod getJoiningMethod()
      Get the joining method or it the device is the focus owner.

      Returns:
      joining method or focus owner ParticipantDevice.JoiningMethod

    • getName

      @Nullable String getName()
      Return the name of the device or null.

      Returns:
      the name of the device or null.

    • getNativeVideoWindowId

      @Nullable Object getNativeVideoWindowId()
      Get window ID.

      Returns:
      the window ID of the device

    • setNativeVideoWindowId

      void setNativeVideoWindowId(@Nullable Object windowId)
      Set window ID for a device.

      Parameters:
      windowId - the window ID of the device

    • getSecurityLevel

      ChatRoom.SecurityLevel getSecurityLevel()
      Get the security level of a participant's device.

      Returns:
      The ChatRoom#SecurityLevel of the device

    • getState

      ParticipantDevice.State getState()
      Get the state of a participant device.

      Returns:
      The ParticipantDevice.State of the device

    • getTimeOfDisconnection

      long getTimeOfDisconnection()
      Get the timestamp the device left a conference.

      Returns:
      time of disconnection a conference as returned by time(nullptr). For
      UNIX based systems it is the number of seconds since 00:00hours of the 1st of
      January 1970

    • getTimeOfJoining

      long getTimeOfJoining()
      Get the timestamp the device joined a conference.

      Returns:
      time of joining a conference as returned by time(nullptr). For UNIX
      based systems it is the number of seconds since 00:00hours of the 1st of
      January 1970

    • createNativeVideoWindowId

      @Nullable Object createNativeVideoWindowId()
      Create a window ID and return it.

      Returns:
      the window ID of the device

    • getSsrc

      int getSsrc(StreamType streamType)
      Get the audio stream SSRC of the device.

      Parameters:
      streamType - A StreamType
      Returns:
      the audio stream SSRC of the device

    • getStreamAvailability

      boolean getStreamAvailability(StreamType streamType)
      Get the stream availability of the device.

      The availability information represents whether a given stream type is
      currently available to be presented in the conference for a ParticipantDevice
      Parameters:
      streamType - A StreamType
      Returns:
      true if the stream of type stream_type is available for device, false
      otherwise

    • getStreamCapability

      MediaDirection getStreamCapability(StreamType streamType)
      Get the stream capability of the device.

      The capability information represents the capability for the #ParticipantDevice
      to handle a given stream type (audio, video or text).
      Parameters:
      streamType - A StreamType
      Returns:
      the capability of stream of type stream_type of the device MediaDirection

    • addListener

      void addListener(ParticipantDeviceListener listener)

    • removeListener

      void removeListener(ParticipantDeviceListener listener)

    • setUserData

      void setUserData(Object data)
      Sets the object to store in this object user's data
      Parameters:
      data - the object to store

    • getUserData

      Object getUserData()
      Gets the object stored in this object user's data
      Returns:
      the object store if any, null otherwise

    • getNativePointer

      long getNativePointer()
      Gets the native pointer used by this class to make native method calls.
      Returns:
      the nativer pointer, as long

    • toString

      String toString()
      Overrides:
      toString in class Object