• 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
    • AccountDevice
    • AccountListener
    • AccountListener.OnConferenceInformationUpdatedDelegate
    • AccountListener.OnMessageWaitingIndicationChangedDelegate
    • AccountListener.OnRegistrationStateChangedDelegate
    • AccountManagerServices
    • AccountManagerServicesRequest
    • AccountManagerServicesRequestListener
    • AccountManagerServicesRequestListener.OnDevicesListFetchedDelegate
    • AccountManagerServicesRequestListener.OnRequestErrorDelegate
    • AccountManagerServicesRequestListener.OnRequestSuccessfulDelegate
    • AccountManagerServicesRequestType
    • AccountParams
    • Address
    • AddressFamily
    • Alert
    • AlertListener
    • AlertListener.OnTerminatedDelegate
    • AlertType
    • AudioDevice
    • AudioDeviceCapabilities
    • AudioDeviceType
    • AuthInfo
    • AuthMethod
    • AVPFMode
    • BaudotMode
    • BaudotStandard
    • BearerToken
    • Buffer
    • Call
    • CallDir
    • CallListener
    • CallListener.OnAckProcessingDelegate
    • CallListener.OnAudioDeviceChangedDelegate
    • CallListener.OnAuthenticationTokenVerifiedDelegate
    • CallListener.OnBaudotDetectedDelegate
    • CallListener.OnCameraNotWorkingDelegate
    • CallListener.OnDtmfReceivedDelegate
    • CallListener.OnEncryptionChangedDelegate
    • CallListener.OnGoclearAckSentDelegate
    • CallListener.OnInfoMessageReceivedDelegate
    • CallListener.OnNextVideoFrameDecodedDelegate
    • CallListener.OnReceiveMasterKeyChangedDelegate
    • CallListener.OnReferRequestedDelegate
    • CallListener.OnRemoteRecordingDelegate
    • CallListener.OnSecurityLevelDowngradedDelegate
    • CallListener.OnSendMasterKeyChangedDelegate
    • CallListener.OnSnapshotTakenDelegate
    • CallListener.OnStateChangedDelegate
    • CallListener.OnStatsUpdatedDelegate
    • CallListener.OnTmmbrReceivedDelegate
    • CallListener.OnTransferStateChangedDelegate
    • CallListener.OnVideoDisplayErrorOccurredDelegate
    • CallLog
    • CallParams
    • CallState
    • CallStats
    • CallStatus
    • CardDavParams
    • ChatMessage
    • ChatMessageDirection
    • ChatMessageListener
    • ChatMessageListener.OnEphemeralMessageDeletedDelegate
    • ChatMessageListener.OnEphemeralMessageTimerStartedDelegate
    • ChatMessageListener.OnFileTransferProgressIndicationDelegate
    • ChatMessageListener.OnFileTransferRecvDelegate
    • ChatMessageListener.OnFileTransferSendChunkDelegate
    • ChatMessageListener.OnFileTransferSendDelegate
    • ChatMessageListener.OnFileTransferTerminatedDelegate
    • ChatMessageListener.OnMsgStateChangedDelegate
    • ChatMessageListener.OnNewMessageReactionDelegate
    • ChatMessageListener.OnParticipantImdnStateChangedDelegate
    • ChatMessageListener.OnReactionRemovedDelegate
    • ChatMessageReaction
    • ChatMessageState
    • ChatParams
    • ChatRoom
    • ChatRoomBackend
    • ChatRoomCapabilities
    • ChatRoomEncryptionBackend
    • ChatRoomEphemeralMode
    • ChatRoomHistoryFilter
    • 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.OnNewMessageReactionDelegate
    • 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.OnAllowedParticipantListChangedDelegate
    • ConferenceListener.OnAudioDeviceChangedDelegate
    • ConferenceListener.OnAvailableMediaChangedDelegate
    • ConferenceListener.OnFullStateReceivedDelegate
    • ConferenceListener.OnParticipantAddedDelegate
    • ConferenceListener.OnParticipantAdminStatusChangedDelegate
    • ConferenceListener.OnParticipantDeviceAddedDelegate
    • ConferenceListener.OnParticipantDeviceIsMutedDelegate
    • ConferenceListener.OnParticipantDeviceIsSpeakingChangedDelegate
    • ConferenceListener.OnParticipantDeviceJoiningRequestDelegate
    • ConferenceListener.OnParticipantDeviceMediaAvailabilityChangedDelegate
    • ConferenceListener.OnParticipantDeviceMediaCapabilityChangedDelegate
    • ConferenceListener.OnParticipantDeviceRemovedDelegate
    • ConferenceListener.OnParticipantDeviceScreenSharingChangedDelegate
    • ConferenceListener.OnParticipantDeviceStateChangedDelegate
    • ConferenceListener.OnParticipantRemovedDelegate
    • ConferenceListener.OnParticipantRoleChangedDelegate
    • ConferenceListener.OnStateChangedDelegate
    • ConferenceListener.OnSubjectChangedDelegate
    • ConferenceParams
    • ConferenceParticipantListType
    • ConferenceScheduler
    • ConferenceSchedulerListener
    • ConferenceSchedulerListener.OnInvitationsSentDelegate
    • ConferenceSchedulerListener.OnStateChangedDelegate
    • ConferenceSchedulerState
    • ConferenceSchedulerType
    • ConferenceSecurityLevel
    • ConferenceState
    • Config
    • ConfiguringState
    • ConsolidatedPresence
    • Content
    • Core
    • Core.MSOglContextInfo
    • CoreListener
    • CoreListener.OnAccountAddedDelegate
    • CoreListener.OnAccountRegistrationStateChangedDelegate
    • CoreListener.OnAccountRemovedDelegate
    • 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.OnDefaultAccountChangedDelegate
    • 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.OnMessageWaitingIndicationChangedDelegate
    • 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.OnRemainingNumberOfFileTransferChangedDelegate
    • CoreListener.OnSnapshotTakenDelegate
    • CoreListener.OnSubscribeReceivedDelegate
    • CoreListener.OnSubscriptionStateChangedDelegate
    • CoreListener.OnTransferStateChangedDelegate
    • CoreListener.OnVersionUpdateCheckResultReceivedDelegate
    • CoreLogCollectionUploadState
    • DialPlan
    • Dictionary
    • DigestAuthenticationPolicy
    • EcCalibratorStatus
    • EktInfo
    • ErrorInfo
    • Event
    • EventListener
    • EventListener.OnNotifyReceivedDelegate
    • EventListener.OnNotifyResponseDelegate
    • EventListener.OnPublishReceivedDelegate
    • EventListener.OnPublishStateChangedDelegate
    • EventListener.OnSubscribeReceivedDelegate
    • EventListener.OnSubscribeStateChangedDelegate
    • EventLog
    • EventLogType
    • Factory
    • Friend
    • FriendCapability
    • FriendDevice
    • FriendList
    • FriendListener
    • FriendListener.OnPresenceReceivedDelegate
    • FriendListListener
    • FriendListListener.OnContactCreatedDelegate
    • FriendListListener.OnContactDeletedDelegate
    • FriendListListener.OnContactUpdatedDelegate
    • FriendListListener.OnNewSipAddressDiscoveredDelegate
    • 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.OnMoreResultsAvailableDelegate
    • MagicSearchListener.OnSearchResultsReceivedDelegate
    • MagicSearchSource
    • MediaDirection
    • MediaEncryption
    • MediaFileFormat
    • MediaResourceMode
    • MediastreamerFactory
    • MessageWaitingIndication
    • MessageWaitingIndicationContextClass
    • MessageWaitingIndicationSummary
    • NatPolicy
    • Participant
    • ParticipantDevice
    • ParticipantDeviceDisconnectionMethod
    • ParticipantDeviceIdentity
    • ParticipantDeviceJoiningMethod
    • ParticipantDeviceListener
    • ParticipantDeviceListener.OnIsMutedDelegate
    • ParticipantDeviceListener.OnIsSpeakingChangedDelegate
    • ParticipantDeviceListener.OnScreenSharingChangedDelegate
    • ParticipantDeviceListener.OnStateChangedDelegate
    • ParticipantDeviceListener.OnStreamAvailabilityChangedDelegate
    • ParticipantDeviceListener.OnStreamCapabilityChangedDelegate
    • ParticipantDeviceListener.OnThumbnailStreamAvailabilityChangedDelegate
    • ParticipantDeviceListener.OnThumbnailStreamCapabilityChangedDelegate
    • 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
    • RecorderParams
    • RecorderState
    • RegistrationState
    • RemoteContactDirectory
    • RemoteContactDirectoryType
    • SearchDirection
    • SearchResult
    • SecurityEventType
    • SecurityLevel
    • SessionExpiresRefresher
    • SignalInformation
    • SignalStrengthUnit
    • SignalType
    • SrtpSuite
    • StreamType
    • SubscribePolicy
    • SubscriptionDir
    • SubscriptionState
    • SupportLevel
    • ToneID
    • Transports
    • TransportType
    • Tunnel
    • TunnelConfig
    • TunnelMode
    • UpnpState
    • Vcard
    • VersionUpdateCheckResult
    • VideoActivationPolicy
    • VideoDefinition
    • VideoSourceDescriptor
    • VideoSourceScreenSharingType
    • VideoSourceType
    • XmlRpcArgType
    • XmlRpcRequest
    • XmlRpcRequestListener
    • XmlRpcRequestListener.OnResponseDelegate
    • XmlRpcSession
    • XmlRpcStatus
    • ZrtpKeyAgreement
    • ZrtpPeerStatus

