Class Core
Main object to instanciate and on which to keep a reference.
This object is the first object to instanciante, and will allow you to perform
all kind of tasks. To create it, use either
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class Core : LinphoneObject
Remarks
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.
Properties
AccountCreatorBackend
Set the AccountCreator backend on the Core.
Declaration
public AccountCreatorBackend AccountCreatorBackend { set; }
Property Value
| Type | Description |
|---|---|
| AccountCreatorBackend |
AccountCreatorUrl
Get the AccountCreator url on the Core.
Declaration
public string AccountCreatorUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | url The URL to reach. |
AccountList
Returns an unmodifiable list of entered accounts.
Declaration
public IEnumerable<Account> AccountList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<Account> |
AdaptiveRateAlgorithm
Returns which adaptive rate algorithm is currently configured for future calls.
Declaration
public string AdaptiveRateAlgorithm { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the adaptive rate algorithm. Currently two values are supported: 'advanced', which is the default value, or 'basic'. |
Remarks
See : AdaptiveRateAlgorithm
AdaptiveRateControlEnabled
Returns whether adaptive rate control is enabled.
Declaration
public bool AdaptiveRateControlEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if adaptive rate control is enabled, false otherwise |
Remarks
See :
AudioAdaptiveJittcompEnabled
Tells whether the audio adaptive jitter compensation is enabled.
Declaration
public bool AudioAdaptiveJittcompEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the audio adaptive jitter compensation is enabled, false otherwise. |
AudioDevices
Returns a list of audio devices, with only the first device for each type To have the list of all audio devices, use ExtendedAudioDevices
Declaration
public IEnumerable<AudioDevice> AudioDevices { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<AudioDevice> | A list with the first AudioDevice of each type |
AudioDscp
Get the DSCP field for outgoing audio streams.
The DSCP defines the quality of service in IP packets.
Declaration
public int AudioDscp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current DSCP value |
AudioJittcomp
Returns the nominal audio jitter buffer size in milliseconds.
Declaration
public int AudioJittcomp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The nominal audio jitter buffer size in milliseconds |
AudioMulticastAddr
Use to get multicast address to be used for audio stream.
Declaration
public string AudioMulticastAddr { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | an ipv4/6 multicast address or default value. |
AudioMulticastEnabled
Use to get multicast state of audio stream.
Declaration
public bool AudioMulticastEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if subsequent calls will propose multicast ip set by AudioMulticastAddr |
AudioMulticastTtl
Use to get multicast ttl to be used for audio stream.
Declaration
public int AudioMulticastTtl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | a time to leave value |
AudioPayloadTypes
Return the list of the available audio payload types.
Declaration
public IEnumerable<PayloadType> AudioPayloadTypes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<PayloadType> | A freshly allocated list of the available payload types. The list must be destroyed with bctbx_list_free() after usage. The elements of the list haven't to be unref. |
AudioPort
Gets the UDP port used for audio streaming.
Declaration
public int AudioPort { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The UDP port used for audio streaming |
AudioPortsRange
Get the audio port range from which is randomly chosen the UDP port used for audio streaming.
Declaration
public Range AudioPortsRange { get; }
Property Value
| Type | Description |
|---|---|
| Range | a Range object |
AuthInfoList
Returns an unmodifiable list of currently entered AuthInfo.
Declaration
public IEnumerable<AuthInfo> AuthInfoList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<AuthInfo> | A list of AuthInfo. |
AutoDownloadIcalendarsEnabled
Gets if the auto download for incoming icalendars is enabled or not.
Declaration
public bool AutoDownloadIcalendarsEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if icalendars will be automatically downloaded, false otherwise. |
AutoDownloadVoiceRecordingsEnabled
Gets if the auto download for incoming voice recordings is enabled or not.
Declaration
public bool AutoDownloadVoiceRecordingsEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if voice recordings will be automatically downloaded, false otherwise. |
AutoIterateBackgroundSchedule
Gets the timer used to schedule the call to core.iterate() method when in background (Android only).
This is only used when AutoIterateEnabled returns true.
Declaration
public int AutoIterateBackgroundSchedule { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The timing in milliseconds used to schedule the call while in background (default is 500ms). |
AutoIterateEnabled
Gets whether auto iterate is enabled or not (Android & iOS only).
Declaration
public bool AutoIterateEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if Iterate() is scheduled automatically, false otherwise |
AutoIterateForegroundSchedule
Gets the timer used to schedule the call to core.iterate() method when in foreground (Android only).
This is only used when AutoIterateEnabled returns true.
Declaration
public int AutoIterateForegroundSchedule { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The timing in milliseconds used to schedule the call while in foreground (default is 20ms). |
AutomaticHttpProxyDetectionEnabled
Returns whether automatic http proxy is enabled.
Declaration
public bool AutomaticHttpProxyDetectionEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if automatic http proxy is enabled or false. |
AutoSendRingingEnabled
Gets if the automatic sending of 180 Ringing is enabled or not.
Declaration
public bool AutoSendRingingEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the automatic sending of 180 Ringing is enabled, false otherwise. |
AvpfMode
Return AVPF enablement.
See AvpfMode .
Declaration
public AVPFMode AvpfMode { get; set; }
Property Value
| Type | Description |
|---|---|
| AVPFMode | The current AVPFMode mode |
AvpfRrInterval
Return the avpf report interval in seconds.
Declaration
public int AvpfRrInterval { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current AVPF report interval in seconds |
CallkitEnabled
Special function to check if the callkit is enabled, False by default.
Declaration
public bool CallkitEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if callkit is enabled, false otherwise. |
CallLogs
Get the list of call logs (past calls).
Declaration
public IEnumerable<CallLog> CallLogs { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<CallLog> | A list of CallLog. |
Calls
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 Iterate(). Similarly the Call objects inside it might be destroyed without prior notice. To hold references to Call object into your program, you must use linphone_call_ref.
Declaration
public IEnumerable<Call> Calls { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<Call> | A list of Call |
CallsNb
Get the number of Call.
Declaration
public int CallsNb { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current number of calls |
CallToneIndicationsEnabled
Check whether tone indications of calls are enabled.
Declaration
public bool CallToneIndicationsEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if call tone indications are enabled |
CameraSensorRotation
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.
Declaration
public int CameraSensorRotation { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The camera sensor rotation in degrees (0 to 360) or -1 if it could not be retrieved |
CapabilityNegociationEnabled
Check if the capability negotiation (RFC5939) is supported or not.
Declaration
public bool CapabilityNegociationEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if capability negotiation is supported; false otherwise. |
CapabilityNegotiationReinviteEnabled
Check if the capability negotiation (RFC5939) reINVITE is enabled or not.
Declaration
public bool CapabilityNegotiationReinviteEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if capability negotiation reINVITE is enabled; false otherwise. |
CaptureDevice
Gets the name of the currently assigned sound device for capture.
Declaration
public string CaptureDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The name of the currently assigned sound device for capture. |
CfgLinesMergingEnabled
Check if cfg lines are going to the merged if the capability negotiation (RFC5939) is supported or not.
Declaration
public bool CfgLinesMergingEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if acfg and pcfg lines with consecutive indexes are going to be merged; false otherwise. |
ChatEnabled
Returns whether chat is enabled.
Declaration
public bool ChatEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if chat is enabled, false otherwise |
ChatMessagesAggregationEnabled
Returns whether chat messages grouping is enabled or not.
Declaration
public bool ChatMessagesAggregationEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if received chat messages will be notified as a bundle, false otherwise. |
ChatRooms
Returns a list of chat rooms.
Declaration
public IEnumerable<ChatRoom> ChatRooms { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<ChatRoom> | List of chat rooms. |
Conference
Get a pointer on the internal conference object.
Declaration
public Conference Conference { get; }
Property Value
| Type | Description |
|---|---|
| Conference | A pointer on Conference or null if no conference are going on. |
ConferenceIcsInMessageBodyEnabled
Gets wether conference invitations will be sent in the chat message body or as a file attachment.
Declaration
public bool ConferenceIcsInMessageBodyEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if ICS will be sent in the message body (by default), false if it will be sent as a file attachment. |
ConferenceInformationList
Retrieve the list of conference information on DB.
Declaration
public IEnumerable<ConferenceInfo> ConferenceInformationList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<ConferenceInfo> | The list of conference infos . |
ConferenceLocalInputVolume
Get the set input volume of the local participant.
Declaration
public float ConferenceLocalInputVolume { get; }
Property Value
| Type | Description |
|---|---|
| System.Single | A value inside [0.0 ; 1.0] |
ConferenceParticipantListType
Tells whether the default conference participant list is open or closed.
Declaration
public ConferenceParticipantListType ConferenceParticipantListType { get; set; }
Property Value
| Type | Description |
|---|---|
| ConferenceParticipantListType | A ConferenceParticipantListType participant list type |
ConferenceServerEnabled
Tells whether the conference server feature is enabled.
Declaration
public bool ConferenceServerEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether the conference server feature is enabled or not |
ConferenceSize
Get the number of participants including me, if it in, in the running conference.
The local participant is included in the count only if it is in the conference.
Declaration
public int ConferenceSize { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The number of participants including me, if it in. |
Config
Returns the config object used to manage the storage (config) file.
Declaration
public Config Config { get; }
Property Value
| Type | Description |
|---|---|
| Config | a Config object. |
ConsolidatedPresence
Get my consolidated presence.
Declaration
public ConsolidatedPresence ConsolidatedPresence { get; set; }
Property Value
| Type | Description |
|---|---|
| ConsolidatedPresence | My ConsolidatedPresence presence |
CurrentCall
Gets the current call.
Declaration
public Call CurrentCall { get; }
Property Value
| Type | Description |
|---|---|
| Call | The current call or null if no call is running. |
CurrentCallRemoteAddress
Get the remote address of the current call.
Declaration
public Address CurrentCallRemoteAddress { get; }
Property Value
| Type | Description |
|---|---|
| Address | The remote address of the current call or null if there is no current call. |
CurrentPreviewVideoDefinition
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.
Declaration
public VideoDefinition CurrentPreviewVideoDefinition { get; }
Property Value
| Type | Description |
|---|---|
| VideoDefinition | The captured VideoDefinition. |
Remarks
See : PreviewVideoDefinition
DefaultAccount
Returns the default account, that is the one used to determine the current identity.
Declaration
public Account DefaultAccount { get; set; }
Property Value
| Type | Description |
|---|---|
| Account | The default account. |
DefaultConferenceLayout
Gets the default conference layout core the linphone core.
Declaration
public ConferenceLayout DefaultConferenceLayout { get; set; }
Property Value
| Type | Description |
|---|---|
| ConferenceLayout | conference layout |
DefaultEphemeralLifetime
Gets the default lifetime of ephemeral messages in seconds core the linphone core.
Declaration
public int DefaultEphemeralLifetime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | lifetime of ephemeral messages in seconds |
DefaultFriendList
Retrieves the first list of Friend from the core.
Declaration
public FriendList DefaultFriendList { get; }
Property Value
| Type | Description |
|---|---|
| FriendList | the first FriendList object or null. |
DefaultInputAudioDevice
Gets the default input audio device.
Declaration
public AudioDevice DefaultInputAudioDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| AudioDevice | The default input audio device |
DefaultOutputAudioDevice
Gets the default output audio device.
Declaration
public AudioDevice DefaultOutputAudioDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| AudioDevice | The default output audio device |
DefaultProxyConfig
Returns the default proxy configuration, that is the one used to determine the current identity.
Declaration
public ProxyConfig DefaultProxyConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| ProxyConfig | The default proxy configuration. |
DefaultVideoDisplayFilter
Get 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.
Declaration
public string DefaultVideoDisplayFilter { get; }
Property Value
| Type | Description |
|---|---|
| System.String | The default video display filter. |
DelayedTimeout
Gets the delayed timeout See DelayedTimeout for details.
Declaration
public int DelayedTimeout { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current delayed timeout in seconds |
DeviceRotation
Gets the current device orientation.
Declaration
public int DeviceRotation { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current device orientation |
Remarks
See : DeviceRotation
DigestAuthenticationPolicy
Get the current digest authentication policy applicable for SIP and HTTP.
Get the current digest authentication policy applicable for SIP and HTTP.
Declaration
public DigestAuthenticationPolicy DigestAuthenticationPolicy { get; set; }
Property Value
| Type | Description |
|---|---|
| DigestAuthenticationPolicy | The current digest authentication policy. |
DisableRecordOnMute
Get whether the microphone will be completely deactivated when muted.
Please refer to DisableRecordOnMute.
Declaration
public bool DisableRecordOnMute { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | True if you wish to entirely stop the audio recording when muting the microphone. |
DnsSearchEnabled
Tells whether DNS search (use of local domain if the fully qualified name did return results) is enabled.
Declaration
public bool DnsSearchEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if DNS search is enabled, false if disabled. |
DnsServers
Forces liblinphone to use the supplied list of dns servers, instead of system's ones.
Declaration
public IEnumerable<string> DnsServers { set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> |
DnsServersApp
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.
Declaration
public IEnumerable<string> DnsServersApp { set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> |
DnsSetByApp
Tells if the DNS was set by an application.
Declaration
public bool DnsSetByApp { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if DNS was set by app, false otherwise. |
DnsSrvEnabled
Tells whether DNS SRV resolution is enabled.
Declaration
public bool DnsSrvEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if DNS SRV resolution is enabled, false if disabled. |
DownloadBandwidth
Retrieve the maximum available download bandwidth.
This value was set by DownloadBandwidth.
Declaration
public int DownloadBandwidth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | the download bandiwdth in kbits/s, 0 for infinite |
DownloadPtime
Get audio packetization time linphone expects to receive from peer.
A value of zero means that ptime is not specified.
Declaration
public int DownloadPtime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | the download packetization time set |
EchoCancellationCalibration
Gets the currently stored calibration delay for the software echo cancellation.
Declaration
public int EchoCancellationCalibration { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | 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 StartEchoCancellerCalibration(). |
EchoCancellationEnabled
Returns true if echo cancellation is enabled.
Declaration
public bool EchoCancellationEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether echo cancellation is enabled or disabled |
EchoCancellerFilterName
Get the name of the mediastreamer2 filter used for echo cancelling.
Declaration
public string EchoCancellerFilterName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The name of the mediastreamer2 filter used for echo cancelling. |
EchoLimiterEnabled
Tells whether echo limiter is enabled.
Declaration
public bool EchoLimiterEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the echo limiter is enabled, false otherwise. |
EnableSipUpdate
Enable or disable the UPDATE method support.
Declaration
public int EnableSipUpdate { set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
ExpectedBandwidth
Sets expected available upload bandwidth This is IP bandwidth, in kbit/s.
This information is used by liblinphone together with remote side available bandwidth signaled in SDP messages to properly configure audio & video codec's output bitrate.
Declaration
public int ExpectedBandwidth { set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
ExtendedAudioDevices
Returns the list of all audio devices.
Declaration
public IEnumerable<AudioDevice> ExtendedAudioDevices { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<AudioDevice> | A list of all AudioDevice |
FileTransferServer
Get 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".
Declaration
public string FileTransferServer { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | URL of the file server. |
ForcedIceRelayEnabled
Indicates whether the ICE relay path is forcibly selected.
Declaration
public bool ForcedIceRelayEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | a boolean value indicating whether forced relay is enabled. |
Remarks
See :
FriendListSubscriptionEnabled
Returns whether or not friend lists subscription are enabled.
Declaration
public bool FriendListSubscriptionEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | whether or not the feature is enabled |
FriendsDatabasePath
Gets the database filename where friends will be stored.
Declaration
public string FriendsDatabasePath { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | filesystem path. |
FriendsLists
Retrieves the list of FriendList from the core.
Declaration
public IEnumerable<FriendList> FriendsLists { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<FriendList> | A list of FriendList. |
FutureConferenceInformationList
Retrieve the list of future conference information on DB.
Declaration
public IEnumerable<ConferenceInfo> FutureConferenceInformationList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<ConferenceInfo> | The list of future conference infos . |
GenericComfortNoiseEnabled
Returns enablement of RFC3389 generic comfort noise algorithm.
Declaration
public bool GenericComfortNoiseEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if generic comfort noise is enabled, false otherwise. |
GlobalState
Returns the global state of core.
Declaration
public GlobalState GlobalState { get; }
Property Value
| Type | Description |
|---|---|
| GlobalState | a GlobalState enum. |
GuessHostname
Returns true if hostname part of primary contact is guessed automatically.
Declaration
public bool GuessHostname { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if guess hostname enabled, false otherwise. |
HttpProxyHost
Get http proxy address to be used for signaling.
Declaration
public string HttpProxyHost { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | hostname of IP adress of the http proxy (can be null to disable). |
HttpProxyPort
Get http proxy port to be used for signaling.
Declaration
public int HttpProxyPort { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | port of the http proxy. |
Identity
Gets the default identity SIP address.
This is an helper function. If no default proxy is set, this will return the primary contact ( see PrimaryContact ). If a default proxy is set it returns the registered identity on the proxy.
Declaration
public string Identity { get; }
Property Value
| Type | Description |
|---|---|
| System.String | The default identity SIP address. |
ImNotifPolicy
Get the ImNotifPolicy object controlling the instant messaging notifications.
Declaration
public ImNotifPolicy ImNotifPolicy { get; }
Property Value
| Type | Description |
|---|---|
| ImNotifPolicy | A ImNotifPolicy object. |
InCallTimeout
Gets the in call timeout See InCallTimeout for details.
Declaration
public int InCallTimeout { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current in call timeout in seconds |
IncTimeout
Returns the incoming call timeout See IncTimeout for details.
Declaration
public int IncTimeout { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current incoming call timeout in seconds |
InputAudioDevice
Gets the input audio device for the current call.
Declaration
public AudioDevice InputAudioDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| AudioDevice | The input audio device for the current or first call, null if there is no call. |
Ipv6Enabled
Tells whether IPv6 is enabled or not.
Declaration
public bool Ipv6Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether IPv6 is enabled or not |
Remarks
See :
IsAutoDownloadIcalendarsEnabled
Gets if the auto download for incoming icalendars is enabled or not.
Declaration
public bool IsAutoDownloadIcalendarsEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if icalendars will be automatically downloaded, false otherwise. |
IsAutoDownloadVoiceRecordingsEnabled
Gets if the auto download for incoming voice recordings is enabled or not.
Declaration
public bool IsAutoDownloadVoiceRecordingsEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if voice recordings will be automatically downloaded, false otherwise. |
IsAutoIterateEnabled
Gets whether auto iterate is enabled or not (Android & iOS only).
Declaration
public bool IsAutoIterateEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if Iterate() is scheduled automatically, false otherwise |
IsEchoCancellerCalibrationRequired
Check whether the device is echo canceller calibration is required.
Declaration
public bool IsEchoCancellerCalibrationRequired { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if it is required, false otherwise |
IsFriendListSubscriptionEnabled
Returns whether or not friend lists subscription are enabled.
Declaration
public bool IsFriendListSubscriptionEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | whether or not the feature is enabled |
IsInBackground
Gets whether the Core is considering itself in background or not.
The Core foreground/background state depends on the last call made to EnterBackground() or EnterForeground().
Declaration
public bool IsInBackground { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the Core is in background, false otherwise. |
IsIncomingInvitePending
Tells whether there is an incoming invite pending.
Declaration
public bool IsIncomingInvitePending { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean telling whether an incoming invite is pending or not. |
IsInConference
Indicates whether the local participant is part of a conference.
Declaration
public bool IsInConference { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the local participant is in a conference, false otherwise. |
Remarks
Warning : That function automatically fails in the case of conferences
using a conferencet server (focus). If you use such a conference, you should
use
IsMediaEncryptionMandatory
Check if the configured media encryption is mandatory or not.
Declaration
public bool IsMediaEncryptionMandatory { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if media encryption is mandatory; false otherwise. |
IsNativeRingingEnabled
Returns whether the native ringing is enabled or not.
Declaration
public bool IsNativeRingingEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | True if we use the native ringing, false otherwise |
IsNetworkReachable
return network state either as positioned by the application or by linphone itself.
Declaration
public bool IsNetworkReachable { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if network is reachable, false otherwise |
IsPushNotificationAvailable
Gets whether push notifications are available or not (Android & iOS only).
Declaration
public bool IsPushNotificationAvailable { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if push notifications are available, false otherwise |
IsPushNotificationEnabled
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
Declaration
public bool IsPushNotificationEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if push notifications are enabled, false otherwise |
IsRecordAwareEnabled
Gets if the record aware feature is enabled or not.
Declaration
public bool IsRecordAwareEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the record aware feature is enabled, false otherwise. |
IsSenderNameHiddenInForwardMessage
Returns whether or not sender name is hidden in forward message.
Declaration
public bool IsSenderNameHiddenInForwardMessage { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | whether or not the feature |
IsVerifyServerCertificates
Get whether the tls server certificate must be verified when connecting to a SIP/TLS server.
Declaration
public bool IsVerifyServerCertificates { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | True if the tls server certificate must be verified |
IsVerifyServerCn
Get whether the tls server certificate common name must be verified when connecting to a SIP/TLS server.
Declaration
public bool IsVerifyServerCn { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | True if the tls server certificate common name must be verified |
IsVibrationOnIncomingCallEnabled
Gets whether the device will vibrate while an incoming call is ringing (Android only).
Declaration
public bool IsVibrationOnIncomingCallEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the device will vibrate (if possible), false otherwise |
KeepAliveEnabled
Is signaling keep alive enabled.
Declaration
public bool KeepAliveEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether signaling keep alive is enabled |
LastOutgoingCallLog
Get the latest outgoing call log.
Conference calls are not returned by this function! Requires ENABLE_DB_STORAGE to work.
Declaration
public CallLog LastOutgoingCallLog { get; }
Property Value
| Type | Description |
|---|---|
| CallLog | The last outgoing call log if any. |
LdapList
Returns a list of entered LDAPs.
Items must be freed with linphone_ldap_unref
Declaration
public IEnumerable<Ldap> LdapList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<Ldap> |
LimeX3DhEnabled
Tells wether LIME X3DH is enabled or not.
Declaration
public bool LimeX3DhEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | The current lime state |
LimeX3DhServerUrl
Get the x3dh server url.
Declaration
public string LimeX3DhServerUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The x3dh server url. |
LinphoneSpecsList
Get the list of linphone specs string values representing what functionalities the linphone client supports.
Declaration
public IEnumerable<string> LinphoneSpecsList { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | A list of supported specs. The list must be freed with bctbx_list_free() after usage. |
Listener
Declaration
public CoreListener Listener { get; set; }
Property Value
| Type | Description |
|---|---|
| CoreListener |
LocalPermissionEnabled
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.
Declaration
public bool LocalPermissionEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if local permission request is granted, false otherwise. |
LogCollectionMaxFileSize
Get the max file size in bytes of the files used for log collection.
Declaration
public static long LogCollectionMaxFileSize { get; }
Property Value
| Type | Description |
|---|---|
| System.Int64 | The max file size in bytes of the files used for log collection. |
LogCollectionPath
Get the path where the log files will be written for log collection.
Declaration
public static string LogCollectionPath { get; }
Property Value
| Type | Description |
|---|---|
| System.String | The path where the log files will be written. |
LogCollectionPrefix
Get the prefix of the filenames that will be used for log collection.
Declaration
public static string LogCollectionPrefix { get; }
Property Value
| Type | Description |
|---|---|
| System.String | The prefix of the filenames used for log collection. |
LogCollectionUploadServerUrl
Gets the url of the server where to upload the collected log files.
Declaration
public string LogCollectionUploadServerUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The url of the server where to upload the collected log files. |
MaxCalls
Get 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
Declaration
public int MaxCalls { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | max number of simultaneous calls |
MaxSizeForAutoDownloadIncomingFiles
Gets the size under which incoming files in chat messages will be downloaded automatically.
Declaration
public int MaxSizeForAutoDownloadIncomingFiles { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The size in bytes, -1 if autodownload feature is disabled, 0 to download them all no matter the size |
MediaDevice
Gets the name of the currently assigned sound device for media.
Declaration
public string MediaDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The name of the currently assigned sound device for capture. |
MediaEncryption
Get the media encryption policy being used for RTP packets.
Declaration
public MediaEncryption MediaEncryption { get; set; }
Property Value
| Type | Description |
|---|---|
| MediaEncryption | The MediaEncryption policy being used. |
MediaEncryptionMandatory
Define 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.
Declaration
public bool MediaEncryptionMandatory { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
MediaNetworkReachable
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 NetworkReachable.
Declaration
public bool MediaNetworkReachable { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
MediaResourceMode
This function returns the media resource mode for this core.
Declaration
public MediaResourceMode MediaResourceMode { get; set; }
Property Value
| Type | Description |
|---|---|
| MediaResourceMode | The media resource mode |
MicEnabled
Tells whether the microphone is enabled.
Declaration
public bool MicEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the microphone is enabled, false if disabled. |
MicGainDb
Get microphone gain in db.
Declaration
public float MicGainDb { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | The current microphone gain |
MissedCallsCount
Get the number of missed calls.
Once checked, this counter can be reset with ResetMissedCallsCount().
Declaration
public int MissedCallsCount { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The number of missed calls. |
MsFactory
Declaration
public MediastreamerFactory MsFactory { get; }
Property Value
| Type | Description |
|---|---|
| MediastreamerFactory |
Mtu
Returns the maximum transmission unit size in bytes.
Declaration
public int Mtu { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
NatAddress
Deprecated.
Get the public IP address of NAT being used.
Declaration
public string NatAddress { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The public IP address of NAT being used. |
NativePreviewWindowId
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.
Declaration
public IntPtr NativePreviewWindowId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.IntPtr |
NativePreviewWindowIdString
Declaration
public string NativePreviewWindowIdString { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
NativeRingingEnabled
Returns whether the native ringing is enabled or not.
Declaration
public bool NativeRingingEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | True if we use the native ringing, false otherwise |
NativeVideoWindowId
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.
Declaration
public IntPtr NativeVideoWindowId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.IntPtr |
NativeVideoWindowIdString
Declaration
public string NativeVideoWindowIdString { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
NatPolicy
Get The policy that is used to pass through NATs/firewalls.
It may be overridden by a NAT policy for a specific proxy config.
Declaration
public NatPolicy NatPolicy { get; set; }
Property Value
| Type | Description |
|---|---|
| NatPolicy | NatPolicy object in use. |
Remarks
See : NatPolicy
NetworkReachable
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.
Declaration
public bool NetworkReachable { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
NortpTimeout
Gets the value of the no-rtp timeout.
When no RTP or RTCP packets have been received for a while 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.
Declaration
public int NortpTimeout { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The value of the no-rtp timeout in seconds |
OutputAudioDevice
Gets the output audio device for the current call.
Declaration
public AudioDevice OutputAudioDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| AudioDevice | The output audio device for the current or first call, null if there is no call. |
PlaybackDevice
Gets the name of the currently assigned sound device for playback.
Declaration
public string PlaybackDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The name of the currently assigned sound device for playback. |
PlaybackGainDb
Get playback gain in db before entering sound card.
Declaration
public float PlaybackGainDb { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | The current playback gain |
PlayFile
Get the wav file that is played when putting somebody on hold, or when files are used instead of soundcards (see UseFiles).
The file is a 16 bit linear wav file.
Declaration
public string PlayFile { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to the file that is played when putting somebody on hold. |
PostQuantumAvailable
Are PostQuantum algoritms available.
Declaration
public static bool PostQuantumAvailable { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if Post Quantum algorithms are available false otherwise |
PreferredFramerate
Returns the preferred video framerate, previously set by PreferredFramerate.
Declaration
public float PreferredFramerate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | frame rate in number of frames per seconds. |
PreferredVideoDefinition
Get the preferred video definition for the stream that is captured and sent to the remote party.
Declaration
public VideoDefinition PreferredVideoDefinition { get; set; }
Property Value
| Type | Description |
|---|---|
| VideoDefinition | The preferred VideoDefinition |
PreferredVideoDefinitionByName
Sets the preferred video definition by its name.
Call SupportedVideoDefinitions to have a list of supported video definitions.
Declaration
public string PreferredVideoDefinitionByName { set; }
Property Value
| Type | Description |
|---|---|
| System.String |
PresenceModel
Get my presence model.
Declaration
public PresenceModel PresenceModel { get; set; }
Property Value
| Type | Description |
|---|---|
| PresenceModel | A PresenceModel object, or null if no presence model has been set. |
PreviewVideoDefinition
Get the definition of the captured video.
Declaration
public VideoDefinition PreviewVideoDefinition { get; set; }
Property Value
| Type | Description |
|---|---|
| VideoDefinition | The captured VideoDefinition if it was previously set by PreviewVideoDefinition, otherwise a 0x0 LinphoneVideoDefinition. |
Remarks
See : PreviewVideoDefinition
PreviewVideoDefinitionByName
Declaration
public string PreviewVideoDefinitionByName { set; }
Property Value
| Type | Description |
|---|---|
| System.String |
PrimaryContact
Returns the default identity when no proxy configuration is used.
Declaration
public string PrimaryContact { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the primary contact identity |
PrimaryContactParsed
Same as PrimaryContact but the result is a Address object instead of const char *.
Declaration
public Address PrimaryContactParsed { get; }
Property Value
| Type | Description |
|---|---|
| Address | a Address object. |
ProvisioningUri
Get provisioning URI.
Declaration
public string ProvisioningUri { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the provisioning URI. |
ProxyConfigList
Returns an unmodifiable list of entered proxy configurations.
Declaration
public IEnumerable<ProxyConfig> ProxyConfigList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<ProxyConfig> | A list of ProxyConfig. |
PushIncomingCallTimeout
Returns the push incoming call timeout See PushIncomingCallTimeout for details.
Declaration
public int PushIncomingCallTimeout { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current push incoming call timeout in seconds |
PushNotificationConfig
Gets the push notification configuration object if it exists.
Declaration
public PushNotificationConfig PushNotificationConfig { get; }
Property Value
| Type | Description |
|---|---|
| PushNotificationConfig | the PushNotificationConfig if it exists, null otherwise. |
PushNotificationEnabled
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
Declaration
public bool PushNotificationEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if push notifications are enabled, false otherwise |
QrcodeVideoPreviewEnabled
Tells whether QRCode is enabled in the preview.
Declaration
public bool QrcodeVideoPreviewEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether QRCode is enabled in the preview. |
RealtimeTextEnabled
Gets if realtime text is enabled or not.
Declaration
public bool RealtimeTextEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if realtime text is enabled, false otherwise |
RecordAwareEnabled
Gets if the record aware feature is enabled or not.
Declaration
public bool RecordAwareEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the record aware feature is enabled, false otherwise. |
RecordFile
Get the wav file where incoming stream is recorded, when files are used instead of soundcards (see UseFiles).
This feature is different from call recording (RecordFile) The file is a 16 bit linear wav file.
Declaration
public string RecordFile { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to the file where incoming stream is recorded. |
RemoteRingbackTone
Get the ring back tone played to far end during incoming calls.
Declaration
public string RemoteRingbackTone { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the path to the remote ring back tone to be played. |
RetransmissionOnNackEnabled
Tells whether NACK context is enabled or not.
Declaration
public bool RetransmissionOnNackEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether NACK context is enabled or not |
Ring
Returns the path to the wav file used for ringing.
Declaration
public string Ring { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to the wav file used for ringing. |
Ringback
Returns the path to the wav file used for ringing back.
Declaration
public string Ringback { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to the wav file used for ringing back. |
RingDuringIncomingEarlyMedia
Tells whether the ring play is enabled during an incoming early media call.
Declaration
public bool RingDuringIncomingEarlyMedia { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
RingerDevice
Gets the name of the currently assigned sound device for ringing.
Declaration
public string RingerDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The name of the currently assigned sound device for ringing. |
RootCa
Gets the path to a file or folder containing the trusted root CAs (PEM format)
Declaration
public string RootCa { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to a file or folder containing the trusted root CAs. |
RootCaData
Sets the trusted root CAs (PEM format)
Declaration
public string RootCaData { set; }
Property Value
| Type | Description |
|---|---|
| System.String |
RtpBundleEnabled
Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.
See https://datatracker.ietf.org/doc/html/rfc8843 for more information.
Declaration
public bool RtpBundleEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | a boolean indicating the enablement of rtp bundle mode. |
Sdp200AckEnabled
Media offer control param for SIP INVITE.
Declaration
public bool Sdp200AckEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if INVITE has to be sent whitout SDP. |
SelfViewEnabled
Tells whether video self view during call is enabled or not.
Declaration
public bool SelfViewEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether self view is enabled |
Remarks
See :
SenderNameHiddenInForwardMessageEnabled
Enable whether or not to hide sender name in forward message.
Declaration
public bool SenderNameHiddenInForwardMessageEnabled { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
SessionExpiresEnabled
Check if the Session Timers feature is enabled.
Declaration
public bool SessionExpiresEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
SessionExpiresMinValue
Returns the session expires min value, 90 by default.
Declaration
public int SessionExpiresMinValue { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
SessionExpiresRefresherValue
Returns the session expires refresher value.
Declaration
public SessionExpiresRefresher SessionExpiresRefresherValue { get; set; }
Property Value
| Type | Description |
|---|---|
| SessionExpiresRefresher |
SessionExpiresValue
Returns the session expires value.
Declaration
public int SessionExpiresValue { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
SipDscp
Get the DSCP field for SIP signaling channel.
The DSCP defines the quality of service in IP packets.
Declaration
public int SipDscp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current DSCP value |
SipNetworkReachable
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 NetworkReachable.
Declaration
public bool SipNetworkReachable { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
SipTransportTimeout
Get the SIP transport timeout.
Declaration
public int SipTransportTimeout { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The SIP transport timeout in milliseconds. |
SoundDevicesList
Gets the list of the available sound devices.
Declaration
public IEnumerable<string> SoundDevicesList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | An unmodifiable array of strings contanining the names of the available sound devices that is null terminated. |
SrtpCryptoSuites
Get the crypto suites available to the core.
Declaration
public string SrtpCryptoSuites { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | a comma separated list of supported suites |
StaticPicture
Get the path to the image file streamed when "Static picture" is set as the video device.
Declaration
public string StaticPicture { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to the image file streamed when "Static picture" is set as the video device. |
StaticPictureFps
Get the frame rate for static picture.
Declaration
public float StaticPictureFps { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | The frame rate used for static picture. |
StunServer
Get the STUN server address being used.
Declaration
public string StunServer { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The STUN server address being used. |
SupportedFileFormatsList
Returns a null terminated table of strings containing the file format extension supported for call recording.
Declaration
public IEnumerable<string> SupportedFileFormatsList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | The supported formats, typically 'wav' and 'mkv'. |
SupportedTag
Set the supported tags.
Declaration
public string SupportedTag { set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Tag100RelSupportLevel
Get the support level of the 100rel attribute.
Declaration
public SupportLevel Tag100RelSupportLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| SupportLevel | The 100 rel support level |
TcapLineMergingEnabled
Define whether tcap lines are going to be merged if capability negotiation (RFC5939) is supported.
Declaration
public bool TcapLineMergingEnabled { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TcapLinesMergingEnabled
Check if tcap lines are going to the merged if the capability negotiation (RFC5939) is supported or not.
Declaration
public bool TcapLinesMergingEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if tcap lines with consecutive indexes are going to be merged; false otherwise. |
TextPayloadTypes
Return the list of the available text payload types.
Declaration
public IEnumerable<PayloadType> TextPayloadTypes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<PayloadType> | A freshly allocated list of the available payload types. The list must be destroyed with bctbx_list_free() after usage. The elements of the list haven't to be unref. |
TextPort
Gets the UDP port used for text streaming.
Declaration
public int TextPort { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The UDP port used for text streaming |
TextPortsRange
Get the text port range from which is randomly chosen the UDP port used for text streaming.
Declaration
public Range TextPortsRange { get; }
Property Value
| Type | Description |
|---|---|
| Range | a Range object |
TlsCert
Gets the TLS certificate.
Declaration
public string TlsCert { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the TLS certificate or null if not set yet. |
TlsCertPath
Gets the path to the TLS certificate file.
Declaration
public string TlsCertPath { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the TLS certificate path or null if not set yet. |
TlsKey
Gets the TLS key.
Declaration
public string TlsKey { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the TLS key or null if not set yet. |
TlsKeyPath
Gets the path to the TLS key file.
Declaration
public string TlsKeyPath { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the TLS key path or null if not set yet. |
Transports
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).
Declaration
public Transports Transports { get; set; }
Property Value
| Type | Description |
|---|---|
| Transports | A Transports structure with the configured ports |
TransportsUsed
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.
Declaration
public Transports TransportsUsed { get; }
Property Value
| Type | Description |
|---|---|
| Transports | A Transports structure with the ports being used |
Tunnel
get tunnel instance if available
Declaration
public Tunnel Tunnel { get; }
Property Value
| Type | Description |
|---|---|
| Tunnel | Tunnel or null if not available. |
UnreadChatMessageCount
Return the global unread chat message count.
Declaration
public int UnreadChatMessageCount { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The global unread chat message count. |
UnreadChatMessageCountFromActiveLocals
Return the unread chat message count for all active local address.
(Primary contact + proxy configs.)
Declaration
public int UnreadChatMessageCountFromActiveLocals { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The unread chat message count. |
UploadBandwidth
Retrieve the maximum available upload bandwidth.
This value was set by UploadBandwidth.
Declaration
public int UploadBandwidth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | the upload bandiwdth in kbits/s, 0 for infinite |
UploadPtime
Set audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time.
Declaration
public int UploadPtime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | the upload packetization time set |
UpnpExternalIpaddress
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).
Declaration
public string UpnpExternalIpaddress { get; }
Property Value
| Type | Description |
|---|---|
| System.String | a null terminated string containing the external ip address. If the the external ip address is not available return null. |
UpnpState
Return the internal state of uPnP.
Declaration
public UpnpState UpnpState { get; }
Property Value
| Type | Description |
|---|---|
| UpnpState | an LinphoneUpnpState. |
UseFiles
Gets whether linphone is currently streaming audio from and to files, rather than using the soundcard.
Declaration
public bool UseFiles { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value representing whether linphone is streaming audio from and to files or not. |
UseInfoForDtmf
Indicates whether SIP INFO is used to send digits.
Declaration
public bool UseInfoForDtmf { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether SIP INFO is used to send digits |
UserAgent
Gets the user-agent as a string.
Declaration
public string UserAgent { get; }
Property Value
| Type | Description |
|---|---|
| System.String | liblinphone's user agent as a string. |
UserCertificatesPath
Get the path to the directory storing the user's certificates.
Declaration
public string UserCertificatesPath { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to the directory storing the user's certificates. |
UseRfc2833ForDtmf
Indicates whether RFC2833 is used to send digits.
Declaration
public bool UseRfc2833ForDtmf { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether RFC2833 is used to send digits |
Version
Returns liblinphone's version as a string.
Declaration
public static string Version { get; }
Property Value
| Type | Description |
|---|---|
| System.String | the current version of the Core |
VibrationOnIncomingCallEnabled
Gets whether the device will vibrate while an incoming call is ringing (Android only).
Declaration
public bool VibrationOnIncomingCallEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the device will vibrate (if possible), false otherwise |
VideoActivationPolicy
Get the default policy for video.
See VideoActivationPolicy for more details.
Declaration
public VideoActivationPolicy VideoActivationPolicy { get; set; }
Property Value
| Type | Description |
|---|---|
| VideoActivationPolicy | The video policy being used |
VideoAdaptiveJittcompEnabled
Tells whether the video adaptive jitter compensation is enabled.
Declaration
public bool VideoAdaptiveJittcompEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the video adaptive jitter compensation is enabled, false otherwise. |
VideoCaptureEnabled
Tells whether video capture is enabled.
Declaration
public bool VideoCaptureEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if video capture is enabled, false if disabled. |
VideoDevice
Returns the name of the currently active video device.
Declaration
public string VideoDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The name of the currently active video device. |
VideoDevicesList
Gets the list of the available video capture devices.
Declaration
public IEnumerable<string> VideoDevicesList { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | An unmodifiable array of strings contanining the names of the available video capture devices that is null terminated. |
VideoDisplayEnabled
Tells whether video display is enabled.
Declaration
public bool VideoDisplayEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if video display is enabled, false if disabled. |
VideoDisplayFilter
Get the name of the mediastreamer2 filter used for rendering video.
Declaration
public string VideoDisplayFilter { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The currently selected video display filter. |
VideoDscp
Get the DSCP field for outgoing video streams.
The DSCP defines the quality of service in IP packets.
Declaration
public int VideoDscp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The current DSCP value |
VideoEnabled
Returns true if either capture or display is enabled, false otherwise.
same as ( VideoCaptureEnabled | VideoDisplayEnabled )
Declaration
public bool VideoEnabled { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if either capture or display is enabled, false otherwise. |
VideoJittcomp
Returns the nominal video jitter buffer size in milliseconds.
Declaration
public int VideoJittcomp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The nominal video jitter buffer size in milliseconds |
VideoMulticastAddr
Use to get multicast address to be used for video stream.
Declaration
public string VideoMulticastAddr { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | an ipv4/6 multicast address, or default value. |
VideoMulticastEnabled
Use to get multicast state of video stream.
Declaration
public bool VideoMulticastEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if subsequent calls will propose multicast ip set by VideoMulticastAddr |
VideoMulticastTtl
Use to get multicast ttl to be used for video stream.
Declaration
public int VideoMulticastTtl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | a time to leave value |
VideoPayloadTypes
Return the list of the available video payload types.
Declaration
public IEnumerable<PayloadType> VideoPayloadTypes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<PayloadType> | A freshly allocated list of the available payload types. The list must be destroyed with bctbx_list_free() after usage. The elements of the list haven't to be unref. |
VideoPort
Gets the UDP port used for video streaming.
Declaration
public int VideoPort { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The UDP port used for video streaming |
VideoPortsRange
Get the video port range from which is randomly chosen the UDP port used for video streaming.
Declaration
public Range VideoPortsRange { get; }
Property Value
| Type | Description |
|---|---|
| Range | a Range object |
VideoPreset
Get the video preset used for video calls.
Declaration
public string VideoPreset { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The name of the video preset used for video calls (can be null if the default video preset is used). |
VideoPreviewEnabled
Tells whether video preview is enabled.
Declaration
public bool VideoPreviewEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether video preview is enabled |
VideoSourceReuseEnabled
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 durfing calls. It just indicates the 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.
Declaration
public bool VideoSourceReuseEnabled { set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
WifiOnlyEnabled
Tells whether Wifi only mode is enabled or not.
Declaration
public bool WifiOnlyEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether Wifi only mode is enabled or not |
Remarks
Warning : Only works for Android platform.
ZeroRtpPortForStreamInactiveEnabled
Check if RTP port is set to 0 when a stream is inactive.
Declaration
public bool ZeroRtpPortForStreamInactiveEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the RTP port is set to 0 if the stream direction is inactive; false otherwise. |
ZrtpCacheDb
Get a pointer to the sqlite db holding zrtp/lime cache.
Declaration
public IntPtr ZrtpCacheDb { get; }
Property Value
| Type | Description |
|---|---|
| System.IntPtr | An sqlite3 pointer cast to a void one or null if cache is not available(not enabled at compile or access failed) |
ZrtpGoClearEnabled
Check if the ZRTP go clear is enabled or not.
Declaration
public bool ZrtpGoClearEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if ZTRP go clear is enabled; false otherwise. |
ZrtpSecretsFile
Get the path to the file storing the zrtp secrets cache.
Declaration
public string ZrtpSecretsFile { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The path to the file storing the zrtp secrets cache. |
Methods
ActivateAudioSession(Boolean)
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.
Declaration
public void ActivateAudioSession(bool actived)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | actived |
AddAccount(Account)
Add an account.
This will start registration on the proxy, if registration is enabled.
Declaration
public void AddAccount(Account account)
Parameters
| Type | Name | Description |
|---|---|---|
| Account | account | the Account to add |
AddAllToConference()
Add all current calls into the conference.
If no conference is running a new internal conference context is created and all current calls are added to it.
Declaration
public void AddAllToConference()
Remarks
Warning : This function guarantees that the local endpoint is added to the conference.
AddAuthInfo(AuthInfo)
Adds authentication information to the Core.
That piece of information will be used during all SIP transactions that require authentication.
Declaration
public void AddAuthInfo(AuthInfo info)
Parameters
| Type | Name | Description |
|---|---|---|
| AuthInfo | info | The AuthInfo to add. |
AddContentTypeSupport(String)
Add support for the specified content type.
It is the application responsibility to handle it correctly afterwards.
Declaration
public void AddContentTypeSupport(string contentType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | contentType | The content type to add support for |
AddFriendList(FriendList)
Add a friend list.
Declaration
public void AddFriendList(FriendList list)
Parameters
| Type | Name | Description |
|---|---|---|
| FriendList | list | FriendList object |
AddLdap(Ldap)
Add or update a LDAP server and save it to the configuration.
Declaration
public void AddLdap(Ldap ldap)
Parameters
| Type | Name | Description |
|---|---|---|
| Ldap | ldap | The LDAP to add/update. |
AddLinphoneSpec(String)
Add the given linphone specs to the list of functionalities the linphone client supports.
Declaration
public void AddLinphoneSpec(string spec)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | spec | The spec to add |
AddProvisioningHeader(String, String)
Add an extra header for retrieving the remote provisioning (check 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.
Declaration
public void AddProvisioningHeader(string headerName, string val)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | headerName | the header to use when downloading the configuration. |
| System.String | val | the value to use when downloading the configuration. |
AddProxyConfig(ProxyConfig)
Add a proxy configuration.
This will start registration on the proxy, if registration is enabled.
Declaration
public void AddProxyConfig(ProxyConfig config)
Parameters
| Type | Name | Description |
|---|---|---|
| ProxyConfig | config | the ProxyConfig to add |
AddSupportedTag(String)
This function controls signaling features supported by the core.
They are typically included in a SIP Supported header.
Declaration
public void AddSupportedTag(string tag)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | tag | The feature tag name |
AddToConference(Call)
Add 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.
Declaration
public void AddToConference(Call call)
Parameters
| Type | Name | Description |
|---|---|---|
| Call | call | The current call with the participant to add |
AudioRouteChanged()
Special function to indicate if the audio route is changed.
Must be called in the callback of AVAudioSessionRouteChangeNotification.
Declaration
public void AudioRouteChanged()
ChatRoomGetDefaultEphemeralMode()
Gets the default ephemeral message mode core the linphone core.
Declaration
public ChatRoomEphemeralMode ChatRoomGetDefaultEphemeralMode()
Returns
| Type | Description |
|---|---|
| ChatRoomEphemeralMode | the default ephemeral message mode ChatRoomEphemeralMode |
ChatRoomSetDefaultEphemeralMode(ChatRoomEphemeralMode)
Sets the default ephemeral message mode.
Declaration
public void ChatRoomSetDefaultEphemeralMode(ChatRoomEphemeralMode mode)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatRoomEphemeralMode | mode | default ephemeral message mode ChatRoomEphemeralMode |
CheckForUpdate(String)
Checks if a new version of the application is available.
Declaration
public void CheckForUpdate(string currentVersion)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | currentVersion | The current version of the application |
ClearAccounts()
Erase all account from config.
Declaration
public void ClearAccounts()
ClearAllAuthInfo()
Clear all authentication information.
Declaration
public void ClearAllAuthInfo()
ClearCallLogs()
Erase the call log.
Declaration
public void ClearCallLogs()
ClearLdaps()
Erase all LDAP from the configuration.
Declaration
public void ClearLdaps()
ClearProvisioningHeaders()
Clear all headers that were added with
Declaration
public void ClearProvisioningHeaders()
ClearProxyConfig()
Erase all proxies from config.
Declaration
public void ClearProxyConfig()
CompressLogCollection()
Compress the log collection in a single file.
Declaration
public static string CompressLogCollection()
Returns
| Type | Description |
|---|---|
| System.String | The path of the compressed log collection file (to be freed calling ms_free()). |
ConfigSync()
Writes the config file to disk.
Declaration
public void ConfigSync()
ConfigureAudioSession()
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.
Declaration
public void ConfigureAudioSession()
CreateAccount(AccountParams)
Create an account using given parameters, see CreateAccountParams().
Declaration
public Account CreateAccount(AccountParams parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| AccountParams | parameters | AccountParams object |
Returns
| Type | Description |
|---|---|
| Account | Account with default values set |
CreateAccountCreator(String)
Create a AccountCreator and set Linphone Request callbacks.
Declaration
public AccountCreator CreateAccountCreator(string xmlrpcUrl)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | xmlrpcUrl | The URL to the XML-RPC server. |
Returns
| Type | Description |
|---|---|
| AccountCreator | The new AccountCreator object. |
CreateAccountParams()
Create an account params using default values from Linphone core.
Declaration
public AccountParams CreateAccountParams()
Returns
| Type | Description |
|---|---|
| AccountParams | AccountParams with default values set |
CreateAddress(String)
Create a Address object by parsing the user supplied address, given as a string.
Declaration
public Address CreateAddress(string address)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | address | String containing the user supplied address |
Returns
| Type | Description |
|---|---|
| Address | The create Address object |
CreateCallLog(Address, Address, CallDir, Int32, Int64, Int64, CallStatus, Boolean, Single)
Creates a fake CallLog.
Declaration
public CallLog CreateCallLog(Address from, Address to, CallDir dir, int duration, long startTime, long connectedTime, CallStatus status, bool videoEnabled, float quality)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | from | Address of caller |
| Address | to | Address of callee |
| CallDir | dir | CallDir of call |
| System.Int32 | duration | call length in seconds |
| System.Int64 | startTime | timestamp of call start time |
| System.Int64 | connectedTime | timestamp of call connection |
| CallStatus | status | CallStatus of call |
| System.Boolean | videoEnabled | whether video was enabled or not for this call |
| System.Single | quality | call quality |
Returns
| Type | Description |
|---|---|
| CallLog | a CallLog object |
CreateCallParams(Call)
Create a CallParams suitable for
The parameters are initialized according to the current Core configuration and the last used local CallParams, the ones passed through
Declaration
public CallParams CreateCallParams(Call call)
Parameters
| Type | Name | Description |
|---|---|---|
| Call | call | Call for which the parameters are to be build, or null in the case where the parameters are to be used for a new outgoing call. |
Returns
| Type | Description |
|---|---|
| CallParams | A new CallParams object. |
CreateChatRoom(Address)
Declaration
public ChatRoom CreateChatRoom(Address participant)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | participant | Address representing the initial participant to add to the chat room |
Returns
| Type | Description |
|---|---|
| ChatRoom | The newly created chat room. |
CreateChatRoom(ChatRoomParams, Address, Address)
Declaration
public ChatRoom CreateChatRoom(ChatRoomParams parameters, Address localAddr, Address participant)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatRoomParams | parameters | The chat room creation parameters ChatRoomParams |
| Address | localAddr | Address representing the local proxy configuration to use for the chat room creation |
| Address | participant | Address representing the initial participant to add to the chat room |
Returns
| Type | Description |
|---|---|
| ChatRoom | The newly created chat room. |
CreateChatRoom(ChatRoomParams, Address, IEnumerable<Address>)
Create a chat room.
Declaration
public ChatRoom CreateChatRoom(ChatRoomParams parameters, Address localAddr, IEnumerable<Address> participants)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatRoomParams | parameters | The chat room creation parameters ChatRoomParams |
| Address | localAddr | Address representing the local proxy configuration to use for the chat room creation or null |
| System.Collections.Generic.IEnumerable<Address> | participants | The initial list of participants of the chat room. |
Returns
| Type | Description |
|---|---|
| ChatRoom | The newly created chat room (can be an existing one if backend is Basic) or null. |
CreateChatRoom(ChatRoomParams, Address, String, IEnumerable<Address>)
Create a chat room.
Declaration
public ChatRoom CreateChatRoom(ChatRoomParams parameters, Address localAddr, string subject, IEnumerable<Address> participants)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatRoomParams | parameters | The chat room creation parameters ChatRoomParams |
| Address | localAddr | Address representing the local proxy configuration to use for the chat room creation |
| System.String | subject | The subject of the group chat room |
| System.Collections.Generic.IEnumerable<Address> | participants | The initial list of participants of the chat room |
Returns
| Type | Description |
|---|---|
| ChatRoom | The newly created chat room. |
CreateChatRoom(ChatRoomParams, String, IEnumerable<Address>)
Create a chat room.
Declaration
public ChatRoom CreateChatRoom(ChatRoomParams parameters, string subject, IEnumerable<Address> participants)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatRoomParams | parameters | The chat room creation parameters ChatRoomParams |
| System.String | subject | |
| System.Collections.Generic.IEnumerable<Address> | participants | The initial list of participants of the chat room. |
Returns
| Type | Description |
|---|---|
| ChatRoom | The newly created chat room. |
CreateChatRoom(String, IEnumerable<Address>)
Declaration
public ChatRoom CreateChatRoom(string subject, IEnumerable<Address> participants)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subject | The subject of the group chat room |
| System.Collections.Generic.IEnumerable<Address> | participants | The initial list of participants of the chat room. |
Returns
| Type | Description |
|---|---|
| ChatRoom | The newly created chat room. |
CreateClientGroupChatRoom(String, Boolean)
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
Declaration
public ChatRoom CreateClientGroupChatRoom(string subject, bool fallback)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subject | The subject of the group chat room |
| System.Boolean | fallback | Boolean 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
| Type | Description |
|---|---|
| ChatRoom | The newly created client-side group chat room. |
CreateClientGroupChatRoom(String, Boolean, Boolean)
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
Declaration
public ChatRoom CreateClientGroupChatRoom(string subject, bool fallback, bool encrypted)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subject | The subject of the group chat room |
| System.Boolean | fallback | Boolean 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 |
| System.Boolean | encrypted | Boolean value telling whether we should apply encryption or not on chat messages sent and received on this room. |
Returns
| Type | Description |
|---|---|
| ChatRoom | The newly created client-side group chat room. |
CreateConferenceParams(Conference)
Create some default conference parameters for instanciating a conference with
Declaration
public ConferenceParams CreateConferenceParams(Conference conference)
Parameters
| Type | Name | Description |
|---|---|---|
| Conference | conference | 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
| Type | Description |
|---|---|
| ConferenceParams | a ConferenceParams object. |
CreateConferenceScheduler()
Create a conference scheduler that can be used to create remote conferences for now or later and then send conference info as an ICS through chat.
Declaration
public ConferenceScheduler CreateConferenceScheduler()
Returns
| Type | Description |
|---|---|
| ConferenceScheduler | A pointer on the freshly created ConferenceScheduler. |
CreateConferenceWithParams(ConferenceParams)
Create a conference.
Local or remote conference is determinated from the 'conference_type' variable in the 'misc' section of the configuration, or by the factory address parameter. See ConferenceFactoryAddress for more details.
Declaration
public Conference CreateConferenceWithParams(ConferenceParams parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| ConferenceParams | parameters | Parameters of the conference. See ConferenceParams. |
Returns
| Type | Description |
|---|---|
| Conference | A pointer on the freshly created conference Conference. That object will be automatically freed by the core after calling TerminateConference(). |
CreateConfig(String)
Create a Config object from a user config file.
Declaration
public Config CreateConfig(string filename)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filename | The filename of the config file to read to fill the instantiated Config |
Returns
| Type | Description |
|---|---|
| Config | a Config object. |
CreateContent()
Create a content with default values from Linphone core.
Declaration
public Content CreateContent()
Returns
| Type | Description |
|---|---|
| Content | Content object with default values set |
CreateDefaultChatRoomParams()
Creates and returns the default chat room parameters.
Declaration
public ChatRoomParams CreateDefaultChatRoomParams()
Returns
| Type | Description |
|---|---|
| ChatRoomParams | A ChatRoomParams object |
CreateFriend()
Create a default LinphoneFriend.
Declaration
public Friend CreateFriend()
Returns
| Type | Description |
|---|---|
| Friend | The created Friend object |
CreateFriendList()
Create a new empty FriendList object.
Declaration
public FriendList CreateFriendList()
Returns
| Type | Description |
|---|---|
| FriendList | A new FriendList object. |
CreateFriendWithAddress(String)
Create a Friend from the given address.
Declaration
public Friend CreateFriendWithAddress(string address)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | address | A string containing the address to create the Friend from |
Returns
| Type | Description |
|---|---|
| Friend | The created Friend object. |
CreateInfoMessage()
Creates an empty info message.
Declaration
public InfoMessage CreateInfoMessage()
Returns
| Type | Description |
|---|---|
| InfoMessage | a new LinphoneInfoMessage. |
CreateLdap()
Create an empty LDAP search.
Params must be call to save the parameters in the configuration file.
Declaration
public Ldap CreateLdap()
Returns
| Type | Description |
|---|---|
| Ldap | Ldap with default values set |
CreateLdapParams()
Create a LDAP params using default values from Linphone core.
Check #linphone_ldap_params to update values. In order to add a new LDAP configuration to Magic search, these parameters must be passed to linphone_core_create_ldap_with_params. Or, use Params. The newly created LDAP from CreateLdap().
Declaration
public LdapParams CreateLdapParams()
Returns
| Type | Description |
|---|---|
| LdapParams | LdapParams with default values set. |
CreateLdapWithParams(LdapParams)
Create a LDAP search using given parameters and store them in the configuration file.
Declaration
public Ldap CreateLdapWithParams(LdapParams parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| LdapParams | parameters | LdapParams object |
Returns
| Type | Description |
|---|---|
| Ldap | Ldap with default values set |
CreateLocalPlayer(String, String, IntPtr)
Create an independent media file player.
This player support WAVE and MATROSKA formats.
Declaration
public Player CreateLocalPlayer(string soundCardName, string videoDisplayName, IntPtr windowId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | soundCardName | Playback sound card. If null, the ringer sound card set in Core will be used |
| System.String | videoDisplayName | Video display. If null, the video display set in Core will be used |
| System.IntPtr | windowId | Id of the drawing window. Depend of video out |
Returns
| Type | Description |
|---|---|
| Player | A pointer on the new instance. null if failed. |
CreateMagicSearch()
Create a MagicSearch object.
Declaration
public MagicSearch CreateMagicSearch()
Returns
| Type | Description |
|---|---|
| MagicSearch | The created MagicSearch object |
CreateNativePreviewWindowId()
Create a native window handle for the video preview window.
see linphone_core_set_native_video_window_id for details about window_id MSQOgl can be used for the creation. CreateNativePreviewWindowId() returns a #QQuickFramebufferObject::Renderer. This object must be returned by your QQuickFramebufferObject::createRenderer() overload for Qt. linphone_core_set_native_preview_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.
Declaration
public IntPtr CreateNativePreviewWindowId()
Returns
| Type | Description |
|---|---|
| System.IntPtr | The native window handle of the video preview window. |
CreateNativeVideoWindowId()
Create a native window handle for the video window.
see linphone_core_set_native_video_window_id for details about window_id MSQOgl can be used for the creation. 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.
Declaration
public IntPtr CreateNativeVideoWindowId()
Returns
| Type | Description |
|---|---|
| System.IntPtr | The native window handle of the video window. |
CreateNatPolicy()
Create a new NatPolicy object with every policies being disabled.
Declaration
public NatPolicy CreateNatPolicy()
Returns
| Type | Description |
|---|---|
| NatPolicy | A new NatPolicy object. |
CreateNotify(Address, String)
Create an out-of-dialog notification, specifying the destination resource, the event name.
The notification can be send with
Declaration
public Event CreateNotify(Address resource, string ev)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | resource | the destination resource |
| System.String | ev | the event name |
Returns
| Type | Description |
|---|---|
| Event | a Event holding the context of the notification. |
CreateOneShotPublish(Address, String)
Create a publish context for a one-shot publish.
After being created, the publish must be sent using
Declaration
public Event CreateOneShotPublish(Address resource, string ev)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | resource | the resource uri for the event |
| System.String | ev | the event name |
Returns
| Type | Description |
|---|---|
| Event | the Event holding the context of the publish. |
CreatePresenceActivity(PresenceActivityType, String)
Create a PresenceActivity with the given type and description.
Declaration
public PresenceActivity CreatePresenceActivity(PresenceActivityType acttype, string description)
Parameters
| Type | Name | Description |
|---|---|---|
| PresenceActivityType | acttype | The PresenceActivityType to set for the activity. |
| System.String | description | An additional description of the activity to set for the activity. Can be null if no additional description is to be added. |
Returns
| Type | Description |
|---|---|
| PresenceActivity | The created PresenceActivity object. |
CreatePresenceModel()
Create a default LinphonePresenceModel.
Declaration
public PresenceModel CreatePresenceModel()
Returns
| Type | Description |
|---|---|
| PresenceModel | The created PresenceModel object. |
CreatePresenceModelWithActivity(PresenceActivityType, String)
Create a PresenceModel with the given activity type and activity description.
Declaration
public PresenceModel CreatePresenceModelWithActivity(PresenceActivityType acttype, string description)
Parameters
| Type | Name | Description |
|---|---|---|
| PresenceActivityType | acttype | The PresenceActivityType to set for the activity of the created model. |
| System.String | description | An additional description of the activity to set for the activity. Can be null if no additional description is to be added. |
Returns
| Type | Description |
|---|---|
| PresenceModel | The created PresenceModel object. |
CreatePresenceModelWithActivityAndNote(PresenceActivityType, String, String, String)
Create a PresenceModel with the given activity type, activity description, note content and note language.
Declaration
public PresenceModel CreatePresenceModelWithActivityAndNote(PresenceActivityType acttype, string description, string note, string lang)
Parameters
| Type | Name | Description |
|---|---|---|
| PresenceActivityType | acttype | The PresenceActivityType to set for the activity of the created model. |
| System.String | description | An additional description of the activity to set for the activity. Can be null if no additional description is to be added. |
| System.String | note | The content of the note to be added to the created model. |
| System.String | lang | The language of the note to be added to the created model. |
Returns
| Type | Description |
|---|---|
| PresenceModel | The created PresenceModel object. |
CreatePresenceNote(String, String)
Create a PresenceNote with the given content and language.
Declaration
public PresenceNote CreatePresenceNote(string content, string lang)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | content | The content of the note to be created. |
| System.String | lang | The language of the note to be created. |
Returns
| Type | Description |
|---|---|
| PresenceNote | The created PresenceNote object. |
CreatePresencePerson(String)
Create a PresencePerson with the given id.
Declaration
public PresencePerson CreatePresencePerson(string id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The id of the person to be created. |
Returns
| Type | Description |
|---|---|
| PresencePerson | The created PresencePerson object. |
CreatePresenceService(String, PresenceBasicStatus, String)
Create a PresenceService with the given id, basic status and contact.
Declaration
public PresenceService CreatePresenceService(string id, PresenceBasicStatus basicStatus, string contact)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The id of the service to be created. |
| PresenceBasicStatus | basicStatus | The basic status of the service to be created. |
| System.String | contact | A string containing a contact information corresponding to the service to be created. |
Returns
| Type | Description |
|---|---|
| PresenceService | The created PresenceService object. |
CreatePrimaryContactParsed()
Same as PrimaryContact but the result is a Address object instead of const char *.
Declaration
public Address CreatePrimaryContactParsed()
Returns
| Type | Description |
|---|---|
| Address | a Address object. |
CreateProxyConfig()
Create a proxy config with default values from Linphone core.
Declaration
public ProxyConfig CreateProxyConfig()
Returns
| Type | Description |
|---|---|
| ProxyConfig | ProxyConfig with default values set |
CreatePublish(Address, String, Int32)
Create a publish context for an event state.
After being created, the publish must be sent using
Declaration
public Event CreatePublish(Address resource, string ev, int expires)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | resource | the resource uri for the event |
| System.String | ev | the event name |
| System.Int32 | expires | the lifetime of event being published, -1 if no associated duration, in which case it will not be refreshed. |
Returns
| Type | Description |
|---|---|
| Event | the Event holding the context of the publish. |
CreateRecorder(RecorderParams)
Create a media file recorder.
This recorder support WAVE and MATROSKA formats.
Declaration
public Recorder CreateRecorder(RecorderParams parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| RecorderParams | parameters | The RecorderParams that will contains all recorder parameters. |
Returns
| Type | Description |
|---|---|
| Recorder | A pointer on the new instance. null if failed. |
CreateRecorderParams()
Create a recorder params that will hold parameters.
This recorder support WAVE and MATROSKA formats.
Declaration
public RecorderParams CreateRecorderParams()
Returns
| Type | Description |
|---|---|
| RecorderParams | A pointer on the newly created instance. |
CreateSubscribe(Address, ProxyConfig, String, Int32)
Create 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
Declaration
public Event CreateSubscribe(Address resource, ProxyConfig proxy, string ev, int expires)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | resource | the destination resource |
| ProxyConfig | proxy | the proxy configuration to use |
| System.String | ev | the event name |
| System.Int32 | expires | the whished duration of the subscription |
Returns
| Type | Description |
|---|---|
| Event | a Event holding the context of the created subcription. |
CreateSubscribe(Address, String, Int32)
Create 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
Declaration
public Event CreateSubscribe(Address resource, string ev, int expires)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | resource | the destination resource |
| System.String | ev | the event name |
| System.Int32 | expires | the whished duration of the subscription |
Returns
| Type | Description |
|---|---|
| Event | a Event holding the context of the created subcription. |
CreateXmlRpcSession(String)
Create a XmlRpcSession for a given url.
Declaration
public XmlRpcSession CreateXmlRpcSession(string url)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | url | The URL to the XML-RPC server. Must be NON null. |
Returns
| Type | Description |
|---|---|
| XmlRpcSession | The new XmlRpcSession object. |
DeleteChatRoom(ChatRoom)
Removes a chatroom including all message history from the LinphoneCore.
Declaration
public void DeleteChatRoom(ChatRoom chatRoom)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatRoom | chatRoom | A ChatRoom object |
DeleteConferenceInformation(ConferenceInfo)
Deletes a conference information from DB.
Declaration
public void DeleteConferenceInformation(ConferenceInfo conferenceInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| ConferenceInfo | conferenceInfo | the ConferenceInfo to delete. |
DidRegisterForRemotePush(IntPtr)
Sets device_token when application didRegisterForRemoteNotificationsWithDeviceToken (IOS only).
Declaration
public void DidRegisterForRemotePush(IntPtr deviceToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IntPtr | deviceToken | (NSData *). |
DidRegisterForRemotePushWithStringifiedToken(String)
Sets device_token when application didRegisterForRemoteNotificationsWithDeviceToken (IOS only).
Declaration
public void DidRegisterForRemotePushWithStringifiedToken(string deviceTokenStr)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | deviceTokenStr | extracted from the Data objectf received in didRegisterForRemoteNotificationsWithDeviceToken ios function. Append ":remote" after data formating.. |
DisableChat(Reason)
Inconditionnaly disable incoming chat messages.
Declaration
public void DisableChat(Reason denyReason)
Parameters
| Type | Name | Description |
|---|---|---|
| Reason | denyReason | the deny reason (None has no effect). |
EnableChat()
Enable reception of incoming chat messages.
By default it is enabled but it can be disabled with
Declaration
public void EnableChat()
EnableLogCollection(LogCollectionState)
Enable the linphone core log collection to upload logs on a server.
Declaration
public static void EnableLogCollection(LogCollectionState state)
Parameters
| Type | Name | Description |
|---|---|---|
| LogCollectionState | state | LogCollectionState value telling whether to enable log collection or not. |
EnsureRegistered()
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.
Declaration
public void EnsureRegistered()
EnterBackground()
This method is called by the application to notify the linphone core library when it enters background mode.
Declaration
public void EnterBackground()
EnterConference()
Join the local participant to the running conference.
Declaration
public void EnterConference()
EnterForeground()
This method is called by the application to notify the linphone core library when it enters foreground mode.
Declaration
public void EnterForeground()
FileFormatSupported(String)
Returns whether a specific file format is supported.
Declaration
public bool FileFormatSupported(string fmt)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fmt | The format extension (wav, mkv). |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the file format is supported, false otherwise |
Remarks
See : linphone_core_get_supported_file_formats
FindAuthInfo(String, String, String)
Find 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.
Declaration
public AuthInfo FindAuthInfo(string realm, string username, string sipDomain)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | realm | the authentication 'realm' (optional) |
| System.String | username | the SIP username to be authenticated (mandatory) |
| System.String | sipDomain | the SIP domain name (optional) |
Returns
| Type | Description |
|---|---|
| AuthInfo | a AuthInfo if found. |
FindCallFromUri(String)
Search from the list of current calls if a remote address match uri.
Declaration
public Call FindCallFromUri(string uri)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | uri | which should match call remote uri |
Returns
| Type | Description |
|---|---|
| Call | Call or null if no match is found. |
FindCallLog(String, Int32)
Get the call log matching the call id, or null if can't be found.
Declaration
public CallLog FindCallLog(string callId, int limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | callId | Call id of the call log to find |
| System.Int32 | limit | Search limit of the most recent call logs to find |
Returns
| Type | Description |
|---|---|
| CallLog | A call log matching the call id if any. |
FindCallLogFromCallId(String)
Get the call log matching the call id, or null if can't be found.
Declaration
public CallLog FindCallLogFromCallId(string callId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | callId | Call id of the call log to find |
Returns
| Type | Description |
|---|---|
| CallLog | A call log matching the call id if any. |
FindChatRoom(Address, Address)
Find a chat room.
No reference is transfered to the application. The Core keeps a reference on the chat room.
Declaration
public ChatRoom FindChatRoom(Address peerAddr, Address localAddr)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | peerAddr | a linphone address. |
| Address | localAddr | a linphone address. |
Returns
| Type | Description |
|---|---|
| ChatRoom | ChatRoom where messaging can take place. |
FindConferenceInformationFromUri(Address)
Retrieve the conference information linked to the provided URI if any.
Declaration
public ConferenceInfo FindConferenceInformationFromUri(Address uri)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | uri | Address of the uri. |
Returns
| Type | Description |
|---|---|
| ConferenceInfo | The ConferenceInfo found if any, null otherwise. |
FindContactsByChar(String, Boolean)
Retrieves a list of Address sort and filter.
Declaration
public IEnumerable<Address> FindContactsByChar(string filter, bool sipOnly)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filter | Chars used for the filter* |
| System.Boolean | sipOnly | Only sip address or not |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<Address> | A list of filtered Address
|
FindFriend(Address)
Search a Friend by its address.
Declaration
public Friend FindFriend(Address address)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | address | The Address to use to search the friend. |
Returns
| Type | Description |
|---|---|
| Friend | The Friend object corresponding to the given address or null if not found. |
FindFriendByPhoneNumber(String)
Search a Friend by its phone number.
Declaration
public Friend FindFriendByPhoneNumber(string phoneNumber)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | phoneNumber | The phone number to use to search the friend. |
Returns
| Type | Description |
|---|---|
| Friend | The Friend object corresponding to the given phone number or null if not found. |
FindFriends(Address)
Search all Friend matching an address.
Declaration
public IEnumerable<Friend> FindFriends(Address address)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | address | The address to use to search the friends. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<Friend> | A list of Friend corresponding to the given address. |
FindOneToOneChatRoom(Address, Address, Boolean)
Find a one to one chat room.
No reference is transfered to the application. The Core keeps a reference on the chat room.
Declaration
public ChatRoom FindOneToOneChatRoom(Address localAddr, Address participantAddr, bool encrypted)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | localAddr | a linphone address. |
| Address | participantAddr | a linphone address. |
| System.Boolean | encrypted | whether to look for an encrypted chat room or not |
Returns
| Type | Description |
|---|---|
| ChatRoom | ChatRoom where messaging can take place. |
GetAccountByIdkey(String)
Search for a Account by it's idkey.
Declaration
public Account GetAccountByIdkey(string idkey)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idkey | An arbitrary idkey string associated to an account. |
Returns
| Type | Description |
|---|---|
| Account | the Account object for the given idkey value, or null if none found |
GetCallByCallid(String)
Get the call by callid.
Declaration
public Call GetCallByCallid(string callId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | callId |
Returns
| Type | Description |
|---|---|
| Call | call Call, return null if there is no call find. |
GetCallByRemoteAddress(String)
Get the call with the remote_address specified.
Declaration
public Call GetCallByRemoteAddress(string remoteAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | remoteAddress | The remote address of the call that we want to get |
Returns
| Type | Description |
|---|---|
| Call | The call if it has been found, null otherwise. |
GetCallByRemoteAddress2(Address)
Get the call with the specified Address.
Declaration
public Call GetCallByRemoteAddress2(Address remoteAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | remoteAddress | the Address for which the call remote address must match |
Returns
| Type | Description |
|---|---|
| Call | the Call of the call if found. |
GetCallHistory(Address, Address)
Get 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.
Declaration
public IEnumerable<CallLog> GetCallHistory(Address peerAddress, Address localAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | peerAddress | The remote Address object. |
| Address | localAddress | The local Address object |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<CallLog> | A list of CallLog. |
GetCallHistoryForAddress(Address)
Get the list of call logs (past calls) that matches the given Address.
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.
Declaration
public IEnumerable<CallLog> GetCallHistoryForAddress(Address address)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | address | Address object |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<CallLog> | A list of CallLog. |
GetChatRoom(Address)
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 transfered to the application. The Core keeps a reference on the chat room.
Declaration
public ChatRoom GetChatRoom(Address addr)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | addr | a linphone address. |
Returns
| Type | Description |
|---|---|
| ChatRoom | ChatRoom where messaging can take place. |
Remarks
Warning : This method is prone to errors, use
GetChatRoom(Address, Address)
Get a chat room.
If it does not exist yet, it will be created as a basic chat room. No reference is transfered to the application. The Core keeps a reference on the chat room.
Declaration
public ChatRoom GetChatRoom(Address peerAddr, Address localAddr)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | peerAddr | a linphone address. |
| Address | localAddr | a linphone address. |
Returns
| Type | Description |
|---|---|
| ChatRoom | ChatRoom where messaging can take place. |
Remarks
Warning : This method is prone to errors, use
GetChatRoomFromUri(String)
Get a chat room for messaging from a sip uri like sip:joe@sip.linphone.org.
If it does not exist yet, it will be created as a basic chat room. No reference is transfered to the application. The Core keeps a reference on the chat room.
Declaration
public ChatRoom GetChatRoomFromUri(string to)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | to | The destination address for messages. |
Returns
| Type | Description |
|---|---|
| ChatRoom | ChatRoom where messaging can take place. |
Remarks
Warning : This method is prone to errors, use
GetConferenceInformationListAfterTime(Int64)
Retrieve the list of conference information on DB after a certain time.
Declaration
public IEnumerable<ConferenceInfo> GetConferenceInformationListAfterTime(long time)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | time | Time to retrieve conference info. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<ConferenceInfo> | The list of conference infos . |
GetFriendByRefKey(String)
Search a Friend by its reference key.
Declaration
public Friend GetFriendByRefKey(string key)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The reference key to use to search the friend. |
Returns
| Type | Description |
|---|---|
| Friend | The Friend object corresponding to the given reference key. |
GetFriendListByName(String)
Retrieves the list of Friend from the core that has the given display name.
Declaration
public FriendList GetFriendListByName(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | the name of the list |
Returns
| Type | Description |
|---|---|
| FriendList | the first FriendList object or null. |
GetPayloadType(String, Int32, Int32)
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.
Declaration
public PayloadType GetPayloadType(string type, int rate, int channels)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | type | payload mime type (I.E SPEEX, PCMU, VP8) |
| System.Int32 | rate | can be LINPHONE_FIND_PAYLOAD_IGNORE_RATE |
| System.Int32 | channels | number of channels, can be LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS |
Returns
| Type | Description |
|---|---|
| PayloadType | Returns null if not found. If a PayloadType is returned, it must be released with linphone_payload_type_unref after using it. |
Remarks
Warning : The returned payload type is allocated as a floating reference i.e. the reference counter is initialized to 0.
GetProxyConfigByIdkey(String)
Search for a ProxyConfig by it's idkey.
Declaration
public ProxyConfig GetProxyConfigByIdkey(string idkey)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idkey | An arbitrary idkey string associated to a proxy configuration |
Returns
| Type | Description |
|---|---|
| ProxyConfig | the ProxyConfig object for the given idkey value, or null if none found |
GetUnreadChatMessageCountFromLocal(Address)
Return the unread chat message count for a given local address.
Declaration
public int GetUnreadChatMessageCountFromLocal(Address address)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | address | Address object. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The unread chat message count. |
GetZrtpStatus(String)
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)
Declaration
public ZrtpPeerStatus GetZrtpStatus(string addr)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | addr | the peer uri |
Returns
| Type | Description |
|---|---|
| ZrtpPeerStatus |
|
HasBuiltinEchoCanceller()
Check whether the device has a hardware echo canceller.
Declaration
public bool HasBuiltinEchoCanceller()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if it does, false otherwise |
HasCrappyOpengl()
Check whether the device is flagged has crappy opengl.
Declaration
public bool HasCrappyOpengl()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if crappy opengl flag is set, false otherwise |
InCall()
Tells whether there is a call running.
Declaration
public bool InCall()
Returns
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether a call is currently running or not |
InterpretUrl(String)
Constructs a 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.
Declaration
public Address InterpretUrl(string url)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | url | the url to parse |
Returns
| Type | Description |
|---|---|
| Address | the Address matching the url or null in case of failure. |
Remarks
See :
InterpretUrl(String, Boolean)
Constructs a 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.
Declaration
public Address InterpretUrl(string url, bool applyInternationalPrefix)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | url | the url to parse |
| System.Boolean | applyInternationalPrefix | whether or not to try to format url as phone number using default account prefix if it set (and if url is a number). |
Returns
| Type | Description |
|---|---|
| Address | the Address matching the url or null in case of failure. |
Remarks
See :
Invite(String)
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.
Declaration
public Call Invite(string url)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | url | The destination of the call (sip address, or phone number). |
Returns
| Type | Description |
|---|---|
| Call | A Call object or null in case of failure. |
InviteAddress(Address)
Initiates an outgoing call given a destination Address The Address
can be constructed directly using linphone_address_new, or created by
The application doesn't own a reference to the returned Call object. Use linphone_call_ref to safely keep the Call pointer valid within your application.
Declaration
public Call InviteAddress(Address addr)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | addr | The destination of the call (sip address). |
Returns
| Type | Description |
|---|---|
| Call | A Call object or null in case of failure. |
InviteAddressWithParams(Address, CallParams)
Initiates an outgoing call given a destination Address The Address
can be constructed directly using linphone_address_new, or created by
The application doesn't own a reference to the returned Call object. Use linphone_call_ref to safely keep the Call pointer valid within your application. If the proxy is not specified in parameters, the caller proxy will be automatically selected by finding what is the best to reach the destination of the call.
Declaration
public Call InviteAddressWithParams(Address addr, CallParams parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | addr | The destination of the call (sip address). |
| CallParams | parameters | Call parameters |
Returns
| Type | Description |
|---|---|
| Call | A Call object or null in case of failure. |
InviteAddressWithParams(Address, CallParams, String, Content)
Initiates an outgoing call given a destination Address The Address
can be constructed directly using linphone_address_new, or created by
The application doesn't own a reference to the returned Call object. Use linphone_call_ref to safely keep the Call pointer valid within your application. If the proxy is not specified in parameters, the caller proxy will be automatically selected by finding what is the best to reach the destination of the call.
Declaration
public Call InviteAddressWithParams(Address addr, CallParams parameters, string subject, Content content)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | addr | The destination of the call (sip address). |
| CallParams | parameters | Call parameters |
| System.String | subject | Subject of the call |
| Content | content | Body of the SIP INVITE |
Returns
| Type | Description |
|---|---|
| Call | A Call object or null in case of failure. |
InviteWithParams(String, CallParams)
Initiates an outgoing call according to supplied call parameters The application doesn't own a reference to the returned Call object.
Use linphone_call_ref to safely keep the Call pointer valid within your application.
Declaration
public Call InviteWithParams(string url, CallParams parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | url | The destination of the call (sip address, or phone number). |
| CallParams | parameters | the CallParams call parameters |
Returns
| Type | Description |
|---|---|
| Call | A Call object or null in case of failure. |
IsContentTypeSupported(String)
Tells whether a content type is supported.
Declaration
public bool IsContentTypeSupported(string contentType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | contentType | The content type to check |
Returns
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether the specified content type is supported or not. |
IsMediaEncryptionSupported(MediaEncryption)
Check if media encryption is supported.
Declaration
public bool IsMediaEncryptionSupported(MediaEncryption menc)
Parameters
| Type | Name | Description |
|---|---|---|
| MediaEncryption | menc | The media encryption policy to be used. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the media encryption is supported, false otherwise |
IsMediaFilterSupported(String)
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.
Declaration
public bool IsMediaFilterSupported(string filtername)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filtername | the filter name |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the filter is loaded and usable, false otherwise |
Iterate()
Main loop function.
It is crucial that your application call it periodically. Iterate() performs various backgrounds tasks:
Declaration
public void Iterate()
LdapAvailable()
Tells if LDAP is available.
Declaration
public bool LdapAvailable()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if LDAP is available, false otherwise |
LeaveConference()
Make the local participant leave the running conference.
Declaration
public void LeaveConference()
LimeX3DhAvailable()
Tells if LIME X3DH is available.
Declaration
public bool LimeX3DhAvailable()
Returns
| Type | Description |
|---|---|
| System.Boolean |
LoadConfigFromXml(String)
Update current config with the content of a xml config file.
Declaration
public void LoadConfigFromXml(string xmlUri)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | xmlUri | the path to the xml file |
LogCollectionEnabled()
Tells whether the linphone core log collection is enabled.
Declaration
public static LogCollectionState LogCollectionEnabled()
Returns
| Type | Description |
|---|---|
| LogCollectionState | The LogCollectionState of the Core log collection. |
MediaEncryptionSupported(MediaEncryption)
Check if a media encryption type is supported.
Declaration
public bool MediaEncryptionSupported(MediaEncryption menc)
Parameters
| Type | Name | Description |
|---|---|---|
| MediaEncryption | menc |
Returns
| Type | Description |
|---|---|
| System.Boolean | whether a media encryption scheme is supported by the Core engine |
MigrateLogsFromRcToDb()
Migrates the call logs from the linphonerc to the database if not done yet.
Declaration
public void MigrateLogsFromRcToDb()
MigrateToMultiTransport()
Migrate configuration so that all SIP transports are enabled.
Versions of linphone < 3.7 did not support using multiple SIP transport simultaneously. This function helps application to migrate the configuration so that all transports are enabled. Existing proxy configuration are added a transport parameter so that they continue using the unique transport that was set previously. This function must be used just after creating the core, before any call to Iterate()
Declaration
public void MigrateToMultiTransport()
NotifyAllFriends(PresenceModel)
Notify all friends that have subscribed.
Declaration
public void NotifyAllFriends(PresenceModel presence)
Parameters
| Type | Name | Description |
|---|---|---|
| PresenceModel | presence | PresenceModel to notify |
NotifyNotifyPresenceReceived(Friend)
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.
Declaration
public void NotifyNotifyPresenceReceived(Friend linphoneFriend)
Parameters
| Type | Name | Description |
|---|---|---|
| Friend | linphoneFriend | the Friend whose presence information has been received. |
NotifyNotifyPresenceReceivedForUriOrTel(Friend, String, PresenceModel)
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.
Declaration
public void NotifyNotifyPresenceReceivedForUriOrTel(Friend linphoneFriend, string uriOrTel, PresenceModel presenceModel)
Parameters
| Type | Name | Description |
|---|---|---|
| Friend | linphoneFriend | the Friend whose presence information has been received. |
| System.String | uriOrTel | telephone number or sip uri |
| PresenceModel | presenceModel | the PresenceModel that has been modified |
PauseAllCalls()
Pause all currently running calls.
Declaration
public void PauseAllCalls()
PlayDtmf(SByte, Int32)
Plays a dtmf sound to the local user.
Declaration
public void PlayDtmf(sbyte dtmf, int durationMs)
Parameters
| Type | Name | Description |
|---|---|---|
| System.SByte | dtmf | DTMF to play ['0'..'16'] | '#' | '#' |
| System.Int32 | durationMs | Duration in ms, -1 means play until next further call to StopDtmf() |
PlayLocal(String)
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.
Declaration
public void PlayLocal(string audiofile)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | audiofile | The path to an audio file in wav PCM 16 bit format |
PreemptSoundResources()
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.
Declaration
public int PreemptSoundResources()
Returns
| Type | Description |
|---|---|
| System.Int32 | 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. |
PreviewOglRender()
Call generic OpenGL render for a given core.
Declaration
public void PreviewOglRender()
ProcessPushNotification(String)
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.
Declaration
public void ProcessPushNotification(string callId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | callId | the Call-ID of the MESSAGE or INVITE for which the push was received and to wait for. |
Publish(Address, String, Int32, Content)
Publish an event state.
This first create a Event with
Declaration
public Event Publish(Address resource, string ev, int expires, Content body)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | resource | the resource uri for the event |
| System.String | ev | the event name |
| System.Int32 | expires | the lifetime of event being published, -1 if no associated duration, in which case it will not be refreshed. |
| Content | body | the actual published data |
Returns
| Type | Description |
|---|---|
| Event | the Event holding the context of the publish. |
RealtimeTextGetKeepaliveInterval()
Gets keep alive interval of real time text.
Declaration
public uint RealtimeTextGetKeepaliveInterval()
Returns
| Type | Description |
|---|---|
| System.UInt32 | keep alive interval of real time text. |
RealtimeTextSetKeepaliveInterval(UInt32)
Set keep alive interval for real time text.
Declaration
public void RealtimeTextSetKeepaliveInterval(uint interval)
Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | interval | The keep alive interval of real time text, 25000 by default. |
RefreshRegisters()
force registration refresh to be initiated upon next iterate
Declaration
public void RefreshRegisters()
RejectSubscriber(Friend)
Black list a friend.
same as IncSubscribePolicy with SPDeny policy;
Declaration
public void RejectSubscriber(Friend linphoneFriend)
Parameters
| Type | Name | Description |
|---|---|---|
| Friend | linphoneFriend | Friend to reject |
ReloadMsPlugins(String)
Reload mediastreamer2 plugins from specified directory.
Declaration
public void ReloadMsPlugins(string path)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | the path from where plugins are to be loaded, pass null to use default (compile-time determined) plugin directory. |
ReloadSoundDevices()
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.
Declaration
public void ReloadSoundDevices()
ReloadVideoDevices()
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.
Declaration
public void ReloadVideoDevices()
RemoveAccount(Account)
Removes an account.
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.
Declaration
public void RemoveAccount(Account account)
Parameters
| Type | Name | Description |
|---|---|---|
| Account | account | the Account to remove |
RemoveAuthInfo(AuthInfo)
Removes an authentication information object.
Declaration
public void RemoveAuthInfo(AuthInfo info)
Parameters
| Type | Name | Description |
|---|---|---|
| AuthInfo | info | The AuthInfo to remove. |
RemoveCallLog(CallLog)
Remove 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.
Declaration
public void RemoveCallLog(CallLog callLog)
Parameters
| Type | Name | Description |
|---|---|---|
| CallLog | callLog | CallLog object to remove. |
RemoveContentTypeSupport(String)
Remove support for the specified content type.
It is the application responsibility to handle it correctly afterwards.
Declaration
public void RemoveContentTypeSupport(string contentType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | contentType | The content type to remove support for |
RemoveFriendList(FriendList)
Removes a friend list.
Declaration
public void RemoveFriendList(FriendList list)
Parameters
| Type | Name | Description |
|---|---|---|
| FriendList | list | FriendList object |
RemoveFromConference(Call)
Remove a call from the conference.
Declaration
public void RemoveFromConference(Call call)
Parameters
| Type | Name | Description |
|---|---|---|
| Call | call | a call that has been previously merged into the conference. |
RemoveLdap(Ldap)
Remove a LDAP from the configuration.
Declaration
public void RemoveLdap(Ldap ldap)
Parameters
| Type | Name | Description |
|---|---|---|
| Ldap | ldap | The LDAP to remove. |
RemoveLinphoneSpec(String)
Remove the given linphone specs from the list of functionalities the linphone client supports.
Declaration
public void RemoveLinphoneSpec(string spec)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | spec | The spec to remove |
RemoveProxyConfig(ProxyConfig)
Removes a proxy configuration.
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.
Declaration
public void RemoveProxyConfig(ProxyConfig config)
Parameters
| Type | Name | Description |
|---|---|---|
| ProxyConfig | config | the ProxyConfig to remove |
RemoveSupportedTag(String)
Remove a supported tag.
Declaration
public void RemoveSupportedTag(string tag)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | tag | The tag to remove |
Remarks
See :
ResetEchoCancellationCalibration()
Clears all state resulting from a previous echo canceller calibration procedure, which restores default policy and settings for echo cancellation.
Declaration
public void ResetEchoCancellationCalibration()
Remarks
See :
ResetLogCollection()
Reset the log collection by removing the log files.
Declaration
public static void ResetLogCollection()
ResetMissedCallsCount()
Reset the counter of missed calls.
Declaration
public void ResetMissedCallsCount()
SearchChatRoom(ChatRoomParams, Address, Address, IEnumerable<Address>)
Find a chat room.
Declaration
public ChatRoom SearchChatRoom(ChatRoomParams parameters, Address localAddr, Address remoteAddr, IEnumerable<Address> participants)
Parameters
| Type | Name | Description |
|---|---|---|
| ChatRoomParams | parameters | The chat room parameters to match ChatRoomParams or null |
| Address | localAddr | Address representing the local proxy configuration or null |
| Address | remoteAddr | Address to search for or null |
| System.Collections.Generic.IEnumerable<Address> | participants | The participants that must be present in the chat room to find. |
Returns
| Type | Description |
|---|---|
| ChatRoom | A matching chat room or null if none matches. |
SearchConference(Address)
Find a conference.
Declaration
public Conference SearchConference(Address conferenceAddr)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | conferenceAddr | Address representing the conference address |
Returns
| Type | Description |
|---|---|
| Conference | A pointer on Conference whose conference address is the one provided as argument or null if none matches |
SearchConference(ConferenceParams, Address, Address, IEnumerable<Address>)
Find a conference.
Declaration
public Conference SearchConference(ConferenceParams parameters, Address localAddr, Address remoteAddr, IEnumerable<Address> participants)
Parameters
| Type | Name | Description |
|---|---|---|
| ConferenceParams | parameters | The conference parameters to match ConferenceParams or null |
| Address | localAddr | Address representing the local proxy configuration or null |
| Address | remoteAddr | Address to search for or null |
| System.Collections.Generic.IEnumerable<Address> | participants | The participants that must be present in the chat room to find |
Returns
| Type | Description |
|---|---|
| Conference | A pointer on Conference satisfying the non-null function arguments or null if none matches |
SerializeLogs()
Enable logs serialization (output logs from either the thread that creates the linphone core or the thread that calls Iterate()).
Must be called before creating the linphone core.
Declaration
public static void SerializeLogs()
SetAudioPortRange(Int32, Int32)
Sets the UDP port range from which to randomly select the port used for audio streaming.
Declaration
public void SetAudioPortRange(int minPort, int maxPort)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | minPort | The lower bound of the audio port range to use |
| System.Int32 | maxPort | The upper bound of the audio port range to use |
SetLogCollectionMaxFileSize(Int64)
Set 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
Declaration
public static void SetLogCollectionMaxFileSize(long size)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | size | The max file size in bytes of the files used for log collection. |
SetLogCollectionPath(String)
Set 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
Declaration
public static void SetLogCollectionPath(string path)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path where the log files will be written. |
SetLogCollectionPrefix(String)
Set 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
Declaration
public static void SetLogCollectionPrefix(string prefix)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | prefix | The prefix to use for the filenames for log collection. |
SetQrcodeDecodeRect(Int32, Int32, Int32, Int32)
Set the rectangle where the decoder will search a QRCode.
Declaration
public void SetQrcodeDecodeRect(int x, int y, int w, int h)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | x | axis |
| System.Int32 | y | axis |
| System.Int32 | w | width |
| System.Int32 | h | height |
SetTextPortRange(Int32, Int32)
Sets the UDP port range from which to randomly select the port used for text streaming.
Declaration
public void SetTextPortRange(int minPort, int maxPort)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | minPort | The lower bound of the text port range to use |
| System.Int32 | maxPort | The upper bound of the text port range to use |
SetTone(ToneID, String)
Assign an audio file to be played as a specific tone id.
This function typically allows to customize telephony tones per country.
Declaration
public void SetTone(ToneID toneId, string audiofile)
Parameters
| Type | Name | Description |
|---|---|---|
| ToneID | toneId | the #LinphoneToneId |
| System.String | audiofile | a wav file to be played or null to disable it. |
SetUserAgent(String, String)
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.
Declaration
public void SetUserAgent(string name, string version)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | Name of the user agent. |
| System.String | version | Version of the user agent. |
SetVideoPortRange(Int32, Int32)
Sets the UDP port range from which to randomly select the port used for video streaming.
Declaration
public void SetVideoPortRange(int minPort, int maxPort)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | minPort | The lower bound of the video port range to use |
| System.Int32 | maxPort | The upper bound of the video port range to use |
SoundDeviceCanCapture(String)
Tells whether a specified sound device can capture sound.
Declaration
public bool SoundDeviceCanCapture(string device)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | device | the device name as returned by linphone_core_get_sound_devices |
Returns
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether the specified sound device can capture sound |
SoundDeviceCanPlayback(String)
Tells whether a specified sound device can play sound.
Declaration
public bool SoundDeviceCanPlayback(string device)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | device | the device name as returned by linphone_core_get_sound_devices |
Returns
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether the specified sound device can play sound |
SoundResourcesLocked()
Check 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 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.
Declaration
public bool SoundResourcesLocked()
Returns
| Type | Description |
|---|---|
| System.Boolean | A boolean value telling whether a call will need the sound resources in near future |
Start()
Start a Core object after it has been instantiated and not automatically started.
Also re-initialize a Core object that has been stopped using Stop(). Must be called only if GlobalState is either Ready of Off. State will changed to Startup, Configuring and then On.
Declaration
public void Start()
StartConferenceRecording(String)
Start recording the running conference.
Declaration
public void StartConferenceRecording(string path)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | Path to the file where the recording will be written |
StartEchoCancellerCalibration()
Starts an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.
Declaration
public void StartEchoCancellerCalibration()
StartEchoTester(UInt32)
Start the simulation of call to test the latency with an external device.
Declaration
public void StartEchoTester(uint rate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | rate | Sound sample rate. |
Stop()
Stop a Core object after it has been instantiated and started.
If stopped, it can be started again using Start(). Must be called only if GlobalState is either On. State will changed to Shutdown and then Off.
Declaration
public void Stop()
StopAsync()
Stop asynchronously a Core object after it has been instantiated and started.
State changes to Shutdown then 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 GlobalState is On. When GlobalState is Off Core can be started again using Start().
Declaration
public void StopAsync()
StopConferenceRecording()
Stop recording the running conference.
Declaration
public void StopConferenceRecording()
StopDtmf()
Stops playing a dtmf started by
Declaration
public void StopDtmf()
StopEchoTester()
Stop the simulation of call.
Declaration
public void StopEchoTester()
StopRinging()
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.
Declaration
public void StopRinging()
Subscribe(Address, String, Int32, Content)
Create 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.
Declaration
public Event Subscribe(Address resource, string ev, int expires, Content body)
Parameters
| Type | Name | Description |
|---|---|---|
| Address | resource | the destination resource |
| System.String | ev | the event name |
| System.Int32 | expires | the whished duration of the subscription |
| Content | body | an optional body, may be null. |
Returns
| Type | Description |
|---|---|
| Event | a Event holding the context of the created subcription. |
TakePreviewSnapshot(String)
Take 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.
Declaration
public void TakePreviewSnapshot(string file)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | file | a path where to write the jpeg content. |
TerminateAllCalls()
Terminates all the calls.
Declaration
public void TerminateAllCalls()
TerminateConference()
Terminate 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.
Declaration
public void TerminateConference()
TunnelAvailable()
True if tunnel support was compiled.
Declaration
public static bool TunnelAvailable()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if library was built with tunnel, false otherwise |
UploadLogCollection()
Upload the log collection to the configured server url.
Declaration
public void UploadLogCollection()
UpnpAvailable()
Return the availability of uPnP.
Declaration
public static bool UpnpAvailable()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if uPnP is available otherwise return false. |
UsePreviewWindow(Boolean)
Tells the core to use a separate window for local camera preview video, instead of inserting local view within the remote video window.
Declaration
public void UsePreviewWindow(bool yesno)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | yesno | true to use a separate window, false to insert the preview in the remote video window. |
VcardSupported()
Tells whether VCARD support is builtin.
Declaration
public static bool VcardSupported()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if VCARD is supported, false otherwise. |
VerifyServerCertificates(Boolean)
Specify whether the tls server certificate must be verified when connecting to a SIP/TLS server.
Declaration
public void VerifyServerCertificates(bool yesno)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | yesno | A boolean value telling whether the tls server certificate must be verified |
VerifyServerCn(Boolean)
Specify whether the tls server certificate common name must be verified when connecting to a SIP/TLS server.
Declaration
public void VerifyServerCn(bool yesno)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | yesno | A boolean value telling whether the tls server certificate common name must be verified |
VideoSupported()
Test if video is supported.
Declaration
public bool VideoSupported()
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the library was built with video support, false otherwise |