Class ConferenceParams
Object defining parameters for a 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; }
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 |
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. |
Description
Get conference description.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String | the conference description. |
EndTime
Get the end time of the conference.
Declaration
public long EndTime { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 | end time of a conference as time_t type or 0 for open end of a conference. For UNIX based systems it is the number of seconds since 00:00hours of the 1st of January 1970 |
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 |
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 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. |
StartTime
Get the start time of the conference.
Declaration
public long StartTime { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 | start time of a conference as time_t type or 0 for immediate start of a conference. For UNIX based systems it is the number of seconds since 00:00hours of the 1st of January 1970 |
Subject
Get conference subject.
Declaration
public string Subject { get; set; }
Property Value
Type | Description |
---|---|
System.String | the 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 ConferenceParams.
Declaration
public ConferenceParams Clone()
Returns
Type | Description |
---|---|
ConferenceParams | An allocated ConferenceParams with the same parameters than params |