Class ConferenceParams
Object defining parameters for a Linphone.Conference.
Can be created by calling function
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class ConferenceParams : LinphoneObject
Properties
Account
Returns the account for the conference.
Declaration
public Account Account { get; set; }
Property Value
| Type | Description |
|---|---|
| Account | a pointer to the account or null if it is not set. |
AudioEnabled
Check whether audio capabilities are enabled.
Declaration
public bool AudioEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference supports audio capabilities, false otherwise |
ChatEnabled
Check whether chat capabilities are enabled.
Declaration
public bool ChatEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference supports chat capabilities, false otherwise |
ChatParams
Get the chat parameters.
Declaration
public ChatParams ChatParams { get; }
Property Value
| Type | Description |
|---|---|
| ChatParams | the chat parameters if chat capabilities are on, null otherwise |
ConferenceFactoryAddress
Get the conference factory address of the conference that has been set.
Declaration
public Address ConferenceFactoryAddress { get; set; }
Property Value
| Type | Description |
|---|---|
| Address | the factory address conference description. |
DescriptionUtf8
Get conference description (utf8).
Declaration
public string DescriptionUtf8 { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the conference description. |
GroupEnabled
Get the group chat status of the text capabilities of the conference associated with the given parameters.
Declaration
public bool GroupEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if group chat is enabled, false if one-to-one |
Hidden
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.
Declaration
public bool Hidden { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsAudioEnabled
Check whether audio capabilities are enabled.
Declaration
public bool IsAudioEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference supports audio capabilities, false otherwise |
IsChatEnabled
Check whether chat capabilities are enabled.
Declaration
public bool IsChatEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference supports chat capabilities, false otherwise |
IsHidden
Get the value of the hidden flag.
Declaration
public bool IsHidden { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | whether the conference is hidden or not |
IsLocalParticipantEnabled
Returns whether local participant has to enter the conference.
Declaration
public bool IsLocalParticipantEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if local participant is by default part of the conference, false otherwise |
IsOneParticipantConferenceEnabled
Returns whether conference can have only one participant.
Declaration
public bool IsOneParticipantConferenceEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference can have only one participant, false otherwise |
IsValid
Returns whether the given parameters are valid or not.
Declaration
public bool IsValid { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the given parameters are valid, false otherwise |
IsVideoEnabled
Check whether video capabilities are enabled.
Declaration
public bool IsVideoEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference supports video capabilities, false otherwise |
LocalParticipantEnabled
Returns whether local participant has to enter the conference.
Declaration
public bool LocalParticipantEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if local participant is by default part of the conference, false otherwise |
OneParticipantConferenceEnabled
Returns whether conference can have only one participant.
Declaration
public bool OneParticipantConferenceEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference can have only one participant, false otherwise |
ParticipantListType
Get the participant list type.
Declaration
public ConferenceParticipantListType ParticipantListType { get; set; }
Property Value
| Type | Description |
|---|---|
| ConferenceParticipantListType | participant list type Linphone.ConferenceParticipantListType. |
ProxyCfg
Returns the proxy configuration for the conference.
Declaration
public ProxyConfig ProxyCfg { get; }
Property Value
| Type | Description |
|---|---|
| ProxyConfig | a pointer to the proxy configuration or null if it is not set. |
SecurityLevel
Retrieve the desired security level of the conference.
Declaration
public ConferenceSecurityLevel SecurityLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| ConferenceSecurityLevel | The desired security level of the conference. |
Subject
Get the conference subject.
Declaration
public string Subject { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | conference subject. |
SubjectUtf8
Get the conference subject as an UTF-8 string.
Declaration
public string SubjectUtf8 { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | conference subject. |
VideoEnabled
Check whether video capabilities are enabled.
Declaration
public bool VideoEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the conference supports video capabilities, false otherwise |
Methods
Clone()
Clone a Linphone.ConferenceParams.
Declaration
public ConferenceParams Clone()
Returns
| Type | Description |
|---|---|
| ConferenceParams | An allocated Linphone.ConferenceParams with the same parameters than params |