Namespace Linphone

Classes

Account

Object that represents a Linphone Account.

This object replaces the deprecated Linphone.ProxyConfig. Use a Linphone.AccountParams object to configure it.

AccountCreator

The object used to configure an account on a server via XML-RPC, see https://wiki.linphone.org/xwiki/wiki/public/view/Lib/Features/Override%20account%20creator%20request/.

AccountCreatorListener

An object to handle the responses callbacks for handling the Linphone.AccountCreator operations.

AccountDevice

Object that represents a device that at least once was connected to a given account.

AccountListener

An object to handle the callbacks for the handling of Linphone.Account objects.

AccountManagerServices

Creates and manage SIP user accounts remotely, using the REST API of the Flexisip Account Manager.

AccountManagerServicesRequest

Request object created by Linphone.AccountManagerServices.

AccountManagerServicesRequestListener

An object to handle the callbacks for Linphone.AccountManagerServicesRequest object.

AccountParams

Object that is used to set the different parameters of a Linphone.Account.

Note that authenticated accounts should have a corresponding Linphone.AuthInfo added to the Linphone.Core to register properly.

Address

Object that represents a parsed SIP address.

A SIP address is made of display name, username, domain name, port, and various uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'. You can create an address using Linphone.Factory.CreateAddress() or Linphone.Core.InterpretUrl() and both will return a null object if it doesn't match the grammar defined by the standard. This object is used in almost every other major objects to identity people (including yourself) & servers. The Linphone.Address has methods to extract and manipulate all parts of the address.

Alert

Object that represents an alert.

Alerts are raised at run-time when particular conditions are met, for example bad network quality. The full list of available alert types is described by the Linphone.AlertType enum. An application is notified of new alerts through the Linphone.CoreListener interface. Once raised, the application may use the Linphone.AlertListener interface to get notified when the alert stops. For each kind of alert, a Linphone.Dictionary is filled with relevant informations, returned by Linphone.Alert.Informations. The keys available are documented per-type in Linphone.AlertType enum.

AlertListener

Object that represents a callback attached to an alert.

AudioDevice

Object holding audio device information.

It contains the name of the device, it's type if available (Earpiece, Speaker, Bluetooth, etc..) and capabilities (input, output or both) the name of the driver that created it (filter in mediastreamer). You can use the Linphone.AudioDevice objects to configure default input/output devices or do it dynamically during a call. To get the list of available devices, use Linphone.Core.AudioDevices. This list will be limited to one device of each type. Use Linphone.Core.ExtendedAudioDevices for a complete list.

AuthInfo

Object holding authentication information.

In most case, authentication information consists of a username and password. If realm isn't set, it will be deduced automatically from the first authentication challenge as for the hash algorithm. Sometimes, a userid is required by the proxy and then domain can be useful to discriminate different credentials. You can also use this object if you need to use a client certificate. Once created and filled, a Linphone.AuthInfo must be added to the Linphone.Core in order to become known and used automatically when needed. Use Linphone.Core.AddAuthInfo() for that purpose. The Linphone.Core object can take the initiative to request authentication information when needed to the application through the authentication_requested() callback of it's Linphone.CoreListener. The application can respond to this information request later using Linphone.Core.AddAuthInfo(). This will unblock all pending authentication transactions and retry them with authentication headers.

BearerToken

Object that represents a bearer token (eg OAUTH).

SIP servers may support "bearer" kind of authentication, in which case an authentication token needs to be supplied in order to authenticate to the SIP service. Applications are responsible to obtain the token from an authentication server. In order to pass it to liblinphone for usage, the token needs to be encapsulated into a Linphone.BearerToken, together with its expiration time and target server name for which it is intended to use, then passed into a Linphone.AuthInfo object. Both access and refresh tokens may be represented. If both are provided to the Linphone.AuthInfo, then liblinphone automatically uses the refresh token to obtain a new access token when the latter is expired.

Buffer

The object representing a data buffer.

Call

This object represents a call issued or received by the Linphone.Core.

Linphone only allows at most one active call at any given time and it will be in Linphone.CallState.StreamsRunning. However, if the core is locally hosting a Linphone.Conference, you may have some or all the calls in the conference in Linphone.CallState.StreamsRunning as well as an additional active call outside of the conference in Linphone.CallState.StreamsRunning if the local participant of the Linphone.Conference is not part of it. You can get the Linphone.CallState of the call using Linphone.Call.State, it's current Linphone.CallParams with Linphone.Call.CurrentParams and the latest statistics by calling Linphone.Call.AudioStats or Linphone.Call.VideoStats. The application can receive the various kind of events occuring in a call through the Linphone.CallListener interface, see also Linphone.Call.AddListener().

CallListener

That class holds all the callbacks which are called by Linphone.Call objects.

Use Linphone.Factory.CreateCallCbs() to create an instance. Then, call the callback setters on the events you need to monitor and pass the object to a Linphone.Call instance through Linphone.Call.AddListener().

CallLog

Object used to keep track of all calls initiated, received or missed.

It contains the call ID, date & time at which the call took place and it's duration (0 if it wasn't answered). You can also know if video was enabled or not or if it was a conference, as well as it's average quality. If needed, you can also create a fake Linphone.CallLog using Linphone.Core.CreateCallLog(), otherwise use Linphone.Core.CallLogs or even Linphone.Call.CallLog to get the log of an ongoing call.

CallParams

An object containing various parameters of a Linphone.Call.

You can specify your params while answering an incoming call using Linphone.Call.AcceptWithParams() or while initiating an outgoing call with Linphone.Core.InviteAddressWithParams(). This object can be created using Linphone.Core.CreateCallParams(), using null for the call pointer if you plan to use it for an outgoing call. For each call, three Linphone.CallParams are available: yours, your correspondent's and the one that describe the current state of the call that is the result of the negociation between the previous two. For example, you might enable a certain feature in your call param but this feature can be denied in the remote's configuration, hence the difference.

CallStats

This object carry various statistic informations regarding the quality of an audio or video stream for a given Linphone.Call.

To receive these informations periodically and as soon as they are computed, implement the call_stats_updated() callback inside a Linphone.CoreListener. At any time, the application can access latest computed statistics using Linphone.Call.AudioStats and Linphone.Call.VideoStats.

CardDavParams

The Linphone.CardDavParams object represents a remote CardDAV server used by Linphone.MagicSearch as a plugin source.

ChatMessage

A Linphone.ChatMessage represents an instant message that can be send or received through a Linphone.ChatRoom.

