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

Classes

struct  MSOglContextInfo
 

Public Member Functions

void AbortAuthentication (Linphone.AuthInfo info)
 
void ActivateAudioSession (bool activated)
 
void AddAccount (Linphone.Account account)
 
void AddAllToConference ()
 
void AddAuthInfo (Linphone.AuthInfo info)
 
void AddContentTypeSupport (string contentType)
 
void AddFriendList (Linphone.FriendList list)
 
void AddLdap (Linphone.Ldap ldap)
 
void AddLinphoneSpec (string spec)
 
void AddProvisioningHeader (string headerName, string val)
 
void AddProxyConfig (Linphone.ProxyConfig config)
 
void AddRemoteContactDirectory (Linphone.RemoteContactDirectory remoteContactDirectory)
 
void AddSupportedTag (string tag)
 
void AddToConference (Linphone.Call call)
 
void AudioRouteChanged ()
 
bool CallRingingDisabled ()
 
Linphone.ChatRoomEphemeralMode ChatRoomGetDefaultEphemeralMode ()
 
void ChatRoomSetDefaultEphemeralMode (Linphone.ChatRoomEphemeralMode mode)
 
void CheckForUpdate (string currentVersion)
 
void ClearAccounts ()
 
void ClearAllAuthInfo ()
 
void ClearCallLogs ()
 
void ClearLdaps ()
 
void ClearProvisioningHeaders ()
 
void ClearProxyConfig ()
 
void ConfigSync ()
 
void ConfigureAudioSession ()
 
Linphone.Account CreateAccount (Linphone.AccountParams parameters)
 
Linphone.AccountCreator CreateAccountCreator (string xmlrpcUrl)
 
Linphone.AccountManagerServices CreateAccountManagerServices ()
 
Linphone.AccountParams CreateAccountParams ()
 
Linphone.Address CreateAddress (string address)
 
Linphone.CallLog CreateCallLog (Linphone.Address from, Linphone.Address to, Linphone.CallDir dir, int duration, long startTime, long connectedTime, Linphone.CallStatus status, bool videoEnabled, float quality)
 
Linphone.CallParams CreateCallParams (Linphone.Call call)
 
Linphone.CardDavParams CreateCardDavParams ()
 
Linphone.RemoteContactDirectory CreateCardDavRemoteContactDirectory (Linphone.CardDavParams parameters)
 
Linphone.ConferenceScheduler CreateCcmpConferenceScheduler (Linphone.Account account)
 
Linphone.ChatRoom CreateChatRoom (Linphone.ConferenceParams parameters, IEnumerable< Linphone.Address > participants)
 
Linphone.ChatRoom CreateChatRoom (Linphone.ChatRoomParams parameters, Linphone.Address localAddr, string subject, IEnumerable< Linphone.Address > participants)
 
Linphone.ChatRoom CreateChatRoom (Linphone.ChatRoomParams parameters, string subject, IEnumerable< Linphone.Address > participants)
 
Linphone.ChatRoom CreateChatRoom (string subject, IEnumerable< Linphone.Address > participants)
 
Linphone.ChatRoom CreateChatRoom (Linphone.ChatRoomParams parameters, Linphone.Address localAddr, Linphone.Address participant)
 
Linphone.ChatRoom CreateChatRoom (Linphone.Address participant)
 
Linphone.ChatRoom CreateChatRoom (Linphone.ChatRoomParams parameters, Linphone.Address localAddr, IEnumerable< Linphone.Address > participants)
 
Linphone.ChatRoom CreateClientGroupChatRoom (string subject, bool fallback)
 
Linphone.ChatRoom CreateClientGroupChatRoom (string subject, bool fallback, bool encrypted)
 
Linphone.ConferenceParams CreateConferenceParams (Linphone.Conference conference)
 
Linphone.ConferenceScheduler CreateConferenceScheduler ()
 
Linphone.ConferenceScheduler CreateConferenceScheduler (Linphone.Account account)
 
Linphone.ConferenceScheduler CreateConferenceSchedulerWithType (Linphone.Account account, Linphone.ConferenceSchedulerType schedulingType)
 
Linphone.Conference CreateConferenceWithParams (Linphone.ConferenceParams parameters)
 
Linphone.Config CreateConfig (string filename)
 
Linphone.Content CreateContent ()
 
Linphone.ConferenceScheduler CreateDbConferenceScheduler (Linphone.Account account)
 
Linphone.ChatRoomParams CreateDefaultChatRoomParams ()
 
Linphone.EktInfo CreateEktInfoFromXml (string xmlBody)
 
Linphone.Friend CreateFriend ()
 
Linphone.Friend CreateFriendFromVcard (Linphone.Vcard vcard)
 
Linphone.FriendList CreateFriendList ()
 
Linphone.Friend CreateFriendWithAddress (string address)
 
Linphone.InfoMessage CreateInfoMessage ()
 
Linphone.Ldap CreateLdap ()
 
Linphone.LdapParams CreateLdapParams ()
 
Linphone.RemoteContactDirectory CreateLdapRemoteContactDirectory (Linphone.LdapParams parameters)
 
Linphone.Ldap CreateLdapWithParams (Linphone.LdapParams parameters)
 
Linphone.Player CreateLocalPlayer (string soundCardName, string videoDisplayName, IntPtr windowId)
 
Linphone.MagicSearch CreateMagicSearch ()
 
Linphone.NatPolicy CreateNatPolicy ()
 
IntPtr CreateNativePreviewWindowId (IntPtr context)
 
IntPtr CreateNativePreviewWindowId ()
 
IntPtr CreateNativeVideoWindowId (IntPtr context)
 
IntPtr CreateNativeVideoWindowId ()
 
Linphone.Event CreateNotify (Linphone.Address resource, string ev)
 
Linphone.Event CreateOneShotPublish (Linphone.Address resource, string ev)
 
Linphone.PresenceActivity CreatePresenceActivity (Linphone.PresenceActivityType acttype, string description)
 
Linphone.PresenceModel CreatePresenceModel ()
 
Linphone.PresenceModel CreatePresenceModelWithActivity (Linphone.PresenceActivityType acttype, string description)
 
Linphone.PresenceModel CreatePresenceModelWithActivityAndNote (Linphone.PresenceActivityType acttype, string description, string note, string lang)
 
Linphone.PresenceNote CreatePresenceNote (string content, string lang)
 
Linphone.PresencePerson CreatePresencePerson (string id)
 
Linphone.PresenceService CreatePresenceService (string id, Linphone.PresenceBasicStatus basicStatus, string contact)
 
Linphone.Address CreatePrimaryContactParsed ()
 
Linphone.ProxyConfig CreateProxyConfig ()
 
Linphone.Event CreatePublish (Linphone.Address resource, string ev, int expires)
 
Linphone.Recorder CreateRecorder (Linphone.RecorderParams parameters)
 
Linphone.RecorderParams CreateRecorderParams ()
 
Linphone.ConferenceScheduler CreateSipConferenceScheduler (Linphone.Account account)
 
Linphone.Event CreateSubscribe (Linphone.Address resource, string ev, int expires)
 
Linphone.Event CreateSubscribe (Linphone.Address resource, Linphone.ProxyConfig proxy, string ev, int expires)
 
Linphone.Vcard CreateVcardFromText (string input)
 
string CreateXmlFromEktInfo (Linphone.EktInfo ektInfo, Linphone.Account account)
 
string CreateXmlFromEktInfo (Linphone.EktInfo ektInfo)
 
Linphone.XmlRpcSession CreateXmlRpcSession (string url)
 
void DeleteChatRoom (Linphone.ChatRoom chatRoom)
 
void DeleteConferenceInformation (Linphone.ConferenceInfo conferenceInfo)
 
void DidRegisterForRemotePush (IntPtr deviceToken)
 
void DidRegisterForRemotePushWithStringifiedToken (string deviceTokenStr)
 
void DisableCallRinging (bool yesno)
 
void DisableChat (Linphone.Reason denyReason)
 
void EnableChat ()
 
void EnsureRegistered ()
 
void EnterBackground ()
 
void EnterConference ()
 
void EnterForeground ()
 
bool FileFormatSupported (string fmt)
 
Linphone.AuthInfo FindAuthInfo (string realm, string username, string sipDomain)
 
Linphone.Call FindCallFromUri (string uri)
 
Linphone.CallLog FindCallLog (string callId, int limit)
 
Linphone.CallLog FindCallLogFromCallId (string callId)
 
Linphone.ChatRoom FindChatRoom (Linphone.Address peerAddr, Linphone.Address localAddr)
 
Linphone.ConferenceInfo FindConferenceInformationFromCcmpUri (string uri)
 
Linphone.ConferenceInfo FindConferenceInformationFromUri (Linphone.Address uri)
 
IEnumerable< Linphone.AddressFindContactsByChar (string filter, bool sipOnly)
 
Linphone.Friend FindFriend (Linphone.Address address)
 
Linphone.Friend FindFriendByPhoneNumber (string phoneNumber)
 
IEnumerable< Linphone.FriendFindFriends (Linphone.Address address)
 
Linphone.ChatRoom FindOneToOneChatRoom (Linphone.Address localAddr, Linphone.Address participantAddr, bool encrypted)
 
Linphone.Account GetAccountByIdkey (string idkey)
 
Linphone.Call GetCallByCallid (string callId)
 
Linphone.Call GetCallByRemoteAddress (string remoteAddress)
 
Linphone.Call GetCallByRemoteAddress2 (Linphone.Address remoteAddress)
 
IEnumerable< Linphone.CallLogGetCallHistory (Linphone.Address peerAddress, Linphone.Address localAddress)
 
Linphone.ChatRoom GetChatRoom (Linphone.Address addr)
 
Linphone.ChatRoom GetChatRoom (Linphone.Address peerAddr, Linphone.Address localAddr)
 
Linphone.ChatRoom GetChatRoomFromUri (string to)
 
IEnumerable< Linphone.ConferenceInfoGetConferenceInformationListAfterTime (long time)
 
IEnumerable< Linphone.ConferenceInfoGetConferenceInformationsWithParticipant (Linphone.Address uri)
 
Linphone.Friend GetFriendByRefKey (string key)
 
Linphone.FriendList GetFriendListByName (string name)
 
Linphone.PayloadType GetPayloadType (string type, int rate, int channels)
 
Linphone.ProxyConfig GetProxyConfigByIdkey (string idkey)
 
Linphone.ZrtpPeerStatus GetZrtpStatus (string addr)
 
bool HasBuiltinEchoCanceller ()
 
bool HasCrappyOpengl ()
 
bool InCall ()
 
Linphone.Address InterpretUrl (string url)
 
Linphone.Address InterpretUrl (string url, bool applyInternationalPrefix)
 
Linphone.Call Invite (string url)
 
Linphone.Call InviteAddress (Linphone.Address addr)
 
Linphone.Call InviteAddressWithParams (Linphone.Address addr, Linphone.CallParams parameters)
 
Linphone.Call InviteAddressWithParams (Linphone.Address addr, Linphone.CallParams parameters, string subject, Linphone.Content content)
 
Linphone.Call InviteWithParams (string url, Linphone.CallParams parameters)
 
bool IsContentTypeSupported (string contentType)
 
bool IsMediaEncryptionSupported (Linphone.MediaEncryption menc)
 
bool IsMediaFilterSupported (string filtername)
 
bool IsPluginLoaded (string name)
 
void Iterate ()
 
bool LdapAvailable ()
 
void LeaveConference ()
 
bool LimeX3DhAvailable ()
 
void LoadConfigFromXml (string xmlUri)
 
bool MediaEncryptionSupported (Linphone.MediaEncryption menc)
 
void MigrateLogsFromRcToDb ()
 
void NotifyAllFriends (Linphone.PresenceModel presence)
 
void NotifyNotifyPresenceReceived (Linphone.Friend linphoneFriend)
 
void NotifyNotifyPresenceReceivedForUriOrTel (Linphone.Friend linphoneFriend, string uriOrTel, Linphone.PresenceModel presenceModel)
 
void PauseAllCalls ()
 
void PlayDtmf (sbyte dtmf, int durationMs)
 
void PlayLocal (string audiofile)
 
int PreemptSoundResources ()
 
void PreviewOglRender ()
 
void ProcessPushNotification (string callId)
 
Linphone.Event Publish (Linphone.Address resource, string ev, int expires, Linphone.Content body)
 
void RefreshRegisters ()
 
void RejectSubscriber (Linphone.Friend linphoneFriend)
 
void ReloadMsPlugins (string path)
 
void ReloadSoundDevices ()
 
void ReloadVideoDevices ()
 
void RemoveAccount (Linphone.Account account)
 
void RemoveAccountWithData (Linphone.Account account)
 
void RemoveAuthInfo (Linphone.AuthInfo info)
 
void RemoveCallLog (Linphone.CallLog callLog)
 
void RemoveContentTypeSupport (string contentType)
 
void RemoveFriendList (Linphone.FriendList list)
 
void RemoveFromConference (Linphone.Call call)
 
void RemoveLdap (Linphone.Ldap ldap)
 
void RemoveLinphoneSpec (string spec)
 
void RemoveProxyConfig (Linphone.ProxyConfig config)
 
void RemoveRemoteContactDirectory (Linphone.RemoteContactDirectory remoteContactDirectory)
 
void RemoveSupportedTag (string tag)
 
void ResetEchoCancellationCalibration ()
 
void ResetMissedCallsCount ()
 
Linphone.ChatRoom SearchChatRoom (Linphone.ChatRoomParams parameters, Linphone.Address localAddr, Linphone.Address remoteAddr, IEnumerable< Linphone.Address > participants)
 
Linphone.ChatRoom SearchChatRoom (Linphone.ConferenceParams parameters, Linphone.Address localAddr, Linphone.Address remoteAddr, IEnumerable< Linphone.Address > participants)
 
Linphone.ChatRoom SearchChatRoomByIdentifier (string identifier)
 
Linphone.Conference SearchConference (Linphone.ConferenceParams parameters, Linphone.Address localAddr, Linphone.Address remoteAddr, IEnumerable< Linphone.Address > participants)
 
Linphone.Conference SearchConference (Linphone.Address conferenceAddr)
 
Linphone.Conference SearchConferenceByIdentifier (string identifier)
 
void SetAudioPortRange (int minPort, int maxPort)
 
void SetQrcodeDecodeRect (int x, int y, int w, int h)
 
void SetRefreshWindow (int minValue, int maxValue)
 
void SetTextPortRange (int minPort, int maxPort)
 
void SetTone (Linphone.ToneID toneId, string audiofile)
 
void SetUserAgent (string name, string version)
 
void SetVideoPortRange (int minPort, int maxPort)
 
bool SoundDeviceCanCapture (string device)
 
bool SoundDeviceCanPlayback (string device)
 
bool SoundResourcesLocked ()
 
void Start ()
 
void StartEchoCancellerCalibration ()
 
void StartEchoTester (uint rate)
 
void Stop ()
 
void StopAsync ()
 
void StopDtmf ()
 
void StopEchoTester ()
 
void StopRinging ()
 
Linphone.Event Subscribe (Linphone.Address resource, string ev, int expires, Linphone.Content body)
 
void TakePreviewSnapshot (string file)
 
void TerminateAllCalls ()
 
void TerminateConference ()
 
void UpgradeDatabase ()
 
void UploadLogCollection ()
 
void UsePreviewWindow (bool yesno)
 
void VerifyServerCertificates (bool yesno)
 
void VerifyServerCn (bool yesno)
 
bool VideoSupported ()
 

Static Public Member Functions

static string CompressLogCollection ()
 
static void EnableLogCollection (Linphone.LogCollectionState state)
 
static Linphone.LogCollectionState LogCollectionEnabled ()
 
static void ResetLogCollection ()
 
static void SerializeLogs ()
 
static void SetLogCollectionMaxFileSize (long size)
 
static void SetLogCollectionPath (string path)
 
static void SetLogCollectionPrefix (string prefix)
 
static bool TunnelAvailable ()
 
static bool UpnpAvailable ()
 
static bool VcardSupported ()
 

Properties

MediastreamerFactory MsFactory [get]
 
string NativeVideoWindowIdString [get, set]
 
string NativePreviewWindowIdString [get, set]
 
IntPtr NativeVideoWindowId [get, set]
 
IntPtr NativePreviewWindowId [get, set]
 
CoreListener Listener [get, set]
 
static long LogCollectionMaxFileSize [get]
 
static string LogCollectionPath [get]
 
static string LogCollectionPrefix [get]
 
static bool PostQuantumAvailable [get]
 
static string Version [get]
 
Linphone.AccountCreatorBackend AccountCreatorBackend [get, set]
 
string AccountCreatorUrl [get, set]
 
IEnumerable< Linphone.AccountAccountList [get]
 
string AdaptiveRateAlgorithm [get, set]
 
bool AdaptiveRateControlEnabled [get, set]
 
bool AgcEnabled [get, set]
 
bool AlertsEnabled [get, set]
 
bool AudioAdaptiveJittcompEnabled [get, set]
 
IEnumerable< Linphone.AudioDeviceAudioDevices [get]
 
int AudioDscp [get, set]
 
int AudioJittcomp [get, set]
 
string AudioMulticastAddr [get, set]
 
bool AudioMulticastEnabled [get, set]
 
int AudioMulticastTtl [get, set]
 
IEnumerable< Linphone.PayloadTypeAudioPayloadTypes [get, set]
 
int AudioPort [get, set]
 
Linphone.Range AudioPortsRange [get]
 
IEnumerable< Linphone.AuthInfoAuthInfoList [get]
 
bool AutoDownloadIcalendarsEnabled [get, set]
 
bool AutoDownloadVoiceRecordingsEnabled [get, set]
 
int AutoIterateBackgroundSchedule [get, set]
 
bool AutoIterateEnabled [get, set]
 
int AutoIterateForegroundSchedule [get, set]
 
bool AutoSendRingingEnabled [get, set]
 
bool AutomaticHttpProxyDetectionEnabled [get, set]
 
Linphone.AVPFMode AvpfMode [get, set]
 
int AvpfRrInterval [get, set]
 
bool BaudotEnabled [get, set]
 
IEnumerable< Linphone.CallLogCallLogs [get]
 
string CallLogsDatabasePath [get, set]
 
string CallOnHoldMusicFile [get, set]
 
bool CallToneIndicationsEnabled [get, set]
 
bool CallkitEnabled [get, set]
 
IEnumerable< Linphone.CallCalls [get]
 
int CallsNb [get]
 
int CameraSensorRotation [get]
 
int CameraWhitebalance [get, set]
 
bool CapabilityNegociationEnabled [get, set]
 
bool CapabilityNegotiationReinviteEnabled [get, set]
 
string CaptureDevice [get, set]
 
bool CfgLinesMergingEnabled [get, set]
 
bool ChatEnabled [get]
 
bool ChatMessagesAggregationEnabled [get, set]
 
IEnumerable< Linphone.ChatRoomChatRooms [get]
 
int ConferenceAvailabilityBeforeStart [get, set]
 
int ConferenceCleanupPeriod [get, set]
 
int ConferenceExpirePeriod [get, set]
 
bool ConferenceIcsInMessageBodyEnabled [get, set]
 
IEnumerable< Linphone.ConferenceInfoConferenceInformationList [get]
 
float ConferenceLocalInputVolume [get]
 
int ConferenceMaxThumbnails [get, set]
 
Linphone.ConferenceParticipantListType ConferenceParticipantListType [get, set]
 
bool ConferenceServerEnabled [get, set]
 
Linphone.Config Config [get]
 
Linphone.ConsolidatedPresence ConsolidatedPresence [get, set]
 
Linphone.Call CurrentCall [get]
 
Linphone.Address CurrentCallRemoteAddress [get]
 
Linphone.VideoDefinition CurrentPreviewVideoDefinition [get]
 
bool DatabaseEnabled [get, set]
 
Linphone.Account DefaultAccount [get, set]
 
Linphone.ConferenceLayout DefaultConferenceLayout [get, set]
 
int DefaultEphemeralLifetime [get, set]
 
Linphone.ChatRoomEphemeralMode DefaultEphemeralMode [get, set]
 
int DefaultEphemeralNotReadLifetime [get, set]
 
Linphone.FriendList DefaultFriendList [get]
 
