Class 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 Address. 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 Devices.
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class ParticipantDevice : LinphoneObject
Properties
Address
Get the address of a participant's device.
Declaration
public Address Address { get; }
Property Value
Type | Description |
---|---|
Address | The Address of the participant's device |
DisconnectionMethod
Get the disconnection method.
Declaration
public ParticipantDeviceDisconnectionMethod DisconnectionMethod { get; }
Property Value
Type | Description |
---|---|
ParticipantDeviceDisconnectionMethod | disconnection method ParticipantDeviceDisconnectionMethod |
DisconnectionReason
Get the disconnection reason.
Declaration
public string DisconnectionReason { get; }
Property Value
Type | Description |
---|---|
System.String | disconnection reason |
IsInConference
Return whether the participant device is in a conference or not.
Declaration
public bool IsInConference { get; }
Property Value
Type | Description |
---|---|
System.Boolean | a boolean to state whether the device is in a conference |
IsMuted
Return whether the participant device is muted or not.
Declaration
public bool IsMuted { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the participant device is muted, false otherwise. |
IsSpeaking
Return whether the participant device is speaking or not.
Declaration
public bool IsSpeaking { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the participant device is speaking, false otherwise. |
JoiningMethod
Get the joining method or it the device is the focus owner.
Declaration
public ParticipantDeviceJoiningMethod JoiningMethod { get; }
Property Value
Type | Description |
---|---|
ParticipantDeviceJoiningMethod | joining method or focus owner ParticipantDeviceJoiningMethod |
Listener
Declaration
public ParticipantDeviceListener Listener { get; set; }
Property Value
Type | Description |
---|---|
ParticipantDeviceListener |
Name
Return the name of the device or null.
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
System.String | the name of the device or null. |
NativeVideoWindowId
Get window ID.
Declaration
public IntPtr NativeVideoWindowId { get; set; }
Property Value
Type | Description |
---|---|
System.IntPtr | the window ID of the device |
ScreenSharingEnabled
Return whether the participant device is screen sharing or not.
Declaration
public bool ScreenSharingEnabled { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the participant device is screen sharing, false otherwise. |
SecurityLevel
Get the security level of a participant's device.
Declaration
public ChatRoomSecurityLevel SecurityLevel { get; }
Property Value
Type | Description |
---|---|
ChatRoomSecurityLevel | The ChatRoomSecurityLevel of the device |
State
Get the state of a participant device.
Declaration
public ParticipantDeviceState State { get; }
Property Value
Type | Description |
---|---|
ParticipantDeviceState | The ParticipantDeviceState of the device |
ThumbnailSsrc
Get the thumbnail stream SSRC of the device.
Declaration
public uint ThumbnailSsrc { get; }
Property Value
Type | Description |
---|---|
System.UInt32 | the thumbnail stream's SSRC of the device |
ThumbnailStreamAvailability
Get the thumbnail 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
Declaration
public bool ThumbnailStreamAvailability { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the stream of type stream_type is available for device, false otherwise |
ThumbnailStreamCapability
Get the thumbnail stream capability of the device.
Declaration
public MediaDirection ThumbnailStreamCapability { get; }
Property Value
Type | Description |
---|---|
MediaDirection | the capability of the thumbnail stream of the device MediaDirection |
TimeOfDisconnection
Get the timestamp the device left a conference.
Declaration
public long TimeOfDisconnection { get; }
Property Value
Type | Description |
---|---|
System.Int64 | 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 |
TimeOfJoining
Get the timestamp the device joined a conference.
Declaration
public long TimeOfJoining { get; }
Property Value
Type | Description |
---|---|
System.Int64 | 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 |
Methods
CreateNativeVideoWindowId()
Create a window ID and return it.
Declaration
public IntPtr CreateNativeVideoWindowId()
Returns
Type | Description |
---|---|
System.IntPtr | the window ID of the device |
GetSsrc(StreamType)
Get the stream SSRC of the device.
Declaration
public uint GetSsrc(StreamType streamType)
Parameters
Type | Name | Description |
---|---|---|
StreamType | streamType |
Returns
Type | Description |
---|---|
System.UInt32 | the stream's SSRC of the device |
GetStreamAvailability(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
Declaration
public bool GetStreamAvailability(StreamType streamType)
Parameters
Type | Name | Description |
---|---|---|
StreamType | streamType |
Returns
Type | Description |
---|---|
System.Boolean | true if the stream of type stream_type is available for device, false otherwise |
GetStreamCapability(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).
Declaration
public MediaDirection GetStreamCapability(StreamType streamType)
Parameters
Type | Name | Description |
---|---|---|
StreamType | streamType |
Returns
Type | Description |
---|---|
MediaDirection | the capability of stream of type stream_type of the device MediaDirection |