To create a Linphone.ChatMessage, use Linphone.ChatRoom.CreateEmptyMessage(), then either add text using Linphone.ChatMessage.AddUtf8TextContent() or a Linphone.Content with file informations using Linphone.ChatMessage.AddFileContent(). A valid Linphone.Content for file transfer must contain a type and subtype, the name of the file and it's size. Finally call Linphone.ChatMessage.Send() to send it. To send files through a Linphone.ChatMessage, you need to have configured a file transfer server URL with Linphone.Core.FileTransferServer. On the receiving side, either use Linphone.ChatMessage.DownloadContent() to download received files or enable auto-download in the Linphone.Core using Linphone.Core.MaxSizeForAutoDownloadIncomingFiles, -1 disabling the feature and 0 always downloading files no matter it's size. Keep in mind a Linphone.ChatMessage created by a Linphone.ChatRoomBackend.Basic Linphone.ChatRoom can only contain one Linphone.Content, either text or file.

ChatMessageListener

An object to handle the callbacks for the handling a Linphone.ChatMessage objects.

ChatMessageReaction

A chat message reaction is an emoji sent by someone in the same chat room to react to a specific Linphone.ChatMessage.

To create a Linphone.ChatMessageReaction, use Linphone.ChatMessage.CreateReaction(). Once you are ready, send the reaction using Linphone.ChatMessageReaction.Send(). Reactions are available using Linphone.ChatMessage.Reactions and will be notified using dedicated callbacks either in Linphone.CoreListener or Linphone.ChatMessageListener.

ChatParams

Object defining settings strictly associated with Linphone.ChatRoom objects such as ephemeral settings and backends.

It is automatically created when you enable chat capabilities in the Linphone.ConferenceParams. If the Linphone.ChatRoom backend is Linphone.ChatRoomBackend.Basic, then no other parameter is required, but Linphone.ChatMessage sent and received won't benefit from all features a Linphone.ChatRoomBackend.FlexisipChat can offer like conversation with multiple participants and a subject, end-to-end encryption, ephemeral messages, etc... but this type is the only one that can interoperate with other SIP clients or with non-flexisip SIP proxies.

ChatRoom

A chat room is the place where Linphone.ChatMessage are exchanged.

To create (or find) a Linphone.ChatRoom, you first need a Linphone.ChatRoomParams object. A chat room is uniquely identified by it's local and remote SIP addresses, meaning you can only have one chat room between two accounts (unless the backend is Linphone.ChatRoomBackend.FlexisipChat). Then you can call Linphone.Core.SearchChatRoom() or Linphone.Core.CreateChatRoom(). Be careful as a Linphone.ChatRoomBackend.FlexisipChat backend Linphone.ChatRoom will be created asynchronously, so make sure you add a Linphone.ChatRoomListener to the returned object to be notified when it will be in state Linphone.ChatRoomState.Created. All chat rooms are loaded from database when the Linphone.Core starts, and you can get them using Linphone.Core.ChatRooms. This method doesn't return empty chat rooms nor ones for which the local address doesn't match an existing Linphone.Account identity, unless you specify otherwise in the [misc] section of your configuration file by setting hide_empty_chat_rooms=0 and/or hide_chat_rooms_from_removed_proxies=0.

ChatRoomListener

An object to handle the callbacks for the handling a Linphone.ChatRoom objects.

Use Linphone.Factory.CreateChatRoomCbs() to create an instance. Then pass the object to a Linphone.ChatRoom instance through Linphone.ChatRoom.AddListener().

ChatRoomParams

Object defining parameters for a Linphone.ChatRoom.

Can be created with Linphone.Core.CreateDefaultChatRoomParams(). You can use Linphone.ChatRoomParams.IsValid() to check if your configuration is valid or not. If the Linphone.ChatRoom backend is Linphone.ChatRoomBackend.Basic, then no other parameter is required, but Linphone.ChatMessage sent and received won't benefit from all features a Linphone.ChatRoomBackend.FlexisipChat can offer like conversation with multiple participants and a subject, end-to-end encryption, ephemeral messages, etc... but this type is the only one that can interoperate with other SIP clients or with non-flexisip SIP proxies.

Conference

A conference is the object that allow to make calls when there are 2 or more participants.

To create (or find) a Linphone.Conference, you first need a Linphone.ConferenceParams object. Linphone.Core.CreateConferenceWithParams() allows you to create a conference. A conference is uniquely identified by a conference address, meaning you can have more than one conference between two accounts. To find a conference among those a core is part of, you can call Linphone.Core.SearchConference(). A Linphone.Conference may be created automatically and implicitely when an outgoing call is made to a conference server. Thanks to the standard 'isfocus' contact parameter, the call is identified as belonging to a conference. The conference object can then be retrieved with Linphone.Call.Conference.

ConferenceInfo

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

ConferenceListener

An object to handle the callbacks for the handling a Linphone.Conference objects.

Use Linphone.Factory.CreateConferenceCbs() to create an instance. Then pass the object to a Linphone.Conference instance through Linphone.Conference.AddListener().

ConferenceParams

Object defining parameters for a Linphone.Conference.

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

ConferenceScheduler

Creates and manages conferences on a conferenceing service, and send conference invitations to notify participants.

ConferenceSchedulerListener

Callbacks of Linphone.ConferenceScheduler object.

Config

This object is used to manipulate a configuration file.

The format of the configuration file is a .ini like format: Various types can be used: strings and lists of strings, integers, floats, booleans (written as 0 or 1) and range of integers. Usually a Linphone.Core is initialized using two Linphone.Config, one default (where configuration changes through API calls will be saved) and one named 'factory' which is read-only and overwrites any setting that may exists in the default one. It is also possible to use only one (either default or factory) or even none.

Content

This object holds data that can be embedded in a signaling message or IM message.

Use Linphone.Core.CreateContent() to create it, and then you should set at least it's type and subtype and fill the buffer with your data. A Linphone.Content can be multipart (contain other contents), have file information (name, path, size), be encrypted, have custom headers, etc...

Core

Main object to instanciate and on which to keep a reference.

This object is the first object to instanciante, and will allow you to perform all kind of tasks. To create it, use either Linphone.Factory.CreateCore() or Linphone.Factory.CreateCoreWithConfig(), see Linphone.Config for more information about factory and default config. On some platforms like Android or iOS you will need to give it the Context of your application. Once the Linphone.Core is in state Linphone.GlobalState.Ready, use Linphone.Core.Start(). It will then go to state Linphone.GlobalState.On and from that you can start using it for calls and chat messages. It is recommended to add a Linphone.CoreListener listener using Linphone.Core.AddListener() to monitor different events. To be able to receive events from the network, you must schedule a call Linphone.Core.Iterate() often, like every 20ms. On Android & iOS Linphone.Core.IsAutoIterateEnabled() is enabled by default so you don't have to worry about that unless you disable it using Linphone.Core.EnableAutoIterate() or by setting in the [misc] section of your configuration auto_iterate=0.

CoreListener

That class holds all the callbacks which are called by Linphone.Core.

Once created, add your Linphone.CoreListener using Linphone.Core.AddListener(). Keep a reference on it as long as you need it. You can use Linphone.Core.RemoveListener() to remove it but that isn't mandatory. The same applies to all listeners in our API.

DialPlan

Represents a dial plan.

Dictionary

Object that represents key-value pair container.

DigestAuthenticationPolicy

The LinphoneDigestAuthenticationPolicy holds parameters relative to digest authentication procedures.

EktInfo

Object representing all informations present in an Encrypted Key Transport event.

ErrorInfo

Object representing full details about a signaling error or status.

All Linphone.ErrorInfo object returned by the liblinphone API are readonly and transcients. For safety they must be used immediately after obtaining them. Any other function call to the liblinphone may change their content or invalidate the pointer.

Event

Object representing an event state, which is subcribed or published.

EventListener

An object to handle the callbacks for handling the LinphoneEvent operations.

EventLog

Object that represents an event that must be stored in database.

For example, all chat related events are wrapped in an Linphone.EventLog, and many callbacks use this kind of type as parameter. Use Linphone.EventLog.Type to get the Linphone.EventLogType it refers to, and then you can use one of the accessor methods to get the underlying object, for example Linphone.EventLog.ChatMessage for a Linphone.ChatMessage.

Factory

The factory is a singleton object devoted to the creation of all the objects of Liblinphone that cannot be created by Linphone.Core itself.

