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 Summary

Modifier and Type	Method	Description
void	addListener(ParticipantDeviceListener listener)
java.lang.Object	createNativeVideoWindowId()	Create a window ID and return it.
Address	getAddress()	Get the address of a participant's device.
ParticipantDeviceDisconnectionMethod	getDisconnectionMethod()	Get the disconnection method.
java.lang.String	getDisconnectionReason()	Get the disconnection reason.
boolean	getIsMuted()	Return whether the participant device is muted or not.
boolean	getIsSpeaking()	Return whether the participant device is speaking or not.
ParticipantDeviceJoiningMethod	getJoiningMethod()	Get the joining method or it the device is the focus owner.
java.lang.String	getName()	Return the name of the device or null.
long	getNativePointer()	Gets the native pointer used by this class to make native method calls.
java.lang.Object	getNativeVideoWindowId()	Get window ID.
ChatRoomSecurityLevel	getSecurityLevel()	Get the security level of a participant's device.
int	getSsrc(StreamType streamType)	Get the audio stream SSRC of the device.
ParticipantDeviceState	getState()	Get the state of a participant device.
boolean	getStreamAvailability(StreamType streamType)	Get the stream availability of the device.
MediaDirection	getStreamCapability(StreamType streamType)	Get the stream capability of the device.
long	getTimeOfDisconnection()	Get the timestamp the device left a conference.
long	getTimeOfJoining()	Get the timestamp the device joined a conference.
java.lang.Object	getUserData()	Gets the object stored in this object user's data
boolean	isInConference()	Return whether the participant device is in a conference or not.
void	removeListener(ParticipantDeviceListener listener)
void	setNativeVideoWindowId(java.lang.Object windowId)	Set window ID for a device.
void	setUserData(java.lang.Object data)	Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getAddress

@NonNull
Address getAddress()

Get the address of a participant's device.

Returns:

The Address of the participant's device

getDisconnectionMethod

ParticipantDeviceDisconnectionMethod getDisconnectionMethod()

Get the disconnection method.

Returns:

disconnection method ParticipantDeviceDisconnectionMethod

getDisconnectionReason

@Nullable
java.lang.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

ParticipantDeviceJoiningMethod getJoiningMethod()

Get the joining method or it the device is the focus owner.

Returns:

joining method or focus owner ParticipantDeviceJoiningMethod

getName

@Nullable
java.lang.String getName()

Return the name of the device or null.

Returns:

the name of the device or null.

getNativeVideoWindowId

@Nullable
java.lang.Object getNativeVideoWindowId()

Get window ID.

Returns:

the window ID of the device

setNativeVideoWindowId

void setNativeVideoWindowId(@Nullable
                            java.lang.Object windowId)

Set window ID for a device.

Parameters:

windowId - the window ID of the device

getSecurityLevel

ChatRoomSecurityLevel getSecurityLevel()

Get the security level of a participant's device.

Returns:

The ChatRoomSecurityLevel of the device

getState

ParticipantDeviceState getState()

Get the state of a participant device.

Returns:

The ParticipantDeviceState 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
java.lang.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(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.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

java.lang.String toString()

Overrides:

toString in class java.lang.Object