• Api Documentation
Show / Hide Table of Contents
  • Linphone
    • Account
    • AccountCreator
    • AccountCreatorActivationCodeStatus
    • AccountCreatorAlgoStatus
    • AccountCreatorBackend
    • AccountCreatorDomainStatus
    • AccountCreatorEmailStatus
    • AccountCreatorLanguageStatus
    • AccountCreatorListener
    • AccountCreatorListener.OnAccountCreationRequestTokenDelegate
    • AccountCreatorListener.OnAccountCreationTokenUsingRequestTokenDelegate
    • AccountCreatorListener.OnActivateAccountDelegate
    • AccountCreatorListener.OnActivateAliasDelegate
    • AccountCreatorListener.OnCreateAccountDelegate
    • AccountCreatorListener.OnIsAccountActivatedDelegate
    • AccountCreatorListener.OnIsAccountExistDelegate
    • AccountCreatorListener.OnIsAccountLinkedDelegate
    • AccountCreatorListener.OnIsAliasUsedDelegate
    • AccountCreatorListener.OnLinkAccountDelegate
    • AccountCreatorListener.OnLoginLinphoneAccountDelegate
    • AccountCreatorListener.OnRecoverAccountDelegate
    • AccountCreatorListener.OnSendTokenDelegate
    • AccountCreatorListener.OnUpdateAccountDelegate
    • AccountCreatorPasswordStatus
    • AccountCreatorPhoneNumberStatus
    • AccountCreatorStatus
    • AccountCreatorTransportStatus
    • AccountCreatorUsernameStatus
    • AccountListener
    • AccountListener.OnRegistrationStateChangedDelegate
    • AccountParams
    • Address
    • AddressFamily
    • Alert
    • AlertListener
    • AlertListener.OnTerminatedDelegate
    • AlertType
    • AudioDevice
    • AudioDeviceCapabilities
    • AudioDeviceType
    • AuthInfo
    • AuthMethod
    • AVPFMode
    • Buffer
    • Call
    • CallDir
    • CallListener
    • CallListener.OnAckProcessingDelegate
    • CallListener.OnAudioDeviceChangedDelegate
    • CallListener.OnCameraNotWorkingDelegate
    • CallListener.OnDtmfReceivedDelegate
    • CallListener.OnEncryptionChangedDelegate
    • CallListener.OnGoclearAckSentDelegate
    • CallListener.OnInfoMessageReceivedDelegate
    • CallListener.OnNextVideoFrameDecodedDelegate
    • CallListener.OnReceiveMasterKeyChangedDelegate
    • CallListener.OnRemoteRecordingDelegate
    • CallListener.OnSendMasterKeyChangedDelegate
    • CallListener.OnSnapshotTakenDelegate
    • CallListener.OnStateChangedDelegate
    • CallListener.OnStatsUpdatedDelegate
    • CallListener.OnTmmbrReceivedDelegate
    • CallListener.OnTransferStateChangedDelegate
    • CallListener.OnVideoDisplayErrorOccurredDelegate
    • CallLog
    • CallParams
    • CallState
    • CallStats
    • CallStatus
    • ChatMessage
    • ChatMessageDirection
    • ChatMessageListener
    • ChatMessageListener.OnEphemeralMessageDeletedDelegate
    • ChatMessageListener.OnEphemeralMessageTimerStartedDelegate
    • ChatMessageListener.OnFileTransferProgressIndicationDelegate
    • ChatMessageListener.OnFileTransferRecvDelegate
    • ChatMessageListener.OnFileTransferSendChunkDelegate
    • ChatMessageListener.OnFileTransferSendDelegate
    • ChatMessageListener.OnMsgStateChangedDelegate
    • ChatMessageListener.OnNewMessageReactionDelegate
    • ChatMessageListener.OnParticipantImdnStateChangedDelegate
    • ChatMessageListener.OnReactionRemovedDelegate
    • ChatMessageReaction
    • ChatMessageState
    • ChatRoom
    • ChatRoomBackend
    • ChatRoomCapabilities
    • ChatRoomEncryptionBackend
    • ChatRoomEphemeralMode
    • ChatRoomListener
    • ChatRoomListener.OnChatMessageParticipantImdnStateChangedDelegate
    • ChatRoomListener.OnChatMessageReceivedDelegate
    • ChatRoomListener.OnChatMessageSendingDelegate
    • ChatRoomListener.OnChatMessageSentDelegate
    • ChatRoomListener.OnChatMessageShouldBeStoredDelegate
    • ChatRoomListener.OnChatMessagesReceivedDelegate
    • ChatRoomListener.OnChatRoomReadDelegate
    • ChatRoomListener.OnConferenceAddressGenerationDelegate
    • ChatRoomListener.OnConferenceJoinedDelegate
    • ChatRoomListener.OnConferenceLeftDelegate
    • ChatRoomListener.OnEphemeralEventDelegate
    • ChatRoomListener.OnEphemeralMessageDeletedDelegate
    • ChatRoomListener.OnEphemeralMessageTimerStartedDelegate
    • ChatRoomListener.OnIsComposingReceivedDelegate
    • ChatRoomListener.OnMessageReceivedDelegate
    • ChatRoomListener.OnMessagesReceivedDelegate
    • ChatRoomListener.OnNewEventDelegate
    • ChatRoomListener.OnNewEventsDelegate
    • ChatRoomListener.OnParticipantAddedDelegate
    • ChatRoomListener.OnParticipantAdminStatusChangedDelegate
    • ChatRoomListener.OnParticipantDeviceAddedDelegate
    • ChatRoomListener.OnParticipantDeviceMediaAvailabilityChangedDelegate
    • ChatRoomListener.OnParticipantDeviceRemovedDelegate
    • ChatRoomListener.OnParticipantDeviceStateChangedDelegate
    • ChatRoomListener.OnParticipantRegistrationSubscriptionRequestedDelegate
    • ChatRoomListener.OnParticipantRegistrationUnsubscriptionRequestedDelegate
    • ChatRoomListener.OnParticipantRemovedDelegate
    • ChatRoomListener.OnSecurityEventDelegate
    • ChatRoomListener.OnStateChangedDelegate
    • ChatRoomListener.OnSubjectChangedDelegate
    • ChatRoomListener.OnUndecryptableMessageReceivedDelegate
    • ChatRoomParams
    • ChatRoomSecurityLevel
    • ChatRoomState
    • CodecPriorityPolicy
    • Conference
    • ConferenceInfo
    • ConferenceInfoState
    • ConferenceJoiningMode
    • ConferenceLayout
    • ConferenceListener
    • ConferenceListener.OnActiveSpeakerParticipantDeviceDelegate
    • ConferenceListener.OnAudioDeviceChangedDelegate
    • ConferenceListener.OnAvailableMediaChangedDelegate
    • ConferenceListener.OnParticipantAddedDelegate
    • ConferenceListener.OnParticipantAdminStatusChangedDelegate
    • ConferenceListener.OnParticipantDeviceAddedDelegate
    • ConferenceListener.OnParticipantDeviceIsMutedDelegate
    • ConferenceListener.OnParticipantDeviceIsSpeakingChangedDelegate
    • ConferenceListener.OnParticipantDeviceMediaAvailabilityChangedDelegate
    • ConferenceListener.OnParticipantDeviceMediaCapabilityChangedDelegate
    • ConferenceListener.OnParticipantDeviceRemovedDelegate
    • ConferenceListener.OnParticipantDeviceStateChangedDelegate
    • ConferenceListener.OnParticipantRemovedDelegate
    • ConferenceListener.OnParticipantRoleChangedDelegate
    • ConferenceListener.OnStateChangedDelegate
    • ConferenceListener.OnSubjectChangedDelegate
    • ConferenceParams
    • ConferenceParticipantListType
    • ConferenceScheduler
    • ConferenceSchedulerListener
    • ConferenceSchedulerListener.OnInvitationsSentDelegate
    • ConferenceSchedulerListener.OnStateChangedDelegate
    • ConferenceSchedulerState
    • ConferenceSecurityLevel
    • ConferenceState
    • Config
    • ConfiguringState
    • ConsolidatedPresence
    • Content
    • Core
    • Core.MSOglContextInfo
    • CoreListener
    • CoreListener.OnAccountRegistrationStateChangedDelegate
    • CoreListener.OnAudioDeviceChangedDelegate
    • CoreListener.OnAudioDevicesListUpdatedDelegate
    • CoreListener.OnAuthenticationRequestedDelegate
    • CoreListener.OnBuddyInfoUpdatedDelegate
    • CoreListener.OnCallCreatedDelegate
    • CoreListener.OnCallEncryptionChangedDelegate
    • CoreListener.OnCallGoclearAckSentDelegate
    • CoreListener.OnCallIdUpdatedDelegate
    • CoreListener.OnCallLogUpdatedDelegate
    • CoreListener.OnCallReceiveMasterKeyChangedDelegate
    • CoreListener.OnCallSendMasterKeyChangedDelegate
    • CoreListener.OnCallStateChangedDelegate
    • CoreListener.OnCallStatsUpdatedDelegate
    • CoreListener.OnChatRoomEphemeralMessageDeletedDelegate
    • CoreListener.OnChatRoomReadDelegate
    • CoreListener.OnChatRoomSessionStateChangedDelegate
    • CoreListener.OnChatRoomStateChangedDelegate
    • CoreListener.OnChatRoomSubjectChangedDelegate
    • CoreListener.OnConferenceInfoReceivedDelegate
    • CoreListener.OnConferenceStateChangedDelegate
    • CoreListener.OnConfiguringStatusDelegate
    • CoreListener.OnDtmfReceivedDelegate
    • CoreListener.OnEcCalibrationAudioInitDelegate
    • CoreListener.OnEcCalibrationAudioUninitDelegate
    • CoreListener.OnEcCalibrationResultDelegate
    • CoreListener.OnFirstCallStartedDelegate
    • CoreListener.OnFriendListCreatedDelegate
    • CoreListener.OnFriendListRemovedDelegate
    • CoreListener.OnGlobalStateChangedDelegate
    • CoreListener.OnImeeUserRegistrationDelegate
    • CoreListener.OnInfoReceivedDelegate
    • CoreListener.OnIsComposingReceivedDelegate
    • CoreListener.OnLastCallEndedDelegate
    • CoreListener.OnLogCollectionUploadProgressIndicationDelegate
    • CoreListener.OnLogCollectionUploadStateChangedDelegate
    • CoreListener.OnMessageReceivedDelegate
    • CoreListener.OnMessageReceivedUnableDecryptDelegate
    • CoreListener.OnMessageSentDelegate
    • CoreListener.OnMessagesReceivedDelegate
    • CoreListener.OnNetworkReachableDelegate
    • CoreListener.OnNewAlertTriggeredDelegate
    • CoreListener.OnNewMessageReactionDelegate
    • CoreListener.OnNewSubscriptionRequestedDelegate
    • CoreListener.OnNotifyPresenceReceivedDelegate
    • CoreListener.OnNotifyPresenceReceivedForUriOrTelDelegate
    • CoreListener.OnNotifyReceivedDelegate
    • CoreListener.OnNotifySentDelegate
    • CoreListener.OnPreviewDisplayErrorOccurredDelegate
    • CoreListener.OnPublishReceivedDelegate
    • CoreListener.OnPublishStateChangedDelegate
    • CoreListener.OnPushNotificationReceivedDelegate
    • CoreListener.OnQrcodeFoundDelegate
    • CoreListener.OnReactionRemovedDelegate
    • CoreListener.OnReferReceivedDelegate
    • CoreListener.OnRegistrationStateChangedDelegate
    • CoreListener.OnSubscribeReceivedDelegate
    • CoreListener.OnSubscriptionStateChangedDelegate
    • CoreListener.OnTransferStateChangedDelegate
    • CoreListener.OnVersionUpdateCheckResultReceivedDelegate
    • CoreLogCollectionUploadState
    • DialPlan
    • Dictionary
    • DigestAuthenticationPolicy
    • EcCalibratorStatus
    • ErrorInfo
    • Event
    • EventListener
    • EventListener.OnNotifyResponseDelegate
    • EventLog
    • EventLogType
    • Factory
    • Friend
    • FriendCapability
    • FriendList
    • FriendListener
    • FriendListener.OnPresenceReceivedDelegate
    • FriendListListener
    • FriendListListener.OnContactCreatedDelegate
    • FriendListListener.OnContactDeletedDelegate
    • FriendListListener.OnContactUpdatedDelegate
    • FriendListListener.OnPresenceReceivedDelegate
    • FriendListListener.OnSyncStatusChangedDelegate
    • FriendListStatus
    • FriendListSyncStatus
    • FriendListType
    • FriendPhoneNumber
    • GlobalState
    • Headers
    • IceState
    • ImNotifPolicy
    • InfoMessage
    • Ldap
    • LdapAuthMethod
    • LdapCertVerificationMode
    • LdapCheck
    • LdapDebugLevel
    • LdapParams
    • LimeState
    • LinphoneException
    • LinphoneObject
    • LinphoneWrapper
    • LogCollectionState
    • LoggingService
    • LoggingServiceListener
    • LoggingServiceListener.OnLogMessageWrittenDelegate
    • LogLevel
    • MagicSearch
    • MagicSearchAggregation
    • MagicSearchListener
    • MagicSearchListener.OnLdapHaveMoreResultsDelegate
    • MagicSearchListener.OnSearchResultsReceivedDelegate
    • MagicSearchSource
    • MediaDirection
    • MediaEncryption
    • MediaResourceMode
    • MediastreamerFactory
    • NatPolicy
    • Participant
    • ParticipantDevice
    • ParticipantDeviceDisconnectionMethod
    • ParticipantDeviceIdentity
    • ParticipantDeviceJoiningMethod
    • ParticipantDeviceListener
    • ParticipantDeviceListener.OnIsMutedDelegate
    • ParticipantDeviceListener.OnIsSpeakingChangedDelegate
    • ParticipantDeviceListener.OnStateChangedDelegate
    • ParticipantDeviceListener.OnStreamAvailabilityChangedDelegate
    • ParticipantDeviceListener.OnStreamCapabilityChangedDelegate
    • ParticipantDeviceListener.OnVideoDisplayErrorOccurredDelegate
    • ParticipantDeviceState
    • ParticipantImdnState
    • ParticipantInfo
    • ParticipantRole
    • PayloadType
    • Player
    • PlayerListener
    • PlayerListener.OnEofReachedDelegate
    • PlayerState
    • PresenceActivity
    • PresenceActivityType
    • PresenceBasicStatus
    • PresenceModel
    • PresenceNote
    • PresencePerson
    • PresenceService
    • Privacy
    • ProxyConfig
    • PublishState
    • PushNotificationConfig
    • PushNotificationMessage
    • Range
    • Reason
    • Recorder
    • RecorderFileFormat
    • RecorderParams
    • RecorderState
    • RegistrationState
    • SearchResult
    • SecurityEventType
    • SessionExpiresRefresher
    • SignalInformation
    • SignalStrengthUnit
    • SignalType
    • SrtpSuite
    • StreamType
    • SubscribePolicy
    • SubscriptionDir
    • SubscriptionState
    • SupportLevel
    • ToneID
    • Transports
    • TransportType
    • Tunnel
    • TunnelConfig
    • TunnelMode
    • UpnpState
    • Vcard
    • VersionUpdateCheckResult
    • VideoActivationPolicy
    • VideoDefinition
    • VideoSourceDescriptor
    • VideoSourceType
    • XmlRpcArgType
    • XmlRpcRequest
    • XmlRpcRequestListener
    • XmlRpcRequestListener.OnResponseDelegate
    • XmlRpcSession
    • XmlRpcStatus
    • ZrtpKeyAgreement
    • ZrtpPeerStatus