It is also used to configure a few behaviors before creating the Linphone.Core, like the logs verbosity or collection.

Friend

This object is used to store a SIP address.

Linphone.Friend is mainly used to implement an adressbook feature, and are used as data for the Linphone.MagicSearch object. If your proxy supports it, you can also use it to subscribe to presence information. The objects are stored in a Linphone.FriendList which are in turn stored inside the Linphone.Core. They can be stored inside a database if the path to it is configured, otherwise they will be lost after the Linphone.Core is destroyed. Thanks to the vCard plugin, you can also store more information like phone numbers, organization, etc...

FriendDevice

Object that represents a Linphone.Friend's device (name, trust level) for a given SIP address.

FriendList

This object representing a list of Linphone.Friend.

You can use it to store contacts locally or synchronize them through CardDAV protocol.

FriendListener

An object to handle the callbacks for Linphone.Friend.

FriendListListener

An object to handle the callbacks for Linphone.Friend synchronization.

FriendPhoneNumber

Object that represents a Linphone.Friend's phone number.

Headers

Object representing a chain of protocol headers.

It provides read/write access to the headers of the underlying protocol.

ImNotifPolicy

Policy to use to send/receive instant messaging composing/delivery/display notifications.

The sending of this information is done as in the RFCs 3994 (is_composing) and 5438 (imdn delivered/displayed).

InfoMessage

Object representing an informational message sent or received by the core.

Ldap

Object that represents a LDAP connection.

Use a Linphone.LdapParams object to configure it.

LdapParams

Object that is used to set the different parameters of a Linphone.Ldap.

LinphoneException

All methods that returns a LinphoneStatus with a value != 0 as an error code in C are translated in C# by throwing a LinphoneException

LinphoneObject

LinphoneWrapper

Only contains the LIB_NAME value that represents the library in which all DllImport are made

LoggingService

Singleton class giving access to logging features.

It supports custom domain, writing into a file as well as several verbosity levels. The Linphone.LoggingServiceListener listener allows you to be notified each time a log is printed. As the Linphone.LoggingService is a singleton, use Linphone.LoggingService. to get it.

LoggingServiceListener

Listener for Linphone.LoggingService.

MagicSearch

A Linphone.MagicSearch is used to search for contacts from various sources:

MagicSearchListener

Linphone.MagicSearchListener is an interface to be notified of results of contact searches initiated from the Linphone.MagicSearch.

MediastreamerFactory

MessageWaitingIndication

Object representing a Message Waiting Indication.

MessageWaitingIndicationSummary

Object representing the summary for a context in a Message Waiting Indication.

NatPolicy

Policy to use to pass through NATs/firewalls.

Participant

Identifies a member of a Linphone.Conference or Linphone.ChatRoom.

A participant is identified by it's SIP address. It can have many Linphone.ParticipantDevice.

ParticipantDevice

This object represents a unique device for a member of a Linphone.Conference or Linphone.ChatRoom.

Devices are identified by the gruu parameter inside the Linphone.Address which can be obtained by Linphone.ParticipantDevice.Address. It is specially usefull to know the security level of each device inside an end-to-end encrypted Linphone.ChatRoom. You can get a list of all Linphone.ParticipantDevice using Linphone.Participant.Devices.

ParticipantDeviceIdentity

This object is only used on server side for Linphone.ChatRoom with Linphone.ChatRoomBackend.FlexisipChat backend.

ParticipantDeviceListener

An object to handle the callbacks for the handling a Linphone.ParticipantDevice objects.

Use Linphone.Factory.CreateParticipantDeviceCbs() to create an instance. Then pass the object to a Linphone.ParticipantDevice instance through Linphone.ParticipantDevice.AddListener().

ParticipantImdnState

This object represents the delivery/display state of a given chat message for a given participant.

It also contains a timestamp at which this participant state has changed. Use Linphone.ChatMessage.ParticipantsByImdnState to get all Linphone.ParticipantImdnState for a given state. From there use Linphone.ParticipantImdnState.Participant to get the Linphone.Participant object if you need it.

ParticipantInfo

Object defining all information related to a participant.

PayloadType

Object representing an RTP payload type.

Player

Player interface.

PlayerListener

An object to handle the callbacks for the handling a Linphone.Player objects.

PresenceActivity

Presence activity type holding information about a presence activity.

PresenceModel

Presence model type holding information about the presence of a person.

PresenceNote

Presence note type holding information about a presence note.

PresencePerson

Presence person holding information about a presence person.

PresenceService

Presence service type holding information about a presence service.

ProxyConfig

Represents an account configuration to be used by Linphone.Core.

In addition to the Linphone.AuthInfo that stores the credentials, you need to configure a Linphone.ProxyConfig as well to be able to connect to a proxy server. A minimal proxy config consists of an identity address (sip:username@domain.tld) and the proxy server address,

PushNotificationConfig

Object holding push notification configuration that will be set in the contact URI parameters of the Contact header in the REGISTER, if the Linphone.AccountParams is configured to allow push notifications, see Linphone.AccountParams.PushNotificationAllowed.

This object can be accessed through the Linphone.AccountParams object, which can be obtained from your Linphone.Account object.

PushNotificationMessage

Object holding chat message data received by a push notification on iOS platform only.

This object is a subset of Linphone.ChatMessage, so only a few methods of it's parent are available, like linphone_push_notification_message_get_text_content and linphone_push_notification_message_get_subject, just enough to be able to build a notification to show the user.

Range

Structure describing a range of integers.

Recorder

Interface used to record audio and video into files.

RecorderParams

Object containing various parameters of a Linphone.Recorder.

RemoteContactDirectory

Object that represents a remote contact directory such as a LDAP or CardDAV server; used as a Linphone.MagicSearch source.

SearchResult

The Linphone.SearchResult object represents a result of a search initiated from a Linphone.MagicSearch.

SignalInformation

Object to get signal (wifi/4G etc...) informations.

Transports

SIP transports & ports configuration object.

Indicates which transport among UDP, TCP, TLS and DTLS should be enabled and if so on which port to listen. You can use special values like LC_SIP_TRANSPORT_DISABLED (0), LC_SIP_TRANSPORT_RANDOM (-1) and LC_SIP_TRANSPORT_DONTBIND (-2). Once configuration is complete, use Linphone.Core.Transports to apply it. This will be saved in configuration file so you don't have to do it each time the Linphone.Core starts.

Tunnel

Linphone tunnel object.

TunnelConfig

Tunnel settings.

Vcard

Object storing contact information using vCard 4.0 format.

VideoActivationPolicy

Object describing policy regarding video streams establishments.

Use Linphone.VideoActivationPolicy.AutomaticallyAccept and Linphone.VideoActivationPolicy.AutomaticallyInitiate to tell the Core to automatically accept or initiate video during calls. Even if disabled, you'll still be able to add it later while the call is running.

VideoDefinition

This object represents a video definition, eg.

it's width, it's height and possibly it's name. It is mostly used to configure the default video size sent by your camera during a video call with Linphone.Core.PreferredVideoDefinition method.

VideoSourceDescriptor

Object that is used to describe a video source.

XmlRpcRequest

The Linphone.XmlRpcRequest object representing a XML-RPC request to be sent.

XmlRpcRequestListener

An object to handle the callbacks for handling the Linphone.XmlRpcRequest operations.

XmlRpcSession

The Linphone.XmlRpcSession object used to send XML-RPC requests and handle their responses.

Structs

Core.MSOglContextInfo

Enums

AccountCreatorActivationCodeStatus

Enum describing activation code checking, used by the Linphone.AccountCreator.

AccountCreatorAlgoStatus

Enum describing algorithm checking, used by the Linphone.AccountCreator.

AccountCreatorBackend

Enum describing backend used in the Linphone.AccountCreator.

AccountCreatorDomainStatus

Enum describing domain checking, used by the Linphone.AccountCreator.

AccountCreatorEmailStatus

Enum describing email checking, used by the Linphone.AccountCreator.

AccountCreatorLanguageStatus

Enum describing language checking, used by the Linphone.AccountCreator.

AccountCreatorPasswordStatus

Enum describing password checking, used by the Linphone.AccountCreator.

AccountCreatorPhoneNumberStatus