Linphone.AudioDevice DefaultInputAudioDevice [get, set]
 
Linphone.AudioDevice DefaultOutputAudioDevice [get, set]
 
Linphone.ProxyConfig DefaultProxyConfig [get, set]
 
string DefaultVideoDisplayFilter [get]
 
int DelayedTimeout [get, set]
 
int DeviceRotation [get, set]
 
Linphone.DigestAuthenticationPolicy DigestAuthenticationPolicy [get, set]
 
bool DisableRecordOnMute [get, set]
 
bool DnsSearchEnabled [get, set]
 
IEnumerable< string > DnsServers [set]
 
IEnumerable< string > DnsServersApp [set]
 
bool DnsSetByApp [get]
 
bool DnsSrvEnabled [get, set]
 
int DownloadBandwidth [get, set]
 
int DownloadPtime [get, set]
 
int EchoCancellationCalibration [get]
 
bool EchoCancellationEnabled [get, set]
 
string EchoCancellerFilterName [get, set]
 
bool EchoLimiterEnabled [get, set]
 
bool EktPluginLoaded [set]
 
bool EmptyChatroomsDeletionEnabled [get, set]
 
int EnableSipUpdate [set]
 
Linphone.EphemeralChatMessagePolicy EphemeralChatMessagePolicy [get, set]
 
int ExpectedBandwidth [set]
 
IEnumerable< Linphone.AudioDeviceExtendedAudioDevices [get]
 
bool FecEnabled [get, set]
 
string FileTransferServer [get, set]
 
bool ForcedIceRelayEnabled [get, set]
 
bool FriendListSubscriptionEnabled [get, set]
 
string FriendsDatabasePath [get, set]
 
IEnumerable< Linphone.FriendListFriendsLists [get]
 
IEnumerable< Linphone.ConferenceInfoFutureConferenceInformationList [get]
 
bool GenericComfortNoiseEnabled [get, set]
 
Linphone.GlobalState GlobalState [get]
 
bool GruuInConferenceAddressEnabled [get, set]
 
bool GuessHostname [get, set]
 
string HttpProxyHost [get, set]
 
int HttpProxyPort [get, set]
 
string Identity [get]
 
Linphone.ImNotifPolicy ImNotifPolicy [get]
 
int ImdnResendPeriod [get, set]
 
int ImdnToEverybodyThreshold [get, set]
 
int InCallTimeout [get, set]
 
int IncTimeout [get, set]
 
Linphone.AudioDevice InputAudioDevice [get, set]
 
bool Ipv6Enabled [get, set]
 
bool IsAutoDownloadIcalendarsEnabled [get]
 
bool IsAutoDownloadVoiceRecordingsEnabled [get]
 
bool IsAutoIterateEnabled [get]
 
bool IsEchoCancellerCalibrationRequired [get]
 
bool IsEktPluginLoaded [get]
 
bool IsFriendListSubscriptionEnabled [get]
 
bool IsInBackground [get]
 
bool IsInConference [get]
 
bool IsIncomingInvitePending [get]
 
bool IsMediaEncryptionMandatory [get]
 
bool IsNativeRingingEnabled [get]
 
bool IsNetworkReachable [get]
 
bool IsPushNotificationAvailable [get]
 
bool IsPushNotificationEnabled [get]
 
bool IsRecordAwareEnabled [get]
 
bool IsSenderNameHiddenInForwardMessage [get]
 
bool IsVerifyServerCertificates [get]
 
bool IsVerifyServerCn [get]
 
bool IsVibrationOnIncomingCallEnabled [get]
 
bool KeepAliveEnabled [get, set]
 
string Label [get, set]
 
Linphone.CallLog LastOutgoingCallLog [get]
 
IEnumerable< Linphone.LdapLdapList [get]
 
bool LimeX3DhEnabled [get, set]
 
string LimeX3DhServerUrl [get, set]
 
IEnumerable< string > LinphoneSpecsList [get, set]
 
IEnumerable< string > LoadedPlugins [get]
 
bool LocalPermissionEnabled [get]
 
string LogCollectionUploadServerUrl [get, set]
 
int MaxCallLogs [get, set]
 
int MaxCalls [get, set]
 
int MaxSizeForAutoDownloadIncomingFiles [get, set]
 
string MediaDevice [get, set]
 
Linphone.MediaEncryption MediaEncryption [get, set]
 
bool MediaEncryptionMandatory [set]
 
bool MediaNetworkReachable [set]
 
Linphone.MediaResourceMode MediaResourceMode [get, set]
 
int MessageAutomaticResendingDelay [get, set]
 
int MessageSendingDelay [get, set]
 
bool MicEnabled [get, set]
 
float MicGainDb [get, set]
 
int MissedCallsCount [get]
 
int Mtu [get, set]
 
string NatAddress [get, set]
 
Linphone.NatPolicy NatPolicy [get, set]
 
bool NativeRingingEnabled [get, set]
 
bool NetworkReachable [set]
 
bool NoiseSuppressionEnabled [get, set]
 
int NortpOnholdTimeout [get, set]
 
int NortpTimeout [get, set]
 
Linphone.AudioDevice OutputAudioDevice [get, set]
 
string PlayFile [get, set]
 
string PlaybackDevice [get, set]
 
float PlaybackGainDb [get, set]
 
float PreferredFramerate [get, set]
 
Linphone.VideoDefinition PreferredVideoDefinition [get, set]
 
string PreferredVideoDefinitionByName [set]
 
Linphone.PresenceModel PresenceModel [get, set]
 
Linphone.VideoDefinition PreviewVideoDefinition [get, set]
 
string PreviewVideoDefinitionByName [set]
 
string PrimaryContact [get, set]
 
Linphone.Address PrimaryContactAddress [get]
 
Linphone.Address PrimaryContactParsed [get]
 
string ProvisioningUri [get, set]
 
IEnumerable< Linphone.ProxyConfigProxyConfigList [get]
 
int PushIncomingCallTimeout [get, set]
 
Linphone.PushNotificationConfig PushNotificationConfig [get]
 
bool PushNotificationEnabled [get, set]
 
bool QrcodeVideoPreviewEnabled [get, set]
 
int QueuedMessageResendPeriod [get, set]
 
bool RealtimeTextEnabled [get]
 
uint RealtimeTextKeepaliveInterval [get, set]
 
bool RecordAwareEnabled [get, set]
 
string RecordFile [get, set]
 
bool RegisterOnlyWhenNetworkIsUp [get, set]
 
uint RemainingDownloadFileCount [get]
 
uint RemainingUploadFileCount [get]
 
IEnumerable< Linphone.RemoteContactDirectoryRemoteContactDirectories [get]
 
string RemoteRingbackTone [get, set]
 
bool RetransmissionOnNackEnabled [get, set]
 
string Ring [get, set]
 
bool RingDuringIncomingEarlyMedia [get, set]
 
string Ringback [get, set]
 
string RingerDevice [get, set]
 
string RootCa [get, set]
 
string RootCaData [set]
 
bool RtpBundleEnabled [get, set]
 
bool Sdp200AckEnabled [get, set]
 
bool SelfViewEnabled [get, set]
 
bool SendMessageAfterNotifyEnabled [get, set]
 
bool SenderNameHiddenInForwardMessageEnabled [set]
 
bool SessionExpiresEnabled [get, set]
 
int SessionExpiresMinValue [get, set]
 
Linphone.SessionExpiresRefresher SessionExpiresRefresherValue [get, set]
 
int SessionExpiresValue [get, set]
 
int SipDscp [get, set]
 
bool SipNetworkReachable [set]
 
int SipTransportTimeout [get, set]
 
IEnumerable< string > SoundDevicesList [get]
 
string SrtpCryptoSuites [get, set]
 
string StaticPicture [get, set]
 
float StaticPictureFps [get, set]
 
string StunServer [get, set]
 
IEnumerable< string > SupportedFileFormatsList [get]
 
string SupportedTag [set]
 
Linphone.SupportLevel Tag100RelSupportLevel [get, set]
 
bool TcapLineMergingEnabled [set]
 
bool TcapLinesMergingEnabled [get]
 
IEnumerable< Linphone.PayloadTypeTextPayloadTypes [get, set]
 
int TextPort [get, set]
 
Linphone.Range TextPortsRange [get]
 
string TlsCert [get, set]
 
string TlsCertPath [get, set]
 
string TlsKey [get, set]
 
string TlsKeyPath [get, set]
 
Linphone.Transports Transports [get, set]
 
Linphone.Transports TransportsUsed [get]
 
Linphone.Tunnel Tunnel [get]
 
int UnreadChatMessageCount [get]
 
int UnreadChatMessageCountFromActiveLocals [get]
 
int UploadBandwidth [get, set]
 
int UploadPtime [get, set]
 
string UpnpExternalIpaddress [get]
 
Linphone.UpnpState UpnpState [get]
 
bool UseFiles [get, set]
 
bool UseInfoForDtmf [get, set]
 
bool UseRfc2833ForDtmf [get, set]
 
string UserAgent [get]
 
string UserCertificatesPath [get, set]
 
bool VibrationOnIncomingCallEnabled [get, set]
 
Linphone.VideoActivationPolicy VideoActivationPolicy [get, set]
 
bool VideoAdaptiveJittcompEnabled [get, set]
 
bool VideoCaptureEnabled [get, set]
 
Linphone.CodecPriorityPolicy VideoCodecPriorityPolicy [get, set]
 
string VideoDevice [get, set]
 
IEnumerable< string > VideoDevicesList [get]
 
bool VideoDisplayEnabled [get, set]
 
string VideoDisplayFilter [get, set]
 
int VideoDscp [get, set]
 
bool VideoEnabled [get]
 
int VideoJittcomp [get, set]
 
string VideoMulticastAddr [get, set]
 
bool VideoMulticastEnabled [get, set]
 
int VideoMulticastTtl [get, set]
 
IEnumerable< Linphone.PayloadTypeVideoPayloadTypes [get, set]
 
int VideoPort [get, set]
 
Linphone.Range VideoPortsRange [get]
 
string VideoPreset [get, set]
 
bool VideoPreviewEnabled [get, set]
 
bool VideoSourceReuseEnabled [set]
 
bool WifiOnlyEnabled [get, set]
 
bool ZeroRtpPortForStreamInactiveEnabled [get, set]
 
IntPtr ZrtpCacheDb [get]
 
bool ZrtpGoClearEnabled [get, set]
 
