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

Public Member Functions

void AddParticipant (Linphone.Address participant)
 
void AddParticipant (Linphone.ParticipantInfo participantInfo)
 
void AddParticipantInfos (IEnumerable< Linphone.ParticipantInfo > participantInfos)
 
Linphone.ConferenceInfo Clone ()
 
Linphone.ParticipantInfo FindParticipant (Linphone.Address participant)
 
bool GetCapability (Linphone.StreamType streamType)
 
void RemoveParticipant (Linphone.Address participant)
 
void SetCapability (Linphone.StreamType streamType, bool enable)
 
void UpdateParticipant (Linphone.ParticipantInfo participantInfo)
 

Properties

string CcmpUri [get, set]
 
long DateTime [get, set]
 
string Description [get, set]
 
string DescriptionUtf8 [get, set]
 
uint Duration [get, set]
 
string IcalendarString [get]
 
string IcsUid [get, set]
 
Linphone.Address Organizer [get, set]
 
Linphone.ParticipantInfo OrganizerInfo [get, set]
 
IEnumerable< Linphone.ParticipantInfoParticipantInfos [get, set]
 
IEnumerable< Linphone.AddressParticipants [get, set]
 
Linphone.ConferenceSecurityLevel SecurityLevel [get, set]
 
Linphone.ConferenceInfoState State [get]
 
string Subject [get, set]
 
string SubjectUtf8 [get, set]
 
Linphone.Address Uri [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

Object defining all information related to a past or future conference.

Member Function Documentation

void Linphone.ConferenceInfo.AddParticipant ( Linphone.Address  participant)
inline

Add a participant to the conference.

Parameters
participantThe participant (Linphone.Address) to add.
void Linphone.ConferenceInfo.AddParticipant ( Linphone.ParticipantInfo  participantInfo)
inline

Add a participant to the conference.

Parameters
participantInfoThe participant information (Linphone.ParticipantInfo) to add. This method can be called to set attributes such as the role to the organizer of the conference
void Linphone.ConferenceInfo.AddParticipantInfos ( IEnumerable< Linphone.ParticipantInfo participantInfos)
inline

Add a list of participants.

Parameters
participantInfosThe list of participant informations to add. A list of Linphone.ParticipantInfo objects.
Linphone.ConferenceInfo Linphone.ConferenceInfo.Clone ( )
inline

Clone an object Linphone.ConferenceInfo.

Returns
the cloned Linphone.ConferenceInfo object.
Linphone.ParticipantInfo Linphone.ConferenceInfo.FindParticipant ( Linphone.Address  participant)
inline

Find a participant information in the conference information.

Parameters
participantThe participant (Linphone.Address) to search.
Returns
The participant information (Linphone.ParticipantInfo).
bool Linphone.ConferenceInfo.GetCapability ( Linphone.StreamType  streamType)
inline

Get the capability of the conference.

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

Parameters
streamTypeA Linphone.StreamType
Returns
the capability of the conference linked to conference information Linphone.ConferenceInfo
void Linphone.ConferenceInfo.RemoveParticipant ( Linphone.Address  participant)
inline

Remove a participant from the conference.

Parameters
participantThe participant (Linphone.Address) to remove.
void Linphone.ConferenceInfo.SetCapability ( Linphone.StreamType  streamType,
bool  enable 
)
inline

Sets the capability of the conference.

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

Parameters
streamTypeA Linphone.StreamType
enablethe capability of the conference linked to conference information Linphone.ConferenceInfo
void Linphone.ConferenceInfo.UpdateParticipant ( Linphone.ParticipantInfo  participantInfo)
inline

Update the participant information in the conference informations.

Parameters
participantInfoThe participant information (Linphone.ParticipantInfo) to update. This method can be called to change attributes such as the role to the organizer of the conference

Property Documentation

string Linphone.ConferenceInfo.CcmpUri
getset

Retrieve the CCMP URI of the conference.

Returns
The URI of the conference stored in the CCMP server.
long Linphone.ConferenceInfo.DateTime
getset

Retrieve the date and time of the conference.

Returns
The date and time of the conference.
string Linphone.ConferenceInfo.Description
getset

Retrieve the description of the conference.

Returns
The description of the conference.
string Linphone.ConferenceInfo.DescriptionUtf8
getset

Retrieve the description of the conference.

Returns
The description of the conference.
uint Linphone.ConferenceInfo.Duration
getset

Retrieve the duration (in minutes) of the conference.

Returns
The duration of the conference.
string Linphone.ConferenceInfo.IcalendarString
get

Retrieve the conference as an Icalendar string.

Returns
The conference as an Icalendar string. The returned char* must be freed by the caller.
string Linphone.ConferenceInfo.IcsUid
getset

Retrieve the ICS UID linked to a conference info.

Returns
the ICS UID.
Linphone.Address Linphone.ConferenceInfo.Organizer
getset

Retrieve the organizer of the conference.

Returns
The Linphone.Address of the conference's organizer.
Linphone.ParticipantInfo Linphone.ConferenceInfo.OrganizerInfo
getset

Retrieve the organizer of the conference.

Returns
The Linphone.ParticipantInfo of the conference's organizer.
IEnumerable<Linphone.ParticipantInfo> Linphone.ConferenceInfo.ParticipantInfos
getset

Retrieve the list of participants as list of participant infos.

Returns
The list of participant informations. A list of Linphone.ParticipantInfo objects.
IEnumerable<Linphone.Address> Linphone.ConferenceInfo.Participants
getset

Retrieve the list of participants as list of addresses.

Returns
The list of participants. A list of Linphone.Address objects.

Deprecated : 24/08/2023 use linphone_conference_info_get_participant_infos instead

Linphone.ConferenceSecurityLevel Linphone.ConferenceInfo.SecurityLevel
getset

Retrieve the desired security level of the conference.

Returns
The desired security level of the conference.
Linphone.ConferenceInfoState Linphone.ConferenceInfo.State
get

Retrieve the state of the conference info.

Returns
Linphone.ConferenceInfoState object.
string Linphone.ConferenceInfo.Subject
getset

Retrieve the subject of the conference.

Returns
The subject of the conference.
string Linphone.ConferenceInfo.SubjectUtf8
getset

Retrieve the subject of the conference.

Returns
The subject of the conference.
Linphone.Address Linphone.ConferenceInfo.Uri
get

Retrieve the URI of the conference.

Returns
The URI of the conference (Linphone.Address).

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