Enum describing phone number checking, used by the Linphone.AccountCreator.

AccountCreatorStatus

Enum describing the status of server request, used by the Linphone.AccountCreator.

AccountCreatorTransportStatus

Enum describing transport checking, used by the Linphone.AccountCreator.

AccountCreatorUsernameStatus

Enum describing username checking, used by the Linphone.AccountCreator.

AccountManagerServicesRequestType

List of all supported Linphone.AccountManagerServicesRequest requests, allowing to know which one triggered either a callback from the Linphone.AccountManagerServicesRequestListener.

AddressFamily

Enum describing Ip family.

AlertType

All kinds of alerts.

AudioDeviceCapabilities

Linphone.AudioDeviceCapabilities enum represents whether a device can record audio, play audio or both

AudioDeviceType

Linphone.AudioDeviceType enum represents the different types of an audio device.

AuthMethod

Enum describing the authentication methods.

AVPFMode

Enum describing RTP AVPF activation modes.

BaudotMode

Linphone.BaudotMode enum represents the Baudot mode to use for the call.

BaudotStandard

Linphone.BaudotStandard enum represents the Baudot standard to use to send Baudot tones in the call.

CallDir

Enum representing the direction of a call.

CallState

Linphone.CallState enum represents the different states a call can reach into.

The application is notified of a state change through the LinphoneCoreVTable::call_state_changed callback.

CallStatus

Enum representing the status of a call.

ChatMessageDirection

Linphone.ChatMessageDirection is used to indicate if a message is outgoing or incoming.

ChatMessageState

Linphone.ChatMessageState is used to notify if messages have been successfully delivered or not.

ChatRoomBackend

Linphone.ChatRoomBackend is used to indicate the backend implementation of a chat room.

ChatRoomCapabilities

Linphone.ChatRoomCapabilities is used to indicate the capabilities of a chat room.

ChatRoomEncryptionBackend

Linphone.ChatRoomEncryptionBackend is used to indicate the encryption engine used by a chat room.

ChatRoomEphemeralMode

Linphone.ChatRoomEphemeralMode is used to the ephemeral message mode used by a chat room.

ChatRoomHistoryFilter

Linphone.ChatRoomHistoryFilter is used to determine which filter to apply to history functions.

ChatRoomSecurityLevel

TODO move to encryption engine object when available Linphone.ChatRoomSecurityLevel is used to indicate the encryption security level of a chat room.

ChatRoomState

Linphone.ChatRoomState is used to indicate the current state of a chat room.

CodecPriorityPolicy

Codec priority policies.

This enum represents different policies for managing offered codec lists during calls, as well as the offer-answer logic. Currently, policies can be applied only for video codecs.

ConferenceInfoState

Linphone.ConferenceInfoState is used to list all states of a conference info object

ConferenceJoiningMode

Mode of joining conference.

ConferenceLayout

Linphone.ConferenceLayout is used to indicate the layout used by the conference.

ConferenceParticipantListType

Type of conference participant list.

When participant list is closed, no more participants can be added other than those declared when creating the conference When participant list is open, other people can join the conference upon invitation of a participant no more participants can be added other than those declared when creating the conference

ConferenceSchedulerState

Describes conference scheduler possible states.

It is notified via the conference_scheduler_state_changed callback in Linphone.ConferenceSchedulerListener.

ConferenceSchedulerType

Linphone.ConferenceSchedulerType is used to know which conference scheduler type the core is using

ConferenceSecurityLevel

Conference minimum security level.

ConferenceState

Linphone.ConferenceState is used to indicate the current state of a conference.

ConfiguringState

Describes the state of the remote configuring process of the Linphone.Core object, 'Skipped' when the feature is disabled.

It is notified via the configuring_status() callback in Linphone.CoreListener.

ConsolidatedPresence

Consolidated presence information: 'online' means the user is open for communication, 'busy' means the user is open for communication but involved in an other activity, 'do not disturb' means the user is not open for communication, and 'offline' means that no presence information is available.

CoreLogCollectionUploadState

Used to notify if log collection upload have been successfully delivered or not.

EcCalibratorStatus

Enum describing the result of the echo canceller calibration process.

EventLogType

Linphone.EventLogType is used to indicate the type of an event.

Useful for cast.

FriendCapability

Enum describing the capabilities of a Linphone.Friend, populated through presence subscribe/notify process.

FriendListStatus

Enum describing the status of a LinphoneFriendList operation.

FriendListSyncStatus

Enum describing the status of a CardDAV synchronization.

FriendListType

The types of FriendList.

GlobalState

Describes the global state of the Linphone.Core object.

It is notified via the global_state_changed() callback in Linphone.CoreListener.

IceState

Enum describing ICE states.

LdapAuthMethod

Enum describing how the authentification will be made.

LdapCertVerificationMode

Enum describing server certificates verification modes.

LdapCheck

Enum describing errors in LDAP parameters.

LdapDebugLevel

Enum Debug verbosity for OpenLdap.

LimeState

LogCollectionState

Whether or not to keep a file with the logs.

LogLevel

Verbosity levels of log messages.

MagicSearchAggregation

Enum describing how to merge Linphone.SearchResult from Linphone.MagicSearch.

MagicSearchSource

Enum describing the search categories for Magic Search.

MediaDirection

Indicates for a given media the stream direction.

MediaEncryption

Enum describing type of media encryption types.

MediaFileFormat

Enum representing the file format of a recording.

MediaResourceMode

Media resource usage.

MessageWaitingIndicationContextClass

Enum describing the different contexts for the Linphone.MessageWaitingIndicationSummary.

ParticipantDeviceDisconnectionMethod

Linphone.ParticipantDeviceDisconnectionMethod is used to indicate how a participant left a conference.

ParticipantDeviceJoiningMethod

Linphone.ParticipantDeviceJoiningMethod is used to indicate how a participant joined a conference or if it is the focus.

ParticipantDeviceState

Linphone.ParticipantDeviceState is used to list all states a participant device can be in

ParticipantRole

Linphone.ParticipantRole is used to define a role of a participant within a conference

PlayerState

The state of a Linphone.Player.

PresenceActivityType

Activities as defined in section 3.2 of RFC 4480.

PresenceBasicStatus

Basic status as defined in section 4.1.4 of RFC 3863.

Privacy

Defines privacy policy to apply as described by rfc3323.

PublishState

Enum for publish states.

Reason

Enum describing various failure reasons or contextual information for some events.

RecorderState

Enum representing the state of a recording.

RegistrationState

Describes proxy registration states.

It is notified via the registration_state_changed() callback in Linphone.CoreListener.

RemoteContactDirectoryType

Enum describing the type of #RemoteContactDirectory (currently CardDAV or LDAP).

SearchDirection

Enum for search direction.

SecurityEventType

Linphone.SecurityEventType is used to indicate the type of security event.

SecurityLevel

Security level determined by type of encryption (point-to-point, end-to-end, etc...) and whether or not a SAS validation was made with the remote(s) end(s).

A Linphone.SecurityLevel.EndToEndEncryptedAndVerified level means it's end-to-end encrypted and SAS validation was made. An Linphone.SecurityLevel.Unsafe level means end-to-end-encrypted but it's likely a man-in-the-middle exists between you and one device.

SessionExpiresRefresher

Session Timers refresher.

SignalStrengthUnit

All signal units that a device can use.

SignalType

All signal types that a device can use.

SrtpSuite

Enum describing type of SRTP encryption suite.

StreamType

Enum describing the stream types.

SubscribePolicy

Enum controlling behavior for incoming subscription request.

Use by Linphone.Friend.IncSubscribePolicy

SubscriptionDir

Enum for subscription direction (incoming or outgoing).

SubscriptionState

Enum for subscription states.

Linphone.SubscriptionState.Terminated and Linphone.SubscriptionState.Error are final states.

SupportLevel

ToneID

Enum listing frequent telephony tones.

TransportType

Enum describing transport type for LinphoneAddress.

TunnelMode

Enum describing the tunnel modes.

UpnpState

Enum describing uPnP states.

VersionUpdateCheckResult

Enum describing the result of a version update check.

VideoSourceScreenSharingType

Enum representing the sub type of the screen sharing.