string ZrtpSecretsFile [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

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.

Warning : Our API isn't thread-safe but also isn't blocking, so it is strongly recommend to always call our methods from the main thread.

Once you don't need it anymore, call Linphone.Core.Stop() and release the reference on it so it can gracefully shutdown.

Member Function Documentation

void Linphone.Core.AbortAuthentication ( Linphone.AuthInfo  info)
inline

This method is used to abort a user authentication request initiated by Linphone.Core from the authentication_requested callback of Linphone.CoreListener.

Note : this function currently does not take into account the 'info' parameter. All pending authentication requests are aborted.

Parameters
infothe Linphone.AuthInfo for which to abort authentication
void Linphone.Core.ActivateAudioSession ( bool  activated)
inline

Special function to indicate if the audio session is activated.

Must be called when ProviderDelegate of the callkit notifies that the audio session is activated or deactivated.

Parameters
activatedtrue to activate the audio session, false to disable it.
void Linphone.Core.AddAccount ( Linphone.Account  account)
inline

Adds an account.

This will start registration on the proxy, if registration is enabled.

Parameters
accountthe Linphone.Account to add
Returns
0 if successful, -1 otherwise
void Linphone.Core.AddAllToConference ( )
inline

Adds all calls into the conference.

If no conference is running a new internal conference context is created and all current calls are added to it.

Returns
0 if succeeded. Negative number if failed

Warning : This function guarantees that the local endpoint is added to the conference.

Deprecated : 23/01/2025 Use Linphone.Conference.InviteParticipants() instead.

void Linphone.Core.AddAuthInfo ( Linphone.AuthInfo  info)
inline

Adds authentication information to the Linphone.Core.

These nformation will be used during all SIP or HTTP transactions that require authentication.

Parameters
infoThe Linphone.AuthInfo to add.
void Linphone.Core.AddContentTypeSupport ( string  contentType)
inline

Add support for the specified content type.

It is the application responsibility to handle it correctly afterwards.

Parameters
contentTypeThe content type to add support for
void Linphone.Core.AddFriendList ( Linphone.FriendList  list)
inline

Add a friend list.

Parameters
listLinphone.FriendList object
void Linphone.Core.AddLdap ( Linphone.Ldap  ldap)
inline

Add or update a LDAP server and save it to the configuration.

Parameters
ldapThe Linphone.Ldap object to add/update.

Deprecated : 18/11/2024 use Linphone.Core.AddRemoteContactDirectory() instead.

void Linphone.Core.AddLinphoneSpec ( string  spec)
inline

Add the given linphone specs to the list of functionalities the linphone client supports.

See : Linphone.Core.LinphoneSpecsList

Parameters
specThe spec to add
void Linphone.Core.AddProvisioningHeader ( string  headerName,
string  val 
)
inline

Add an extra header for retrieving the remote provisioning (check Linphone.Core.ProvisioningUri).

This can also be set from configuration file or factory config file, from[misc] section, item "config-uri-headers_X" where X is the index of the header starting by 0.

Parameters
headerNamethe header to use when downloading the configuration.
valthe value to use when downloading the configuration.
void Linphone.Core.AddProxyConfig ( Linphone.ProxyConfig  config)
inline

Add a proxy configuration.

This will start registration on the proxy, if registration is enabled.

Parameters
configthe Linphone.ProxyConfig to add
Returns
0 if successful, -1 otherwise

Deprecated : 04/09/2024 Use Linphone.Core.AddAccount()

void Linphone.Core.AddRemoteContactDirectory ( Linphone.RemoteContactDirectory  remoteContactDirectory)
inline

Adds a Linphone.RemoteContactDirectory object previously created to the Core, to be used later by Linphone.MagicSearch to query contacts using either LDAP or CardDAV.

Parameters
remoteContactDirectorythe newly created Linphone.RemoteContactDirectory to add.
void Linphone.Core.AddSupportedTag ( string  tag)
inline

This function controls signaling features supported by the core.

They are typically included in a SIP Supported header.

Parameters
tagThe feature tag name
void Linphone.Core.AddToConference ( Linphone.Call  call)
inline

Adds a participant to the conference.

If no conference is going on a new internal conference context is created and the participant is added to it.

Parameters
callThe current call with the participant to add
Returns
0 if succeeded. Negative number if failed

Deprecated : 23/01/2025 Use Linphone.Conference.AddParticipant() instead.

void Linphone.Core.AudioRouteChanged ( )
inline

Special function to indicate if the audio route is changed.

Must be called in the callback of AVAudioSessionRouteChangeNotification.

Deprecated : 07/01/2020 now handled in the linphone SDK directly

bool Linphone.Core.CallRingingDisabled ( )
inline

Check whether ringing of calls is disabled.

Returns
true if call ringing is disabled
Linphone.ChatRoomEphemeralMode Linphone.Core.ChatRoomGetDefaultEphemeralMode ( )
inline

Gets the default ephemeral message mode.

Returns
the default ephemeral message mode Linphone.ChatRoomEphemeralMode

Deprecated : 21/11/2025 use Linphone.Core.DefaultEphemeralMode.

void Linphone.Core.ChatRoomSetDefaultEphemeralMode ( Linphone.ChatRoomEphemeralMode  mode)
inline

Sets the default ephemeral message mode.

Parameters
modedefault ephemeral message mode Linphone.ChatRoomEphemeralMode

Deprecated : 21/11/2025 use Linphone.Core.DefaultEphemeralMode.

void Linphone.Core.CheckForUpdate ( string  currentVersion)
inline

Asynchronously checks if a new version of the application is available from a well-known http server URI given by Linphone.Core 's configuration.

The result of the check is given through the Linphone.CoreListener interface, see linphone_core_cbs_set_version_update_check_result_received. The http URI has to be given in [misc] section as key 'version_check_url_root'. The subdirectory is appended to this root URI, per platform, and a "VERSION" file is fetched. For example: -https://download.linphone.org/releases/android/RELEASE -https://download.linphone.org/releases/windows/RELEASE The RELEASE file is expected to contain the most recent version number available followed by an http uri where this version can be retrieved. For example: 5.2.5 https://play.google.com/store/apps/details?id=org.linphone

void Linphone.Core.ClearAccounts ( )
inline

Erases all accounts from config.

void Linphone.Core.ClearAllAuthInfo ( )
inline

Clears all authentication information.

void Linphone.Core.ClearCallLogs ( )
inline

Erases the call log list.

void Linphone.Core.ClearLdaps ( )
inline

Erases all LDAP from the configuration.

Deprecated : 18/11/2024 use Linphone.Core.RemoveRemoteContactDirectory() instead.

void Linphone.Core.ClearProvisioningHeaders ( )
inline

Clear all headers that were added with Linphone.Core.AddProvisioningHeader().

void Linphone.Core.ClearProxyConfig ( )
inline

Erase all proxies from config.

Deprecated : 04/09/2024 Use Linphone.Core.ClearAccounts()

static string Linphone.Core.CompressLogCollection ( )
inlinestatic

Compresses the log collection in a single file.

Returns
The path of the compressed log collection file.
void Linphone.Core.ConfigSync ( )
inline

Forces a flush of the config to disk.

Returns
0 if successful, -1 otherwise
void Linphone.Core.ConfigureAudioSession ( )
inline

Special function to configure audio session with default settings.

Must be called in ProviderDelegate's callbacks when answer an incoming call and start an outgoing call.

Linphone.Account Linphone.Core.CreateAccount ( Linphone.AccountParams  parameters)
inline

Creates an account using given parameters, see Linphone.Core.CreateAccountParams().

Once created, the account must be added to the Linphone.Core in order to be used for registration, calls, messages etc. Use Linphone.Core.AddAccount() to add it to the Linphone.Core.

Parameters
parametersLinphone.AccountParams object
Returns
Linphone.Account with default values set
Linphone.AccountCreator Linphone.Core.CreateAccountCreator ( string  xmlrpcUrl)
inline

Create a Linphone.AccountCreator and set Linphone Request callbacks.

Parameters
xmlrpcUrlThe URL to the XML-RPC server.
Returns
The new Linphone.AccountCreator object.

Deprecated : 04/09/2024 : The Linphone.AccountCreator interface is replaced by the Linphone.AccountManagerServices interface.

Linphone.AccountManagerServices Linphone.Core.CreateAccountManagerServices ( )
inline
Linphone.AccountParams Linphone.Core.CreateAccountParams ( )
inline

Create an account params using default values from Linphone core.

Returns
Linphone.AccountParams with default values set
Linphone.Address Linphone.Core.CreateAddress ( string  address)
inline

Creates a Linphone.Address object by parsing the user supplied address, given as a string.

Parameters
addressString containing the user supplied address
Returns
The created Linphone.Address object

Deprecated : 04/06/2024 use Linphone.Factory.CreateAddress().

Linphone.CallLog Linphone.Core.CreateCallLog ( Linphone.Address  from,
Linphone.Address  to,
Linphone.CallDir  dir,
int  duration,
long  startTime,
long  connectedTime,
Linphone.CallStatus  status,
bool  videoEnabled,
float  quality 
)
inline

Creates a fake Linphone.CallLog.

Parameters
fromLinphone.Address of caller
toLinphone.Address of callee
dirLinphone.CallDir of call
durationcall length in seconds
startTimetimestamp of call start time
connectedTimetimestamp of call connection
statusLinphone.CallStatus of call
videoEnabledwhether video was enabled or not for this call
qualitycall quality
Returns
a Linphone.CallLog object
Linphone.CallParams Linphone.Core.CreateCallParams ( Linphone.Call  call)
inline

Creates a Linphone.CallParams suitable for Linphone.Core.InviteWithParams(), Linphone.Call.AcceptWithParams(), Linphone.Call.AcceptEarlyMediaWithParams(), Linphone.Call.Update() or linphone_call_accept_update_with_params().

The parameters are initialized according to the current Linphone.Core configuration and the current state of the call if any. In order to create a Linphone.CallParams for an already created call, the call argument must not be null.

Parameters
callLinphone.Call for which the parameters are to be built, or null in the case where the parameters are to be used for a new outgoing call.
Returns
A new Linphone.CallParams object.
Linphone.CardDavParams Linphone.Core.CreateCardDavParams ( )
inline

Creates a new CardDAV server params object that may be used later by Linphone.MagicSearch to query contacts.

Returns
a new Linphone.CardDavParams object to configure, and then use it to create a Linphone.RemoteContactDirectory using Linphone.Core.CreateCardDavRemoteContactDirectory().
Linphone.RemoteContactDirectory Linphone.Core.CreateCardDavRemoteContactDirectory ( Linphone.CardDavParams  parameters)
inline

Creates a new CardDAV server params object that may be used later by Linphone.MagicSearch to query contacts.

Parameters
parametersthe Linphone.CardDavParams to configure this remote contact directory.
Returns
a new Linphone.RemoteContactDirectory object to configure, and then add using Linphone.Core.AddRemoteContactDirectory().
Linphone.ConferenceScheduler Linphone.Core.CreateCcmpConferenceScheduler ( Linphone.Account  account)
inline

Create a SIP conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

A CCMPConferenceScheduler creates a conference on a server by using the CCMP protocol

Parameters
accountThe Linphone.Account to use in the Linphone.ConferenceScheduler.
Returns
A pointer on the freshly created Linphone.ConferenceScheduler.
Linphone.ChatRoom Linphone.Core.CreateChatRoom ( Linphone.ConferenceParams  parameters,
IEnumerable< Linphone.Address participants 
)
inline

Create a chat room.

Parameters
parametersThe chat room creation parameters Linphone.ConferenceParams
participantsThe initial list of participants of the chat room. A list of Linphone.Address objects.
Returns
The newly created chat room (can be an existing one if backend is Basic) or null.
Linphone.ChatRoom Linphone.Core.CreateChatRoom ( Linphone.ChatRoomParams  parameters,
Linphone.Address  localAddr,
string  subject,
IEnumerable< Linphone.Address participants 
)
inline

Create a chat room.

Parameters
parametersThe chat room creation parameters Linphone.ChatRoomParams
localAddrLinphone.Address representing the local proxy configuration to use for the chat room creation
subjectThe subject of the group chat room
participantsThe initial list of participants of the chat room A list of Linphone.Address objects.
Returns
The newly created chat room.

Deprecated : 02/07/2020, use Linphone.Core.CreateChatRoom() instead

Linphone.ChatRoom Linphone.Core.CreateChatRoom ( Linphone.ChatRoomParams  parameters,
string  subject,
IEnumerable< Linphone.Address participants 
)
inline

Create a chat room.

Parameters
parametersThe chat room creation parameters Linphone.ChatRoomParams
subjectThe subject of the group chat room
participantsThe initial list of participants of the chat room. A list of Linphone.Address objects.
Returns
The newly created chat room.

Deprecated : 02/07/2020, use Linphone.Core.CreateChatRoom() instead

Linphone.ChatRoom Linphone.Core.CreateChatRoom ( string  subject,
IEnumerable< Linphone.Address participants 
)
inline

Parameters
subjectThe subject of the group chat room
participantsThe initial list of participants of the chat room. A list of Linphone.Address objects.
Returns
The newly created chat room.

Deprecated : 02/07/2020, use Linphone.Core.CreateChatRoom() instead

Linphone.ChatRoom Linphone.Core.CreateChatRoom ( Linphone.ChatRoomParams  parameters,
Linphone.Address  localAddr,
Linphone.Address  participant 
)
inline

Parameters
parametersThe chat room creation parameters Linphone.ChatRoomParams
localAddrLinphone.Address representing the local proxy configuration to use for the chat room creation
participantLinphone.Address representing the initial participant to add to the chat room
Returns
The newly created chat room.

Deprecated : 02/07/2020, use Linphone.Core.CreateChatRoom() instead

Linphone.ChatRoom Linphone.Core.CreateChatRoom ( Linphone.Address  participant)
inline

Parameters
participantLinphone.Address representing the initial participant to add to the chat room
Returns
The newly created chat room.

Deprecated : 02/07/2020, use Linphone.Core.CreateChatRoom() instead

Linphone.ChatRoom Linphone.Core.CreateChatRoom ( Linphone.ChatRoomParams  parameters,
Linphone.Address  localAddr,
IEnumerable< Linphone.Address participants 
)
inline

Create a chat room.

Parameters
parametersThe chat room creation parameters Linphone.ChatRoomParams
localAddrLinphone.Address of a local Linphone.Account identity or null
participantsThe initial list of participants of the chat room. A list of Linphone.Address objects.
Returns
The newly created chat room (can be an existing one if backend is Basic) or null.

Deprecated : 22/10/2024, use Linphone.Core.CreateChatRoom() instead

Linphone.ChatRoom Linphone.Core.CreateClientGroupChatRoom ( string  subject,
bool  fallback 
)
inline

Create a client-side group chat room.

When calling this function the chat room is only created at the client-side and is empty. You need to call Linphone.ChatRoom.AddParticipants() to create at the server side and add participants to it. Also, the created chat room will not be a one-on-one chat room even if Linphone.ChatRoom.AddParticipants() is called with only one participant.

Parameters
subjectThe subject of the group chat room
fallbackBoolean value telling whether we should plan on being able to fallback to a basic chat room if the client-side group chat room creation fails
Returns
The newly created client-side group chat room.

Deprecated : 02/07/2020, use Linphone.Core.CreateChatRoom() instead

Linphone.ChatRoom Linphone.Core.CreateClientGroupChatRoom ( string  subject,
bool  fallback,
bool  encrypted 
)
inline

Create a client-side group chat room.

When calling this function the chat room is only created at the client-side and is empty. You need to call Linphone.ChatRoom.AddParticipants() to create at the server side and add participants to it. Also, the created chat room will not be a one-on-one chat room even if Linphone.ChatRoom.AddParticipants() is called with only one participant.

Parameters
subjectThe subject of the group chat room
fallbackBoolean value telling whether we should plan on being able to fallback to a basic chat room if the client-side group chat room creation fails
encryptedBoolean value telling whether we should apply encryption or not on chat messages sent and received on this room.
Returns
The newly created client-side group chat room.

Deprecated : 02/07/2020, use Linphone.Core.CreateChatRoom() instead

Linphone.ConferenceParams Linphone.Core.CreateConferenceParams ( Linphone.Conference  conference)
inline

Creates some default conference parameters for instanciating a conference with Linphone.Core.CreateConferenceWithParams().

Parameters
conferenceLinphone.Conference for which the parameters are to be build, or null in the case where the parameters are to be used for a new conference.
Returns
a Linphone.ConferenceParams object.
Linphone.ConferenceScheduler Linphone.Core.CreateConferenceScheduler ( )
inline

Create a conference scheduler that can be used to schedule conferences on a client conference service and then send conference information invitation as an ICS object through chat.

The default account (see Linphone.Core.DefaultAccount ) is used to determine which kind of conference scheduler is created.

Returns
A pointer on the freshly created Linphone.ConferenceScheduler.
Linphone.ConferenceScheduler Linphone.Core.CreateConferenceScheduler ( Linphone.Account  account)
inline

Create a conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

A SIP-based implementation is created if the Linphone.Account has not defined the URL of a CCMP server, other it will create a implementation relying on CCMP protocol.

Parameters
accountThe Linphone.Account to use in the Linphone.ConferenceScheduler.
Returns
A pointer on the freshly created Linphone.ConferenceScheduler.
Linphone.ConferenceScheduler Linphone.Core.CreateConferenceSchedulerWithType ( Linphone.Account  account,
Linphone.ConferenceSchedulerType  schedulingType 
)
inline

Create a conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat by specifying its type.

Parameters
accountThe Linphone.Account to use in the Linphone.ConferenceScheduler.
schedulingTypeThe type of the Linphone.ConferenceScheduler.
Returns
A pointer on the freshly created Linphone.ConferenceScheduler.
Linphone.Conference Linphone.Core.CreateConferenceWithParams ( Linphone.ConferenceParams  parameters)
inline

Create a conference.

Local or client conference is determinated from the 'conference_type' variable in the 'misc' section of the configuration, or by the factory address parameter. See Linphone.ConferenceParams.ConferenceFactoryAddress for more details.

Parameters
parametersParameters of the conference. See Linphone.ConferenceParams.
Returns
A pointer on the freshly created conference Linphone.Conference. That object will be automatically freed by the core after calling Linphone.Core.TerminateConference().

Warning : To guarantee the backward comatibility, this method will assign the created conference to the conference context held by the core. Nonetheless starting from release 5.4, the conference context will be override at every conference created by calling this method

Linphone.Config Linphone.Core.CreateConfig ( string  filename)
inline

Create a Linphone.Config object from a user config file.

Parameters
filenameThe filename of the config file to read to fill the instantiated Linphone.Config
Returns
a Linphone.Config object.
Linphone.Content Linphone.Core.CreateContent ( )
inline

Creates a content with default values from Linphone core.

Returns
Linphone.Content object with default values set
Linphone.ConferenceScheduler Linphone.Core.CreateDbConferenceScheduler ( Linphone.Account  account)
inline

Create a database conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

The DBConferenceScheduler only creates a conference info to be stored in the database of the linphone core

Parameters
accountThe Linphone.Account to use in the Linphone.ConferenceScheduler.
Returns
A pointer on the freshly created Linphone.ConferenceScheduler.
Linphone.ChatRoomParams Linphone.Core.CreateDefaultChatRoomParams ( )
inline

Creates and returns the default chat room parameters.

Returns
A Linphone.ChatRoomParams object
Linphone.EktInfo Linphone.Core.CreateEktInfoFromXml ( string  xmlBody)
inline

Gets a Linphone.EktInfo from an XML body.

Parameters
xmlBodythe string containing the XML body
Returns
The Linphone.EktInfo
Linphone.Friend Linphone.Core.CreateFriend ( )
inline

Creates an empty LinphoneFriend.

Returns
The created Linphone.Friend object
Linphone.Friend Linphone.Core.CreateFriendFromVcard ( Linphone.Vcard  vcard)
inline

Creates a Linphone.Friend from ai Linphone.Vcard.

Parameters
vcarda Linphone.Vcard object
Returns
A new Linphone.Friend object which has its vCard attribute initialized from the given vCard, accessible using Linphone.Friend.Vcard.
Linphone.FriendList Linphone.Core.CreateFriendList ( )
inline

Creates a new empty Linphone.FriendList object.

Returns
A new Linphone.FriendList object.
Linphone.Friend Linphone.Core.CreateFriendWithAddress ( string  address)
inline

Creates a Linphone.Friend from the given address.

Parameters
addressA string containing the address to create the Linphone.Friend from
Returns
The created Linphone.Friend object.
Linphone.InfoMessage Linphone.Core.CreateInfoMessage ( )
inline

Creates an empty info message.

Returns
a new LinphoneInfoMessage.

The info message can later be filled with information using Linphone.InfoMessage.AddHeader() or Linphone.InfoMessage.Content, and finally sent with Linphone.Call.SendInfoMessage().

Linphone.Ldap Linphone.Core.CreateLdap ( )
inline

Creates an empty LDAP search.

Linphone.Ldap.Params must be call to save the parameters in the configuration file.

Returns
Linphone.Ldap with default values set

Deprecated : 18/11/2024 use Linphone.Core.CreateLdapRemoteContactDirectory() instead.

Linphone.LdapParams Linphone.Core.CreateLdapParams ( )
inline

Create a LDAP params using default values from Linphone core.

Check Linphone.LdapParams to update values. In order to add a new LDAP configuration to Linphone.MagicSearch, these parameters must be passed to linphone_core_create_ldap_with_params. Or, use Linphone.Ldap.Params.

Returns
Linphone.LdapParams with default values set.
Linphone.RemoteContactDirectory Linphone.Core.CreateLdapRemoteContactDirectory ( Linphone.LdapParams  parameters)
inline

Creates a new CardDAV server params object that may be used later by Linphone.MagicSearch to query contacts.

Parameters
parametersthe Linphone.LdapParams to configure this remote contact directory.
Returns
a new Linphone.RemoteContactDirectory object to configure, and then add using Linphone.Core.AddRemoteContactDirectory().
Linphone.Ldap Linphone.Core.CreateLdapWithParams ( Linphone.LdapParams  parameters)
inline

Creates a LDAP search using given parameters, adds it to the core list and stores them in the configuration file.

Parameters
parametersLinphone.LdapParams object
Returns
Linphone.Ldap object

Deprecated : 18/11/2024 use Linphone.Core.CreateLdapRemoteContactDirectory() instead.

Linphone.Player Linphone.Core.CreateLocalPlayer ( string  soundCardName,
string  videoDisplayName,
IntPtr  windowId 
)
inline

Creates a media file player, that can be used to play audio and video to the user, outside of any call or conference.

See Linphone.Core.SupportedFileFormatsList for supported multimedia file types.

Parameters
soundCardNamePlayback sound card. If null, the ringer sound card set in Linphone.Core will be used
videoDisplayNameVideo display. If null, the video display set in Linphone.Core will be used
windowIdId of the drawing window. See linphone_core_set_native_video_window_id for a discussion about supported native video window types.
Returns
A pointer on the new instance. null if failed.
Linphone.MagicSearch Linphone.Core.CreateMagicSearch ( )
inline

Creates a Linphone.MagicSearch object.

Returns
The created Linphone.MagicSearch object
IntPtr Linphone.Core.CreateNativePreviewWindowId ( IntPtr  context)
inline

Create a Window ID for the video preview window.

Available for MSQOGL and MSOGL. see linphone_core_set_native_video_window_id for details about window_id Available for MSQOGL and MSOGL. see linphone_core_set_native_video_window_id for details about window_id MSQOgl can be used for the creation. Linphone.Core.CreateNativePreviewWindowId() returns a QQuickFramebufferObject::Renderer. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt. linphone_core_set_native_preview_window_id_2() must be called with this object after the creation. Note : Qt blocks GUI thread when calling createRenderer(), so it is safe to call linphone functions there if needed. MSQOgl can be used for the creation. Linphone.Core.CreateNativePreviewWindowId() returns a QQuickFramebufferObject::Renderer. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt. linphone_core_set_native_preview_window_id_2() must be called with this object after the creation. Note : Qt blocks GUI thread when calling createRenderer(), so it is safe to call linphone functions there if needed. A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used. A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used.

Parameters
contextpreallocated Window ID (Used only for MSOGL)
Returns
The created Window ID.
IntPtr Linphone.Core.CreateNativePreviewWindowId ( )
inline

Create a native window handle for the video preview window.

see Linphone.Core.CreateNativePreviewWindowId() for details

Returns
The native window handle of the video preview window.
IntPtr Linphone.Core.CreateNativeVideoWindowId ( IntPtr  context)
inline

Create a Window ID from the current call.

Available for MSQOGL and MSOGL. see linphone_core_set_native_video_window_id for details about window_id Available for MSQOGL and MSOGL. see linphone_core_set_native_video_window_id for details about window_id When MSQOgl can be used for the creation: Linphone.Core.CreateNativeVideoWindowId() returns a QQuickFramebufferObject::Renderer. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt. linphone_core_set_native_video_window_id must be called with this object after the creation. Note : Qt blocks GUI thread when calling createRenderer(), so it is safe to call linphone functions there if needed. When MSQOgl can be used for the creation: Linphone.Core.CreateNativeVideoWindowId() returns a QQuickFramebufferObject::Renderer. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt. linphone_core_set_native_video_window_id must be called with this object after the creation. Note : Qt blocks GUI thread when calling createRenderer(), so it is safe to call linphone functions there if needed. A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used. A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used.

Parameters
contextpreallocated Window ID (Used only for MSOGL)
Returns
The created Window ID
IntPtr Linphone.Core.CreateNativeVideoWindowId ( )
inline

Create a native window handle for the video window from the current call.

see Linphone.Core.CreateNativeVideoWindowId() for details

Returns
The native window handle of the video window.
Linphone.NatPolicy Linphone.Core.CreateNatPolicy ( )
inline

Create a new Linphone.NatPolicy object with every policies being disabled.

Returns
A new Linphone.NatPolicy object.
Linphone.Event Linphone.Core.CreateNotify ( Linphone.Address  resource,
string  ev 
)
inline

Creates an out-of-dialog notification, specifying the destination resource, the event name.

The notification can be send with Linphone.Event.Notify().

Parameters
resourcethe destination resource
evthe event name
Returns
a Linphone.Event holding the context of the notification.
Linphone.Event Linphone.Core.CreateOneShotPublish ( Linphone.Address  resource,
string  ev 
)
inline

Creates a publish context for a one-shot publish.

After being created, the publish must be sent using Linphone.Event.SendPublish(). The Linphone.Event is automatically terminated when the publish transaction is finished, either with success or failure. The application must not call Linphone.Event.Terminate() for such one-shot publish.

Parameters
resourcethe resource uri for the event
evthe event name
Returns
the Linphone.Event holding the context of the publish.
Linphone.PresenceActivity Linphone.Core.CreatePresenceActivity ( Linphone.PresenceActivityType  acttype,
string  description 
)
inline

Creates a Linphone.PresenceActivity with the given type and description.

Parameters
acttypeThe Linphone.PresenceActivityType to set for the activity.
descriptionAn additional description of the activity to set for the activity. Can be null if no additional description is to be added.
Returns
The created Linphone.PresenceActivity object.
Linphone.PresenceModel Linphone.Core.CreatePresenceModel ( )
inline

Creates a default LinphonePresenceModel.

Returns
The created Linphone.PresenceModel object.
Linphone.PresenceModel Linphone.Core.CreatePresenceModelWithActivity ( Linphone.PresenceActivityType  acttype,
string  description 
)
inline

Creates a Linphone.PresenceModel with the given activity type and activity description.

Parameters
acttypeThe Linphone.PresenceActivityType to set for the activity of the created model.
descriptionAn additional description of the activity to set for the activity. Can be null if no additional description is to be added.
Returns
The created Linphone.PresenceModel object.
Linphone.PresenceModel Linphone.Core.CreatePresenceModelWithActivityAndNote ( Linphone.PresenceActivityType  acttype,
string  description,
string  note,
string  lang 
)
inline

Creates a Linphone.PresenceModel with the given activity type, activity description, note content and note language.

Parameters
acttypeThe Linphone.PresenceActivityType to set for the activity of the created model.
descriptionAn additional description of the activity to set for the activity. Can be null if no additional description is to be added.
noteThe content of the note to be added to the created model.
langThe language of the note to be added to the created model.
Returns
The created Linphone.PresenceModel object.
Linphone.PresenceNote Linphone.Core.CreatePresenceNote ( string  content,
string  lang 
)
inline

Creates a Linphone.PresenceNote with the given content and language.

Parameters
contentThe content of the note to be created.
langThe language of the note to be created.
Returns
The created Linphone.PresenceNote object.
Linphone.PresencePerson Linphone.Core.CreatePresencePerson ( string  id)
inline

Creates a Linphone.PresencePerson with the given id.

Parameters
idThe id of the person to be created.
Returns
The created Linphone.PresencePerson object.
Linphone.PresenceService Linphone.Core.CreatePresenceService ( string  id,
Linphone.PresenceBasicStatus  basicStatus,
string  contact 
)
inline

Creates a Linphone.PresenceService with the given id, basic status and contact.

Parameters
idThe id of the service to be created.
basicStatusThe basic status of the service to be created.
contactA string containing a contact information corresponding to the service to be created.
Returns
The created Linphone.PresenceService object.
Linphone.Address Linphone.Core.CreatePrimaryContactParsed ( )
inline

Same as Linphone.Core.PrimaryContact but the result is a Linphone.Address object instead of const char *.

Returns
a Linphone.Address object.

Deprecated : prefer using Linphone.Core.PrimaryContactAddress

Linphone.ProxyConfig Linphone.Core.CreateProxyConfig ( )
inline

Create a proxy config with default values from Linphone core.

Returns
Linphone.ProxyConfig with default values set

Deprecated : 04/09/2024 Use Linphone.Core.CreateAccount()

Linphone.Event Linphone.Core.CreatePublish ( Linphone.Address  resource,
string  ev,
int  expires 
)
inline

Creates a publish context for an event state.

After being created, the publish must be sent using Linphone.Event.SendPublish(). After expiry, the publication is refreshed unless it is terminated before.

Parameters
resourcethe resource uri for the event
evthe event name
expiresthe lifetime of event being published, -1 if no associated duration, in which case it will not be refreshed.
Returns
the Linphone.Event holding the context of the publish.
Linphone.Recorder Linphone.Core.CreateRecorder ( Linphone.RecorderParams  parameters)
inline

Creates an independant media file recorder, that can be used to record user's voice or video outside of any call or conference.

See Linphone.Core.SupportedFileFormatsList for supported multimedia file types.

Parameters
parametersThe Linphone.RecorderParams that will contains all recorder parameters.
Returns
A pointer on the new instance. null if failed.
Linphone.RecorderParams Linphone.Core.CreateRecorderParams ( )
inline

Creates an object that holds recording parameters.

See : Linphone.Core.CreateRecorder()

Returns
A pointer on the newly created instance of Linphone.RecorderParams
Linphone.ConferenceScheduler Linphone.Core.CreateSipConferenceScheduler ( Linphone.Account  account)
inline

Create a SIP conference scheduler that can be used to create client conferences for now or later and then send conference info as an ICS through chat.

A SipConferenceScheduler creates a conference on a server by using a SIP dialog

Parameters
accountThe Linphone.Account to use in the Linphone.ConferenceScheduler.
Returns
A pointer on the freshly created Linphone.ConferenceScheduler.
Linphone.Event Linphone.Core.CreateSubscribe ( Linphone.Address  resource,
string  ev,
int  expires 
)
inline

Creates an outgoing subscription, specifying the destination resource, the event name, and an optional content body.

If accepted, the subscription runs for a finite period, but is automatically renewed if not terminated before. Unlike Linphone.Core.Subscribe() the subscription isn't sent immediately. It will be send when calling Linphone.Event.SendSubscribe().

Parameters
resourcethe destination resource
evthe event name
expiresthe whished duration of the subscription
Returns
a Linphone.Event holding the context of the created subcription.
Linphone.Event Linphone.Core.CreateSubscribe ( Linphone.Address  resource,
Linphone.ProxyConfig  proxy,
string  ev,
int  expires 
)
inline

Creates an outgoing subscription, specifying the destination resource, the event name, and an optional content body.

If accepted, the subscription runs for a finite period, but is automatically renewed if not terminated before. Unlike Linphone.Core.Subscribe() the subscription isn't sent immediately. It will be send when calling Linphone.Event.SendSubscribe().

Parameters
resourcethe destination resource
proxythe proxy configuration to use
evthe event name
expiresthe whished duration of the subscription
Returns
a Linphone.Event holding the context of the created subcription.
Linphone.Vcard Linphone.Core.CreateVcardFromText ( string  input)
inline

Creates a vCard from a text, if possible.

Parameters
inputthe vCard raw text to parse.
Returns
a new Linphone.Vcard object if the parsing of the input succeeded, null otherwise.
string Linphone.Core.CreateXmlFromEktInfo ( Linphone.EktInfo  ektInfo,
Linphone.Account  account 
)
inline

Gets an XML body using a specific account.

Parameters
ektInfothe Linphone.EktInfo
accountthe Linphone.Account associated with the conference
Returns
The XML body
string Linphone.Core.CreateXmlFromEktInfo ( Linphone.EktInfo  ektInfo)
inline

Gets an XML body.

Parameters
ektInfothe Linphone.EktInfo
Returns
The XML body

Deprecated : 06/02/2025 use Linphone.Core.CreateXmlFromEktInfo().

Linphone.XmlRpcSession Linphone.Core.CreateXmlRpcSession ( string  url)
inline

Create a Linphone.XmlRpcSession for a given url.

Parameters
urlThe URL to the XML-RPC server. Must be NON null.
Returns
The new Linphone.XmlRpcSession object.
void Linphone.Core.DeleteChatRoom ( Linphone.ChatRoom  chatRoom)
inline

Removes a chatroom including all message history from the LinphoneCore.

Parameters
chatRoomA Linphone.ChatRoom object
void Linphone.Core.DeleteConferenceInformation ( Linphone.ConferenceInfo  conferenceInfo)
inline

Deletes a conference information from DB.

Parameters
conferenceInfothe Linphone.ConferenceInfo to delete.
void Linphone.Core.DidRegisterForRemotePush ( IntPtr  deviceToken)
inline

Sets device_token when application didRegisterForRemoteNotificationsWithDeviceToken (IOS only).

Parameters
deviceTokenformat (NSData *).
void Linphone.Core.DidRegisterForRemotePushWithStringifiedToken ( string  deviceTokenStr)
inline

Sets device_token when application didRegisterForRemoteNotificationsWithDeviceToken (IOS only).

Parameters
deviceTokenStrstring extracted from the Data objectf received in didRegisterForRemoteNotificationsWithDeviceToken ios function. Append ":remote" after data formating..
void Linphone.Core.DisableCallRinging ( bool  yesno)
inline

Enables or disables call ringing.

This value is taken into account from next time call parameters are created. This feature can also be enabled per-call using Linphone.CallParams.

Parameters
yesnoa boolean to indicate whether the feature is to be disabled.
void Linphone.Core.DisableChat ( Linphone.Reason  denyReason)
inline

Inconditionnaly disables incoming chat messages.

Parameters
denyReasonthe deny reason (Linphone.Reason.None has no effect).
void Linphone.Core.EnableChat ( )
inline

Enables reception of incoming chat messages.

By default it is enabled but it can be disabled with Linphone.Core.DisableChat().

static void Linphone.Core.EnableLogCollection ( Linphone.LogCollectionState  state)
inlinestatic

Enables the linphone core log collection to upload logs on a server.

Parameters
stateLinphone.LogCollectionState value telling whether to enable log collection or not.
void Linphone.Core.EnsureRegistered ( )
inline

Call this method when you receive a push notification (if you handle push notifications manually).

It will ensure the proxy configs are correctly registered to the proxy server, so the call or the message will be correctly delivered.

Deprecated : 09/03/2022 See Linphone.Core.ProcessPushNotification() instead.

void Linphone.Core.EnterBackground ( )
inline

This method is called by the application to notify the linphone core library when it enters background mode.

void Linphone.Core.EnterConference ( )
inline

Joins the local participant to the running conference.

Returns
0 if succeeded. Negative number if failed

Deprecated : 09/03/2021 Use Linphone.Conference.Enter() instead.

void Linphone.Core.EnterForeground ( )
inline

This method is called by the application to notify the linphone core library when it enters foreground mode.

bool Linphone.Core.FileFormatSupported ( string  fmt)
inline

Returns whether a specific file format is supported.

See : linphone_core_get_supported_file_formats

Parameters
fmtThe format extension (wav, mkv).
Returns
true if the file format is supported, false otherwise
Linphone.AuthInfo Linphone.Core.FindAuthInfo ( string  realm,
string  username,
string  sipDomain 
)
inline

Finds authentication info matching realm, username, domain criteria.

First of all, (realm,username) pair are searched. If multiple results (which should not happen because realm are supposed to be unique), then domain is added to the search.

Parameters
realmthe authentication 'realm' (optional)
usernamethe SIP username to be authenticated (mandatory)
sipDomainthe SIP domain name (optional)
Returns
a Linphone.AuthInfo if found.
Linphone.Call Linphone.Core.FindCallFromUri ( string  uri)
inline

Search from the list of current calls if a remote address match uri.

Parameters
uriwhich should match call remote uri
Returns
Linphone.Call or null if no match is found.

Deprecated : 27/10/2020. Use Linphone.Core.CallByRemoteAddress2 instead.

Linphone.CallLog Linphone.Core.FindCallLog ( string  callId,
int  limit 
)
inline

Gets the call log matching the call id, or null if can't be found.

Parameters
callIdCall id of the call log to find
limitSearch limit of the most recent call logs to find
Returns
A call log matching the call id if any.
Linphone.CallLog Linphone.Core.FindCallLogFromCallId ( string  callId)
inline

Gets the call log matching the call id, or null if can't be found.

Parameters
callIdCall id of the call log to find
Returns
A call log matching the call id if any.
Linphone.ChatRoom Linphone.Core.FindChatRoom ( Linphone.Address  peerAddr,
Linphone.Address  localAddr 
)
inline

Find a chat room.

No reference is transferred to the application. The Linphone.Core keeps a reference on the chat room.

Parameters
peerAddra linphone address.
localAddra linphone address.
Returns
Linphone.ChatRoom where messaging can take place.

Deprecated : 02/07/2020, use Linphone.Core.SearchChatRoom() instead

Linphone.ConferenceInfo Linphone.Core.FindConferenceInformationFromCcmpUri ( string  uri)
inline

Retrieve the conference information linked to the provided URI if any.

Parameters
uriUri of the conference as provided by the CCMP server backend.
Returns
The Linphone.ConferenceInfo found if any, null otherwise.
Linphone.ConferenceInfo Linphone.Core.FindConferenceInformationFromUri ( Linphone.Address  uri)
inline

Retrieve the conference information linked to the provided URI if any.

Parameters
uriLinphone.Address of the uri.
Returns
The Linphone.ConferenceInfo found if any, null otherwise.
IEnumerable<Linphone.Address> Linphone.Core.FindContactsByChar ( string  filter,
bool  sipOnly 
)
inline

Retrieves a list of Linphone.Address sort and filter.

Parameters
filterChars used for the filter*
sipOnlyOnly sip address or not
Returns
A list of filtered Linphone.Address
Linphone.Friend Linphone.Core.FindFriend ( Linphone.Address  address)
inline

Searches a Linphone.Friend by its address.

Parameters
addressThe Linphone.Address to use to search the friend.
Returns
The Linphone.Friend object corresponding to the given address or null if not found.
Linphone.Friend Linphone.Core.FindFriendByPhoneNumber ( string  phoneNumber)
inline

Searches a Linphone.Friend by its phone number.

Parameters
phoneNumberThe phone number to use to search the friend.
Returns
The Linphone.Friend object corresponding to the given phone number or null if not found.
IEnumerable<Linphone.Friend> Linphone.Core.FindFriends ( Linphone.Address  address)
inline

Searches all Linphone.Friend matching an address.

Parameters
addressThe address to use to search the friends.
Returns
A list of Linphone.Friend corresponding to the given address. A list of Linphone.Friend objects.
Linphone.ChatRoom Linphone.Core.FindOneToOneChatRoom ( Linphone.Address  localAddr,
Linphone.Address  participantAddr,
bool  encrypted 
)
inline

Find a one-on-one chat room.

No reference is transferred to the application. The Linphone.Core keeps a reference on the chat room.

Parameters
localAddra linphone address.
participantAddra linphone address.
encryptedwhether to look for an encrypted chat room or not
Returns
Linphone.ChatRoom where messaging can take place.

Deprecated : 02/07/2020, use Linphone.Core.SearchChatRoom() instead

Linphone.Account Linphone.Core.GetAccountByIdkey ( string  idkey)
inline

Search for a Linphone.Account by it's idkey.

Parameters
idkeyAn arbitrary idkey string associated to an account.
Returns
the Linphone.Account object for the given idkey value, or null if none found
Linphone.Call Linphone.Core.GetCallByCallid ( string  callId)
inline

Gets the call by its SIP callid.

Parameters
callIdof call
Returns
call Linphone.Call, return null if there is no call find.
Linphone.Call Linphone.Core.GetCallByRemoteAddress ( string  remoteAddress)
inline

Get the call with the remote_address specified.

Parameters
remoteAddressThe remote address of the call that we want to get
Returns
The call if it has been found, null otherwise.

Deprecated : 08/07/2020 use Linphone.Core.CallByRemoteAddress2 instead

Linphone.Call Linphone.Core.GetCallByRemoteAddress2 ( Linphone.Address  remoteAddress)
inline

Get the call with the specified Linphone.Address.

Parameters
remoteAddressthe Linphone.Address for which the call remote address must match
Returns
the Linphone.Call of the call if found.
IEnumerable<Linphone.CallLog> Linphone.Core.GetCallHistory ( Linphone.Address  peerAddress,
Linphone.Address  localAddress 
)
inline

Gets the list of call logs (past calls).

At the contrary of linphone_core_get_call_logs, it is your responsibility to unref the logs and free this list once you are done using it. Requires ENABLE_DB_STORAGE to work.

Parameters
peerAddressThe remote Linphone.Address object.
localAddressThe local Linphone.Address object
Returns
A list of Linphone.CallLog. A list of Linphone.CallLog objects.
Linphone.ChatRoom Linphone.Core.GetChatRoom ( Linphone.Address  addr)
inline

Get a chat room whose peer is the supplied address.

If it does not exist yet, it will be created as a basic chat room. No reference is transferred to the application. The Linphone.Core keeps a reference on the chat room.

Warning : This method is prone to errors, use Linphone.Core.SearchChatRoom() instead

Parameters
addra linphone address.
Returns
Linphone.ChatRoom where messaging can take place.

Deprecated : 02/07/2020, use Linphone.Core.SearchChatRoom() instead

Linphone.ChatRoom Linphone.Core.GetChatRoom ( Linphone.Address  peerAddr,
Linphone.Address  localAddr 
)
inline

Get a chat room.

If it does not exist yet, it will be created as a basic chat room. No reference is transferred to the application. The Linphone.Core keeps a reference on the chat room.

Warning : This method is prone to errors, use Linphone.Core.SearchChatRoom() instead

Parameters
peerAddra linphone address.
localAddra linphone address.
Returns
Linphone.ChatRoom where messaging can take place.

Deprecated : 02/07/2020, use Linphone.Core.SearchChatRoom() instead

Linphone.ChatRoom Linphone.Core.GetChatRoomFromUri ( string  to)
inline

Get a chat room for messaging from a sip uri like sip:joe@s.nosp@m.ip.l.nosp@m.inpho.nosp@m.ne.o.nosp@m.rg.

Get a chat room for messaging from a sip uri like sip:joe@s.nosp@m.ip.l.nosp@m.inpho.nosp@m.ne.o.nosp@m.rg.

If it does not exist yet, it will be created as a basic chat room. No reference is transferred to the application. The Linphone.Core keeps a reference on the chat room.

Warning : This method is prone to errors, use Linphone.Core.SearchChatRoom() instead

Parameters
toThe destination address for messages.
Returns
Linphone.ChatRoom where messaging can take place.

Deprecated : 02/07/2020, use Linphone.Core.SearchChatRoom() instead

IEnumerable<Linphone.ConferenceInfo> Linphone.Core.GetConferenceInformationListAfterTime ( long  time)
inline

Retrieve the list of conference information on DB after a certain time.

Parameters
timeTime to retrieve conference info.
Returns
The list of conference infos A list of Linphone.ConferenceInfo objects. .
IEnumerable<Linphone.ConferenceInfo> Linphone.Core.GetConferenceInformationsWithParticipant ( Linphone.Address  uri)
inline

Retrieve the list of conference information on DB where the address passed as argument is either the organizer or a participant.

Parameters
uriLinphone.Address of the participant.
Returns
The list of conference infos A list of Linphone.ConferenceInfo objects. where the address passed as argument is either the organizer or a participant.
Linphone.Friend Linphone.Core.GetFriendByRefKey ( string  key)
inline

Searches a Linphone.Friend by its reference key.

Parameters
keyThe reference key to use to search the friend.
Returns
The Linphone.Friend object corresponding to the given reference key.
Linphone.FriendList Linphone.Core.GetFriendListByName ( string  name)
inline

Retrieves the list of Linphone.Friend from the core that has the given display name.

Parameters
namethe name of the list
Returns
the first Linphone.FriendList object or null.
Linphone.PayloadType Linphone.Core.GetPayloadType ( string  type,
int  rate,
int  channels 
)
inline

Get payload type from mime type and clock rate.

This function searches in audio and video codecs for the given payload type name and clockrate.

Parameters
typepayload mime type (I.E "speex", "pcmu", "h264")
ratecan be LINPHONE_FIND_PAYLOAD_IGNORE_RATE (-1)
channelsnumber of channels, can be LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS (-1)
Returns
Returns null if not found. If a Linphone.PayloadType is returned, it must be released with linphone_payload_type_unref after using it.
Linphone.ProxyConfig Linphone.Core.GetProxyConfigByIdkey ( string  idkey)
inline

Searches for a Linphone.ProxyConfig by it's idkey.

Parameters
idkeyAn arbitrary idkey string associated to a proxy configuration
Returns
the Linphone.ProxyConfig object for the given idkey value, or null if none found

Deprecated : 04/09/2024 Use Linphone.Core.AccountByIdkey

Linphone.ZrtpPeerStatus Linphone.Core.GetZrtpStatus ( string  addr)
inline

Get the zrtp sas validation status for a peer uri.

Once the SAS has been validated or rejected, the status will never return to Unknown (unless you delete your cache)

Parameters
addrthe peer uri
Returns
- LinphoneZrtpPeerStatusUnknown: this uri is not present in cache OR during calls with the active device, SAS never was validated or rejected
bool Linphone.Core.HasBuiltinEchoCanceller ( )
inline

Check whether the device has a hardware echo canceller.

Returns
true if it does, false otherwise
bool Linphone.Core.HasCrappyOpengl ( )
inline

Check whether the device is flagged has crappy opengl.

Returns
true if crappy opengl flag is set, false otherwise
bool Linphone.Core.InCall ( )
inline

Tells whether there is a call running.

Returns
A boolean value telling whether a call is currently running or not
Linphone.Address Linphone.Core.InterpretUrl ( string  url)
inline

Constructs a Linphone.Address from the given string if possible.

In case of just a username, characters will be unescaped. If a phone number is detected, it will be flattened. sip: or sips: prefix will be added if not present. Finally, will be added if not present using default proxy config.

See : Linphone.ProxyConfig.NormalizeSipUri() for documentation.

Parameters
urlthe url to parse
Returns
the Linphone.Address matching the url or null in case of failure.

Deprecated : on 18/07/2022, use Linphone.Core.InterpretUrl() instead.

Linphone.Address Linphone.Core.InterpretUrl ( string  url,
bool  applyInternationalPrefix 
)
inline

Constructs a Linphone.Address from the given string if possible.

In case of just a username, characters will be unescaped. If a phone number is detected, it will be flattened. sip: or sips: prefix will be added if not present. Finally, will be added if not present using the default Linphone.Account.

See : Linphone.Account.NormalizeSipUri() for a similar function.

Parameters
urlthe url to parse
applyInternationalPrefixwhether or not to try to format url as phone number using default account prefix if it set (and if url is a number).
Returns
the Linphone.Address matching the url or null in case of failure.
Linphone.Call Linphone.Core.Invite ( string  url)
inline

Initiates an outgoing call.

The application doesn't own a reference to the returned LinphoneCall object. Use linphone_call_ref to safely keep the LinphoneCall pointer valid within your application.

Parameters
urlThe destination of the call (sip address, or phone number).
Returns
A Linphone.Call object or null in case of failure.
Linphone.Call Linphone.Core.InviteAddress ( Linphone.Address  addr)
inline

Initiates an outgoing call given a destination Linphone.Address The Linphone.Address can be constructed directly using Linphone.Factory.CreateAddress(), or created by Linphone.Core.InterpretUrl().

In C, the application doesn't own a reference to the returned Linphone.Call object. Use linphone_call_ref to safely keep the Linphone.Call pointer valid within your application.

Parameters
addrThe destination of the call (sip address).
Returns
A Linphone.Call object or null in case of failure.
Linphone.Call Linphone.Core.InviteAddressWithParams ( Linphone.Address  addr,
Linphone.CallParams  parameters 
)
inline

Initiates an outgoing call given a destination Linphone.Address The Linphone.Address can be constructed directly using Linphone.Factory.CreateAddress(), or created by Linphone.Core.InterpretUrl().

In C, the application doesn't own a reference to the returned Linphone.Call object. Use linphone_call_ref to safely keep the Linphone.Call pointer valid within your application. If the Linphone.Account is not specified in parameters, the caller's account will be automatically selected by finding what is the best to reach the destination of the call.

Parameters
addrThe destination of the call (sip address).
parametersCall parameters
Returns
A Linphone.Call object or null in case of failure.
Linphone.Call Linphone.Core.InviteAddressWithParams ( Linphone.Address  addr,
Linphone.CallParams  parameters,
string  subject,
Linphone.Content  content 
)
inline

Initiates an outgoing call given a destination Linphone.Address The Linphone.Address can be constructed directly using Linphone.Factory.CreateAddress(), or created by Linphone.Core.InterpretUrl().

In C, the application doesn't own a reference to the returned Linphone.Call object. Use linphone_call_ref to safely keep the Linphone.Call pointer valid within your application. If the Linphone.Account is not specified in parameters, the caller's account will be automatically selected by finding what is the best to reach the destination of the call.

Parameters
addrThe destination of the call (sip address).
parametersCall parameters
subjectSubject of the call, UTF-8 encoded
contentBody of the SIP INVITE
Returns
A Linphone.Call object or null in case of failure.
Linphone.Call Linphone.Core.InviteWithParams ( string  url,
Linphone.CallParams  parameters 
)
inline

Initiates an outgoing call according to supplied call parameters In C, the application doesn't own a reference to the returned Linphone.Call object.

Use linphone_call_ref to safely keep the Linphone.Call pointer valid within your application.

Parameters
urlThe destination of the call (sip address, or phone number).
parametersthe Linphone.CallParams call parameters
Returns
A Linphone.Call object or null in case of failure.
bool Linphone.Core.IsContentTypeSupported ( string  contentType)
inline

Tells whether a content type is supported.

Parameters
contentTypeThe content type to check
Returns
A boolean value telling whether the specified content type is supported or not.
bool Linphone.Core.IsMediaEncryptionSupported ( Linphone.MediaEncryption  menc)
inline

Checks if given media encryption is supported.

Parameters
mencThe media encryption policy to be used.
Returns
true if the media encryption is supported, false otherwise
bool Linphone.Core.IsMediaFilterSupported ( string  filtername)
inline

Checks if the given media filter is loaded and usable.

This is for advanced users of the library, mainly to expose mediastreamer video filter status.

Parameters
filternamethe filter name
Returns
true if the filter is loaded and usable, false otherwise
bool Linphone.Core.IsPluginLoaded ( string  name)
inline

Tells whether a plugin is loaded or not.

Parameters
namename of the plugin
Returns
A boolean value telling whether the plugin has been loaded
void Linphone.Core.Iterate ( )
inline

Main loop integration.

Unless auto-iterate mode is provided ( see Linphone.Core.EnableAutoIterate() ), it is crucial that your application calls Linphone.Core.Iterate() repeatedly. Linphone.Core.Iterate() performs various backgrounds tasks: -receiving of SIP messages -handles timers and timeout -performs registration to proxies -authentication retries The application must call this function periodically, from the same thread it uses for calling other liblinphone methods. It may triggered from the timer in the application's main loop if the application design is single thread model, or from an application thread if the application decides to perform all liblinphone invocations from a dedicated thread. If it is not the case make sure all liblinphone calls are serialized with a mutex. A recommanded timer value is 20 ms for calling this function.

bool Linphone.Core.LdapAvailable ( )
inline

End of group contacts.

Tells if LDAP is available

Returns
true if LDAP is available, false otherwise
void Linphone.Core.LeaveConference ( )
inline

Makes the local participant leave the running conference.

Returns
0 if succeeded. Negative number if failed

Deprecated : 09/03/2021 Use Linphone.Conference.Leave() instead.

bool Linphone.Core.LimeX3DhAvailable ( )
inline

Tells if LIME X3DH is available.

void Linphone.Core.LoadConfigFromXml ( string  xmlUri)
inline

Update current config with the content of a xml config file.

Parameters
xmlUrithe path to the xml file
static Linphone.LogCollectionState Linphone.Core.LogCollectionEnabled ( )
inlinestatic

Tells whether the linphone core log collection is enabled.

Returns
The Linphone.LogCollectionState of the Linphone.Core log collection.
bool Linphone.Core.MediaEncryptionSupported ( Linphone.MediaEncryption  menc)
inline

Checks if a media encryption type is supported.

Parameters
mencLinphone.MediaEncryption
Returns
whether a media encryption scheme is supported by the Linphone.Core engine
void Linphone.Core.MigrateLogsFromRcToDb ( )
inline

Migrates the call logs from the linphonerc to the database if not done yet.

void Linphone.Core.NotifyAllFriends ( Linphone.PresenceModel  presence)
inline

Notifies all friends that have subscribed.

Parameters
presenceLinphone.PresenceModel to notify
void Linphone.Core.NotifyNotifyPresenceReceived ( Linphone.Friend  linphoneFriend)
inline

Notifies the upper layer that a presence status has been received by calling the appropriate callback if one has been set.

This method is for advanced usage, where customization of the liblinphone's internal behavior is required.

Parameters
linphoneFriendthe Linphone.Friend whose presence information has been received.
void Linphone.Core.NotifyNotifyPresenceReceivedForUriOrTel ( Linphone.Friend  linphoneFriend,
string  uriOrTel,
Linphone.PresenceModel  presenceModel 
)
inline

Notifies the upper layer that a presence model change has been received for the uri or telephone number given as a parameter, by calling the appropriate callback if one has been set.

This method is for advanced usage, where customization of the liblinphone's internal behavior is required.

Parameters
linphoneFriendthe Linphone.Friend whose presence information has been received.
uriOrTeltelephone number or sip uri
presenceModelthe Linphone.PresenceModel that has been modified
void Linphone.Core.PauseAllCalls ( )
inline

Pauses all currently running calls.

Returns
0
void Linphone.Core.PlayDtmf ( sbyte  dtmf,
int  durationMs 
)
inline

Plays a dtmf sound to the local user.

Parameters
dtmfDTMF to play ['0'..'16'] | '#' | '#'
durationMsDuration in ms, -1 means play until next further call to Linphone.Core.StopDtmf()
void Linphone.Core.PlayLocal ( string  audiofile)
inline

Plays an audio file to the local user.

This function works at any time, during calls, or when no calls are running. It doesn't request the underlying audio system to support multiple playback streams.

Parameters
audiofileThe path to an audio file in wav PCM 16 bit format
Returns
0 on success, -1 on error
int Linphone.Core.PreemptSoundResources ( )
inline

Empties sound resources to allow a new call to be accepted.

This function is autyomatically called by the core if the media resource mode is set to unique.

Returns
An integer returning the exit value. If it is 0, sound resources have been emptied. Otherwise, sound resources are busy and cannot be freed immediately.
void Linphone.Core.PreviewOglRender ( )
inline

Call generic OpenGL render for a given core.

void Linphone.Core.ProcessPushNotification ( string  callId)
inline

Call this method when you receive a push notification (if you handle push notifications manually).

It will ensure the proxy configs are correctly registered to the proxy server, so the call or the message will be correctly delivered.

Parameters
callIdthe Call-ID of the MESSAGE or INVITE for which the push was received and to wait for.
Linphone.Event Linphone.Core.Publish ( Linphone.Address  resource,
string  ev,
int  expires,
Linphone.Content  body 
)
inline

Publishes an event state.

This first create a Linphone.Event with Linphone.Core.CreatePublish() and calls Linphone.Event.SendPublish() to actually send it. After expiry, the publication is refreshed unless it is terminated before.

Parameters
resourcethe resource uri for the event
evthe event name
expiresthe lifetime of event being published, -1 if no associated duration, in which case it will not be refreshed.
bodythe actual published data
Returns
the Linphone.Event holding the context of the publish.
void Linphone.Core.RefreshRegisters ( )
inline

Forces registration refresh to be initiated upon next iterate.

void Linphone.Core.RejectSubscriber ( Linphone.Friend  linphoneFriend)
inline

Black list a friend.

same as Linphone.Friend.IncSubscribePolicy with Linphone.SubscribePolicy.SPDeny policy;

Parameters
linphoneFriendLinphone.Friend to reject
void Linphone.Core.ReloadMsPlugins ( string  path)
inline

Reload mediastreamer2 plugins from specified directory.

Parameters
paththe path from where plugins are to be loaded, pass null to use default (compile-time determined) plugin directory.
void Linphone.Core.ReloadSoundDevices ( )
inline

Update detection of sound devices.

Use this function when the application is notified of USB plug events, so that list of available hardwares for sound playback and capture is updated.

void Linphone.Core.ReloadVideoDevices ( )
inline

Update detection of camera devices.

Use this function when the application is notified of USB plug events, so that list of available hardwares for video capture is updated.

void Linphone.Core.RemoveAccount ( Linphone.Account  account)
inline

Removes an account.

Linphone.Core will then automatically unregister and place the account on a deleted list. For that reason, a removed account does NOT need to be freed.

Parameters
accountthe Linphone.Account to remove
void Linphone.Core.RemoveAccountWithData ( Linphone.Account  account)
inline

Removes an account and any associated data.

Linphone.Core will then automatically unregister and place the account on a deleted list. For that reason, a removed account does NOT need to be freed.

Parameters
accountthe Linphone.Account to remove
void Linphone.Core.RemoveAuthInfo ( Linphone.AuthInfo  info)
inline

Removes an authentication information object.

Parameters
infoThe Linphone.AuthInfo to remove.
void Linphone.Core.RemoveCallLog ( Linphone.CallLog  callLog)
inline

Removes a specific call log from call history list.

This function destroys the call log object. It must not be accessed anymore by the application after calling this function.

Parameters
callLogLinphone.CallLog object to remove.
void Linphone.Core.RemoveContentTypeSupport ( string  contentType)
inline

Remove support for the specified content type.

It is the application responsibility to handle it correctly afterwards.

Parameters
contentTypeThe content type to remove support for
void Linphone.Core.RemoveFriendList ( Linphone.FriendList  list)
inline

Removes a friend list.

Parameters
listLinphone.FriendList object
void Linphone.Core.RemoveFromConference ( Linphone.Call  call)
inline

Removes a call from the conference.

Parameters
calla call that has been previously merged into the conference.

After removing the remote participant belonging to the supplied call, the call becomes a normal call in paused state. If one single remote participant is left alone together with the local user in the conference after the removal, then the conference is automatically transformed into a simple call in StreamsRunning state. The conference's resources are then automatically destroyed. In other words, unless Linphone.Core.LeaveConference() is explicitly called, the last remote participant of a conference is automatically put in a simple call in running state.

Returns
0 if successful, -1 otherwise.

Deprecated : 23/01/2025 Use Linphone.Conference.RemoveParticipant() instead.

void Linphone.Core.RemoveLdap ( Linphone.Ldap  ldap)
inline

Remove a LDAP from the configuration.

Parameters
ldapThe Linphone.Ldap object to remove.

Deprecated : 18/11/2024 use Linphone.Core.RemoveRemoteContactDirectory() instead.

void Linphone.Core.RemoveLinphoneSpec ( string  spec)
inline

Remove the given linphone specs from the list of functionalities the linphone client supports.

See : Linphone.Core.LinphoneSpecsList

Parameters
specThe spec to remove
void Linphone.Core.RemoveProxyConfig ( Linphone.ProxyConfig  config)
inline

Removes a proxy configuration.

Linphone.Core will then automatically unregister and place the proxy configuration on a deleted list. For that reason, a removed proxy does NOT need to be freed.

Parameters
configthe Linphone.ProxyConfig to remove

Deprecated : 04/09/2024 Use Linphone.Core.RemoveAccount()

void Linphone.Core.RemoveRemoteContactDirectory ( Linphone.RemoteContactDirectory  remoteContactDirectory)
inline

Removes a Linphone.RemoteContactDirectory object previously added to the Core.

Parameters
remoteContactDirectorythe Linphone.RemoteContactDirectory to remove.
void Linphone.Core.RemoveSupportedTag ( string  tag)
inline

Remove a supported tag.

Parameters
tagThe tag to remove

See : Linphone.Core.AddSupportedTag()

void Linphone.Core.ResetEchoCancellationCalibration ( )
inline

Clears all state resulting from a previous echo canceller calibration procedure, which restores default policy and settings for echo cancellation.

See : Linphone.Core.EnableEchoCancellation() and Linphone.Core.StartEchoCancellerCalibration()

static void Linphone.Core.ResetLogCollection ( )
inlinestatic

Resets the log collection by removing the log files.

void Linphone.Core.ResetMissedCallsCount ( )
inline

Resets the counter of missed calls.

Linphone.ChatRoom Linphone.Core.SearchChatRoom ( Linphone.ChatRoomParams  parameters,
Linphone.Address  localAddr,
Linphone.Address  remoteAddr,
IEnumerable< Linphone.Address participants 
)
inline

Find a chat room.

Parameters
parametersThe chat room parameters to match Linphone.ChatRoomParams or null
localAddrLinphone.Address of a local Linphone.Account identity or null
remoteAddrLinphone.Address to search for or null
participantsThe participants that must be present in the chat room to find. A list of Linphone.Address objects.
Returns
A matching chat room or null if none matches.

Deprecated : 22/10/2024, use Linphone.Core.SearchChatRoom() instead

Linphone.ChatRoom Linphone.Core.SearchChatRoom ( Linphone.ConferenceParams  parameters,
Linphone.Address  localAddr,
Linphone.Address  remoteAddr,
IEnumerable< Linphone.Address participants 
)
inline

Find a chat room.

Parameters
parametersThe chat room parameters to match Linphone.ChatRoomParams or null
localAddrLinphone.Address of a local Linphone.Account identity or null
remoteAddrLinphone.Address to search for or null
participantsThe participants that must be present in the chat room to find. A list of Linphone.Address objects.
Returns
A matching chat room or null if none matches.
Linphone.ChatRoom Linphone.Core.SearchChatRoomByIdentifier ( string  identifier)
inline

Find a chat room by its identifier.

Parameters
identifierThe chat room identifier
Returns
A matching chat room or null if none matches.
Linphone.Conference Linphone.Core.SearchConference ( Linphone.ConferenceParams  parameters,
Linphone.Address  localAddr,
Linphone.Address  remoteAddr,
IEnumerable< Linphone.Address participants 
)
inline

Find a conference.

Parameters
parametersThe conference parameters to match Linphone.ConferenceParams or null
localAddrLinphone.Address representing the local proxy configuration or null
remoteAddrLinphone.Address to search for or null
participantsThe participants that must be present in the chat room to find A list of Linphone.Address objects.
Returns
A pointer on Linphone.Conference satisfying the non-null function arguments or null if none matches
Linphone.Conference Linphone.Core.SearchConference ( Linphone.Address  conferenceAddr)
inline

Finds a conference.

Parameters
conferenceAddrLinphone.Address representing the conference address
Returns
A pointer on Linphone.Conference whose conference address is the one provided as argument or null if none matches
Linphone.Conference Linphone.Core.SearchConferenceByIdentifier ( string  identifier)
inline

Find a conference by its identifier.

Parameters
identifierThe conference identifier
Returns
A matching conference or null if none matches.
static void Linphone.Core.SerializeLogs ( )
inlinestatic

Enables logs serialization (output logs from either the thread that creates the linphone core or the thread that calls Linphone.Core.Iterate()).

Must be called before creating the Linphone.Core.

void Linphone.Core.SetAudioPortRange ( int  minPort,
int  maxPort 
)
inline

Sets the UDP port range from which to randomly select the port used for audio streaming.

Parameters
minPortThe lower bound of the audio port range to use
maxPortThe upper bound of the audio port range to use
static void Linphone.Core.SetLogCollectionMaxFileSize ( long  size)
inlinestatic

Sets the max file size in bytes of the files used for log collection.

Warning: this function should only not be used to change size dynamically but instead only before calling Linphone.Core.EnableLogCollection(). If you increase max size on runtime, logs chronological order COULD be broken.

Parameters
sizeThe max file size in bytes of the files used for log collection.
static void Linphone.Core.SetLogCollectionPath ( string  path)
inlinestatic

Sets the path of a directory where the log files will be written for log collection.

When log collection is enabled, the function will close the file with the current prefix in the old path and it will open the new file with current prefix in the new path. If you need to change the path and the file at the same time, then you should deactivate log collection with Linphone.Core.EnableLogCollection() before doing modifications.

Parameters
pathThe path where the log files will be written.
static void Linphone.Core.SetLogCollectionPrefix ( string  prefix)
inlinestatic

Sets the prefix of the filenames that will be used for log collection.

When log collection is enabled, the function will close the old file and it will open the new one in the current path. If you need to change the path and the file at the same time, then you should deactivate log collection with Linphone.Core.EnableLogCollection() before doing modifications.

Parameters
prefixThe prefix to use for the filenames for log collection.
void Linphone.Core.SetQrcodeDecodeRect ( int  x,
int  y,
int  w,
int  h 
)
inline

Set the rectangle where the decoder will search a QRCode.

Parameters
xaxis
yaxis
wwidth
hheight
void Linphone.Core.SetRefreshWindow ( int  minValue,
int  maxValue 
)
inline

Set the refresh window.

During this window, belle-sip schedules the refreshes of the sip messages

Parameters
minValuelower bound of the refresh window
maxValueupper bound of the refresh window

Warning : The refresh window must be set before starting the core

void Linphone.Core.SetTextPortRange ( int  minPort,
int  maxPort 
)
inline

Sets the UDP port range from which to randomly select the port used for text streaming.

Parameters
minPortThe lower bound of the text port range to use
maxPortThe upper bound of the text port range to use
void Linphone.Core.SetTone ( Linphone.ToneID  toneId,
string  audiofile 
)
inline

Assign an audio file to be played as a specific tone id.

This function typically allows to customize telephony tones per country. If you want to disable a tone, set a path to a non-existent file. To disable all tones, use Linphone.Core.EnableCallToneIndications() or set the tone_indications to 0 in the [misc] section of your linphonerc. If you want to disable a tone, set a path to a non-existent file. To disable all tones, use Linphone.Core.EnableCallToneIndications() or set the tone_indications to 0 in the [misc] section of your linphonerc.

Parameters
toneIdthe Linphone.ToneID
audiofilea wav file to be played or null to use the default (generated) one.
void Linphone.Core.SetUserAgent ( string  name,
string  version 
)
inline

Set the user agent string used in SIP messages.

Set the user agent string used in SIP messages as "[ua_name]/[version]". No slash character will be printed if null is given to "version". If null is given to "ua_name" and "version" both, the User-agent header will be empty. This function should be called just after linphone_factory_create_core ideally.

Parameters
nameName of the user agent.
versionVersion of the user agent.
void Linphone.Core.SetVideoPortRange ( int  minPort,
int  maxPort 
)
inline

Sets the UDP port range from which to randomly select the port used for video streaming.

Parameters
minPortThe lower bound of the video port range to use
maxPortThe upper bound of the video port range to use
bool Linphone.Core.SoundDeviceCanCapture ( string  device)
inline

Tells whether a specified sound device can capture sound.

Parameters
devicethe device name as returned by linphone_core_get_sound_devices
Returns
A boolean value telling whether the specified sound device can capture sound

Deprecated : 08/07/2020 use Linphone.AudioDevice API instead()

bool Linphone.Core.SoundDeviceCanPlayback ( string  device)
inline

Tells whether a specified sound device can play sound.

Parameters
devicethe device name as returned by linphone_core_get_sound_devices
Returns
A boolean value telling whether the specified sound device can play sound

Deprecated : 08/07/2020 use Linphone.AudioDevice API instead()

bool Linphone.Core.SoundResourcesLocked ( )
inline

Checks if a call will need the sound resources in near future (typically an outgoing call that is awaiting response).

In liblinphone, it is not possible to have two independant calls using sound device or camera at the same time. In order to prevent this situation, an application can use Linphone.Core.SoundResourcesLocked() to know whether it is possible at a given time to start a new outgoing call. When the function returns true, an application should not allow the user to start an outgoing call.

Returns
A boolean value telling whether a call will need the sound resources in near future
void Linphone.Core.Start ( )
inline

Starts a Linphone.Core object after it has been instantiated and not automatically started.

Also re-initialize a Linphone.Core object that has been stopped using Linphone.Core.Stop(). Must be called only if Linphone.GlobalState is either Ready of Off. State will changed to Startup, Configuring and then On.

Returns
0: success, -1: global failure, -2: could not connect database
void Linphone.Core.StartEchoCancellerCalibration ( )
inline

Starts an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.

Returns
LinphoneStatus whether calibration has started or not.
void Linphone.Core.StartEchoTester ( uint  rate)
inline

Start the simulation of call to test the latency with an external device.

Parameters
rateSound sample rate.
Returns
-1 in case of failure, 1 otherwise.
void Linphone.Core.Stop ( )
inline

Stops a Linphone.Core object after it has been instantiated and started.

If stopped, it can be started again using Linphone.Core.Start(). Must be called only if Linphone.GlobalState is either On. State will changed to Shutdown and then Off. This function may block to perform SIP server unregistration. Using Linphone.Core.StopAsync() is preferred.

Warning : This function must never be called from within an event notification triggered by Liblinphone.

void Linphone.Core.StopAsync ( )
inline

Asynchronously stops a Linphone.Core object after it has been instantiated and started.

State changes to Shutdown then Linphone.Core.Iterate() must be called to allow the Core to end asynchronous tasks (terminate call, etc.). When all tasks are finished, State will change to Off. Must be called only if Linphone.GlobalState is On. When Linphone.GlobalState is Off Linphone.Core can be started again using Linphone.Core.Start().

Warning : This function must never be called from within an event notification triggered by Liblinphone.

void Linphone.Core.StopDtmf ( )
inline

Stops playing a dtmf started by Linphone.Core.PlayDtmf().

void Linphone.Core.StopEchoTester ( )
inline

Stop the simulation of call.

void Linphone.Core.StopRinging ( )
inline

Whenever the liblinphone is playing a ring to advertise an incoming call or ringback of an outgoing call, this function stops the ringing.

Typical use is to stop ringing when the user requests to ignore the call.

Linphone.Event Linphone.Core.Subscribe ( Linphone.Address  resource,
string  ev,
int  expires,
Linphone.Content  body 
)
inline

Creates and send an outgoing subscription, specifying the destination resource, the event name, and an optional content body.

If accepted, the subscription runs for a finite period, but is automatically renewed if not terminated before.

Parameters
resourcethe destination resource
evthe event name
expiresthe whished duration of the subscription
bodyan optional body, may be null.
Returns
a Linphone.Event holding the context of the created subcription.
void Linphone.Core.TakePreviewSnapshot ( string  file)
inline

Takes a photo of currently from capture device and write it into a jpeg file.

Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.

Parameters
filea path where to write the jpeg content.
Returns
0 if successful, -1 otherwise (typically if jpeg format is not supported).
void Linphone.Core.TerminateAllCalls ( )
inline

Terminates all the calls.

Returns
0
void Linphone.Core.TerminateConference ( )
inline

Terminates the running conference.

If it is a local conference, all calls inside it will become back separate calls and will be put in LinphoneCallPaused state. If it is a conference involving a focus server, all calls inside the conference will be terminated. If it is a local conference, all calls inside it will become back separate calls and will be put in LinphoneCallPaused state. If it is a conference involving a focus server, all calls inside the conference will be terminated.

Returns
0 if succeeded. Negative number if failed

Deprecated : 23/01/2025 Use Linphone.Conference.Terminate() instead.

static bool Linphone.Core.TunnelAvailable ( )
inlinestatic

True if tunnel extension was compiled.

Returns
true if library was built with tunnel, false otherwise
void Linphone.Core.UpgradeDatabase ( )
inline

Upgrade the database manually to the latest schema.

void Linphone.Core.UploadLogCollection ( )
inline

Uploads the log collection to the configured server url.

static bool Linphone.Core.UpnpAvailable ( )
inlinestatic

Return the availability of uPnP.

Returns
true if uPnP is available otherwise return false.

Warning : UPNP support has been removed, and proved to be useless.

void Linphone.Core.UsePreviewWindow ( bool  yesno)
inline

Tells the core to use a separate window for local camera preview video, instead of inserting local view within the remote video window.

Parameters
yesnotrue to use a separate window, false to insert the preview in the remote video window.
static bool Linphone.Core.VcardSupported ( )
inlinestatic

Tells whether VCARD support is builtin.

Returns
true if VCARD is supported, false otherwise.
void Linphone.Core.VerifyServerCertificates ( bool  yesno)
inline

Specify whether the tls server certificate must be verified when connecting to a SIP/TLS server.

Parameters
yesnoA boolean value telling whether the tls server certificate must be verified
void Linphone.Core.VerifyServerCn ( bool  yesno)
inline

Specify whether the tls server certificate common name must be verified when connecting to a SIP/TLS server.

Parameters
yesnoA boolean value telling whether the tls server certificate common name must be verified
bool Linphone.Core.VideoSupported ( )
inline

Test if video is supported.

Returns
true if the library was built with video support, false otherwise

Property Documentation

Linphone.AccountCreatorBackend Linphone.Core.AccountCreatorBackend
getset

Gets the Linphone.AccountCreator backend set for the Linphone.Core.

Returns
The Linphone.AccountCreatorBackend
string Linphone.Core.AccountCreatorUrl
getset

Gets the Linphone.AccountCreator url on the Linphone.Core.

Returns
url The URL to reach.
IEnumerable<Linphone.Account> Linphone.Core.AccountList
get

Returns an unmodifiable list of entered accounts.

Returns
A list of Linphone.Account objects.
string Linphone.Core.AdaptiveRateAlgorithm
getset

Returns which adaptive rate algorithm is currently configured for future calls.

See : Linphone.Core.AdaptiveRateAlgorithm

Returns
the adaptive rate algorithm. Currently two values are supported: 'advanced', which is the default value, or 'basic'.
bool Linphone.Core.AdaptiveRateControlEnabled
getset

Returns whether adaptive rate control is enabled.

See : Linphone.Core.EnableAdaptiveRateControl()

Returns
true if adaptive rate control is enabled, false otherwise
bool Linphone.Core.AgcEnabled
getset

Tells whether the experimental software Automatic Gain Control is activated.

This algorithm is very experimental, not usable in its current state.

Returns
true if the AGC is enabled, false otherwise.
bool Linphone.Core.AlertsEnabled
getset

Returns whether alert reporting is enabled.

See Linphone.Alert for more details.

Returns
whether alert reporting is enabled.
bool Linphone.Core.AudioAdaptiveJittcompEnabled
getset

Tells whether the audio adaptive jitter compensation is enabled.

Returns
true if the audio adaptive jitter compensation is enabled, false otherwise.
IEnumerable<Linphone.AudioDevice> Linphone.Core.AudioDevices
get

Returns a list of audio devices, with only the first device for each type To have the list of all audio devices, use Linphone.Core.ExtendedAudioDevices

Returns
A list of Linphone.AudioDevice objects. A list with the first Linphone.AudioDevice of each type
int Linphone.Core.AudioDscp
getset

Gets the DSCP field for outgoing audio streams.

The DSCP defines the quality of service in IP packets.

Returns
The current DSCP value
int Linphone.Core.AudioJittcomp
getset

Returns the nominal audio jitter buffer size in milliseconds.

Returns
The nominal audio jitter buffer size in milliseconds
string Linphone.Core.AudioMulticastAddr
getset

Use to get multicast address to be used for audio stream.

Returns
an ipv4/6 multicast address or default value.
bool Linphone.Core.AudioMulticastEnabled
getset

Use to get multicast state of audio stream.

Returns
true if subsequent calls will propose multicast ip set by Linphone.Core.AudioMulticastAddr
int Linphone.Core.AudioMulticastTtl
getset

Use to get multicast ttl to be used for audio stream.

Returns
a time to leave value
IEnumerable<Linphone.PayloadType> Linphone.Core.AudioPayloadTypes
getset

Returns the list of the available audio payload types.

Returns
A freshly allocated list of the available payload types. A list of Linphone.PayloadType objects.
int Linphone.Core.AudioPort
getset

Gets the UDP port used for audio streaming.

Returns
The UDP port used for audio streaming
Linphone.Range Linphone.Core.AudioPortsRange
get

Get the audio port range from which is randomly chosen the UDP port used for audio streaming.

Returns
a Linphone.Range object
IEnumerable<Linphone.AuthInfo> Linphone.Core.AuthInfoList
get

Returns an unmodifiable list of currently entered Linphone.AuthInfo.

Returns
A list of Linphone.AuthInfo. A list of Linphone.AuthInfo objects.
bool Linphone.Core.AutoDownloadIcalendarsEnabled
getset

Gets if the automatic download of incoming icalendars is enabled or not.

Returns
true if icalendars will be automatically downloaded, false otherwise.
bool Linphone.Core.AutoDownloadVoiceRecordingsEnabled
getset

Gets if the auto download for incoming voice recordings is enabled or not.

Returns
true if voice recordings will be automatically downloaded, false otherwise.
int Linphone.Core.AutoIterateBackgroundSchedule
getset

Gets the timer used to schedule the call to core.iterate() method when in background (Android only).

This is only used when Linphone.Core.AutoIterateEnabled() returns true.

Returns
The timing in milliseconds used to schedule the call while in background (default is 500ms).
bool Linphone.Core.AutoIterateEnabled
getset

Gets whether auto iterate is enabled or not (Android & iOS only).

Returns
true if Linphone.Core.Iterate() is scheduled automatically, false otherwise
int Linphone.Core.AutoIterateForegroundSchedule
getset

Gets the timer used to schedule the call to core.iterate() method when in foreground (Android only).

This is only used when Linphone.Core.AutoIterateEnabled() returns true.

Returns
The timing in milliseconds used to schedule the call while in foreground (default is 20ms).
bool Linphone.Core.AutomaticHttpProxyDetectionEnabled
getset

Returns whether automatic http proxy is enabled.

Returns
true if automatic http proxy is enabled or false.
bool Linphone.Core.AutoSendRingingEnabled
getset

Gets if the automatic sending of 180 Ringing is enabled or not.

Returns
true if the automatic sending of 180 Ringing is enabled, false otherwise.
Linphone.AVPFMode Linphone.Core.AvpfMode
getset

Returns AVPF enablement.

See Linphone.Core.AvpfMode .

Returns
The current Linphone.AVPFMode mode
int Linphone.Core.AvpfRrInterval
getset

Returns the avpf report interval in seconds.

Returns
The current AVPF report interval in seconds
bool Linphone.Core.BaudotEnabled
getset

Returns enablement of text sending via Baudot tones in the audio stream.

Returns
true if text sending via Baudot tones in the audio stream is enabled, false otherwise.
bool Linphone.Core.CallkitEnabled
getset

Special function to check if the callkit is enabled, False by default.

Returns
true if callkit is enabled, false otherwise.
IEnumerable<Linphone.CallLog> Linphone.Core.CallLogs
get

Get the list of call logs (past calls).

Returns
A list of Linphone.CallLog. A list of Linphone.CallLog objects.
string Linphone.Core.CallLogsDatabasePath
getset

Gets the database filename where call logs will be stored.

Returns
filesystem path.

Deprecated : 07/12/2021: Use only for migration purposes

string Linphone.Core.CallOnHoldMusicFile
getset

Get the wav file played when putting a call on hold with Linphone.Call.Pause()

The file is a 16 bit linear file.

Returns
The path to the file that is played when putting a call on hold.
IEnumerable<Linphone.Call> Linphone.Core.Calls
get

Gets the current list of calls.

Note that this list is read-only and might be changed by the core after a function call to Linphone.Core.Iterate(). Similarly the Linphone.Call objects inside it might be destroyed without prior notice. To hold references to Linphone.Call object into your program, you must use linphone_call_ref.

Returns
A list of Linphone.Call A list of Linphone.Call objects.
int Linphone.Core.CallsNb
get

Gets the number of Call.

Returns
The current number of calls
bool Linphone.Core.CallToneIndicationsEnabled
getset

Check whether tone indications of calls are enabled.

Returns
true if call tone indications are enabled
int Linphone.Core.CameraSensorRotation
get

Get the camera sensor rotation.

This is needed on some mobile platforms to get the number of degrees the camera sensor is rotated relative to the screen.

Returns
The camera sensor rotation in degrees (0 to 360) or -1 if it could not be retrieved
int Linphone.Core.CameraWhitebalance
getset

Gets the whitebalance of the camera (currently only supported by Android).

Returns
The whitebalance of the camera, default is -1 (disabled).
bool Linphone.Core.CapabilityNegociationEnabled
getset

Checks if the capability negotiation (RFC5939) is supported or not.

Returns
true if capability negotiation is supported; false otherwise.
bool Linphone.Core.CapabilityNegotiationReinviteEnabled
getset

Checks if the capability negotiation (RFC5939) reINVITE is enabled or not.

Returns
true if capability negotiation reINVITE is enabled; false otherwise.
string Linphone.Core.CaptureDevice
getset

Gets the name of the currently assigned sound device for capture.

Returns
The name of the currently assigned sound device for capture.

Deprecated : 11/09/2024 use Linphone.Core.InputAudioDevice or Linphone.Core.DefaultInputAudioDevice instead.

bool Linphone.Core.CfgLinesMergingEnabled
getset

Checks if cfg lines are going to the merged if the capability negotiation (RFC5939) is supported or not.

Returns
true if acfg and pcfg lines with consecutive indexes are going to be merged; false otherwise.
bool Linphone.Core.ChatEnabled
get

Returns whether chat is enabled.

Returns
true if chat is enabled, false otherwise
bool Linphone.Core.ChatMessagesAggregationEnabled
getset

End of group ldap.

Returns whether chat messages grouping is enabled or not.

Returns
true if received chat messages will be notified as a bundle, false otherwise.
IEnumerable<Linphone.ChatRoom> Linphone.Core.ChatRooms
get

Returns a list of chat rooms.

Returns
List of chat rooms. A list of Linphone.ChatRoom objects.
int Linphone.Core.ConferenceAvailabilityBeforeStart
getset

Gets the conference availability before start.

Returns
the number of seconds the conference can be joined early

Warning : This setting is only applicable to conference servers

int Linphone.Core.ConferenceCleanupPeriod
getset

Gets the conference cleanup timer period.

Returns
the period of the conference cleanup timer
int Linphone.Core.ConferenceExpirePeriod
getset

Gets the conference expire period.

Returns
the number of second after which the conference cannot be joined

Warning : This setting is only applicable to conference servers

bool Linphone.Core.ConferenceIcsInMessageBodyEnabled
getset

Gets wether conference invitations will be sent in the chat message body or as a file attachment.

Returns
true if ICS will be sent in the message body (by default), false if it will be sent as a file attachment.
IEnumerable<Linphone.ConferenceInfo> Linphone.Core.ConferenceInformationList
get

Retrieve the list of conference information on DB.

Returns
The list of conference infos A list of Linphone.ConferenceInfo objects. .
float Linphone.Core.ConferenceLocalInputVolume
get

Returns the input volume of the local participant.

Returns
A value inside [0.0 ; 1.0]

Deprecated : 23/01/2025 Use Linphone.Conference.InputVolume instead.

int Linphone.Core.ConferenceMaxThumbnails
getset

Gets the maximum number of thumbnails requested in the SDP during a conference call Linphone.Account.CallLogs.

Returns
the maximum number of thumbnails requested in the SDP during a conference call
Linphone.ConferenceParticipantListType Linphone.Core.ConferenceParticipantListType
getset

Tells whether the default conference participant list is open or closed.

Returns
A Linphone.ConferenceParticipantListType participant list type
bool Linphone.Core.ConferenceServerEnabled
getset

Tells whether the conference server feature is enabled.

Returns
A boolean value telling whether the conference server feature is enabled or not
Linphone.Config Linphone.Core.Config
get

Returns the config object used to manage the storage (config) file.

Returns
a Linphone.Config object.
Linphone.ConsolidatedPresence Linphone.Core.ConsolidatedPresence
getset

Gets my consolidated presence.

Returns
My Linphone.ConsolidatedPresence presence
Linphone.Call Linphone.Core.CurrentCall
get

Gets the current call.

The current call is defined as follows: If multiple concurrent calls exist, it is the only one that currelty uses the microphone or speaker, otherwise it is the unique call that exists unless this call is in Linphone.CallState.Paused state.

Returns
The current call or null if no call is running.
Linphone.Address Linphone.Core.CurrentCallRemoteAddress
get

Gets the remote address of the current call.

Returns
The remote address of the current call or null if there is no current call.
Linphone.VideoDefinition Linphone.Core.CurrentPreviewVideoDefinition
get

Get the effective video definition provided by the camera for the captured video.

When preview is disabled or not yet started this function returns a 0x0 video definition.

Returns
The captured Linphone.VideoDefinition.

See : Linphone.Core.PreviewVideoDefinition

bool Linphone.Core.DatabaseEnabled
getset

Returns whether the database is enabled.

Returns
a boolean indicating the enablement of the database.
Linphone.Account Linphone.Core.DefaultAccount
getset

Returns the default account, that is the one used to determine the current identity.

Returns
The default account.
Linphone.ConferenceLayout Linphone.Core.DefaultConferenceLayout
getset

Gets the default conference layout.

Returns
conference layout
int Linphone.Core.DefaultEphemeralLifetime
getset

Gets the default lifetime of ephemeral messages in seconds once they are read.

Returns
lifetime of ephemeral messages in seconds once read
Linphone.ChatRoomEphemeralMode Linphone.Core.DefaultEphemeralMode
getset

Gets the default ephemeral message mode.

Returns
the default ephemeral message mode Linphone.ChatRoomEphemeralMode
int Linphone.Core.DefaultEphemeralNotReadLifetime
getset

Gets the default lifetime of ephemeral messages in seconds when they are not read.

Returns
lifetime of ephemeral messages in seconds when not read
Linphone.FriendList Linphone.Core.DefaultFriendList
get

Retrieves the first list of Linphone.Friend from the core.

Returns
the first Linphone.FriendList object or null.
Linphone.AudioDevice Linphone.Core.DefaultInputAudioDevice
getset

Gets the default input audio device.

Returns
The default input audio device
Linphone.AudioDevice Linphone.Core.DefaultOutputAudioDevice
getset

Gets the default output audio device.

Returns
The default output audio device
Linphone.ProxyConfig Linphone.Core.DefaultProxyConfig
getset

Returns the default proxy configuration, that is the one used to determine the current identity.

Returns
The default proxy configuration.

Deprecated : 04/09/2024 Use Linphone.Core.DefaultAccount

string Linphone.Core.DefaultVideoDisplayFilter
get

Gets the name of the default mediastreamer2 filter used for rendering video on the current platform.

This is for advanced users of the library, mainly to expose mediastreamer video filter name and status.

Returns
The default video display filter.
int Linphone.Core.DelayedTimeout
getset

Gets the delayed timeout See Linphone.Core.DelayedTimeout for details.

Returns
The current delayed timeout in seconds

Deprecated : 04/09/2024 Obscure.

int Linphone.Core.DeviceRotation
getset

Gets the current device orientation.

Returns
The current device orientation

See : Linphone.Core.DeviceRotation

Linphone.DigestAuthenticationPolicy Linphone.Core.DigestAuthenticationPolicy
getset

Get the current digest authentication policy applicable for SIP and HTTP.

Returns
The current digest authentication policy.
bool Linphone.Core.DisableRecordOnMute
getset

Get whether the microphone will be completely deactivated when muted.

Please refer to Linphone.Core.DisableRecordOnMute.

Returns
True if you wish to entirely stop the audio recording when muting the microphone.
bool Linphone.Core.DnsSearchEnabled
getset

Tells whether DNS search (use of local domain if the fully qualified name did return results) is enabled.

Returns
true if DNS search is enabled, false if disabled.
IEnumerable<string> Linphone.Core.DnsServers
set

Forces liblinphone to use the supplied list of dns servers, instead of system's ones.

Parameters
serversA list of strings containing the IP addresses of DNS servers to be used. A list of const char * objects. Setting to null restores default behaviour, which is to use the DNS server list provided by the system. The list is copied internally.
IEnumerable<string> Linphone.Core.DnsServersApp
set

Forces liblinphone to use the supplied list of dns servers, instead of system's ones and set dns_set_by_app at true or false according to value of servers list.

See : Linphone.Core.DnsSetByApp

Parameters
serversA list of strings containing the IP addresses of DNS servers to be used. A list of const char * objects. Setting to null restores default behaviour, which is to use the DNS server list provided by the system. The list is copied internally.
bool Linphone.Core.DnsSetByApp
get

Tells if the DNS was set by an application.

Returns
true if DNS was set by app, false otherwise.
bool Linphone.Core.DnsSrvEnabled
getset

Tells whether DNS SRV resolution is enabled.

Returns
true if DNS SRV resolution is enabled, false if disabled.
int Linphone.Core.DownloadBandwidth
getset

Retrieve the maximum available download bandwidth.

This value was set by Linphone.Core.DownloadBandwidth.

Returns
the download bandiwdth in kbits/s, 0 for unknown.
int Linphone.Core.DownloadPtime
getset

Get audio packetization time linphone expects to receive from peer.

A value of zero means that ptime is not specified.

Returns
the download packetization time set
int Linphone.Core.EchoCancellationCalibration
get

Gets the currently stored calibration delay for the software echo cancellation.

Returns
the current calibration value, -1 if it failed, 0 if not done or not needed, a positive value if a software echo canceller is required after running Linphone.Core.StartEchoCancellerCalibration().
bool Linphone.Core.EchoCancellationEnabled
getset

Returns true if echo cancellation is enabled.

Returns
A boolean value telling whether echo cancellation is enabled or disabled
string Linphone.Core.EchoCancellerFilterName
getset

Gets the name of the mediastreamer2 filter used for echo cancelling.

Returns
The name of the mediastreamer2 filter used for echo cancellation.
bool Linphone.Core.EchoLimiterEnabled
getset

Tells whether echo limiter is enabled.

Enables or disable echo limiter. "Echo limiter" refers to an algorithm that creates half-duplex conversation in order to suppress echo. It is experimental and shall be used only in rare cases where echo cancellation cannot perform because of non-linear speaker/mic coupling. You shall not expected good audio quality with the echo limiter.

Returns
true if the echo limiter is enabled, false otherwise.
bool Linphone.Core.EktPluginLoaded
set

sets the state of the EKT plugin in the Linphone core instance.

Parameters
ektPluginLoadedwhether the EKT plugin is loaded or not
bool Linphone.Core.EmptyChatroomsDeletionEnabled
getset

Tells whether empty chat rooms are deleted or not.

Returns
A boolean value telling whether the deletion of empty chatrooms is enabled or not (Applicable to servers only)
int Linphone.Core.EnableSipUpdate
set

Enable or disable the UPDATE method support.

Parameters
valEnable or disable it
Linphone.EphemeralChatMessagePolicy Linphone.Core.EphemeralChatMessagePolicy
getset

Gets the current policy for ephemeral chat messages.

See Linphone.EphemeralChatMessagePolicy for more details.

Returns
the current Linphone.EphemeralChatMessagePolicy.
int Linphone.Core.ExpectedBandwidth
set

Do not use, this function does nothing.

Parameters
bandwidththe bandwidth in kbits/s, 0 for infinite

Deprecated : 04/09/2024 this function does nothing.

IEnumerable<Linphone.AudioDevice> Linphone.Core.ExtendedAudioDevices
get

Returns the list of all audio devices.

Returns
A list of Linphone.AudioDevice objects. A list of all Linphone.AudioDevice
bool Linphone.Core.FecEnabled
getset

Tells whether the flexible FEC feature (RFC8627) is enabled for this Linphone.Core object.

Returns
A boolean value telling whether the flexible FEC feature is enabled or not for this Linphone.Core object
string Linphone.Core.FileTransferServer
getset

Gets the globaly set http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml.

Url may be like: "https://file.linphone.org/upload.php&quot;.

Returns
URL of the file server.
bool Linphone.Core.ForcedIceRelayEnabled
getset

Indicates whether the ICE relay path is forcibly selected.

Returns
a boolean value indicating whether forced relay is enabled.

See : Linphone.Core.EnableForcedIceRelay().

bool Linphone.Core.FriendListSubscriptionEnabled
getset

Returns whether or not friend lists subscription are enabled.

Returns
whether or not the feature is enabled
string Linphone.Core.FriendsDatabasePath
getset

Gets the database filename where friends will be stored.

Returns
filesystem path.

Deprecated : 27/10/2023 Friends are now stored in the main db

IEnumerable<Linphone.FriendList> Linphone.Core.FriendsLists
get

Retrieves the list of Linphone.FriendList from the core.

Returns
A list of Linphone.FriendList. A list of Linphone.FriendList objects.
IEnumerable<Linphone.ConferenceInfo> Linphone.Core.FutureConferenceInformationList
get

Retrieve the list of future conference information on DB.

Returns
The list of future conference infos A list of Linphone.ConferenceInfo objects. .
bool Linphone.Core.GenericComfortNoiseEnabled
getset

Returns enablement of RFC3389 generic comfort noise algorithm.

Returns
true if generic comfort noise is enabled, false otherwise.
Linphone.GlobalState Linphone.Core.GlobalState
get

Returns the global state of core.

Returns
a Linphone.GlobalState enum.
bool Linphone.Core.GruuInConferenceAddressEnabled
getset

Returns whether the gr parameter is kept in the conference address.

Returns
true if the "gr" parameter is kept in the conference address, false otherwise.

See : Linphone.Core.EnableGruuInConferenceAddress() for more informations

bool Linphone.Core.GuessHostname
getset

Returns true if hostname part of primary contact is guessed automatically.

Returns
true if guess hostname enabled, false otherwise.
string Linphone.Core.HttpProxyHost
getset

Gets http proxy address to be used for signaling.

Returns
hostname of IP adress of the http proxy (can be null to disable).
int Linphone.Core.HttpProxyPort
getset

Gets http proxy port to be used for signaling.

Returns
port of the http proxy.
string Linphone.Core.Identity
get

Gets the default identity SIP address.

This is an helper function. If no default proxy is set, this will return the primary contact ( see Linphone.Core.PrimaryContact ). If a default proxy is set it returns the registered identity on the proxy.

Returns
The default identity SIP address.
int Linphone.Core.ImdnResendPeriod
getset

Gets the IMDN resend period.

Returns
the number of second to resend an failed IMDN message
int Linphone.Core.ImdnToEverybodyThreshold
getset

Returns the threshold for sending IMDN to all participants to a Linphone.ChatRoom.

Returns
An integer value telling the threshold for sending IMDN to all participants to a Linphone.ChatRoom
Linphone.ImNotifPolicy Linphone.Core.ImNotifPolicy
get

Gets the Linphone.ImNotifPolicy object controlling the instant messaging delivery and displayed service notifications.

Returns
A Linphone.ImNotifPolicy object.
int Linphone.Core.InCallTimeout
getset

Gets the maximum duration of a call.

See Linphone.Core.InCallTimeout for details.

Returns
The current in call timeout in seconds
int Linphone.Core.IncTimeout
getset

Returns the incoming call timeout See Linphone.Core.IncTimeout for details.

Returns
The current incoming call timeout in seconds
Linphone.AudioDevice Linphone.Core.InputAudioDevice
getset

Gets the input audio device for the current call.

Returns
The input audio device for the current or first call, null if there is no call.
bool Linphone.Core.Ipv6Enabled
getset

Tells whether IPv6 is enabled or not.

Returns
A boolean value telling whether IPv6 is enabled or not
bool Linphone.Core.IsAutoDownloadIcalendarsEnabled
get

Gets if the automatic download of incoming icalendars is enabled or not.

Returns
true if icalendars will be automatically downloaded, false otherwise.

Deprecated : 16/12/2021 Use Linphone.Core.AutoDownloadIcalendarsEnabled() instead.

bool Linphone.Core.IsAutoDownloadVoiceRecordingsEnabled
get

Gets if the auto download for incoming voice recordings is enabled or not.

Returns
true if voice recordings will be automatically downloaded, false otherwise.

Deprecated : 16/12/2021 Use Linphone.Core.AutoDownloadVoiceRecordingsEnabled() instead.

bool Linphone.Core.IsAutoIterateEnabled
get

Gets whether auto iterate is enabled or not (Android & iOS only).

Returns
true if Linphone.Core.Iterate() is scheduled automatically, false otherwise

Deprecated : 16/12/2021 Use Linphone.Core.AutoIterateEnabled() instead.

bool Linphone.Core.IsEchoCancellerCalibrationRequired
get

Check whether the device is echo canceller calibration is required.

Returns
true if it is required, false otherwise
bool Linphone.Core.IsEktPluginLoaded
get

Gets if the EKT plugin is currently loaded in the Linphone core instance.

Returns
true if the EKT plugin is loaded
bool Linphone.Core.IsFriendListSubscriptionEnabled
get

Returns whether or not friend lists subscription are enabled.

Returns
whether or not the feature is enabled

Deprecated : 16/12/2021 Use Linphone.Core.FriendListSubscriptionEnabled() instead.

bool Linphone.Core.IsInBackground
get

Gets whether the Core is considering itself in background or not.

The Core foreground/background state depends on the last call made to Linphone.Core.EnterBackground() or Linphone.Core.EnterForeground().

Returns
true if the Core is in background, false otherwise.
bool Linphone.Core.IsIncomingInvitePending
get

Tells whether there is an incoming invite pending.

Returns
A boolean telling whether an incoming invite is pending or not.
bool Linphone.Core.IsInConference
get

Indicates whether the local participant is part of a conference.

Warning : That function automatically fails in the case of conferences using a conferencet server (focus). If you use such a conference, you should use Linphone.Conference.RemoveParticipant() instead.

Returns
true if the local participant is in a conference, false otherwise.

Deprecated : 09/03/2021 Use Linphone.Conference.IsIn() instead.

bool Linphone.Core.IsMediaEncryptionMandatory
get

Checks if the configured media encryption is mandatory or not.

Returns
true if media encryption is mandatory; false otherwise.
bool Linphone.Core.IsNativeRingingEnabled
get

Returns whether the native ringing is enabled or not.

Returns
True if we use the native ringing, false otherwise

Deprecated : 16/12/2021 Use Linphone.Core.NativeRingingEnabled() instead.

bool Linphone.Core.IsNetworkReachable
get

return network state either as positioned by the application or by linphone itself.

Returns
true if network is reachable, false otherwise
bool Linphone.Core.IsPushNotificationAvailable
get

Gets whether push notifications are available or not (Android & iOS only).

Returns
true if push notifications are available, false otherwise
bool Linphone.Core.IsPushNotificationEnabled
get

Gets whether push notifications are enabled or not (Android & iOS only).

If not, the app will have to handle all the push-related settings for each accounts

Returns
true if push notifications are enabled, false otherwise

Deprecated : 16/12/2021 Use Linphone.Core.PushNotificationEnabled() instead.

bool Linphone.Core.IsRecordAwareEnabled
get

Gets if the record aware feature is enabled or not.

Returns
true if the record aware feature is enabled, false otherwise.

Deprecated : 16/12/2021 Use Linphone.Core.RecordAwareEnabled() instead.

bool Linphone.Core.IsSenderNameHiddenInForwardMessage
get

Returns whether or not sender name is hidden in a forwarded message.

Returns
whether or not the feature
bool Linphone.Core.IsVerifyServerCertificates
get

Get whether the tls server certificate must be verified when connecting to a SIP/TLS server.

Returns
True if the tls server certificate must be verified
bool Linphone.Core.IsVerifyServerCn
get

Get whether the tls server certificate common name must be verified when connecting to a SIP/TLS server.

Returns
True if the tls server certificate common name must be verified
bool Linphone.Core.IsVibrationOnIncomingCallEnabled
get

Gets whether the device will vibrate while an incoming call is ringing (Android only).

Returns
true if the device will vibrate (if possible), false otherwise

Deprecated : 16/12/2021 Use Linphone.Core.VibrationOnIncomingCallEnabled() instead.

bool Linphone.Core.KeepAliveEnabled
getset

Is signaling keep alive enabled.

Returns
A boolean value telling whether signaling keep alive is enabled
string Linphone.Core.Label
getset

Get the label assigned to the LinphoneCore.

The default value is null (no label).

Returns
the assigned label.
Linphone.CallLog Linphone.Core.LastOutgoingCallLog
get

Gets the latest outgoing call log.

Conference calls are not returned by this function! Requires ENABLE_DB_STORAGE to work.

Returns
The last outgoing call log if any.
IEnumerable<Linphone.Ldap> Linphone.Core.LdapList
get

Returns a list of entered LDAPs.

Items must be freed with linphone_ldap_unref

Returns
A list of Linphone.Ldap objects.

Deprecated : 18/11/2024 use Linphone.Core.RemoteContactDirectories instead.

bool Linphone.Core.LimeX3DhEnabled
getset

Tells wether LIME X3DH is enabled or not.

Returns
The current lime state
string Linphone.Core.LimeX3DhServerUrl
getset

Get the x3dh server url.

Returns
The x3dh server url.

Deprecated : 26/08/2022 Use Linphone.AccountParams.LimeServerUrl instead.

IEnumerable<string> Linphone.Core.LinphoneSpecsList
getset

Get the list of linphone specs string values representing what functionalities the linphone client supports.

See : Linphone.Core.LinphoneSpecsList

Returns
A list of supported specs. The list must be freed with bctbx_list_free() after usage. A list of char * objects.
IEnumerable<string> Linphone.Core.LoadedPlugins
get

Return the list of loaded plugins.

Returns
the list of loaded plugins A list of char * objects.
bool Linphone.Core.LocalPermissionEnabled
get

Special function to check if the local network permission has been granted by the user (useful for iOS).

The test performed by this function may popup the local network permission dialog, for that reason it could be a good idea to check it twice to conclude that the user has deny the permission.

Returns
true if local permission request is granted, false otherwise.
long Linphone.Core.LogCollectionMaxFileSize
staticget

Gets the max file size in bytes of the files used for log collection.

Returns
The max file size in bytes of the files used for log collection.
string Linphone.Core.LogCollectionPath
staticget

Gets the path where the log files will be written for log collection.

Returns
The path where the log files will be written.
string Linphone.Core.LogCollectionPrefix
staticget

Gets the prefix of the filenames that will be used for log collection.

Returns
The prefix of the filenames used for log collection.
string Linphone.Core.LogCollectionUploadServerUrl
getset

Gets the url of the server where to upload the collected log files.

Returns
The url of the server where to upload the collected log files.
int Linphone.Core.MaxCallLogs
getset

Gets the maximum number of call logs retrieved when using Linphone.Core.CallLogs or Linphone.Account.CallLogs.

Returns
the maximum number of call logs that will be returned. -1 will return them all.
int Linphone.Core.MaxCalls
getset

Gets the maximum number of simultaneous calls Linphone core can manage at a time.

All new call above this limit are declined with a busy answer

Returns
maximum number of simultaneous calls
int Linphone.Core.MaxSizeForAutoDownloadIncomingFiles
getset

Gets the size under which incoming files in chat messages will be downloaded automatically.

Returns
The size in bytes, -1 if autodownload feature is disabled, 0 to download them all no matter the size
string Linphone.Core.MediaDevice
getset

Gets the name of the currently assigned sound device for media.

Returns
The name of the currently assigned sound device for capture.
Linphone.MediaEncryption Linphone.Core.MediaEncryption
getset

Gets the media encryption type being used for RTP packets.

Returns
The Linphone.MediaEncryption policy being used.
bool Linphone.Core.MediaEncryptionMandatory
set

Defines whether the configured media encryption is mandatory, if it is and the negotation cannot result in the desired media encryption then the call will fail.

If not an INVITE will be resent with encryption disabled.

Parameters
mandatorytrue to set it mandatory; false otherwise.
bool Linphone.Core.MediaNetworkReachable
set

This method is called by the application to notify the linphone core library when the media (RTP) network is reachable.

This is for advanced usage, when SIP and RTP layers are required to use different interfaces. Most applications just need Linphone.Core.NetworkReachable.

Parameters
reachabletrue if network is reachable, false otherwise
Linphone.MediaResourceMode Linphone.Core.MediaResourceMode
getset

This function returns the media resource mode for this core.

Returns
The media resource mode
int Linphone.Core.MessageAutomaticResendingDelay
getset

Returns the duration of the timer that delays the automatic resending of chat messages.

Returns
the duration of the timer in seconds
int Linphone.Core.MessageSendingDelay
getset

Returns the duration of the timer that delays the sending of chat messages.

Returns
the duration of the timer in seconds
bool Linphone.Core.MicEnabled
getset

Tells whether the microphone is enabled.

Returns
true if the microphone is enabled, false if disabled.
float Linphone.Core.MicGainDb
getset

Get microphone gain in db.

Returns
The current microphone gain
int Linphone.Core.MissedCallsCount
get

Gets the number of missed calls.

Once checked, this counter can be reset with Linphone.Core.ResetMissedCallsCount().

Returns
The number of missed calls.
int Linphone.Core.Mtu
getset

Returns the maximum transmission unit size in bytes.

string Linphone.Core.NatAddress
getset

Deprecated.

Get the public IP address of NAT being used.

Returns
The public IP address of NAT being used.

Deprecated : 12/10/2022 Use Linphone.Core.NatPolicy

IntPtr Linphone.Core.NativePreviewWindowId
getset

Get the native window handle of the video preview window.

On Windows UWP/WindowsStore, this is a SwapChainPanel. eg: LinphoneManager.Instance.Core.NativePreviewWindowId = panel; The rendering is automatically done by Linphone.

bool Linphone.Core.NativeRingingEnabled
getset

Returns whether the native ringing is enabled or not.

This property is meaningful for Android platform only. When set to true, the incoming call's ring tone is played by a Android MediaPlayer object playing the phone's default ringtone, and manages vibrator as well. When set to false, the incoming call's ring tone is played using liblinphone's internal ring tone player, that is generic for all platforms.

Returns
True if we use the native ringing, false otherwise
IntPtr Linphone.Core.NativeVideoWindowId
getset

Get the native window handle of the video window.

On Windows UWP/WindowsStore, this is a SwapChainPanel. eg: LinphoneManager.Instance.Core.NativeVideoWindowId = panel; The rendering is automatically done by Linphone.

Linphone.NatPolicy Linphone.Core.NatPolicy
getset

Get The policy that is used to pass through NATs/firewalls.

It may be overridden by a NAT policy for a specific proxy config.

Returns
Linphone.NatPolicy object in use.

See : Linphone.AccountParams.NatPolicy

bool Linphone.Core.NetworkReachable
set

This method is called by the application to notify the linphone core library when network is reachable.

Calling this method with true trigger linphone to initiate a registration process for all proxies. Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.

Parameters
reachabletrue if network is reachable, false otherwise
bool Linphone.Core.NoiseSuppressionEnabled
getset

Indicates whether software noise suppression is enabled.

This does not provide information about hardware noise suppression.

Returns
true if the software noise suppression is enabled, false if disabled.
int Linphone.Core.NortpOnholdTimeout
getset

Gets the value of the no-rtp timeout when the call is on hold.

When no RTP or RTCP packets have been received for a while when the call is on hold Linphone.Core will consider the call is broken (remote end crashed or disconnected from the network), and thus will terminate the call. The no-rtp timeout is the duration above which the call is considered broken.

Returns
The value of the no-rtp timeout in seconds when the call is on hold
int Linphone.Core.NortpTimeout
getset

Gets the value of the no-rtp timeout.

When no RTP or RTCP packets have been received for a while Linphone.Core will consider the call is broken (remote end crashed or disconnected from the network), and thus will terminate the call. The no-rtp timeout is the duration above which the call is considered broken.

Returns
The value of the no-rtp timeout in seconds
Linphone.AudioDevice Linphone.Core.OutputAudioDevice
getset

Gets the output audio device for the current call.

Returns
The output audio device for the current or first call, null if there is no call.
string Linphone.Core.PlaybackDevice
getset

Gets the name of the currently assigned sound device for playback.

Returns
The name of the currently assigned sound device for playback.

Deprecated : 11/09/2024 use Linphone.Core.OutputAudioDevice or Linphone.Core.DefaultOutputAudioDevice instead.

float Linphone.Core.PlaybackGainDb
getset

Gets playback gain in db (before entering sound card).

Returns
The current playback gain
string Linphone.Core.PlayFile
getset

Get the wav file that is played when files are used instead of soundcards (see Linphone.Core.UseFiles).

The file is a 16 bit linear wav file.

Returns
The path to the file that is played when files are used instead of soundcards.
bool Linphone.Core.PostQuantumAvailable
staticget

Are PostQuantum algoritms available.

Returns
true if Post Quantum algorithms are available false otherwise
float Linphone.Core.PreferredFramerate
getset

Returns the preferred video framerate, previously set by Linphone.Core.PreferredFramerate.

Returns
frame rate in number of frames per seconds.
Linphone.VideoDefinition Linphone.Core.PreferredVideoDefinition
getset

Get the preferred video definition for the stream that is captured and sent to the remote party.

Returns
The preferred Linphone.VideoDefinition
string Linphone.Core.PreferredVideoDefinitionByName
set

Sets the preferred video definition by its name.

Call Linphone.Factory.SupportedVideoDefinitions to have a list of supported video definitions.

Parameters
nameThe name of the definition to set
Linphone.PresenceModel Linphone.Core.PresenceModel
getset

Gets my presence model.

Returns
A Linphone.PresenceModel object, or null if no presence model has been set.
Linphone.VideoDefinition Linphone.Core.PreviewVideoDefinition
getset

Get the definition of the captured video.

Returns
The captured Linphone.VideoDefinition if it was previously set by Linphone.Core.PreviewVideoDefinition, otherwise a 0x0 LinphoneVideoDefinition.

See : Linphone.Core.PreviewVideoDefinition

string Linphone.Core.PreviewVideoDefinitionByName
set

-Set the video definition for the captured (preview) video by its name. Call Linphone.Factory.SupportedVideoDefinitions to have a list of supported video definitions. Video resolution names are: qcif, svga, cif, vga, 4cif, svga ...

Parameters
nameThe name of the definition to set
string Linphone.Core.PrimaryContact
getset

Returns the default identity when no account is used.

This SIP address usually contains a private ip address, and may not be routable globally.

Returns
the primary contact identity
Linphone.Address Linphone.Core.PrimaryContactAddress
get

Same as Linphone.Core.PrimaryContact but the result is a Linphone.Address object instead of a string.

Returns
a Linphone.Address object.
Linphone.Address Linphone.Core.PrimaryContactParsed
get

Same as Linphone.Core.PrimaryContact but the result is a Linphone.Address object instead of const char *.

Returns
a Linphone.Address object.

Deprecated : 22/10/2018 Use Linphone.Core.CreatePrimaryContactParsed() instead.

string Linphone.Core.ProvisioningUri
getset

Get provisioning URI.

Returns
the provisioning URI.
IEnumerable<Linphone.ProxyConfig> Linphone.Core.ProxyConfigList
get

Returns an unmodifiable list of entered proxy configurations.

Returns
A list of Linphone.ProxyConfig. A list of Linphone.ProxyConfig objects.

Deprecated : 04/09/2024 Use Linphone.Core.AccountList

int Linphone.Core.PushIncomingCallTimeout
getset

Returns the push incoming call timeout See Linphone.Core.PushIncomingCallTimeout for details.

Returns
The current push incoming call timeout in seconds
Linphone.PushNotificationConfig Linphone.Core.PushNotificationConfig
get

Gets the push notification configuration object if it exists.

Returns
the Linphone.PushNotificationConfig if it exists, null otherwise.
bool Linphone.Core.PushNotificationEnabled
getset

Gets whether push notifications are enabled or not (Android & iOS only).

If not, the app will have to handle all the push-related settings for each accounts

Returns
true if push notifications are enabled, false otherwise
bool Linphone.Core.QrcodeVideoPreviewEnabled
getset

Tells whether QRCode is enabled in the preview.

Returns
A boolean value telling whether QRCode is enabled in the preview.
int Linphone.Core.QueuedMessageResendPeriod
getset

Gets the queued message resend period.

Returns
the number of second to resend a queued message
bool Linphone.Core.RealtimeTextEnabled
get

Gets if realtime text is enabled or not (RFC4103).

Returns
true if realtime text is enabled, false otherwise
uint Linphone.Core.RealtimeTextKeepaliveInterval
getset

Gets keep alive interval of real time text (RFC4103).

Returns
keep alive interval of real time text.
bool Linphone.Core.RecordAwareEnabled
getset

Gets if the record aware feature is enabled or not.

Returns
true if the record aware feature is enabled, false otherwise.
string Linphone.Core.RecordFile
getset

Get the wav file where incoming stream is recorded, when files are used instead of soundcards (see Linphone.Core.UseFiles).

This feature is different from call recording (Linphone.CallParams.RecordFile) The file is a 16 bit linear wav file.

Returns
The path to the file where incoming stream is recorded.
bool Linphone.Core.RegisterOnlyWhenNetworkIsUp
getset

Gets if accounts will wait for network to be connected before trying to REGISTER or not.

Returns
true if accounts will wait for internet connection before trying to REGISTER, false otherwise.
uint Linphone.Core.RemainingDownloadFileCount
get

Returns how many attachments are yet to be downloaded.

Returns
how many attachments are yet to be downloaded.
uint Linphone.Core.RemainingUploadFileCount
get

Returns how many attachments are yet to be uploaded.

Returns
how many attachments are yet to be uploaded.
IEnumerable<Linphone.RemoteContactDirectory> Linphone.Core.RemoteContactDirectories
get

Gets the list of currently configured LDAP or CardDAV remote servers used by Linphone.MagicSearch.

Returns
the list of Linphone.RemoteContactDirectory currently configured, if any. A list of Linphone.RemoteContactDirectory objects.
string Linphone.Core.RemoteRingbackTone
getset

Get the ring back tone played to far end during incoming calls.

Returns
the path to the remote ring back tone to be played.
bool Linphone.Core.RetransmissionOnNackEnabled
getset

Gets whether the use RTCP NACK for reliability of video transmission is enabled or not.

Using RTCP NACK feedback is one of the available techniques to help mitigate the loss of video RTP packets. It gives good results when round trip time is low. It is disabled by default.

Returns
A boolean value telling whether NACK usage is enabled or not
string Linphone.Core.Ring
getset

Returns the path to the wav file used for ringing.

Returns
The path to the wav file used for ringing.
string Linphone.Core.Ringback
getset

Returns the path to the wav file used for ringing back.

Returns
The path to the wav file used for ringing back.
bool Linphone.Core.RingDuringIncomingEarlyMedia
getset

Tells whether the ring play is enabled during an incoming early media call.

string Linphone.Core.RingerDevice
getset

Gets the name of the currently assigned sound device for ringing.

Returns
The name of the currently assigned sound device for ringing.

Deprecated : 29/08/2025 Use a combination of Linphone.Core.ExtendedAudioDevices and Linphone.AudioDevice.UseForRinging instead.

string Linphone.Core.RootCa
getset

Gets the path to a file or folder containing the trusted root CAs (PEM format)

Returns
The path to a file or folder containing the trusted root CAs.
string Linphone.Core.RootCaData
set

Sets the trusted root CAs (PEM format)

Parameters
dataThe trusted root CAs as a string
bool Linphone.Core.RtpBundleEnabled
getset

Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.

See https://datatracker.ietf.org/doc/html/rfc8843 for more information. See https://datatracker.ietf.org/doc/html/rfc8843 for more information.

Returns
a boolean indicating the enablement of rtp bundle mode.
bool Linphone.Core.Sdp200AckEnabled
getset

Media offer control param for SIP INVITE.

Returns
true if INVITE has to be sent whitout SDP.
bool Linphone.Core.SelfViewEnabled
getset

Tells whether video self view during call is enabled or not.

Returns
A boolean value telling whether self view is enabled

See : Linphone.Core.EnableSelfView() for details.

bool Linphone.Core.SenderNameHiddenInForwardMessageEnabled
set

Enables whether or not to hide sender name in forwarded message.

Parameters
enablewhether or not to enable the feature
bool Linphone.Core.SendMessageAfterNotifyEnabled
getset

Returns enablement of sending chat messages on group chats after receiving the NOTIFY full state.

Returns
true if the core waits for the NOTIFY full statet before sending messages to group chats, false otherwise.
bool Linphone.Core.SessionExpiresEnabled
getset

Check if the Session Timers feature is enabled.

Returns
true if session timers are enabled, false otherwise
int Linphone.Core.SessionExpiresMinValue
getset

Returns the session expires min value, 90 by default.

Returns
The minSE value
Linphone.SessionExpiresRefresher Linphone.Core.SessionExpiresRefresherValue
getset

Returns the session expires refresher value.

Returns
The Linphone.SessionExpiresRefresher configuration refresher value
int Linphone.Core.SessionExpiresValue
getset

Returns the session expires value.

Returns
The session timer expire value
int Linphone.Core.SipDscp
getset

Gets the DSCP field for SIP signaling channel.

The DSCP defines the quality of service in IP packets.

Returns
The current DSCP value
bool Linphone.Core.SipNetworkReachable
set

This method is called by the application to notify the linphone core library when the SIP network is reachable.

This is for advanced usage, when SIP and RTP layers are required to use different interfaces. Most applications just need Linphone.Core.NetworkReachable.

Parameters
reachabletrue if network is reachable, false otherwise
int Linphone.Core.SipTransportTimeout
getset

Gets the SIP transport timeout, which represents the maximum time permitted to establish a connection to a SIP server.

Returns
The SIP transport timeout in milliseconds.
IEnumerable<string> Linphone.Core.SoundDevicesList
get

Gets the list of the available sound devices.

Returns
An unmodifiable array of strings contanining the names of the available sound devices that is null terminated. A list of char * objects.

Deprecated : 10/04/2021 Use Linphone.Core.AudioDevices instead.

string Linphone.Core.SrtpCryptoSuites
getset

Gets the crypto suites available to the core.

Returns
a comma separated list of supported suites
string Linphone.Core.StaticPicture
getset

Get the path to the image file streamed when "Static picture" is set as the video device.

Returns
The path to the image file streamed when "Static picture" is set as the video device.
float Linphone.Core.StaticPictureFps
getset

Get the frame rate for static picture.

Returns
The frame rate used for static picture.
string Linphone.Core.StunServer
getset

Get the STUN server address being used.

Returns
The STUN server address being used.

Deprecated : 04/09/2024 use Linphone.Core.NatPolicy or Linphone.AccountParams.NatPolicy.

IEnumerable<string> Linphone.Core.SupportedFileFormatsList
get

Returns a list of strings containing the file format types supported for call recording.

Returns
The supported formats, typically 'wav', 'mka', 'mkv', 'smff'. A list of char * objects.
string Linphone.Core.SupportedTag
set

Set the SIP supported tags.

Parameters
tagsThe SIP feature tags to set
Linphone.SupportLevel Linphone.Core.Tag100RelSupportLevel
getset

Gets the support level of the 100rel attribute.

Returns
The 100 rel support level
bool Linphone.Core.TcapLineMergingEnabled
set

Defines whether tcap lines are going to be merged if capability negotiation (RFC5939) is supported.

Parameters
mergetrue to merge tcap lines with consecutive indexes; false otherwise.
bool Linphone.Core.TcapLinesMergingEnabled
get

Checks if tcap lines are going to the merged if the capability negotiation (RFC5939) is supported or not.

Returns
true if tcap lines with consecutive indexes are going to be merged; false otherwise.
IEnumerable<Linphone.PayloadType> Linphone.Core.TextPayloadTypes
getset

Returns the list of the available real-time text payload types.

Returns
A freshly allocated list of the available payload types. A list of Linphone.PayloadType objects.
int Linphone.Core.TextPort
getset

Gets the UDP port used for text streaming.

Returns
The UDP port used for text streaming
Linphone.Range Linphone.Core.TextPortsRange
get

Get the text port range from which is randomly chosen the UDP port used for text streaming.

Returns
a Linphone.Range object
string Linphone.Core.TlsCert
getset

Gets the TLS certificate.

Returns
the TLS certificate or null if not set yet.
string Linphone.Core.TlsCertPath
getset

Gets the path to the TLS certificate file.

Returns
the TLS certificate path or null if not set yet.
string Linphone.Core.TlsKey
getset

Gets the TLS key.

Returns
the TLS key or null if not set yet.
string Linphone.Core.TlsKeyPath
getset

Gets the path to the TLS key file.

Returns
the TLS key path or null if not set yet.
Linphone.Transports Linphone.Core.Transports
getset

Retrieves the port configuration used for each transport (udp, tcp, tls).

A zero value port for a given transport means the transport is not used. A value of LC_SIP_TRANSPORT_RANDOM (-1) means the port is to be chosen randomly by the system. A value of LC_SIP_TRANSPORT_DONTBIND (-2) means that the socket will not be bound explicitely, in other words liblinphone won't listen for incoming connections at all. This mode is suitable for a pure client application (ex: a mobile application).

Returns
A Linphone.Transports structure with the configured ports
Linphone.Transports Linphone.Core.TransportsUsed
get

Retrieves the real port number assigned for each sip transport (udp, tcp, tls).

A zero value means that the transport is not activated. If LC_SIP_TRANSPORT_RANDOM was passed to linphone_core_set_sip_transports, the random port choosed by the system is returned.

Returns
A Linphone.Transports structure with the ports being used
Linphone.Tunnel Linphone.Core.Tunnel
get

Gets tunnel instance if available.

Returns
Linphone.Tunnel or null if not available.
int Linphone.Core.UnreadChatMessageCount
get

Returns the global unread chat message count.

Returns
The global unread chat message count.
int Linphone.Core.UnreadChatMessageCountFromActiveLocals
get

Returns the unread chat message count for all active local address.

(Primary contact + proxy configs.)

Returns
The unread chat message count.
int Linphone.Core.UploadBandwidth
getset

Retrieve the maximum available upload bandwidth.

This value was set by Linphone.Core.UploadBandwidth.

Returns
the upload bandiwdth in kbits/s, 0 for unknown.
int Linphone.Core.UploadPtime
getset

Gets audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time.

Returns
the upload packetization time set
string Linphone.Core.UpnpExternalIpaddress
get

Return the external ip address of router.

In some cases the uPnP can have an external ip address but not a usable uPnP (state different of Ok).

Returns
a null terminated string containing the external ip address. If the the external ip address is not available return null.
Linphone.UpnpState Linphone.Core.UpnpState
get

Return the internal state of uPnP.

Returns
an LinphoneUpnpState.
bool Linphone.Core.UseFiles
getset

Gets whether linphone is currently streaming audio from and to files, rather than using the soundcard.

Returns
A boolean value representing whether linphone is streaming audio from and to files or not.
bool Linphone.Core.UseInfoForDtmf
getset

Indicates whether SIP INFO can be used to send digits.

Returns
A boolean value telling whether SIP INFO is used to send digits
string Linphone.Core.UserAgent
get

Gets the user-agent as a string.

Returns
liblinphone's user agent as a string.
string Linphone.Core.UserCertificatesPath
getset

Get the path to the directory storing the user's certificates.

Returns
The path to the directory storing the user's certificates.
bool Linphone.Core.UseRfc2833ForDtmf
getset

Indicates whether RFC2833/RFC4633 can be used to send digits.

Returns
A boolean value telling whether RFC2833 is used to send digits
string Linphone.Core.Version
staticget

Returns liblinphone's version as a string.

Returns
the current version of the Linphone.Core
bool Linphone.Core.VibrationOnIncomingCallEnabled
getset

Gets whether the device will vibrate while an incoming call is ringing (Android only).

Returns
true if the device will vibrate (if possible), false otherwise
Linphone.VideoActivationPolicy Linphone.Core.VideoActivationPolicy
getset

Get the default policy for video.

See Linphone.Core.VideoActivationPolicy for more details.

Returns
The currently used video policy
bool Linphone.Core.VideoAdaptiveJittcompEnabled
getset

Tells whether the video adaptive jitter compensation is enabled.

Returns
true if the video adaptive jitter compensation is enabled, false otherwise.
bool Linphone.Core.VideoCaptureEnabled
getset

Tells whether video capture is enabled.

Returns
true if video capture is enabled, false if disabled.
Linphone.CodecPriorityPolicy Linphone.Core.VideoCodecPriorityPolicy
getset

Gets the current priority policy for video codecs (payload types).

See Linphone.CodecPriorityPolicy for more details.

Returns
the current Linphone.CodecPriorityPolicy
string Linphone.Core.VideoDevice
getset

Returns the name of the currently active video device.

Returns
The name of the currently active video device.
IEnumerable<string> Linphone.Core.VideoDevicesList
get

Gets the list of the available video capture devices.

Returns
An unmodifiable array of strings contanining the names of the available video capture devices that is null terminated. A list of char * objects.
bool Linphone.Core.VideoDisplayEnabled
getset

Tells whether video display is enabled.

Returns
true if video display is enabled, false if disabled.
string Linphone.Core.VideoDisplayFilter
getset

Gets the name of the mediastreamer2 engine (filter) used for rendering video.

Returns
The currently selected video display filter.
int Linphone.Core.VideoDscp
getset

Gets the DSCP field for outgoing video streams.

The DSCP defines the quality of service in IP packets.

Returns
The current DSCP value
bool Linphone.Core.VideoEnabled
get

Returns true if either capture or display is enabled, false otherwise.

same as ( Linphone.Core.VideoCaptureEnabled() | Linphone.Core.VideoDisplayEnabled() )

Returns
true if either capture or display is enabled, false otherwise.
int Linphone.Core.VideoJittcomp
getset

Returns the nominal video jitter buffer size in milliseconds.

Returns
The nominal video jitter buffer size in milliseconds
string Linphone.Core.VideoMulticastAddr
getset

Use to get multicast address to be used for video stream.

Returns
an ipv4/6 multicast address, or default value.
bool Linphone.Core.VideoMulticastEnabled
getset

Use to get multicast state of video stream.

Returns
true if subsequent calls will propose multicast ip set by Linphone.Core.VideoMulticastAddr
int Linphone.Core.VideoMulticastTtl
getset

Use to get multicast ttl to be used for video stream.

Returns
a time to leave value
IEnumerable<Linphone.PayloadType> Linphone.Core.VideoPayloadTypes
getset

Returns the list of the available video payload types (codecs), in their order of preference.

Returns
A freshly allocated list of the available payload types. A list of Linphone.PayloadType objects.
int Linphone.Core.VideoPort
getset

Gets the UDP port used for video streaming.

Returns
The UDP port used for video streaming
Linphone.Range Linphone.Core.VideoPortsRange
get

Get the video port range from which is randomly chosen the UDP port used for video streaming.

Returns
a Linphone.Range object
string Linphone.Core.VideoPreset
getset

Get the video preset used for video calls.

Returns
The name of the video preset used for video calls (can be null if the default video preset is used).
bool Linphone.Core.VideoPreviewEnabled
getset

Tells whether video preview is enabled.

Returns
A boolean value telling whether video preview is enabled
bool Linphone.Core.VideoSourceReuseEnabled
set

Enable or disable video source reuse when switching from preview to actual video call.

This source reuse is useful when you always display the preview, even before calls are initiated. By keeping the video source for the transition to a real video call, you will smooth out the source close/reopen cycle. This function does not have any effect during calls. It just indicates the Linphone.Core to initiate future calls with video source reuse or not. Also, at the end of a video call, the source will be closed whatsoever for now.

Parameters
enabletrue to enable video source reuse. false to disable it for subsequent calls.
bool Linphone.Core.WifiOnlyEnabled
getset

Tells whether Wifi only mode is enabled or not.

Warning : Only works for Android platform.

Returns
A boolean value telling whether Wifi only mode is enabled or not
bool Linphone.Core.ZeroRtpPortForStreamInactiveEnabled
getset

Checks if RTP port is set to 0 when a stream is inactive.

Returns
true if the RTP port is set to 0 if the stream direction is inactive; false otherwise.
IntPtr Linphone.Core.ZrtpCacheDb
get

Get a pointer to the sqlite db holding zrtp/lime cache.

Returns
An sqlite3 pointer cast to a void one or null if cache is not available(not enabled at compile or access failed)
bool Linphone.Core.ZrtpGoClearEnabled
getset

Checks if the ZRTP go clear is enabled or not.

Returns
true if ZTRP go clear is enabled; false otherwise.
string Linphone.Core.ZrtpSecretsFile
getset

Gets the path to the file storing the zrtp secrets cache.

Returns
The path to the file storing the zrtp secrets cache.

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