Class ConferenceParams

Object defining parameters for a Conference.

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

Inheritance
System.Object
LinphoneObject
ConferenceParams
Inherited Members
LinphoneObject.StringArrayToBctbxList(IEnumerable<String>)
LinphoneObject.CleanStringArrayPtrs()
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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

ChatRoomBackend

Get the backend implementation of the text capabilities of theconference associated with the given parameters.

Declaration
public ChatRoomBackend ChatRoomBackend { get; set; }
Property Value
Type Description
ChatRoomBackend

the ChatRoomBackend

ChatRoomEncryptionBackend

Get the encryption implementation of the text capabilities of theconference associated with the given parameters.

Declaration
public ChatRoomEncryptionBackend ChatRoomEncryptionBackend { get; set; }
Property Value
Type Description
ChatRoomEncryptionBackend

the ChatRoomEncryptionBackend

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.

EncryptionEnabled

Get the encryption status of the text capabilities of theconference associated with the given parameters.

Declaration
public bool EncryptionEnabled { get; }
Property Value
Type Description
System.Boolean

true if encryption is enabled, false otherwise

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

EphemeralLifetime

Get lifetime (in seconds) for all new ephemeral messages in the text capabilities of theconference.

After the message is read, it will be deleted after "time" seconds.

Declaration
public int EphemeralLifetime { get; set; }
Property Value
Type Description
System.Int32

the ephemeral lifetime (in seconds)

Remarks

See : linphone_conference_params_ephemeral_enabled()

EphemeralMode

Get the ephemeral message mode of the text capabilities of theconference associated with the given parameters.

Declaration
public ChatRoomEphemeralMode EphemeralMode { get; set; }
Property Value
Type Description
ChatRoomEphemeralMode

the ephemeral message mode ChatRoomEphemeralMode

GroupEnabled

Get the group chat status of the text capabilities of theconference 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 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.

RttEnabled

Get the real time text status of the text capabilities of theconference associated with the given parameters.

Declaration
public bool RttEnabled { get; set; }
Property Value
Type Description
System.Boolean

true if real time text is enabled, false otherwise

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 the conference subject.

Get conference subject.

Declaration
public string Subject { 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 ConferenceParams.

Declaration
public ConferenceParams Clone()
Returns
Type Description
ConferenceParams

An allocated ConferenceParams with the same parameters than params

In This Article
Back to top Generated by DocFX