VideoSourceType

Enum representing the type of a video source.

XmlRpcArgType

Enum describing the types of argument for LinphoneXmlRpcRequest.

XmlRpcStatus

Enum describing the status of a LinphoneXmlRpcRequest.

ZrtpKeyAgreement

Enum describing the ZRTP key exchange algorithns.

ZrtpPeerStatus

Enum describing the ZRTP SAS validation status of a peer URI.

Delegates

AccountCreatorListener.OnAccountCreationRequestTokenDelegate

Callback to notify a response of server.

AccountCreatorListener.OnAccountCreationTokenUsingRequestTokenDelegate

Callback to notify a response of server.

AccountCreatorListener.OnActivateAccountDelegate

Callback to notify a response of server.

AccountCreatorListener.OnActivateAliasDelegate

Callback to notify a response of server.

AccountCreatorListener.OnCreateAccountDelegate

Callback to notify a response of server.

AccountCreatorListener.OnIsAccountActivatedDelegate

Callback to notify a response of server.

AccountCreatorListener.OnIsAccountExistDelegate

Callback to notify a response of server.

AccountCreatorListener.OnIsAccountLinkedDelegate

Callback to notify a response of server.

AccountCreatorListener.OnIsAliasUsedDelegate

Callback to notify a response of server.

AccountCreatorListener.OnLinkAccountDelegate

Callback to notify a response of server.

AccountCreatorListener.OnLoginLinphoneAccountDelegate

Callback to notify a response of server.

AccountCreatorListener.OnRecoverAccountDelegate

Callback to notify a response of server.

AccountCreatorListener.OnSendTokenDelegate

Callback to notify a response of server.

AccountCreatorListener.OnUpdateAccountDelegate

Callback to notify a response of server.

AccountListener.OnConferenceInformationUpdatedDelegate

Callback for notifying that the conference information list of an account has been updated.

This is generally the case when retrieving conference informations from a CCMP server as the request might take a little bit of time to be responded. In order to allow the core to perform its tasks while the conference information are being sent, the core will send first the list of conference information that are locally stored and then this callback is called once it is updated with the information received by the CCMP server.

AccountListener.OnMessageWaitingIndicationChangedDelegate

Callback for notifying a message waiting indication change for the account.

AccountListener.OnRegistrationStateChangedDelegate

Callback for notifying when a registration state has changed for the account.

AccountManagerServicesRequestListener.OnDevicesListFetchedDelegate

Callback for notifying when the #LinphoneAccountManagerServicesRequestGetDevicesList request has results available.

AccountManagerServicesRequestListener.OnRequestErrorDelegate

Callback for notifying a request has failed.

AccountManagerServicesRequestListener.OnRequestSuccessfulDelegate

Callback for notifying a request was successful.

AlertListener.OnTerminatedDelegate

Callback to know if an alert stops.

CallListener.OnAckProcessingDelegate

Callback for notifying the processing SIP ACK messages.

CallListener.OnAudioDeviceChangedDelegate

Callback to notify that the audio device has been changed.

CallListener.OnAuthenticationTokenVerifiedDelegate

Call authentication token verified callback.

CallListener.OnBaudotDetectedDelegate

Callback to notify that Baudot tones have been detected in the audio received from the remote.

CallListener.OnCameraNotWorkingDelegate

Callback to notify that the camera is not working and has been changed to "No Webcam".

A camera is detected as mis-functionning as soon as it outputs no frames at all during a period of 5 seconds. This check is only performed on desktop platforms, in the purpose of notifying camera failures, for example if when a usb cable gets disconnected.

CallListener.OnDtmfReceivedDelegate

Callback for being notified of received DTMFs.

CallListener.OnEncryptionChangedDelegate

Call encryption changed callback.

CallListener.OnGoclearAckSentDelegate

GoClear ACK sent callback.

CallListener.OnInfoMessageReceivedDelegate

Callback for receiving info messages.

CallListener.OnNextVideoFrameDecodedDelegate

Callback to notify a next video frame has been decoded.

CallListener.OnReceiveMasterKeyChangedDelegate

Call receive master key changed callback.

CallListener.OnReferRequestedDelegate

Callback for notifying when a call transfer (refer) is requested.

CallListener.OnRemoteRecordingDelegate

Callback to notify that the call is being recorded by the remote.

CallListener.OnSecurityLevelDowngradedDelegate

Call security level downgraded callback.

CallListener.OnSendMasterKeyChangedDelegate

Call send master key changed callback.

CallListener.OnSnapshotTakenDelegate

Callback for notifying a snapshot taken.

CallListener.OnStateChangedDelegate

Call state notification callback.

CallListener.OnStatsUpdatedDelegate

Callback for receiving quality statistics for calls.

CallListener.OnTmmbrReceivedDelegate

Callback for notifying a received TMMBR.

CallListener.OnTransferStateChangedDelegate

Callback for notifying progresses of transfers.

CallListener.OnVideoDisplayErrorOccurredDelegate

Callback to notify that there are errors from the video rendering.

The error code depends of the implementation.

ChatMessageListener.OnEphemeralMessageDeletedDelegate

Call back used to notify ephemeral message is deleted.

ChatMessageListener.OnEphemeralMessageTimerStartedDelegate

Callback used to notify an ephemeral message that its lifespan before disappearing has started to decrease.

This callback is called when the ephemeral message is read by the receiver.

ChatMessageListener.OnFileTransferProgressIndicationDelegate

File transfer progress indication callback prototype.

ChatMessageListener.OnFileTransferRecvDelegate

File transfer receive callback prototype.

This function is called by the core upon an incoming File transfer is started. This function may be call several time for the same file in case of large file.

ChatMessageListener.OnFileTransferSendChunkDelegate

File transfer send callback prototype.

This function is called by the core when an outgoing file transfer is started. This function is called until size is set to 0.

ChatMessageListener.OnFileTransferSendDelegate

File transfer send callback prototype.

This function is called by the core when an outgoing file transfer is started. This function is called until size is set to 0.

ChatMessageListener.OnFileTransferTerminatedDelegate

File transfer terminated callback prototype.

ChatMessageListener.OnMsgStateChangedDelegate

Call back used to notify message delivery status.

ChatMessageListener.OnNewMessageReactionDelegate

Callback used to notify a reaction has been received or sent for a given message.

ChatMessageListener.OnParticipantImdnStateChangedDelegate

Call back used to notify participant IMDN state.

ChatMessageListener.OnReactionRemovedDelegate

Callback used to notify a reaction has been removed from a given message.

ChatRoomListener.OnChatMessageParticipantImdnStateChangedDelegate

Callback used to notify a participant state has changed in a message of this chat room.

ChatRoomListener.OnChatMessageReceivedDelegate

Callback used to notify a chat room that a chat message has been received.

ChatRoomListener.OnChatMessageSendingDelegate

Callback used to notify a chat room that a chat message is being sent.

ChatRoomListener.OnChatMessageSentDelegate

Callback used to notify a chat room that a chat message has been sent.

ChatRoomListener.OnChatMessageShouldBeStoredDelegate

Callback used to tell the core whether or not to store the incoming message in db or not using Linphone.ChatMessage.ToBeStored.

ChatRoomListener.OnChatMessagesReceivedDelegate

Callback used to notify a chat room that one or many chat messages have been received.

Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using Linphone.Core.ChatMessagesAggregationEnabled), it replaces the single chat message received callback.

ChatRoomListener.OnChatRoomReadDelegate

Callback used to notify a chat room was "marked as read".

ChatRoomListener.OnConferenceAddressGenerationDelegate

Callback used when a group chat room is created server-side to generate the address of the chat room.

The function Linphone.ChatRoom.ConferenceAddress needs to be called by this callback.

ChatRoomListener.OnConferenceJoinedDelegate

Callback used to notify a chat room has been joined.

ChatRoomListener.OnConferenceLeftDelegate

Callback used to notify a chat room has been left.

ChatRoomListener.OnEphemeralEventDelegate

Callback used to notify a chat room that an ephemeral related event has been generated.

ChatRoomListener.OnEphemeralMessageDeletedDelegate

Callback used to notify a chat room that an ephemeral message has been deleted.

