Liblinphone  5.5.0
Linphone.ParticipantDevice Class Reference
Inheritance diagram for Linphone.ParticipantDevice:
Linphone.LinphoneObject

Public Member Functions

IntPtr CreateNativeVideoWindowId (IntPtr context)
 
IntPtr CreateNativeVideoWindowId ()
 
uint GetSsrc (Linphone.StreamType streamType)
 
bool GetStreamAvailability (Linphone.StreamType streamType)
 
Linphone.MediaDirection GetStreamCapability (Linphone.StreamType streamType)
 
string GetStreamLabel (Linphone.StreamType streamType)
 

Properties

ParticipantDeviceListener Listener [get, set]
 
Linphone.Address Address [get]
 
Linphone.ParticipantDeviceDisconnectionMethod DisconnectionMethod [get]
 
string DisconnectionReason [get]
 
bool IsInConference [get]
 
bool IsMe [get]
 
bool IsMuted [get]
 
bool IsSpeaking [get]
 
Linphone.ParticipantDeviceJoiningMethod JoiningMethod [get]
 
string Name [get]
 
IntPtr NativeVideoWindowId [get, set]
 
Linphone.Participant Participant [get]
 
bool ScreenSharingEnabled [get]
 
Linphone.ChatRoomSecurityLevel SecurityLevel [get]
 
Linphone.ParticipantDeviceState State [get]
 
uint ThumbnailSsrc [get]
 
bool ThumbnailStreamAvailability [get]
 
Linphone.MediaDirection ThumbnailStreamCapability [get]
 
string ThumbnailStreamLabel [get]
 
long TimeOfDisconnection [get]
 
long TimeOfJoining [get]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

This object represents a unique device for a member of a Linphone.Conference or Linphone.ChatRoom.

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

Member Function Documentation

IntPtr Linphone.ParticipantDevice.CreateNativeVideoWindowId ( IntPtr  context)
inline

Creates a window ID and return it.

See : linphone_core_set_native_video_window_id for a general discussion about window IDs.

A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used. A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used.

Parameters
contextpreallocated Window ID (Used only for MSOGL)
Returns
the native video window id (type may vary depending on platform).
IntPtr Linphone.ParticipantDevice.CreateNativeVideoWindowId ( )
inline

Creates a window ID and return it.

See : linphone_core_set_native_video_window_id for a general discussion about window IDs.

Returns
the native video window id (type may vary depending on platform).
uint Linphone.ParticipantDevice.GetSsrc ( Linphone.StreamType  streamType)
inline

Get the audio stream SSRC of the device.

Parameters
streamTypeA Linphone.StreamType
Returns
the stream's SSRC of the device
bool Linphone.ParticipantDevice.GetStreamAvailability ( Linphone.StreamType  streamType)
inline

Gets 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 Linphone.ParticipantDevice

Parameters
streamTypeA Linphone.StreamType
Returns
true if the stream of type stream_type is available for device, false otherwise
Linphone.MediaDirection Linphone.ParticipantDevice.GetStreamCapability ( Linphone.StreamType  streamType)
inline

Gets the stream capability of the device.

The capability information represents the capability for the Linphone.ParticipantDevice to handle a given stream type (audio, video or text).

Parameters
streamTypeA Linphone.StreamType
Returns
the capability of stream of type stream_type of the device Linphone.MediaDirection
string Linphone.ParticipantDevice.GetStreamLabel ( Linphone.StreamType  streamType)
inline

Gets the stream label of the device.

The capability information represents the capability for the Linphone.ParticipantDevice to handle a given stream type (audio, video or text).

Parameters
streamTypeA Linphone.StreamType
Returns
the label of stream of type stream_type of the device

Property Documentation

Linphone.Address Linphone.ParticipantDevice.Address
get

Gets the address of a participant's device.

Returns
The Linphone.Address of the participant's device
Linphone.ParticipantDeviceDisconnectionMethod Linphone.ParticipantDevice.DisconnectionMethod
get

Gets the disconnection method.

Returns
disconnection method Linphone.ParticipantDeviceDisconnectionMethod
string Linphone.ParticipantDevice.DisconnectionReason
get

Gets the disconnection reason.

Returns
disconnection reason
bool Linphone.ParticipantDevice.IsInConference
get

Returns whether the participant device is in a conference or not.

Returns
a boolean to state whether the device is in a conference
bool Linphone.ParticipantDevice.IsMe
get

Tells whether the participant device is Me.

Returns
true if the participant is me, false otherwise.
bool Linphone.ParticipantDevice.IsMuted
get

Returns whether the participant device is muted or not.

Returns
true if the participant device is muted, false otherwise.
bool Linphone.ParticipantDevice.IsSpeaking
get

Returns whether the participant device is speaking or not.

Returns
true if the participant device is speaking, false otherwise.
Linphone.ParticipantDeviceJoiningMethod Linphone.ParticipantDevice.JoiningMethod
get

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

Returns
joining method or focus owner Linphone.ParticipantDeviceJoiningMethod
string Linphone.ParticipantDevice.Name
get

Returns the name of the device.

Returns
the name of the device or null.
IntPtr Linphone.ParticipantDevice.NativeVideoWindowId
getset

Gets the native window ID where video for this participant device is to be rendered.

Returns
the window ID of the device
Linphone.Participant Linphone.ParticipantDevice.Participant
get

Returns the Linphone.Participant this Linphone.ParticipantDevice belongs to.

Returns
the Linphone.Participant this device belongs to
bool Linphone.ParticipantDevice.ScreenSharingEnabled
get

Returns whether the participant device is screen sharing or not.

Returns
true if the participant device is screen sharing, false otherwise.
Linphone.ChatRoomSecurityLevel Linphone.ParticipantDevice.SecurityLevel
get

Gets the security level of a participant's device.

Returns
The Linphone.ChatRoomSecurityLevel of the device
Linphone.ParticipantDeviceState Linphone.ParticipantDevice.State
get

Gets the state of a participant device.

Returns
The Linphone.ParticipantDeviceState of the device
uint Linphone.ParticipantDevice.ThumbnailSsrc
get

Get the thumbnail stream SSRC of the device.

Returns
the thumbnail stream's SSRC of the device
bool Linphone.ParticipantDevice.ThumbnailStreamAvailability
get

Gets 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 Linphone.ParticipantDevice

Returns
true if the stream of type stream_type is available for device, false otherwise
Linphone.MediaDirection Linphone.ParticipantDevice.ThumbnailStreamCapability
get

Gets the thumbnail stream capability of the device.

Returns
the capability of the thumbnail stream of the device Linphone.MediaDirection
string Linphone.ParticipantDevice.ThumbnailStreamLabel
get

Gets the thumbnail stream label of the device.

Returns
the label of the thumbnail stream of the device
long Linphone.ParticipantDevice.TimeOfDisconnection
get

Gets 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:00:00 of the 1st of January 1970
long Linphone.ParticipantDevice.TimeOfJoining
get

Gets the timestamp the device joined a conference.

Returns
time of joining a conference expressed as a number of seconds since 00:00:00 of the 1st of January 1970

The documentation for this class was generated from the following file: