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

Public Member Functions

Linphone.ConferenceParams Clone ()
 

Properties

Linphone.Account Account [get, set]
 
bool AudioEnabled [get, set]
 
bool ChatEnabled [get, set]
 
Linphone.ChatParams ChatParams [get]
 
Linphone.Address ConferenceFactoryAddress [get, set]
 
string DescriptionUtf8 [get, set]
 
bool GroupEnabled [get, set]
 
bool Hidden [set]
 
bool IsAudioEnabled [get]
 
bool IsChatEnabled [get]
 
bool IsHidden [get]
 
bool IsLocalParticipantEnabled [get]
 
bool IsOneParticipantConferenceEnabled [get]
 
bool IsValid [get]
 
bool IsVideoEnabled [get]
 
bool LocalParticipantEnabled [get, set]
 
bool OneParticipantConferenceEnabled [get, set]
 
Linphone.ConferenceParticipantListType ParticipantListType [get, set]
 
Linphone.ProxyConfig ProxyCfg [get]
 
Linphone.ConferenceSecurityLevel SecurityLevel [get, set]
 
string Subject [get, set]
 
string SubjectUtf8 [get, set]
 
bool VideoEnabled [get, set]
 

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 parameters for a Linphone.Conference.

Can be created by calling function Linphone.Core.CreateConferenceParams().

Member Function Documentation

Linphone.ConferenceParams Linphone.ConferenceParams.Clone ( )
inline

Clone a Linphone.ConferenceParams.

Returns
An allocated Linphone.ConferenceParams with the same parameters than params

Property Documentation

Linphone.Account Linphone.ConferenceParams.Account
getset

Returns the account for the conference.

Returns
a pointer to the account or null if it is not set.
bool Linphone.ConferenceParams.AudioEnabled
getset

Check whether audio capabilities are enabled.

Returns
true if the conference supports audio capabilities, false otherwise
bool Linphone.ConferenceParams.ChatEnabled
getset

Check whether chat capabilities are enabled.

Returns
true if the conference supports chat capabilities, false otherwise
Linphone.ChatParams Linphone.ConferenceParams.ChatParams
get

Get the chat parameters.

Returns
the chat parameters if chat capabilities are on, null otherwise
Linphone.Address Linphone.ConferenceParams.ConferenceFactoryAddress
getset

Get the conference factory address of the conference that has been set.

Returns
the factory address conference description.
string Linphone.ConferenceParams.DescriptionUtf8
getset

Get conference description (utf8).

Returns
the conference description.
bool Linphone.ConferenceParams.GroupEnabled
getset

Get the group chat status of the text capabilities of the conference associated with the given parameters.

Returns
true if group chat is enabled, false if one-on-one
bool Linphone.ConferenceParams.Hidden
set

Set the conference as hidden.

This means that the contact address will not have any conference releated attribute such as isfocus, the conference ID and the admin status.

Parameters
hiddenBoolean that states whether the conference is hidden or not
bool Linphone.ConferenceParams.IsAudioEnabled
get

Check whether audio capabilities are enabled.

Returns
true if the conference supports audio capabilities, false otherwise

Deprecated : 16/12/2021 Use Linphone.ConferenceParams.AudioEnabled() instead.

bool Linphone.ConferenceParams.IsChatEnabled
get

Check whether chat capabilities are enabled.

Returns
true if the conference supports chat capabilities, false otherwise

Deprecated : 16/12/2021 Use Linphone.ConferenceParams.ChatEnabled() instead.

bool Linphone.ConferenceParams.IsHidden
get

Get the value of the hidden flag.

Returns
whether the conference is hidden or not
bool Linphone.ConferenceParams.IsLocalParticipantEnabled
get

Returns whether local participant has to enter the conference.

Returns
true if local participant is by default part of the conference, false otherwise

Deprecated : 16/12/2021 Use Linphone.ConferenceParams.LocalParticipantEnabled() instead.

bool Linphone.ConferenceParams.IsOneParticipantConferenceEnabled
get

Returns whether conference can have only one participant.

Returns
true if the conference can have only one participant, false otherwise

Deprecated : 16/12/2021 Use Linphone.ConferenceParams.OneParticipantConferenceEnabled() instead.

bool Linphone.ConferenceParams.IsValid
get

Returns whether the given parameters are valid or not.

Returns
true if the given parameters are valid, false otherwise
bool Linphone.ConferenceParams.IsVideoEnabled
get

Check whether video capabilities are enabled.

Returns
true if the conference supports video capabilities, false otherwise

Deprecated : 16/12/2021 Use Linphone.ConferenceParams.VideoEnabled() instead.

bool Linphone.ConferenceParams.LocalParticipantEnabled
getset

Returns whether local participant has to enter the conference.

Returns
true if local participant is by default part of the conference, false otherwise
bool Linphone.ConferenceParams.OneParticipantConferenceEnabled
getset

Returns whether conference can have only one participant.

Returns
true if the conference can have only one participant, false otherwise
Linphone.ConferenceParticipantListType Linphone.ConferenceParams.ParticipantListType
getset

Get the participant list type.

Returns
participant list type Linphone.ConferenceParticipantListType.
Linphone.ProxyConfig Linphone.ConferenceParams.ProxyCfg
get

Returns the proxy configuration for the conference.

Returns
a pointer to the proxy configuration or null if it is not set.

Deprecated : 11/01/2022 Use Linphone.ConferenceParams.Account instead.

Linphone.ConferenceSecurityLevel Linphone.ConferenceParams.SecurityLevel
getset

Retrieve the desired security level of the conference.

Returns
The desired security level of the conference.
string Linphone.ConferenceParams.Subject
getset

Get the conference subject.

Returns
conference subject.
string Linphone.ConferenceParams.SubjectUtf8
getset

Get the conference subject as an UTF-8 string.

Returns
conference subject.
bool Linphone.ConferenceParams.VideoEnabled
getset

Check whether video capabilities are enabled.

Returns
true if the conference supports video capabilities, false otherwise

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