ChatRoomListener.OnEphemeralMessageTimerStartedDelegate

Callback used to notify a chat room that the lifespan of an ephemeral message before disappearing has started to decrease.

This callback is called when the ephemeral message is read by the receiver.

ChatRoomListener.OnIsComposingReceivedDelegate

Is composing notification callback prototype.

ChatRoomListener.OnMessageReceivedDelegate

Callback used to notify a chat room that a message has been received.

ChatRoomListener.OnMessagesReceivedDelegate

Callback used to notify a chat room that many chat messages have been received.

Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using linphone_core_set_chat_messages_aggregation_enabled), it replaces the single message received callback.

ChatRoomListener.OnNewEventDelegate

Callback used to notify a chat room that an event log has been created.

ChatRoomListener.OnNewEventsDelegate

Callback used to notify a chat room that many event logs have been created.

ChatRoomListener.OnNewMessageReactionDelegate

Callback used to notify a reaction has been received or sent for a given message.

ChatRoomListener.OnParticipantAddedDelegate

Callback used to notify a chat room that a participant has been added.

ChatRoomListener.OnParticipantAdminStatusChangedDelegate

Callback used to notify a chat room that the admin status of a participant has been changed.

ChatRoomListener.OnParticipantDeviceAddedDelegate

Callback used to notify a chat room that a participant has been added.

ChatRoomListener.OnParticipantDeviceMediaAvailabilityChangedDelegate

Callback used to notify a conference that the media availability of a participant device has been changed.

ChatRoomListener.OnParticipantDeviceRemovedDelegate

Callback used to notify a chat room that a participant has been removed.

ChatRoomListener.OnParticipantDeviceStateChangedDelegate

Callback used to notify a conference that a participant device has changed state.

ChatRoomListener.OnParticipantRegistrationSubscriptionRequestedDelegate

Callback used when a group chat room server is subscribing to registration state of a participant.

ChatRoomListener.OnParticipantRegistrationUnsubscriptionRequestedDelegate

Callback used when a group chat room server is unsubscribing to registration state of a participant.

ChatRoomListener.OnParticipantRemovedDelegate

Callback used to notify a chat room that a participant has been removed.

ChatRoomListener.OnSecurityEventDelegate

Callback used to notify a security event in the chat room.

ChatRoomListener.OnStateChangedDelegate

Callback used to notify a chat room state has changed.

ChatRoomListener.OnSubjectChangedDelegate

Callback used to notify that the subject of a chat room has changed.

ChatRoomListener.OnUndecryptableMessageReceivedDelegate

Callback used to notify a chat room that a message has been received but we were unable to decrypt it.

ConferenceListener.OnActiveSpeakerParticipantDeviceDelegate

Callback used to notify which participant device video is being displayed as "actively speaking".

ConferenceListener.OnAllowedParticipantListChangedDelegate

Callback used to notify a conference that the list of participants allowed to join the conference has changed.

ConferenceListener.OnAudioDeviceChangedDelegate

Callback used to notify that the audio device of a conference has changed.

ConferenceListener.OnAvailableMediaChangedDelegate

Callback used to notify that the available media of a conference has changed.

ConferenceListener.OnFullStateReceivedDelegate

Callback used to notify when a notify full state has been received.

ConferenceListener.OnParticipantAddedDelegate

Callback used to notify a conference that a participant has been added.

ConferenceListener.OnParticipantAdminStatusChangedDelegate

Callback used to notify a conference that the admin status of a participant has been changed.

ConferenceListener.OnParticipantDeviceAddedDelegate

Callback used to notify a conference that a participant device has been added.

ConferenceListener.OnParticipantDeviceIsMutedDelegate

Callback used to notify that a participant device is muted or is no longer muted.

ConferenceListener.OnParticipantDeviceIsSpeakingChangedDelegate

Callback used to notify that a participant device is speaking or isn't speaking anymore.

ConferenceListener.OnParticipantDeviceJoiningRequestDelegate

Callback used to notify a conference that a participant has requested to join the conference.

ConferenceListener.OnParticipantDeviceMediaAvailabilityChangedDelegate

Callback used to notify a conference that the media availability of a participant device has been changed.

ConferenceListener.OnParticipantDeviceMediaCapabilityChangedDelegate

Callback used to notify a conference that the media capability of a participant device has been changed.

ConferenceListener.OnParticipantDeviceRemovedDelegate

Callback used to notify a conference that a participant device has been removed.

ConferenceListener.OnParticipantDeviceScreenSharingChangedDelegate

Callback used to notify a conference that a participant device starts or stops screen sharing.

ConferenceListener.OnParticipantDeviceStateChangedDelegate

Callback used to notify a conference that a participant device has changed state.

ConferenceListener.OnParticipantRemovedDelegate

Callback used to notify a conference that a participant has been removed.

ConferenceListener.OnParticipantRoleChangedDelegate

Callback used to notify a conference that the role of a participant has been changed.

ConferenceListener.OnStateChangedDelegate

Callback used to notify a conference state has changed.

ConferenceListener.OnSubjectChangedDelegate

Callback used to notify that the subject of a conference has changed.

ConferenceSchedulerListener.OnInvitationsSentDelegate

Callback for notifying when conference invitations have been sent.

In case of error for some participants, their addresses will be given as parameter.

ConferenceSchedulerListener.OnStateChangedDelegate

Callback for notifying when a registration state has changed for the conference scheduler.

CoreListener.OnAccountAddedDelegate

Account added callback prototype.

CoreListener.OnAccountRegistrationStateChangedDelegate

Callback notifying that a Linphone.Account has its registration state changed.

CoreListener.OnAccountRemovedDelegate

Account removed callback prototype.

CoreListener.OnAudioDeviceChangedDelegate

Callback prototype telling that the audio device for at least one call has changed.

CoreListener.OnAudioDevicesListUpdatedDelegate

Callback prototype telling the audio devices list has been updated.

Either a new device is available or a previously available device isn't anymore. You can call Linphone.Core.AudioDevices to get the new list.

CoreListener.OnAuthenticationRequestedDelegate

Callback for requesting authentication information to application or user.

CoreListener.OnBuddyInfoUpdatedDelegate

Callback prototype when using the buddy plugin.

CoreListener.OnCallCreatedDelegate

Callback notifying that a new Linphone.Call (either incoming or outgoing) has been created.

CoreListener.OnCallEncryptionChangedDelegate

Call encryption changed callback.

CoreListener.OnCallGoclearAckSentDelegate

GoClear ACK sent on call callback.

CoreListener.OnCallIdUpdatedDelegate

Callback to notify the callid of a call has been updated.

This is done typically when a call retry.

CoreListener.OnCallLogUpdatedDelegate

Callback to notify a new call-log entry has been added.

This is done typically when a call terminates.

CoreListener.OnCallReceiveMasterKeyChangedDelegate

Call receive master key changed callback.

CoreListener.OnCallSendMasterKeyChangedDelegate

Call send master key changed callback.

CoreListener.OnCallStateChangedDelegate

Call state notification callback.

CoreListener.OnCallStatsUpdatedDelegate

Callback for receiving quality statistics for calls.

CoreListener.OnChatRoomEphemeralMessageDeletedDelegate

Callback prototype telling that a Linphone.ChatRoom ephemeral message has expired.

CoreListener.OnChatRoomReadDelegate

Chat room marked as read callback.

CoreListener.OnChatRoomSessionStateChangedDelegate

Chat room session state changed callback.

CoreListener.OnChatRoomStateChangedDelegate

Callback prototype telling that a Linphone.ChatRoom state has changed.

CoreListener.OnChatRoomSubjectChangedDelegate

Callback prototype telling that a Linphone.ChatRoom subject has changed.

CoreListener.OnConferenceInfoReceivedDelegate

Callback prototype for notifying the application about a received conference info.

CoreListener.OnConferenceStateChangedDelegate

Callback prototype telling that a Linphone.Conference state has changed.

CoreListener.OnConfiguringStatusDelegate

Callback prototype for configuring status changes notification.

CoreListener.OnDefaultAccountChangedDelegate

Default account changed callback prototype.

CoreListener.OnDtmfReceivedDelegate

Callback for being notified of DTMFs received.

CoreListener.OnEcCalibrationAudioInitDelegate

Function prototype used by linphone_core_cbs_set_ec_calibration_audio_init.

CoreListener.OnEcCalibrationAudioUninitDelegate

Function prototype used by linphone_core_cbs_set_ec_calibration_audio_uninit.

CoreListener.OnEcCalibrationResultDelegate

Function prototype used by linphone_core_cbs_set_ec_calibration_result.

CoreListener.OnFirstCallStartedDelegate

Callback prototype telling a call has started (incoming or outgoing) while there was no other call.

CoreListener.OnFriendListCreatedDelegate

Callback prototype for reporting when a friend list has been added to the core friend lists.

CoreListener.OnFriendListRemovedDelegate

Callback prototype for reporting when a friend list has been removed from the core friend lists.

CoreListener.OnGlobalStateChangedDelegate

Global state notification callback.

CoreListener.OnImeeUserRegistrationDelegate

Callback prototype telling that an Instant Message Encryption Engine user registered on the server with or without success.

CoreListener.OnInfoReceivedDelegate

Callback prototype for receiving info messages.

CoreListener.OnIsComposingReceivedDelegate

Is composing notification callback prototype.

CoreListener.OnLastCallEndedDelegate

Callback prototype telling the last call has ended ( Linphone.Core.CallsNb returns 0)

CoreListener.OnLogCollectionUploadProgressIndicationDelegate

Callback prototype for reporting log collection upload progress indication.

CoreListener.OnLogCollectionUploadStateChangedDelegate

Callback prototype for reporting log collection upload state change.

CoreListener.OnMessageReceivedDelegate

Chat message callback prototype.

CoreListener.OnMessageReceivedUnableDecryptDelegate

Chat message not decrypted callback prototype.

CoreListener.OnMessageSentDelegate

Called after the Linphone.ChatMessage.Send() was called.

The message will be in state InProgress. In case of resend this callback won't be called.

CoreListener.OnMessagesReceivedDelegate

Chat messages callback prototype.

Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using Linphone.Core.ChatMessagesAggregationEnabled), it replaces the single message received callback.

CoreListener.OnMessageWaitingIndicationChangedDelegate

Callback notifying that a Message Waiting Indication state has changed.

CoreListener.OnNetworkReachableDelegate

Callback prototype for reporting network change either automatically detected or notified by Linphone.Core.NetworkReachable.

CoreListener.OnNewAlertTriggeredDelegate

Callback for notifying about an alert (e.g on Qos)

CoreListener.OnNewMessageReactionDelegate

Chat message new reaction callback prototype.

CoreListener.OnNewSubscriptionRequestedDelegate

Reports that a new subscription request has been received and wait for a decision.

CoreListener.OnNotifyPresenceReceivedDelegate

Report status change for a friend previously added to the Linphone.Core with linphone_core_add_friend().

CoreListener.OnNotifyPresenceReceivedForUriOrTelDelegate

Reports presence model change for a specific URI or phone number of a friend.

CoreListener.OnNotifyReceivedDelegate

Callback prototype for notifying the application about notification received from the network.

CoreListener.OnNotifySentDelegate

Callback prototype for notifying the application about notification that is being sent.

CoreListener.OnPreviewDisplayErrorOccurredDelegate

Callback to notify that there are errors from the video rendering.

Check LinphoneCallCbsVideoDisplayErrorOccurredCb for more details.

CoreListener.OnPublishReceivedDelegate

Callback prototype for notifying the application about publish received from the network.

CoreListener.OnPublishStateChangedDelegate

Callback prototype for notifying the application about changes of publish states.

CoreListener.OnPushNotificationReceivedDelegate

Callback prototype for notifying the application a push notification was received.

On iOS it only works with pushkit (VoIP) pushes.

CoreListener.OnQrcodeFoundDelegate

Callback prototype telling the result of decoded qrcode.

CoreListener.OnReactionRemovedDelegate

Chat message removed reaction callback prototype.

CoreListener.OnReferReceivedDelegate

Callback prototype for when a refer is received.

CoreListener.OnRegistrationStateChangedDelegate

Registration state notification callback prototype.

CoreListener.OnRemainingNumberOfFileTransferChangedDelegate

Called after a download is terminated or a new attachement is to be downloaded.

CoreListener.OnSnapshotTakenDelegate

Callback notifying a snapshot has been taken.

CoreListener.OnSubscribeReceivedDelegate

Callback prototype for notifying the application about subscription received from the network.

CoreListener.OnSubscriptionStateChangedDelegate

Callback prototype for notifying the application about changes of subscription states, including arrival of new subscriptions.

CoreListener.OnTransferStateChangedDelegate

Callback for notifying progresses of transfers.

CoreListener.OnVersionUpdateCheckResultReceivedDelegate

Callback prototype for reporting the result of a version update check.

EventListener.OnNotifyReceivedDelegate

Callback used to notify the received to a NOTIFY.

EventListener.OnNotifyResponseDelegate

Callback used to notify the response to a sent NOTIFY.

EventListener.OnPublishReceivedDelegate

Callback used to notify the received to a PUBLISH.

EventListener.OnPublishStateChangedDelegate

PUBLISH state changed callback.

EventListener.OnSubscribeReceivedDelegate

Callback used to notify the received to a SUBSCRIBE.

EventListener.OnSubscribeStateChangedDelegate

SUBSCRIBE state changed callback.

FriendListener.OnPresenceReceivedDelegate

Callback used to notify a friend that it has received presence information.

FriendListListener.OnContactCreatedDelegate

Callback used to notify a new contact has been created on the CardDAV server and downloaded locally.

FriendListListener.OnContactDeletedDelegate

Callback used to notify a contact has been deleted on the CardDAV server.

FriendListListener.OnContactUpdatedDelegate

Callback used to notify a contact has been updated on the CardDAV server.

FriendListListener.OnNewSipAddressDiscoveredDelegate

Callback used to notify a list that a new SIP address was discovered through long term presence mechanism.

FriendListListener.OnPresenceReceivedDelegate

Callback used to notify a list with all friends that have received presence information.

FriendListListener.OnSyncStatusChangedDelegate

Callback used to notify the status of the synchronization has changed.

LoggingServiceListener.OnLogMessageWrittenDelegate

Type of callbacks called each time liblinphone write a log message.

MagicSearchListener.OnLdapHaveMoreResultsDelegate

Callback used to notify when LDAP have more results available.

MagicSearchListener.OnMoreResultsAvailableDelegate

Callback used to notify when more results are available for a given Linphone.MagicSearchSource flag.

MagicSearchListener.OnSearchResultsReceivedDelegate

Callback used to notify when results are received.

ParticipantDeviceListener.OnIsMutedDelegate

Callback used to notify that this participant device is muted or is no longer muted.

ParticipantDeviceListener.OnIsSpeakingChangedDelegate

Callback used to notify that is this participant device speaking has changed.

ParticipantDeviceListener.OnScreenSharingChangedDelegate

Callback used to notify that this participant device is screen sharing or is no longer screen sharing.

ParticipantDeviceListener.OnStateChangedDelegate

Callback used to notify that participant device changed state.

ParticipantDeviceListener.OnStreamAvailabilityChangedDelegate

Callback used to notify that participant device stream availability has changed.

ParticipantDeviceListener.OnStreamCapabilityChangedDelegate

Callback used to notify that participant device stream capability has changed.

ParticipantDeviceListener.OnThumbnailStreamAvailabilityChangedDelegate

Callback used to notify that participant device thumbnail stream availability has changed.

ParticipantDeviceListener.OnThumbnailStreamCapabilityChangedDelegate

Callback used to notify that participant device thumbnail stream capability has changed.

ParticipantDeviceListener.OnVideoDisplayErrorOccurredDelegate

Callback to notify that there are errors from the video rendering of the participant device.

Check LinphoneCallCbsVideoDisplayErrorOccurredCb for more details.

PlayerListener.OnEofReachedDelegate

Callback for notifying end of play (file).

XmlRpcRequestListener.OnResponseDelegate

Callback used to notify the response to an XML-RPC request.

In This Article
Back to top Generated by DocFX