Package org.linphone.core
Interface Core
public interface 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
about factory and default config. On some platforms like Android or iOS you
will need to give it the Context of your application.
Once the
. It will then go to state
using it for calls and chat messages. It is recommended to add a
listener using
To be able to receive events from the network, you must schedule a call
often, like every 20ms. On Android & iOS linphone_core_is_auto_iterate_enabled
is enabled by default so you don't have to worry about that unless you disable
it using
configuration auto_iterate=0. warning: Our API isn't thread-safe but also isn't
blocking, so it is strongly recommend to always call our methods from the main
thread.
Once you don't need it anymore, call
it so it can gracefully shutdown.
This object is the first object to instanciante, and will allow you to perform
all kind of tasks. To create it, use either
Factory.createCore(java.lang.String, java.lang.String, java.lang.Object)
orFactory.createCoreWithConfig(org.linphone.core.Config, java.lang.Object)
, see Config
for more informationabout factory and default config. On some platforms like Android or iOS you
will need to give it the Context of your application.
Once the
Core
is in state GlobalState.Ready
, use start()
. It will then go to state
GlobalState.On
and from that you can startusing it for calls and chat messages. It is recommended to add a
CoreListener
listener using
addListener(org.linphone.core.CoreListener)
to monitor different events.To be able to receive events from the network, you must schedule a call
iterate()
often, like every 20ms. On Android & iOS linphone_core_is_auto_iterate_enabled
is enabled by default so you don't have to worry about that unless you disable
it using
#enableAutoIterate
or by setting in the [misc] section of yourconfiguration auto_iterate=0. warning: Our API isn't thread-safe but also isn't
blocking, so it is strongly recommend to always call our methods from the main
thread.
Once you don't need it anymore, call
stop()
and release the reference onit so it can gracefully shutdown.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
activateAudioSession
(boolean actived) Special function to indicate if the audio session is activated.int
addAccount
(Account account) Add an account.int
Add all current calls into the conference.void
addAuthInfo
(AuthInfo info) Adds authentication information to theCore
.void
addContentTypeSupport
(String contentType) Add support for the specified content type.void
addFriendList
(FriendList list) Add a friend list.void
Add or update a LDAP server and save it to the configuration.void
addLinphoneSpec
(String spec) Add the given linphone specs to the list of functionalities the linphone client
supports.void
addListener
(CoreListener listener) void
addProvisioningHeader
(String headerName, String value) Add an extra header for retrieving the remote provisioning (checksetProvisioningUri(java.lang.String)
).int
addProxyConfig
(ProxyConfig config) Add a proxy configuration.void
addSupportedTag
(String tag) This function controls signaling features supported by the core.int
addToConference
(Call call) Add a participant to the conference.void
Deprecated.07/01/2020 now handled in the linphone SDK directlyGets the default ephemeral message mode @core core the linphone core.void
Sets the default ephemeral message mode.void
checkForUpdate
(String currentVersion) Checks if a new version of the application is available.void
Erase all account from config.void
Clear all authentication information.void
Erase the call log.void
Erase all LDAP from the configuration.void
Clear all headers that were added withaddProvisioningHeader(java.lang.String, java.lang.String)
.void
Erase all proxies from config.Compress the log collection in a single file.int
Writes the config file to disk.void
Special function to configure audio session with default settings.createAccount
(AccountParams params) Create an account using given parameters, seecreateAccountParams()
.createAccountCreator
(String xmlrpcUrl) Create aAccountCreator
and set Linphone Request callbacks.Create an account params using default values from Linphone core.createAddress
(String address) Create aAddress
object by parsing the user supplied address, given as
a string.createCallLog
(Address from, Address to, Call.Dir dir, int duration, long startTime, long connectedTime, Call.Status status, boolean videoEnabled, float quality) Creates a fakeCallLog
.createCallParams
(Call call) Create aCallParams
suitable forinviteWithParams(java.lang.String, org.linphone.core.CallParams)
,
linphone_core_accept_call_with_params,
linphone_core_accept_early_media_with_params or
linphone_core_accept_call_update.createChatRoom
(String subject, Address[] participants) Deprecated.createChatRoom
(Address participant) Deprecated.createChatRoom
(ChatRoomParams params, String subject, Address[] participants) Deprecated.createChatRoom
(ChatRoomParams params, Address localAddr, String subject, Address[] participants) Deprecated.createChatRoom
(ChatRoomParams params, Address localAddr, Address participant) Deprecated.createChatRoom
(ChatRoomParams params, Address localAddr, Address[] participants) Create a chat room.createClientGroupChatRoom
(String subject, boolean fallback) Deprecated.createClientGroupChatRoom
(String subject, boolean fallback, boolean encrypted) Deprecated.createConferenceParams
(Conference conference) Create some default conference parameters for instanciating a conference with
createConferenceWithParams(org.linphone.core.ConferenceParams)
.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.Create a conference.createConfig
(String filename) Create aConfig
object from a user config file.Create a content with default values from Linphone core.Creates and returns the default chat room parameters.Create a default LinphoneFriend.Create a new emptyFriendList
object.createFriendWithAddress
(String address) Create aFriend
from the given address.Creates an empty info message.Create an empty LDAP search.Create a LDAP params using default values from Linphone core.createLdapWithParams
(LdapParams params) Create a LDAP search using given parameters and store them in the configuration
file.createLocalPlayer
(String soundCardName, String videoDisplayName, Object windowId) Create an independent media file player.Create aMagicSearch
object.Create a native window handle for the video preview window.Create a native window handle for the video window.Create a newNatPolicy
object with every policies being disabled.createNotify
(Address resource, String event) Create an out-of-dialog notification, specifying the destination resource, the
event name.createOneShotPublish
(Address resource, String event) Create a publish context for a one-shot publish.createPresenceActivity
(PresenceActivity.Type acttype, String description) Create aPresenceActivity
with the given type and description.Create a default LinphonePresenceModel.createPresenceModelWithActivity
(PresenceActivity.Type acttype, String description) Create aPresenceModel
with the given activity type and activity
description.createPresenceModelWithActivityAndNote
(PresenceActivity.Type acttype, String description, String note, String lang) Create aPresenceModel
with the given activity type, activity
description, note content and note language.createPresenceNote
(String content, String lang) Create aPresenceNote
with the given content and language.Create aPresencePerson
with the given id.createPresenceService
(String id, PresenceBasicStatus basicStatus, String contact) Create aPresenceService
with the given id, basic status and contact.Create a proxy config with default values from Linphone core.createPublish
(Address resource, String event, int expires) Create a publish context for an event state.createRecorder
(RecorderParams params) Create a media file recorder.Create a recorder params that will hold parameters.createSubscribe
(Address resource, String event, int expires) Create an outgoing subscription, specifying the destination resource, the event
name, and an optional content body.createSubscribe
(Address resource, ProxyConfig proxy, String event, int expires) Create an outgoing subscription, specifying the destination resource, the event
name, and an optional content body.Create aXmlRpcSession
for a given url.void
deleteChatRoom
(ChatRoom chatRoom) Removes a chatroom including all message history from the LinphoneCore.void
deleteConferenceInformation
(ConferenceInfo conferenceInfo) Deletes a conference information from DB.void
didRegisterForRemotePush
(Object deviceToken) Sets device_token when application
didRegisterForRemoteNotificationsWithDeviceToken (IOS only).void
didRegisterForRemotePushWithStringifiedToken
(String deviceTokenStr) Sets device_token when application
didRegisterForRemoteNotificationsWithDeviceToken (IOS only).void
disableChat
(Reason denyReason) Inconditionnaly disable incoming chat messages.void
Enable reception of incoming chat messages.void
Enable the linphone core log collection to upload logs on a server.void
Deprecated.09/03/2022 SeeprocessPushNotification(java.lang.String)
instead.void
This method is called by the application to notify the linphone core library
when it enters background mode.int
Deprecated.09/03/2021 UseConference.enter()
instead.void
This method is called by the application to notify the linphone core library
when it enters foreground mode.boolean
Returns whether a specific file format is supported.findAuthInfo
(String realm, String username, String sipDomain) Find authentication info matching realm, username, domain criteria.findCallFromUri
(String uri) Deprecated.27/10/2020.findCallLog
(String callId, int limit) Get the call log matching the call id, or null if can't be found.findCallLogFromCallId
(String callId) Get the call log matching the call id, or null if can't be found.findChatRoom
(Address peerAddr, Address localAddr) Deprecated.Retrieve the conference information linked to the provided URI if any.Address[]
findContactsByChar
(String filter, boolean sipOnly) Retrieves a list ofAddress
sort and filter.findFriend
(Address address) Search aFriend
by its address.findFriendByPhoneNumber
(String phoneNumber) Search aFriend
by its phone number.Friend[]
findFriends
(Address address) Search allFriend
matching an address.findOneToOneChatRoom
(Address localAddr, Address participantAddr, boolean encrypted) Deprecated.getAccountByIdkey
(String idkey) Search for aAccount
by it's idkey.Get theAccountCreator
backend set for theCore
.Get theAccountCreator
url on theCore
.Account[]
Returns an unmodifiable list of entered accounts.Returns which adaptive rate algorithm is currently configured for future calls.Returns a list of audio devices, with only the first device for each type To
have the list of all audio devices, usegetExtendedAudioDevices()
int
Get the DSCP field for outgoing audio streams.int
Returns the nominal audio jitter buffer size in milliseconds.Use to get multicast address to be used for audio stream.int
Use to get multicast ttl to be used for audio stream.Return the list of the available audio payload types.int
Gets the UDP port used for audio streaming.Get the audio port range from which is randomly chosen the UDP port used for
audio streaming.AuthInfo[]
Returns an unmodifiable list of currently enteredAuthInfo
.int
Gets the timer used to schedule the call to core.iterate() method when in
background (Android only).int
Gets the timer used to schedule the call to core.iterate() method when in
foreground (Android only).Return AVPF enablement.int
Return the avpf report interval in seconds.getCallByCallid
(String callId) Get the call by callid.getCallByRemoteAddress
(String remoteAddress) Deprecated.08/07/2020 usegetCallByRemoteAddress2(org.linphone.core.Address)
insteadgetCallByRemoteAddress2
(Address remoteAddress) Get the call with the specifiedAddress
.CallLog[]
getCallHistory
(Address peerAddress, Address localAddress) Get the list of call logs (past calls).CallLog[]
Get the list of call logs (past calls).Deprecated.07/12/2021: Use only for migration purposesCall[]
getCalls()
Gets the current list of calls.int
Get the number of Call.int
Get the camera sensor rotation.Gets the name of the currently assigned sound device for capture.boolean
Returns whether chat messages grouping is enabled or not.getChatRoom
(Address addr) Deprecated.getChatRoom
(Address peerAddr, Address localAddr) Deprecated.Deprecated.ChatRoom[]
Returns a list of chat rooms.Deprecated.Retrieve the list of conference information on DB.getConferenceInformationListAfterTime
(long time) Retrieve the list of conference information on DB after a certain time.float
Get the set input volume of the local participant.Tells whether the default conference participant list is open or closed.int
Deprecated.16/04/2021 UseConference.getParticipantCount()
instead.Returns the config object used to manage the storage (config) file.Get my consolidated presence.Gets the current call.Get the remote address of the current call.Get the effective video definition provided by the camera for the captured
video.Returns the default account, that is the one used to determine the current
identity.Gets the default conference layout @core core the linphone core.long
Gets the default lifetime of ephemeral messages in seconds @core core the
linphone core.Retrieves the first list ofFriend
from the core.Gets the default input audio device.Gets the default output audio device.Returns the default proxy configuration, that is the one used to determine the
current identity.Get the name of the default mediastreamer2 filter used for rendering video on
the current platform.int
Gets the delayed timeout SeesetDelayedTimeout(int)
for details.int
Gets the current device orientation.Get the current digest authentication policy applicable for SIP and HTTP.boolean
Get whether the microphone will be completely deactivated when muted.boolean
Tells if the DNS was set by an application.int
Retrieve the maximum available download bandwidth.int
Get audio packetization time linphone expects to receive from peer.int
Gets the currently stored calibration delay for the software echo cancellation.Get the name of the mediastreamer2 filter used for echo cancelling.Returns the list of all audio devices.Get the globaly set http file transfer server to be used for content type
application/vnd.gsma.rcs-ft-http+xml.getFriendByRefKey
(String key) Search aFriend
by its reference key.getFriendListByName
(String name) Retrieves the list ofFriend
from the core that has the given display
name.Gets the database filename where friends will be stored.Retrieves the list ofFriendList
from the core.Retrieve the list of future conference information on DB.Returns the global state of core.boolean
Returns true if hostname part of primary contact is guessed automatically.Get http proxy address to be used for signaling.int
Get http proxy port to be used for signaling.Gets the default identity SIP address.Get theImNotifPolicy
object controlling the instant messaging
notifications.int
Gets the in call timeout SeesetInCallTimeout(int)
for details.int
Returns the incoming call timeout SeesetIncTimeout(int)
for details.Gets the input audio device for the current call.getLabel()
Get the label assigned to the LinphoneCore.Get the latest outgoing call log.Ldap[]
Returns a list of entered LDAPs.Deprecated.26/08/2022 UseAccountParams.getLimeServerUrl()
instead.String[]
Get the list of linphone specs string values representing what functionalities
the linphone client supports.String[]
Return the list of loaded plugins.int
Get the max file size in bytes of the files used for log collection.Get the path where the log files will be written for log collection.Get the prefix of the filenames that will be used for log collection.Gets the url of the server where to upload the collected log files.int
Get the maximum number of simultaneous calls Linphone core can manage at a
time.int
Gets the size under which incoming files in chat messages will be downloaded
automatically.Gets the name of the currently assigned sound device for media.Get the media encryption policy being used for RTP packets.This function returns the media resource mode for this core.Gets the mediastreamer's factoryfloat
Get microphone gain in db.int
Get the number of missed calls.int
getMtu()
Returns the maximum transmission unit size in bytes.Deprecated.12/10/2022long
Gets the native pointer used by this class to make native method calls.Get the native window handle of the video preview window.Get the native window handle of the video window.Get The policy that is used to pass through NATs/firewalls.int
Gets the value of the no-rtp timeout.Gets the output audio device for the current call.getPayloadType
(String type, int rate, int channels) Get payload type from mime type and clock rate.Gets the name of the currently assigned sound device for playback.float
Get playback gain in db before entering sound card.Get the wav file that is played when putting somebody on hold, or when files
are used instead of soundcards (seesetUseFiles(boolean)
).boolean
Are PostQuantum algoritms available.float
Returns the preferred video framerate, previously set bysetPreferredFramerate(float)
.Get the preferred video definition for the stream that is captured and sent to
the remote party.Get my presence model.Get the definition of the captured video.Returns the default identity when no proxy configuration is used.Deprecated.22/10/2018 UsecreatePrimaryContactParsed()
instead.Get provisioning URI.getProxyConfigByIdkey
(String idkey) Search for aProxyConfig
by it's idkey.Returns an unmodifiable list of entered proxy configurations.int
Returns the push incoming call timeout SeesetPushIncomingCallTimeout(int)
for details.Gets the push notification configuration object if it exists.Get the wav file where incoming stream is recorded, when files are used instead
of soundcards (seesetUseFiles(boolean)
).Get the ring back tone played to far end during incoming calls.getRing()
Returns the path to the wav file used for ringing.Returns the path to the wav file used for ringing back.boolean
Tells whether the ring play is enabled during an incoming early media call.Gets the name of the currently assigned sound device for ringing.Gets the path to a file or folder containing the trusted root CAs (PEM format)
int
Returns the session expires min value, 90 by default.Returns the session expires refresher value.int
Returns the session expires value.int
Get the DSCP field for SIP signaling channel.int
Get the SIP transport timeout, which represents the maximum time permitted to
establish a connection to a SIP server.String[]
Deprecated.10/04/2021 UsegetAudioDevices()
instead.Get the crypto suites available to the core.Get the path to the image file streamed when "Static picture" is set as the
video device.float
Get the frame rate for static picture.Get the STUN server address being used.String[]
Returns a null terminated table of strings containing the file format extension
supported for call recording.Get the support level of the 100rel attribute.Return the list of the available text payload types.int
Gets the UDP port used for text streaming.Get the text port range from which is randomly chosen the UDP port used for
text streaming.Gets the TLS certificate.Gets the path to the TLS certificate file.Gets the TLS key.Gets the path to the TLS key file.Retrieves the port configuration used for each transport (udp, tcp, tls).Retrieves the real port number assigned for each sip transport (udp, tcp, tls).get tunnel instance if available
int
Return the global unread chat message count.int
Return the unread chat message count for all active local address.int
Return the unread chat message count for a given local address.int
Retrieve the maximum available upload bandwidth.int
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.Return the external ip address of router.Return the internal state of uPnP.boolean
Gets whether linphone is currently streaming audio from and to files, rather
than using the soundcard.boolean
Indicates whether SIP INFO is used to send digits.Gets the user-agent as a string.Get the path to the directory storing the user's certificates.Gets the object stored in this object user's databoolean
Indicates whether RFC2833 is used to send digits.Returns liblinphone's version as a string.Get the default policy for video.Get the current priority policy for video codecs (payload types).Returns the name of the currently active video device.String[]
Gets the list of the available video capture devices.Get the name of the mediastreamer2 filter used for rendering video.int
Get the DSCP field for outgoing video streams.int
Returns the nominal video jitter buffer size in milliseconds.Use to get multicast address to be used for video stream.int
Use to get multicast ttl to be used for video stream.Return the list of the available video payload types.int
Gets the UDP port used for video streaming.Get the video port range from which is randomly chosen the UDP port used for
video streaming.Get the video preset used for video calls.Return the list of the available ZRTP key agreement algorithns.Return the ordonated list of the ZRTP key agreement algorithns currently
configured.Get the path to the file storing the zrtp secrets cache.getZrtpStatus
(String addr) Get the zrtp sas validation status for a peer uri.boolean
Check whether the device has a hardware echo canceller.boolean
Check whether the device is flagged has crappy opengl.boolean
inCall()
Tells whether there is a call running.interpretUrl
(String url) Deprecated.on 18/07/2022, useinterpretUrl(java.lang.String)
instead.interpretUrl
(String url, boolean applyInternationalPrefix) Constructs aAddress
from the given string if possible.Initiates an outgoing call.inviteAddress
(Address addr) Initiates an outgoing call given a destinationAddress
TheAddress
can be constructed directly usingFactory.createAddress(java.lang.String)
, or created by
interpretUrl(java.lang.String)
.inviteAddressWithParams
(Address addr, CallParams params) Initiates an outgoing call given a destinationAddress
TheAddress
can be constructed directly usingFactory.createAddress(java.lang.String)
, or created by
interpretUrl(java.lang.String)
.inviteAddressWithParams
(Address addr, CallParams params, String subject, Content content) Initiates an outgoing call given a destinationAddress
TheAddress
can be constructed directly usingFactory.createAddress(java.lang.String)
, or created by
interpretUrl(java.lang.String)
.inviteWithParams
(String url, CallParams params) Initiates an outgoing call according to supplied call parameters The
application doesn't own a reference to the returnedCall
object.boolean
Returns whether adaptive rate control is enabled.boolean
Tells whether the experimental software Automatic Gain Control is activated.boolean
Returns whether alert reporting is enabled.boolean
Tells whether the audio adaptive jitter compensation is enabled.boolean
Use to get multicast state of audio stream.boolean
Gets if the auto download for incoming icalendars is enabled or not.boolean
Gets if the auto download for incoming voice recordings is enabled or not.boolean
Gets whether auto iterate is enabled or not (Android & iOS only).boolean
Returns whether automatic http proxy is enabled.boolean
Gets if the automatic sending of 180 Ringing is enabled or not.boolean
Special function to check if the callkit is enabled, False by default.boolean
Check whether tone indications of calls are enabled.boolean
Check if the capability negotiation (RFC5939) is supported or not.boolean
Check if the capability negotiation (RFC5939) reINVITE is enabled or not.boolean
Check if cfg lines are going to the merged if the capability negotiation
(RFC5939) is supported or not.boolean
Returns whether chat is enabled.boolean
Gets wether conference invitations will be sent in the chat message body or as
a file attachment.boolean
Tells whether the conference server feature is enabled.boolean
isContentTypeSupported
(String contentType) Tells whether a content type is supported.boolean
Tells whether DNS search (use of local domain if the fully qualified name did
return results) is enabled.boolean
Tells whether DNS SRV resolution is enabled.boolean
Returns true if echo cancellation is enabled.boolean
Check whether the device is echo canceller calibration is required.boolean
Tells whether echo limiter is enabled.boolean
Indicates whether the ICE relay path is forcibly selected.boolean
Returns whether or not friend lists subscription are enabled.boolean
Returns enablement of RFC3389 generic comfort noise algorithm.boolean
Gets whether the Core is considering itself in background or not.boolean
Tells whether there is an incoming invite pending.boolean
Deprecated.09/03/2021 UseConference.isIn()
instead.boolean
Tells whether IPv6 is enabled or not.boolean
Is signaling keep alive enabled.boolean
Tells wether LIME X3DH is enabled or not.boolean
Special function to check if the local network permission has been granted by
the user (useful for iOS).boolean
Check if the configured media encryption is mandatory or not.boolean
Check if media encryption is supported.boolean
isMediaFilterSupported
(String filtername) Checks if the given media filter is loaded and usable.boolean
Tells whether the microphone is enabled.boolean
Returns whether the native ringing is enabled or not.boolean
return network state either as positioned by the application or by linphone
itself.boolean
isPluginLoaded
(String name) Tells whether a plugin is loaded or not.boolean
Gets whether push notifications are available or not (Android & iOS only).boolean
Gets whether push notifications are enabled or not (Android & iOS only).boolean
Tells whether QRCode is enabled in the preview.boolean
Gets if realtime text is enabled or not.boolean
Gets if the record aware feature is enabled or not.boolean
Tells whether NACK context is enabled or not.boolean
Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.boolean
Media offer control param for SIP INVITE.boolean
Tells whether video self view during call is enabled or not.boolean
Returns whether or not sender name is hidden in forward message.boolean
Check if the Session Timers feature is enabled.boolean
Check if tcap lines are going to the merged if the capability negotiation
(RFC5939) is supported or not.boolean
Get whether the tls server certificate must be verified when connecting to a
SIP/TLS server.boolean
Get whether the tls server certificate common name must be verified when
connecting to a SIP/TLS server.boolean
Gets whether the device will vibrate while an incoming call is ringing (Android
only).boolean
Tells whether the video adaptive jitter compensation is enabled.boolean
Tells whether video capture is enabled.boolean
Tells whether video display is enabled.boolean
Returns true if either capture or display is enabled, false otherwise.boolean
Use to get multicast state of video stream.boolean
Tells whether video preview is enabled.boolean
Tells whether Wifi only mode is enabled or not.boolean
Check if RTP port is set to 0 when a stream is inactive.boolean
Check if the ZRTP go clear is enabled or not.void
iterate()
Main loop function.boolean
Tells if LDAP is available.int
Deprecated.09/03/2021 UseConference.leave()
instead.boolean
Tells if LIME X3DH is available.void
loadConfigFromXml
(String xmlUri) Update current config with the content of a xml config file.Tells whether the linphone core log collection is enabled.boolean
Check if a media encryption type is supported.void
Migrates the call logs from the linphonerc to the database if not done yet.int
Migrate configuration so that all SIP transports are enabled.void
notifyAllFriends
(PresenceModel presence) Notify all friends that have subscribed.void
notifyNotifyPresenceReceived
(Friend linphoneFriend) Notifies the upper layer that a presence status has been received by calling
the appropriate callback if one has been set.void
notifyNotifyPresenceReceivedForUriOrTel
(Friend linphoneFriend, String uriOrTel, PresenceModel 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.int
Pause all currently running calls.void
playDtmf
(char dtmf, int durationMs) Plays a dtmf sound to the local user.int
Plays an audio file to the local user.int
Empties sound resources to allow a new call to be accepted.void
Call generic OpenGL render for a given core.void
processPushNotification
(String callId) Call this method when you receive a push notification (if you handle push
notifications manually).Publish an event state.int
Gets keep alive interval of real time text.void
realtimeTextSetKeepaliveInterval
(int interval) Set keep alive interval for real time text.void
force registration refresh to be initiated upon next iterate
void
rejectSubscriber
(Friend linphoneFriend) Black list a friend.void
reloadMsPlugins
(String path) Reload mediastreamer2 plugins from specified directory.void
Update detection of sound devices.void
Update detection of camera devices.void
removeAccount
(Account account) Removes an account.void
removeAuthInfo
(AuthInfo info) Removes an authentication information object.void
removeCallLog
(CallLog callLog) Remove a specific call log from call history list.void
removeContentTypeSupport
(String contentType) Remove support for the specified content type.void
removeFriendList
(FriendList list) Removes a friend list.int
removeFromConference
(Call call) Remove a call from the conference.void
removeLdap
(Ldap ldap) Remove a LDAP from the configuration.void
removeLinphoneSpec
(String spec) Remove the given linphone specs from the list of functionalities the linphone
client supports.void
removeListener
(CoreListener listener) void
removeProxyConfig
(ProxyConfig config) Removes a proxy configuration.void
removeSupportedTag
(String tag) Remove a supported tag.void
Clears all state resulting from a previous echo canceller calibration
procedure, which restores default policy and settings for echo cancellation.void
Reset the log collection by removing the log files.void
Reset the counter of missed calls.searchChatRoom
(ChatRoomParams params, Address localAddr, Address remoteAddr, Address[] participants) Find a chat room.searchConference
(Address conferenceAddr) Find a conference.searchConference
(ConferenceParams params, Address localAddr, Address remoteAddr, Address[] participants) Find a conference.void
Enable logs serialization (output logs from either the thread that creates the
linphone core or the thread that callsiterate()
).void
Set theAccountCreator
backend on theCore
.void
Set theAccountCreator
url on theCore
.void
setAdaptiveRateAlgorithm
(String algorithm) Sets adaptive rate algorithm.void
setAdaptiveRateControlEnabled
(boolean enabled) Enable adaptive rate control.void
setAgcEnabled
(boolean val) Enable the experimental software Automatic Gain Control.void
setAlertsEnabled
(boolean enable) Enable alerts.void
setAudioAdaptiveJittcompEnabled
(boolean enable) Enable or disable the audio adaptive jitter compensation.void
setAudioDscp
(int dscp) Set the DSCP field for outgoing audio streams.void
setAudioJittcomp
(int milliseconds) Sets the nominal audio jitter buffer size in milliseconds.int
Use to set multicast address to be used for audio stream.void
setAudioMulticastEnabled
(boolean yesno) Use to enable multicast rtp for audio stream.int
setAudioMulticastTtl
(int ttl) Use to set multicast ttl to be used for audio stream.void
setAudioPayloadTypes
(PayloadType[] payloadTypes) Redefine the list of the available payload types.void
setAudioPort
(int port) Sets the UDP port used for audio streaming.void
setAudioPortRange
(int minPort, int maxPort) Sets the UDP port range from which to randomly select the port used for audio
streaming.void
setAutoDownloadIcalendarsEnabled
(boolean autoDownloadIcalendars) Auto download files attach to a chat message if it's content type matches the
one we use for icalendars.void
setAutoDownloadVoiceRecordingsEnabled
(boolean autoDownloadVoiceRecordings) Auto download files attach to a chat message if it's content type matches the
one we use for voice recordings.void
setAutoIterateBackgroundSchedule
(int schedule) Sets the timer used to schedule the call to core.iterate() method when in
background (Android only).void
setAutoIterateEnabled
(boolean enable) Enable or disable the automatic schedule ofiterate()
method on Android
& iOS.void
setAutoIterateForegroundSchedule
(int schedule) Sets the timer used to schedule the call to core.iterate() method when in
foreground (Android only).void
setAutomaticHttpProxyDetectionEnabled
(boolean enable) Enables or disables automatic http proxy detection.void
setAutoSendRingingEnabled
(boolean enable) Enables the automatic sending of 180 Ringing when receiving a call.void
setAvpfMode
(AVPFMode mode) Enable RTCP feedback (also known as RTP/AVPF profile).void
setAvpfRrInterval
(int interval) Set the avpf report interval in seconds.void
setCallkitEnabled
(boolean enabled) Special function to enable the callkit.void
Deprecated.07/12/2021: Use only for migration purposesvoid
setCallToneIndicationsEnabled
(boolean yesno) Enables or disables call tone indications.void
setCapabilityNegociationEnabled
(boolean enable) Define whether capability negotiation (RFC5939) is supported.void
setCapabilityNegotiationReinviteEnabled
(boolean enable) Define whether capability negotiation (RFC5939) reINVITE is enabled.int
setCaptureDevice
(String devid) Sets the sound device used for capture.void
setCfgLinesMergingEnabled
(boolean merge) Define whether cfg lines are going to be merged if capability negotiation
(RFC5939) is supported.void
setChatMessagesAggregationEnabled
(boolean enabled) Sets whether chat messages grouping is enabled or not.void
setConferenceIcsInMessageBodyEnabled
(boolean enable) Enable sending conference invitations in the chat message body instead of as a
file attachment.void
Select whether the default conference participant list is open or closed.void
setConferenceServerEnabled
(boolean enable) Enable the conference server feature.void
setConsolidatedPresence
(ConsolidatedPresence presence) Set my consolidated presence.void
setDefaultAccount
(Account account) Sets the default account.void
Set the default conference layout.void
setDefaultEphemeralLifetime
(long value) Set the default ephemeral lifetime in seconds.void
setDefaultInputAudioDevice
(AudioDevice audioDevice) Sets the givenAudioDevice
as default input for next calls.void
setDefaultOutputAudioDevice
(AudioDevice audioDevice) Sets the givenAudioDevice
as default output for next calls.void
setDefaultProxyConfig
(ProxyConfig config) Sets the default proxy.void
setDelayedTimeout
(int seconds) Set the in delayed timeout in seconds.void
setDeviceRotation
(int rotation) Tells the core the device current orientation.void
Setup a new digest authentication policy applicable for SIP and HTTP.void
setDisableRecordOnMute
(boolean disable) Calling this method with disable=true will cause the microhone to be completely
deactivated when muted, when given possible by the implementation on the
platform on which liblinphone is running.void
setDnsSearchEnabled
(boolean enable) Enable or disable DNS search (use of local domain if the fully qualified name
did return results).void
setDnsServers
(String[] servers) Forces liblinphone to use the supplied list of dns servers, instead of system's
ones.void
setDnsServersApp
(String[] servers) 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.void
setDnsSrvEnabled
(boolean enable) Enable or disable DNS SRV resolution.void
setDownloadBandwidth
(int bandwidth) Sets maximum available download bandwidth This is IP bandwidth, in kbit/s.void
setDownloadPtime
(int ptime) Set audio packetization time linphone expects to receive from peer.void
setEchoCancellationEnabled
(boolean enable) Enables or disable echo cancellation.void
setEchoCancellerFilterName
(String filtername) Set the name of the mediastreamer2 filter to be used for echo cancelling.void
setEchoLimiterEnabled
(boolean enable) Enables or disable echo limiter.void
setEnableSipUpdate
(int value) Enable or disable the UPDATE method support.void
setExpectedBandwidth
(int bandwidth) Sets expected available upload bandwidth This is IP bandwidth, in kbit/s.void
setFileTransferServer
(String serverUrl) Globaly set an http file transfer server to be used for content type
application/vnd.gsma.rcs-ft-http+xml.void
setForcedIceRelayEnabled
(boolean enable) Artificially cause the relay path to be selected when ICE is used.void
setFriendListSubscriptionEnabled
(boolean enable) Sets whether or not to start friend lists subscription when in foreground.void
setFriendsDatabasePath
(String path) Sets the database filename where friends will be stored.void
setGenericComfortNoiseEnabled
(boolean enabled) Enable RFC3389 generic comfort noise algorithm (CN payload type).void
setGuessHostname
(boolean enable) TellsCore
to guess local hostname automatically in primary contact.void
setHttpProxyHost
(String host) Set http proxy address to be used for signaling during next channel connection.void
setHttpProxyPort
(int port) Set http proxy port to be used for signaling.void
setInCallTimeout
(int seconds) Set the in call timeout in seconds.void
setIncTimeout
(int seconds) Set the incoming call timeout in seconds.void
setInputAudioDevice
(AudioDevice audioDevice) Sets the givenAudioDevice
as input for all active calls.void
setIpv6Enabled
(boolean enable) Turns IPv6 support on or off.void
setKeepAliveEnabled
(boolean enable) Enables signaling keep alive, small udp packet sent periodically to keep udp
NAT association.void
Set a label - for logging/troubleshooting purpose - to the core object.void
setLimeX3DhEnabled
(boolean enable) Tells to LinphoneCore to use LIME X3DH.void
Deprecated.26/08/2022 UseAccountParams.setLimeServerUrl(java.lang.String)
instead.void
setLinphoneSpecsList
(String[] specs) Set the linphone specs list value telling what functionalities the linphone
client supports.void
setLogCollectionMaxFileSize
(int size) Set the max file size in bytes of the files used for log collection.void
setLogCollectionPath
(String path) Set the path of a directory where the log files will be written for log
collection.void
setLogCollectionPrefix
(String prefix) Set the prefix of the filenames that will be used for log collection.void
setLogCollectionUploadServerUrl
(String serverUrl) Set the url of the server where to upload the collected log files.void
setMaxCalls
(int max) Set the maximum number of simultaneous calls Linphone core can manage at a
time.void
setMaxSizeForAutoDownloadIncomingFiles
(int size) Sets the size under which incoming files in chat messages will be downloaded
automatically.int
setMediaDevice
(String devid) Sets the sound device used for media.int
Choose the media encryption policy to be used for RTP packets.void
setMediaEncryptionMandatory
(boolean mandatory) 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.void
setMediaNetworkReachable
(boolean reachable) This method is called by the application to notify the linphone core library
when the media (RTP) network is reachable.void
Sets the media resources mode.void
setMicEnabled
(boolean enable) Enable or disable the microphone.void
setMicGainDb
(float level) Allow to control microphone level: gain in db.void
setMtu
(int mtu) Sets the maximum transmission unit size in bytes.void
setNatAddress
(String addr) Deprecated.12/10/2022void
setNativePreviewWindowId
(Object windowId) Set the native window id where the preview video (local camera) is to be
displayed.void
setNativeRingingEnabled
(boolean enable) Sets whether to use the native ringing (Android only).void
setNativeVideoWindowId
(Object windowId) Set the native video window id where the video is to be displayed.void
setNatPolicy
(NatPolicy policy) Set the policy to use to pass through NATs/firewalls.void
setNetworkReachable
(boolean reachable) This method is called by the application to notify the linphone core library
when network is reachable.void
setNortpTimeout
(int seconds) Sets the no-rtp timeout value in seconds.void
setOutputAudioDevice
(AudioDevice audioDevice) Sets the givenAudioDevice
as output for all active calls.int
setPlaybackDevice
(String devid) Sets the sound device used for playback.void
setPlaybackGainDb
(float level) Allow to control play level before entering sound card: gain in db.void
setPlayFile
(String file) Sets a wav file to be played when putting somebody on hold, or when files are
used instead of soundcards (seesetUseFiles(boolean)
).void
setPreferredFramerate
(float fps) Set the preferred frame rate for video.void
setPreferredVideoDefinition
(VideoDefinition videoDefinition) Set the preferred video definition for the stream that is captured and sent to
the remote party.void
Sets the preferred video definition by its name.void
setPresenceModel
(PresenceModel presence) Set my presence model.void
setPreviewVideoDefinition
(VideoDefinition videoDefinition) Set the video definition for the captured (preview) video.void
int
setPrimaryContact
(String contact) Sets the local "from" identity.int
setProvisioningUri
(String uri) Set URI where to download xml configuration file at startup.void
setPushIncomingCallTimeout
(int seconds) Configure the minimum interval between a push notification and the
corresponding incoming INVITE.void
setPushNotificationEnabled
(boolean enable) Enable or disable push notifications on Android & iOS.void
setQrcodeDecodeRect
(int x, int y, int w, int h) Set the rectangle where the decoder will search a QRCode.void
setQrcodeVideoPreviewEnabled
(boolean enable) Controls QRCode enablement.void
setRecordAwareEnabled
(boolean enable) Enables the record aware feature that will warn other users when recording.void
setRecordFile
(String file) Sets a wav file where incoming stream is to be recorded, when files are used
instead of soundcards (seesetUseFiles(boolean)
).void
setRemoteRingbackTone
(String ring) Specify a ring back tone to be played to far end during incoming calls.void
setRetransmissionOnNackEnabled
(boolean enable) Turns NACK context on or off.void
Sets the path to a wav file used for ringing.void
setRingback
(String path) Sets the path to a wav file used for ringing back.void
setRingDuringIncomingEarlyMedia
(boolean enable) Enable or disable the ring play during an incoming early media call.int
setRingerDevice
(String devid) Sets the sound device used for ringing.void
Sets the path to a file or folder containing trusted root CAs (PEM format)
void
setRootCaData
(String data) Sets the trusted root CAs (PEM format)
void
setRtpBundleEnabled
(boolean value) Enables or disables RTP bundle mode (Media Multiplexing).void
setSdp200AckEnabled
(boolean enable) Control when media offer is sent in SIP INVITE.void
setSelfViewEnabled
(boolean enable) Enables or disable self view during calls.void
setSenderNameHiddenInForwardMessageEnabled
(boolean enable) Enable whether or not to hide sender name in forward message.void
setSessionExpiresEnabled
(boolean enabled) Enable the Session Timers support.void
setSessionExpiresMinValue
(int min) Sets the session expires minSE value, forced to a minimum of 90 by default.void
Sets the session expires refresher value.void
setSessionExpiresValue
(int expires) Sets the session expires value, 0 by default.void
setSipDscp
(int dscp) Set the DSCP field for SIP signaling channel.void
setSipNetworkReachable
(boolean reachable) This method is called by the application to notify the linphone core library
when the SIP network is reachable.void
setSipTransportTimeout
(int timeoutMs) Set the SIP transport timeout, which represents the maximum time permitted to
establish a connection to a SIP server.void
setSrtpCryptoSuites
(String suites) Set the crypto suites available to the core.int
setStaticPicture
(String path) Set the path to the image file to stream when "Static picture" is set as the
video device.int
setStaticPictureFps
(float fps) Set the frame rate for static picture.void
setStunServer
(String server) Set the STUN server address to use when the firewall policy is set to STUN.void
setSupportedTag
(String tags) Set the supported tags.void
Define what level of support is provided to the 100rel attribute.void
setTcapLineMergingEnabled
(boolean merge) Define whether tcap lines are going to be merged if capability negotiation
(RFC5939) is supported.void
setTextPayloadTypes
(PayloadType[] payloadTypes) Redefine the list of the available payload types.void
setTextPort
(int port) Sets the UDP port used for text streaming.void
setTextPortRange
(int minPort, int maxPort) Sets the UDP port range from which to randomly select the port used for text
streaming.void
setTlsCert
(String tlsCert) Sets a TLS certificate used for TLS authentication The certificate won't be
stored, you have to set it after eachCore
startup.void
setTlsCertPath
(String tlsCertPath) Sets a TLS certificate path used for TLS authentication The path will be stored
in the rc file and automatically restored on startup.void
Sets a TLS key used for TLS authentication The key won't be stored, you have to
set it after eachCore
startup.void
setTlsKeyPath
(String tlsKeyPath) Sets a TLS key path used for TLS authentication The path will be stored in the
rc file and automatically restored on startup.void
Assign an audio file to be played as a specific tone id.int
setTransports
(Transports transports) Sets the ports to be used for each of transport (UDP or TCP) A zero value port
for a given transport means the transport is not used.void
setUploadBandwidth
(int bandwidth) Sets maximum available upload bandwidth This is IP bandwidth, in kbit/s.void
setUploadPtime
(int ptime) 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.void
setUseFiles
(boolean yesno) Ask the core to stream audio from and to files, instead of using the soundcard.void
setUseInfoForDtmf
(boolean useInfo) Sets whether SIP INFO is to be used to send digits.void
setUserAgent
(String name, String version) Set the user agent string used in SIP messages.void
Set the path to the directory storing the user's x509 certificates (used by
dtls)
void
setUserData
(Object data) Sets the object to store in this object user's datavoid
setUseRfc2833ForDtmf
(boolean useRfc2833) Sets whether RFC2833 is to be used to send digits.void
setVibrationOnIncomingCallEnabled
(boolean enable) Enable vibration will incoming call is ringing (Android only).void
Sets the default policy for video.void
setVideoAdaptiveJittcompEnabled
(boolean enable) Enable or disable the video adaptive jitter compensation.void
setVideoCaptureEnabled
(boolean enable) Enable or disable video capture.void
Set the priority policy for video codecs (payload types).int
setVideoDevice
(String id) Sets the active video device.void
setVideoDisplayEnabled
(boolean enable) Enable or disable video display.void
setVideoDisplayFilter
(String filterName) Set the name of the mediastreamer2 filter to be used for rendering video.void
setVideoDscp
(int dscp) Set the DSCP field for outgoing video streams.void
setVideoJittcomp
(int milliseconds) Sets the nominal video jitter buffer size in milliseconds.int
Use to set multicast address to be used for video stream.void
setVideoMulticastEnabled
(boolean yesno) Use to enable multicast rtp for video stream.int
setVideoMulticastTtl
(int ttl) Use to set multicast ttl to be used for video stream.void
setVideoPayloadTypes
(PayloadType[] payloadTypes) Redefine the list of the available video payload types.void
setVideoPort
(int port) Sets the UDP port used for video streaming.void
setVideoPortRange
(int minPort, int maxPort) Sets the UDP port range from which to randomly select the port used for video
streaming.void
setVideoPreset
(String preset) Set the video preset to be used for video calls.void
setVideoPreviewEnabled
(boolean enable) Controls video preview enablement.void
setVideoSourceReuseEnabled
(boolean enable) Enable or disable video source reuse when switching from preview to actual
video call.void
setWifiOnlyEnabled
(boolean enable) Turns Wifi only mode on or off.void
setZeroRtpPortForStreamInactiveEnabled
(boolean enable) Define whether RTP port is set to 0 when a stream is inactive.void
setZrtpGoClearEnabled
(boolean enabled) Define whether ZRTP go clear is enabled.void
setZrtpKeyAgreementSuites
(ZrtpKeyAgreement[] keyAgreements) Redefine the list of prefered ZRTP key agreement algorithms.void
setZrtpSecretsFile
(String file) Set the path to the file storing the zrtp secrets cache.boolean
soundDeviceCanCapture
(String device) Deprecated.08/07/2020 useAudioDevice
API instead()boolean
soundDeviceCanPlayback
(String device) Deprecated.08/07/2020 useAudioDevice
API instead()boolean
Check if a call will need the sound resources in near future (typically an
outgoing call that is awaiting response).int
start()
Start aCore
object after it has been instantiated and not
automatically started.int
Deprecated.14/09/2021 UseConference.startRecording(java.lang.String)
instead.int
Starts an echo calibration of the sound devices, in order to find adequate
settings for the echo canceler automatically.int
startEchoTester
(int rate) Start the simulation of call to test the latency with an external device.void
stop()
Stop aCore
object after it has been instantiated and started.void
Stop asynchronously aCore
object after it has been instantiated and
started.int
Deprecated.14/09/2021 UseConference.stopRecording()
instead.void
stopDtmf()
Stops playing a dtmf started byplayDtmf(char, int)
.int
Stop the simulation of call.void
Whenever the liblinphone is playing a ring to advertise an incoming call or
ringback of an outgoing call, this function stops the ringing.Create an outgoing subscription, specifying the destination resource, the event
name, and an optional content body.int
takePreviewSnapshot
(String file) Take a photo of currently from capture device and write it into a jpeg file.int
Terminates all the calls.int
Terminate the running conference.toString()
boolean
True if tunnel support was compiled.void
Upload the log collection to the configured server url.boolean
Return the availability of uPnP.void
usePreviewWindow
(boolean yesno) Tells the core to use a separate window for local camera preview video, instead
of inserting local view within the remote video window.boolean
Tells whether VCARD support is builtin.void
verifyServerCertificates
(boolean yesno) Specify whether the tls server certificate must be verified when connecting to
a SIP/TLS server.void
verifyServerCn
(boolean yesno) Specify whether the tls server certificate common name must be verified when
connecting to a SIP/TLS server.boolean
Test if video is supported.
-
Method Details
-
getMediastreamerFactory
Factory getMediastreamerFactory()Gets the mediastreamer's factory -
getAccountCreatorBackend
AccountCreator.Backend getAccountCreatorBackend()- Returns:
- The
AccountCreator#Backend
-
setAccountCreatorBackend
- Parameters:
backend
- TheAccountCreator#Backend
-
getAccountCreatorUrl
- Returns:
- url The URL to reach.
-
setAccountCreatorUrl
- Parameters:
url
- The URL to reach
-
getAccountList
Returns an unmodifiable list of entered accounts.
- Returns:
-
getAdaptiveRateAlgorithm
Returns which adaptive rate algorithm is currently configured for future calls.
see:setAdaptiveRateAlgorithm(java.lang.String)
- Returns:
- the adaptive rate algorithm. Currently two values are supported:
'advanced', which is the default value, or 'basic'.
-
setAdaptiveRateAlgorithm
Sets adaptive rate algorithm.
It will be used for each new calls starting from now. Calls already started
will not be updated.- Parameters:
algorithm
- the adaptive rate control algorithm. Currently two values are
supported: 'advanced', which is the default value, or 'basic'.
-
isAdaptiveRateControlEnabled
boolean isAdaptiveRateControlEnabled()Returns whether adaptive rate control is enabled.
see:#enableAdaptiveRateControl
- Returns:
- true if adaptive rate control is enabled, false otherwise
-
setAdaptiveRateControlEnabled
void setAdaptiveRateControlEnabled(boolean enabled) Enable adaptive rate control.
Adaptive rate control consists in using RTCP feedback provided information to
dynamically control the output bitrate of the audio and video encoders, so that
we can adapt to the network conditions and available bandwidth. Control of the
audio encoder is done in case of audio-only call, and control of the video
encoder is done for audio & video calls. Adaptive rate control feature is
enabled by default.- Parameters:
enabled
- true to enable adaptive rate control, false otherwise
-
isAgcEnabled
boolean isAgcEnabled()Tells whether the experimental software Automatic Gain Control is activated.
This algorithm is very experimental, not usable in its current state.- Returns:
- true if the AGC is enabled, false otherwise.
-
setAgcEnabled
void setAgcEnabled(boolean val) Enable the experimental software Automatic Gain Control.
This algorithm is very experimental, not usable in its current state. Automatic
Gain Control is usally provided by sound devices, typically on iOS and Android.- Parameters:
val
- a boolean value
-
isAlertsEnabled
boolean isAlertsEnabled()- Returns:
- whether alert reporting is enabled.
-
setAlertsEnabled
void setAlertsEnabled(boolean enable) - Parameters:
enable
- whether alert reporting is enabled or not.
-
isAudioAdaptiveJittcompEnabled
boolean isAudioAdaptiveJittcompEnabled()Tells whether the audio adaptive jitter compensation is enabled.
- Returns:
- true if the audio adaptive jitter compensation is enabled, false
otherwise.
-
setAudioAdaptiveJittcompEnabled
void setAudioAdaptiveJittcompEnabled(boolean enable) Enable or disable the audio adaptive jitter compensation.
- Parameters:
enable
- true to enable the audio adaptive jitter compensation, false to
disable it.
-
getAudioDevices
Returns a list of audio devices, with only the first device for each type To
have the list of all audio devices, usegetExtendedAudioDevices()
- Returns:
- A list with the first
AudioDevice
of each type
-
getAudioDscp
int getAudioDscp()Get the DSCP field for outgoing audio streams.
The DSCP defines the quality of service in IP packets.- Returns:
- The current DSCP value
-
setAudioDscp
void setAudioDscp(int dscp) Set the DSCP field for outgoing audio streams.
The DSCP defines the quality of service in IP packets.- Parameters:
dscp
- The DSCP value to set
-
getAudioJittcomp
int getAudioJittcomp()Returns the nominal audio jitter buffer size in milliseconds.
- Returns:
- The nominal audio jitter buffer size in milliseconds
-
setAudioJittcomp
void setAudioJittcomp(int milliseconds) Sets the nominal audio jitter buffer size in milliseconds.
The value takes effect immediately for all running and pending calls, if any. A
value of 0 disables the jitter buffer.- Parameters:
milliseconds
- the audio jitter buffer size to set in milliseconds
-
getAudioMulticastAddr
Use to get multicast address to be used for audio stream.
- Returns:
- an ipv4/6 multicast address or default value.
-
setAudioMulticastAddr
Use to set multicast address to be used for audio stream.
- Parameters:
ip
- an ipv4/6 multicast address.- Returns:
- 0 in case of success
-
isAudioMulticastEnabled
boolean isAudioMulticastEnabled()Use to get multicast state of audio stream.
- Returns:
- true if subsequent calls will propose multicast ip set by
setAudioMulticastAddr(java.lang.String)
-
setAudioMulticastEnabled
void setAudioMulticastEnabled(boolean yesno) Use to enable multicast rtp for audio stream.
If enabled, outgoing calls put a multicast address fromgetVideoMulticastAddr()
into audio cline. In case of outgoing call audio stream is sent to this
multicast address. For incoming calls behavior is unchanged.- Parameters:
yesno
- if yes, subsequent calls will propose multicast ip set bysetAudioMulticastAddr(java.lang.String)
-
getAudioMulticastTtl
int getAudioMulticastTtl()Use to get multicast ttl to be used for audio stream.
- Returns:
- a time to leave value
-
setAudioMulticastTtl
int setAudioMulticastTtl(int ttl) Use to set multicast ttl to be used for audio stream.
- Parameters:
ttl
- value or -1 if not used. [0..255] default value is 1- Returns:
- 0 in case of success
-
getAudioPayloadTypes
Return the list of the available audio payload types.
- Returns:
- A freshly allocated list of the available payload types.
-
setAudioPayloadTypes
Redefine the list of the available payload types.
- Parameters:
payloadTypes
- The new list of payload types. The core does not take
ownership on it.
-
getAudioPort
int getAudioPort()Gets the UDP port used for audio streaming.
- Returns:
- The UDP port used for audio streaming
-
setAudioPort
void setAudioPort(int port) Sets the UDP port used for audio streaming.
A value of -1 will request the system to allocate the local port randomly. This
is recommended in order to avoid firewall warnings.- Parameters:
port
- The UDP port to use for audio streaming
-
getAudioPortsRange
Get the audio port range from which is randomly chosen the UDP port used for
audio streaming.
- Returns:
- a
Range
object
-
getAuthInfoList
- Returns:
- A list of
AuthInfo
.
-
isAutoDownloadIcalendarsEnabled
boolean isAutoDownloadIcalendarsEnabled()Gets if the auto download for incoming icalendars is enabled or not.
- Returns:
- true if icalendars will be automatically downloaded, false otherwise.
-
setAutoDownloadIcalendarsEnabled
void setAutoDownloadIcalendarsEnabled(boolean autoDownloadIcalendars) Auto download files attach to a chat message if it's content type matches the
one we use for icalendars.
- Parameters:
autoDownloadIcalendars
- true to automatically download incoming
icalendars, false to disable it.
-
isAutoDownloadVoiceRecordingsEnabled
boolean isAutoDownloadVoiceRecordingsEnabled()Gets if the auto download for incoming voice recordings is enabled or not.
- Returns:
- true if voice recordings will be automatically downloaded, false
otherwise.
-
setAutoDownloadVoiceRecordingsEnabled
void setAutoDownloadVoiceRecordingsEnabled(boolean autoDownloadVoiceRecordings) Auto download files attach to a chat message if it's content type matches the
one we use for voice recordings.
- Parameters:
autoDownloadVoiceRecordings
- true to automatically download incoming
voice recordings, false to disable it.
-
getAutoIterateBackgroundSchedule
int getAutoIterateBackgroundSchedule()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.- Returns:
- The timing in milliseconds used to schedule the call while in
background (default is 500ms).
-
setAutoIterateBackgroundSchedule
void setAutoIterateBackgroundSchedule(int schedule) Sets the timer used to schedule the call to core.iterate() method when in
background (Android only).
- Parameters:
schedule
- The timing in milliseconds used to schedule the call while in
background.
-
isAutoIterateEnabled
boolean isAutoIterateEnabled()Gets whether auto iterate is enabled or not (Android & iOS only).
- Returns:
- true if
iterate()
is scheduled automatically, false otherwise
-
setAutoIterateEnabled
void setAutoIterateEnabled(boolean enable) Enable or disable the automatic schedule ofiterate()
method on Android
& iOS.
If enabled,iterate()
will be called on the main thread every 20ms
automatically. If disabled, it is the application that must do this job.- Parameters:
enable
- true to enable auto iterate, false to disable
-
getAutoIterateForegroundSchedule
int getAutoIterateForegroundSchedule()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.- Returns:
- The timing in milliseconds used to schedule the call while in
foreground (default is 20ms).
-
setAutoIterateForegroundSchedule
void setAutoIterateForegroundSchedule(int schedule) Sets the timer used to schedule the call to core.iterate() method when in
foreground (Android only).
- Parameters:
schedule
- The timing in milliseconds used to schedule the call while in
foreground.
-
isAutoSendRingingEnabled
boolean isAutoSendRingingEnabled()Gets if the automatic sending of 180 Ringing is enabled or not.
- Returns:
- true if the automatic sending of 180 Ringing is enabled, false
otherwise.
-
setAutoSendRingingEnabled
void setAutoSendRingingEnabled(boolean enable) Enables the automatic sending of 180 Ringing when receiving a call.
- Parameters:
enable
- true to activate the automatic 180 Ringing, false to disable it.
-
isAutomaticHttpProxyDetectionEnabled
boolean isAutomaticHttpProxyDetectionEnabled()Returns whether automatic http proxy is enabled.
- Returns:
- true if automatic http proxy is enabled or false.
-
setAutomaticHttpProxyDetectionEnabled
void setAutomaticHttpProxyDetectionEnabled(boolean enable) Enables or disables automatic http proxy detection.
- Parameters:
enable
- true if automatic http proxy is enabled or false.
-
getAvpfMode
AVPFMode getAvpfMode()- Returns:
- The current
AVPFMode
mode
-
setAvpfMode
Enable RTCP feedback (also known as RTP/AVPF profile).
SettingAVPFMode.Default
is equivalent to LinphoneAVPFDisabled. This
setting can be overriden perProxyConfig
withProxyConfig.setAvpfMode(org.linphone.core.AVPFMode)
. The value set here is used for calls placed or received out of any proxy
configured, or if the proxy config is configured with LinphoneAVPFDefault.- Parameters:
mode
- The AVPF mode to use.
-
getAvpfRrInterval
int getAvpfRrInterval()Return the avpf report interval in seconds.
- Returns:
- The current AVPF report interval in seconds
-
setAvpfRrInterval
void setAvpfRrInterval(int interval) Set the avpf report interval in seconds.
This value can be overriden by the proxy config usingProxyConfig.setAvpfRrInterval(int)
.- Parameters:
interval
- The report interval in seconds
-
getCallLogs
Get the list of call logs (past calls).
- Returns:
- A list of
CallLog
.
-
getCallLogsDatabasePath
Deprecated.07/12/2021: Use only for migration purposesGets the database filename where call logs will be stored.
- Returns:
- filesystem path.
-
setCallLogsDatabasePath
Deprecated.07/12/2021: Use only for migration purposesSets the database filename where call logs will be stored.
If the file does not exist, it will be created.- Parameters:
path
- filesystem path
-
isCallToneIndicationsEnabled
boolean isCallToneIndicationsEnabled()Check whether tone indications of calls are enabled.
- Returns:
- true if call tone indications are enabled
-
setCallToneIndicationsEnabled
void setCallToneIndicationsEnabled(boolean yesno) Enables or disables call tone indications.
This value is taken into account from next tine call parameters are created.
This feature can also be enabled per-call usingCallParams
. -
isCallkitEnabled
boolean isCallkitEnabled()Special function to check if the callkit is enabled, False by default.
- Returns:
- true if callkit is enabled, false otherwise.
-
setCallkitEnabled
void setCallkitEnabled(boolean enabled) Special function to enable the callkit.
- Parameters:
enabled
- true to enable callkit, false to disable it.
-
getCalls
Gets the current list of calls.
Note that this list is read-only and might be changed by the core after a
function call toiterate()
. Similarly theCall
objects inside it
might be destroyed without prior notice. To hold references toCall
object into your program, you must use linphone_call_ref.- Returns:
- A list of
Call
-
getCallsNb
int getCallsNb()Get the number of Call.
- Returns:
- The current number of calls
-
getCameraSensorRotation
int getCameraSensorRotation()Get the camera sensor rotation.
This is needed on some mobile platforms to get the number of degrees the camera
sensor is rotated relative to the screen.- Returns:
- The camera sensor rotation in degrees (0 to 360) or -1 if it could not
be retrieved
-
isCapabilityNegociationEnabled
boolean isCapabilityNegociationEnabled()Check if the capability negotiation (RFC5939) is supported or not.
- Returns:
- true if capability negotiation is supported; false otherwise.
-
setCapabilityNegociationEnabled
void setCapabilityNegociationEnabled(boolean enable) Define whether capability negotiation (RFC5939) is supported.
-
isCapabilityNegotiationReinviteEnabled
boolean isCapabilityNegotiationReinviteEnabled()Check if the capability negotiation (RFC5939) reINVITE is enabled or not.
- Returns:
- true if capability negotiation reINVITE is enabled; false otherwise.
-
setCapabilityNegotiationReinviteEnabled
void setCapabilityNegotiationReinviteEnabled(boolean enable) Define whether capability negotiation (RFC5939) reINVITE is enabled.
- Parameters:
enable
- true to enable capability negotiation reINVITE; false otherwise.
-
getCaptureDevice
Gets the name of the currently assigned sound device for capture.
- Returns:
- The name of the currently assigned sound device for capture.
-
setCaptureDevice
Sets the sound device used for capture.
- Parameters:
devid
- The device name as returned by linphone_core_get_sound_devices- Returns:
- 0
-
isCfgLinesMergingEnabled
boolean isCfgLinesMergingEnabled()Check if cfg lines are going to the merged if the capability negotiation
(RFC5939) is supported or not.
- Returns:
- true if acfg and pcfg lines with consecutive indexes are going to be
merged; false otherwise.
-
setCfgLinesMergingEnabled
void setCfgLinesMergingEnabled(boolean merge) Define whether cfg lines are going to be merged if capability negotiation
(RFC5939) is supported.
- Parameters:
merge
- true to merge acfg and pcfg lines with consecutive indexes; false
otherwise.
-
isChatEnabled
boolean isChatEnabled()Returns whether chat is enabled.
- Returns:
- true if chat is enabled, false otherwise
-
getChatMessagesAggregationEnabled
boolean getChatMessagesAggregationEnabled()Returns whether chat messages grouping is enabled or not.
- Returns:
- true if received chat messages will be notified as a bundle, false
otherwise.
-
setChatMessagesAggregationEnabled
void setChatMessagesAggregationEnabled(boolean enabled) Sets whether chat messages grouping is enabled or not.
Set [sip] chat_messages_aggregation in your configuration file for the timer,
default is 500ms.- Parameters:
enabled
- true to wait for chat messages and notify them as at once, false
to keep legacy behavior.
-
getChatRooms
Returns a list of chat rooms.
- Returns:
- List of chat rooms.
-
getConference
Deprecated.Get a pointer on the internal conference object.
- Returns:
- A pointer on
Conference
or null if no conference are going on.
-
isConferenceIcsInMessageBodyEnabled
boolean isConferenceIcsInMessageBodyEnabled()Gets wether conference invitations will be sent in the chat message body or as
a file attachment.
- Returns:
- true if ICS will be sent in the message body (by default), false if it
will be sent as a file attachment.
-
setConferenceIcsInMessageBodyEnabled
void setConferenceIcsInMessageBodyEnabled(boolean enable) Enable sending conference invitations in the chat message body instead of as a
file attachment.
- Parameters:
enable
- true to send ICS as message body, false to send it as file
transfer
-
getConferenceInformationList
Retrieve the list of conference information on DB.
- Returns:
- The list of conference infos .
-
getConferenceLocalInputVolume
float getConferenceLocalInputVolume()Get the set input volume of the local participant.
- Returns:
- A value inside [0.0 ; 1.0]
-
getConferenceParticipantListType
Conference.ParticipantListType getConferenceParticipantListType()Tells whether the default conference participant list is open or closed.
- Returns:
- A
Conference#ParticipantListType
participant list type
-
setConferenceParticipantListType
Select whether the default conference participant list is open or closed.
- Parameters:
type
- AConference#ParticipantListType
participant list type
-
isConferenceServerEnabled
boolean isConferenceServerEnabled()Tells whether the conference server feature is enabled.
- Returns:
- A boolean value telling whether the conference server feature is
enabled or not
-
setConferenceServerEnabled
void setConferenceServerEnabled(boolean enable) Enable the conference server feature.
This has the effect to listen of the conference factory uri to create new
conferences when receiving INVITE messages there.- Parameters:
enable
- A boolean value telling whether to enable or disable the
conference server feature
-
getConferenceSize
Deprecated.16/04/2021 UseConference.getParticipantCount()
instead.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.- Returns:
- The number of participants including me, if it in.
-
getConfig
Returns the config object used to manage the storage (config) file.
- Returns:
- a
Config
object.
-
getConsolidatedPresence
ConsolidatedPresence getConsolidatedPresence()Get my consolidated presence.
- Returns:
- My
ConsolidatedPresence
presence
-
setConsolidatedPresence
Set my consolidated presence.
- Parameters:
presence
-ConsolidatedPresence
value
-
getCurrentCall
Gets the current call.
- Returns:
- The current call or null if no call is running.
-
getCurrentCallRemoteAddress
Get the remote address of the current call.
- Returns:
- The remote address of the current call or null if there is no current
call.
-
getCurrentPreviewVideoDefinition
Get the effective video definition provided by the camera for the captured
video.
When preview is disabled or not yet started this function returns a 0x0 video
definition.- Returns:
- The captured
VideoDefinition
.
see:setPreviewVideoDefinition(org.linphone.core.VideoDefinition)
-
getDefaultAccount
Returns the default account, that is the one used to determine the current
identity.
- Returns:
- The default account.
-
setDefaultAccount
Sets the default account.
This default account must be part of the list of already entered
LinphoneAccount. Toggling it as default will makeCore
use the identity
associated with the account in all incoming and outgoing calls.- Parameters:
account
- The account to use as the default one.
-
getDefaultConferenceLayout
Conference.Layout getDefaultConferenceLayout()Gets the default conference layout @core core the linphone core.
- Returns:
- conference layout
-
setDefaultConferenceLayout
Set the default conference layout.
- Parameters:
value
- layout
-
getDefaultEphemeralLifetime
long getDefaultEphemeralLifetime()Gets the default lifetime of ephemeral messages in seconds @core core the
linphone core.
- Returns:
- lifetime of ephemeral messages in seconds
-
setDefaultEphemeralLifetime
void setDefaultEphemeralLifetime(long value) Set the default ephemeral lifetime in seconds.
- Parameters:
value
- lifetime of ephemeral messages in seconds
-
getDefaultFriendList
- Returns:
- the first
FriendList
object or null.
-
getDefaultInputAudioDevice
Gets the default input audio device.
- Returns:
- The default input audio device
-
setDefaultInputAudioDevice
- Parameters:
audioDevice
- TheAudioDevice
-
getDefaultOutputAudioDevice
Gets the default output audio device.
- Returns:
- The default output audio device
-
setDefaultOutputAudioDevice
- Parameters:
audioDevice
- TheAudioDevice
-
getDefaultProxyConfig
Returns the default proxy configuration, that is the one used to determine the
current identity.
- Returns:
- The default proxy configuration.
-
setDefaultProxyConfig
Sets the default proxy.
This default proxy must be part of the list of already entered
LinphoneProxyConfig. Toggling it as default will makeCore
use the
identity associated with the proxy configuration in all incoming and outgoing
calls.- Parameters:
config
- The proxy configuration to use as the default one.
-
getDefaultVideoDisplayFilter
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.- Returns:
- The default video display filter.
-
getDelayedTimeout
int getDelayedTimeout()- Returns:
- The current delayed timeout in seconds
-
setDelayedTimeout
void setDelayedTimeout(int seconds) Set the in delayed timeout in seconds.
After this timeout period, a delayed call (internal call initialisation or
resolution) is resumed.- Parameters:
seconds
- The new delayed timeout
-
getDeviceRotation
int getDeviceRotation()Gets the current device orientation.
- Returns:
- The current device orientation
see:setDeviceRotation(int)
-
setDeviceRotation
void setDeviceRotation(int rotation) Tells the core the device current orientation.
This can be used by capture filters on mobile devices to select between
portrait/landscape mode and to produce properly oriented images. The exact
meaning of the value in rotation if left to each device specific
implementations. IOS supported values are 0 for UIInterfaceOrientationPortrait
and 270 for UIInterfaceOrientationLandscapeRight.- Parameters:
rotation
- The orientation to use
-
getDigestAuthenticationPolicy
Get the current digest authentication policy applicable for SIP and HTTP.
Get the current digest authentication policy applicable for SIP and HTTP.- Returns:
- The current digest authentication policy.
-
setDigestAuthenticationPolicy
Setup a new digest authentication policy applicable for SIP and HTTP.
Setup a new digest authentication policy applicable for SIP and HTTP.- Parameters:
policy
- aDigestAuthenticationPolicy
-
getDisableRecordOnMute
boolean getDisableRecordOnMute()Get whether the microphone will be completely deactivated when muted.
Please refer tosetDisableRecordOnMute(boolean)
.- Returns:
- True if you wish to entirely stop the audio recording when muting the
microphone.
-
setDisableRecordOnMute
void setDisableRecordOnMute(boolean disable) Calling this method with disable=true will cause the microhone to be completely
deactivated when muted, when given possible by the implementation on the
platform on which liblinphone is running.
Otherwise, sound recording remains active but silence is sent instead of
recorded audio. Playback sound will be briefly interrupted while the audio is
reconfigured. Currently only implemented for IOS, it will also disable Apple's
microphone recording indicator when microphone is muted.- Parameters:
disable
- True if you wish to entirely stop the audio recording when
muting the microphone.
-
isDnsSearchEnabled
boolean isDnsSearchEnabled()Tells whether DNS search (use of local domain if the fully qualified name did
return results) is enabled.
- Returns:
- true if DNS search is enabled, false if disabled.
-
setDnsSearchEnabled
void setDnsSearchEnabled(boolean enable) Enable or disable DNS search (use of local domain if the fully qualified name
did return results).
- Parameters:
enable
- true to enable DNS search, false to disable it.
-
setDnsServers
Forces liblinphone to use the supplied list of dns servers, instead of system's
ones.
- Parameters:
servers
- A list of strings containing the IP addresses of DNS servers to
be used. Setting to null restores default behaviour, which is to use the DNS
server list provided by the system. The list is copied internally.
-
setDnsServersApp
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.
- Parameters:
servers
- A list of strings containing the IP addresses of DNS servers to
be used. Setting to null restores default behaviour, which is to use the DNS
server list provided by the system. The list is copied internally.
-
getDnsSetByApp
boolean getDnsSetByApp()Tells if the DNS was set by an application.
- Returns:
- true if DNS was set by app, false otherwise.
-
isDnsSrvEnabled
boolean isDnsSrvEnabled()Tells whether DNS SRV resolution is enabled.
- Returns:
- true if DNS SRV resolution is enabled, false if disabled.
-
setDnsSrvEnabled
void setDnsSrvEnabled(boolean enable) Enable or disable DNS SRV resolution.
- Parameters:
enable
- true to enable DNS SRV resolution, false to disable it.
-
getDownloadBandwidth
int getDownloadBandwidth()- Returns:
- the download bandiwdth in kbits/s, 0 for infinite
-
setDownloadBandwidth
void setDownloadBandwidth(int bandwidth) Sets maximum available download bandwidth This is IP bandwidth, in kbit/s.
This information is used signaled to other parties during calls (within SDP
messages) so that the remote end can have sufficient knowledge to properly
configure its audio & video codec output bitrate to not overflow available
bandwidth.- Parameters:
bandwidth
- the bandwidth in kbits/s, 0 for infinite
-
getDownloadPtime
int getDownloadPtime()Get audio packetization time linphone expects to receive from peer.
A value of zero means that ptime is not specified.- Returns:
- the download packetization time set
-
setDownloadPtime
void setDownloadPtime(int ptime) Set audio packetization time linphone expects to receive from peer.
A value of zero means that ptime is not specified.- Parameters:
ptime
- the download packetization time to set
-
getEchoCancellationCalibration
int getEchoCancellationCalibration()Gets the currently stored calibration delay for the software echo cancellation.
- Returns:
- the current calibration value, -1 if it failed, 0 if not done or not
needed, a positive value if a software echo canceller is required after running
startEchoCancellerCalibration()
.
-
isEchoCancellationEnabled
boolean isEchoCancellationEnabled()Returns true if echo cancellation is enabled.
- Returns:
- A boolean value telling whether echo cancellation is enabled or
disabled
-
setEchoCancellationEnabled
void setEchoCancellationEnabled(boolean enable) Enables or disable echo cancellation.
Value is saved and used for subsequent calls. This actually controls software
echo cancellation only. When 'enable' is set to false, software echo
cancellation is disabled, but hardware one, if available, remains activated.
When set to true, software echo cancellation is activated in either of these
two conditions: -
getEchoCancellerFilterName
Get the name of the mediastreamer2 filter used for echo cancelling.
- Returns:
- The name of the mediastreamer2 filter used for echo cancelling.
-
setEchoCancellerFilterName
Set the name of the mediastreamer2 filter to be used for echo cancelling.
This is for advanced users of the library.- Parameters:
filtername
- The name of the mediastreamer2 filter to be used for echo
cancelling.
-
isEchoLimiterEnabled
boolean isEchoLimiterEnabled()Tells whether echo limiter is enabled.
Enables or disable echo limiter. "Echo limiter" refers to an algorithm that
creates half-duplex conversation in order to suppress echo. It is experimental
and shall be used only in rare cases where echo cancellation cannot perform
because of non-linear speaker/mic coupling. You shall not expected good audio
quality with the echo limiter.- Returns:
- true if the echo limiter is enabled, false otherwise.
-
setEchoLimiterEnabled
void setEchoLimiterEnabled(boolean enable) Enables or disable echo limiter.
"Echo limiter" refers to an algorithm that creates half-duplex conversation in
order to suppress echo. It is experimental and shall be used only in rare cases
where echo cancellation cannot perform because of non-linear speaker/mic
coupling. You shall not expected good audio quality with the echo limiter.- Parameters:
enable
- true to enable echo limiter, false to disable it.
-
setEnableSipUpdate
void setEnableSipUpdate(int value) Enable or disable the UPDATE method support.
- Parameters:
value
- Enable or disable it
-
setExpectedBandwidth
void setExpectedBandwidth(int bandwidth) 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.- Parameters:
bandwidth
- the bandwidth in kbits/s, 0 for infinite
-
getExtendedAudioDevices
Returns the list of all audio devices.
- Returns:
- A list of all
AudioDevice
-
getFileTransferServer
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".- Returns:
- URL of the file server.
-
setFileTransferServer
Globaly set an 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". This value can also be
set for a dedicated account using
linphone_proxy_config_set_file_transfer_server.- Parameters:
serverUrl
- URL of the file server.
-
isForcedIceRelayEnabled
boolean isForcedIceRelayEnabled()Indicates whether the ICE relay path is forcibly selected.
- Returns:
- a boolean value indicating whether forced relay is enabled.
see:#enableForcedIceRelay
.
-
setForcedIceRelayEnabled
void setForcedIceRelayEnabled(boolean enable) Artificially cause the relay path to be selected when ICE is used.
This is mainly a function for test, for example to validate that the relay
service (ever TURN or media-aware SIP proxy) is working as expected. Indeed, in
many cases a path through host or server reflexive candidate will be found by
ICE, which makes difficult to make sure that the relay service is working as
expected.- Parameters:
enable
- boolean value
-
isFriendListSubscriptionEnabled
boolean isFriendListSubscriptionEnabled()Returns whether or not friend lists subscription are enabled.
- Returns:
- whether or not the feature is enabled
-
setFriendListSubscriptionEnabled
void setFriendListSubscriptionEnabled(boolean enable) Sets whether or not to start friend lists subscription when in foreground.
- Parameters:
enable
- whether or not to enable the feature
-
getFriendsDatabasePath
Gets the database filename where friends will be stored.
- Returns:
- filesystem path.
-
setFriendsDatabasePath
Sets the database filename where friends will be stored.
If the file does not exist, it will be created.- Parameters:
path
- filesystem path.
-
getFriendsLists
- Returns:
- A list of
FriendList
.
-
getFutureConferenceInformationList
Retrieve the list of future conference information on DB.
- Returns:
- The list of future conference infos .
-
isGenericComfortNoiseEnabled
boolean isGenericComfortNoiseEnabled()Returns enablement of RFC3389 generic comfort noise algorithm.
- Returns:
- true if generic comfort noise is enabled, false otherwise.
-
setGenericComfortNoiseEnabled
void setGenericComfortNoiseEnabled(boolean enabled) Enable RFC3389 generic comfort noise algorithm (CN payload type).
It is disabled by default, because this algorithm is only relevant for legacy
codecs (PCMU, PCMA, G722). Enablement requires a SDK built with full G729
support: -DENABLE_G729=ON -DENABLE_G729B_CNG=ON . warning: : the G729 support
is not included in Liblinphone default licence - the purchase of a license
extension is required.- Parameters:
enabled
- true if enabled, false otherwise.
-
getGlobalState
Returns the global state of core.
- Returns:
- a
GlobalState
enum.
-
getGuessHostname
boolean getGuessHostname()Returns true if hostname part of primary contact is guessed automatically.
- Returns:
- true if guess hostname enabled, false otherwise.
-
setGuessHostname
void setGuessHostname(boolean enable) - Parameters:
enable
- whether to enable the guess hostname feature or not
-
getHttpProxyHost
Get http proxy address to be used for signaling.
- Returns:
- hostname of IP adress of the http proxy (can be null to disable).
-
setHttpProxyHost
Set http proxy address to be used for signaling during next channel connection.
UsesetNetworkReachable(boolean)
FASLE/true to force channel restart.- Parameters:
host
- Hostname of IP adress of the http proxy (can be null to disable).
-
getHttpProxyPort
int getHttpProxyPort()Get http proxy port to be used for signaling.
- Returns:
- port of the http proxy.
-
setHttpProxyPort
void setHttpProxyPort(int port) Set http proxy port to be used for signaling.
- Parameters:
port
- of the http proxy.
-
getIdentity
Gets the default identity SIP address.
This is an helper function. If no default proxy is set, this will return the
primary contact ( seegetPrimaryContact()
). If a default proxy is set
it returns the registered identity on the proxy.- Returns:
- The default identity SIP address.
-
getImNotifPolicy
- Returns:
- A
ImNotifPolicy
object.
-
getInCallTimeout
int getInCallTimeout()- Returns:
- The current in call timeout in seconds
-
setInCallTimeout
void setInCallTimeout(int seconds) Set the in call timeout in seconds.
After this timeout period, the call is automatically hangup. A value of 0
disables this feature.- Parameters:
seconds
- The new timeout in seconds
-
getIncTimeout
int getIncTimeout()- Returns:
- The current incoming call timeout in seconds
-
setIncTimeout
void setIncTimeout(int seconds) Set the incoming call timeout in seconds.
If an incoming call isn't answered for this timeout period, it is automatically
declined.- Parameters:
seconds
- The new timeout in seconds
-
getInputAudioDevice
Gets the input audio device for the current call.
- Returns:
- The input audio device for the current or first call, null if there is
no call.
-
setInputAudioDevice
- Parameters:
audioDevice
- TheAudioDevice
. null does nothing.
-
isIpv6Enabled
boolean isIpv6Enabled()Tells whether IPv6 is enabled or not.
- Returns:
- A boolean value telling whether IPv6 is enabled or not
see:#enableIpv6
for more details on how IPv6 is supported in
liblinphone.
-
setIpv6Enabled
void setIpv6Enabled(boolean enable) Turns IPv6 support on or off.
- Parameters:
enable
- A boolean value telling whether to enable IPv6 support
-
isEchoCancellerCalibrationRequired
boolean isEchoCancellerCalibrationRequired()Check whether the device is echo canceller calibration is required.
- Returns:
- true if it is required, false otherwise
-
isInBackground
boolean isInBackground()Gets whether the Core is considering itself in background or not.
The Core foreground/background state depends on the last call made toenterBackground()
orenterForeground()
. @return true if the Core is in background, false
otherwise. -
isInConference
Deprecated.09/03/2021 UseConference.isIn()
instead.Indicates whether the local participant is part of a conference.
warning: That function automatically fails in the case of conferences using a
conferencet server (focus). If you use such a conference, you should useConference.removeParticipant(org.linphone.core.Address)
instead.- Returns:
- true if the local participant is in a conference, false otherwise.
-
isIncomingInvitePending
boolean isIncomingInvitePending()Tells whether there is an incoming invite pending.
- Returns:
- A boolean telling whether an incoming invite is pending or not.
-
isMediaEncryptionMandatory
boolean isMediaEncryptionMandatory()Check if the configured media encryption is mandatory or not.
- Returns:
- true if media encryption is mandatory; false otherwise.
-
isNetworkReachable
boolean isNetworkReachable()return network state either as positioned by the application or by linphone
itself.
- Returns:
- true if network is reachable, false otherwise
-
isPushNotificationAvailable
boolean isPushNotificationAvailable()Gets whether push notifications are available or not (Android & iOS only).
- Returns:
- true if push notifications are available, false otherwise
-
isSenderNameHiddenInForwardMessage
boolean isSenderNameHiddenInForwardMessage()Returns whether or not sender name is hidden in forward message.
- Returns:
- whether or not the feature
-
isVerifyServerCertificates
boolean isVerifyServerCertificates()Get whether the tls server certificate must be verified when connecting to a
SIP/TLS server.
- Returns:
- True if the tls server certificate must be verified
-
isVerifyServerCn
boolean isVerifyServerCn()Get whether the tls server certificate common name must be verified when
connecting to a SIP/TLS server.
- Returns:
- True if the tls server certificate common name must be verified
-
isKeepAliveEnabled
boolean isKeepAliveEnabled()Is signaling keep alive enabled.
- Returns:
- A boolean value telling whether signaling keep alive is enabled
-
setKeepAliveEnabled
void setKeepAliveEnabled(boolean enable) Enables signaling keep alive, small udp packet sent periodically to keep udp
NAT association.
- Parameters:
enable
- A boolean value telling whether signaling keep alive is to be
enabled
-
getLabel
String getLabel()Get the label assigned to the LinphoneCore.
The default value is null (no label).- Returns:
- the assigned label.
-
setLabel
Set a label - for logging/troubleshooting purpose - to the core object.
This label is used by the logger to give context. When running an application
with several LinphoneCore objects, (such as a test), it is useful to enhance
the log's readability'.- Parameters:
label
- a developper-friendly label.
-
getLastOutgoingCallLog
Get the latest outgoing call log.
Conference calls are not returned by this function! Requires ENABLE_DB_STORAGE
to work.- Returns:
- The last outgoing call log if any.
-
getLdapList
Returns a list of entered LDAPs.
Items must be freed with linphone_ldap_unref- Returns:
-
isLimeX3DhEnabled
boolean isLimeX3DhEnabled()Tells wether LIME X3DH is enabled or not.
- Returns:
- The current lime state
-
setLimeX3DhEnabled
void setLimeX3DhEnabled(boolean enable) Tells to LinphoneCore to use LIME X3DH.
- Parameters:
enable
- A boolean value telling whether to enable or disable LIME X3DH
-
getLimeX3DhServerUrl
Deprecated.26/08/2022 UseAccountParams.getLimeServerUrl()
instead.Get the x3dh server url.
- Returns:
- The x3dh server url.
-
setLimeX3DhServerUrl
Deprecated.26/08/2022 UseAccountParams.setLimeServerUrl(java.lang.String)
instead.Set the x3dh server url.
If empty, this function will disable LIME X3DH from core. Otherwise, or if
different from the existing value, this will (re-)initialize the LIME X3DH
engine.- Parameters:
url
- The x3dh server url.
-
getLinphoneSpecsList
Get the list of linphone specs string values representing what functionalities
the linphone client supports.
- Returns:
- A list of supported specs. The list must be freed with
bctbx_list_free() after usage.
-
setLinphoneSpecsList
Set the linphone specs list value telling what functionalities the linphone
client supports.
- Parameters:
specs
- The list of string specs to set.
-
getLoadedPlugins
Return the list of loaded plugins.
- Returns:
- the list of loaded plugins
-
isLocalPermissionEnabled
boolean isLocalPermissionEnabled()Special function to check if the local network permission has been granted by
the user (useful for iOS).
The test performed by this function may popup the local network permission
dialog, for that reason it could be a good idea to check it twice to conclude
that the user has deny the permission.- Returns:
- true if local permission request is granted, false otherwise.
-
getLogCollectionUploadServerUrl
Gets the url of the server where to upload the collected log files.
- Returns:
- The url of the server where to upload the collected log files.
-
setLogCollectionUploadServerUrl
Set the url of the server where to upload the collected log files.
- Parameters:
serverUrl
- The url of the server where to upload the collected log files.
-
getMaxCalls
int getMaxCalls()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- Returns:
- max number of simultaneous calls
-
setMaxCalls
void setMaxCalls(int max) Set 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- Parameters:
max
- number of simultaneous calls
-
getMaxSizeForAutoDownloadIncomingFiles
int getMaxSizeForAutoDownloadIncomingFiles()Gets the size under which incoming files in chat messages will be downloaded
automatically.
- Returns:
- The size in bytes, -1 if autodownload feature is disabled, 0 to
download them all no matter the size
-
setMaxSizeForAutoDownloadIncomingFiles
void setMaxSizeForAutoDownloadIncomingFiles(int size) Sets the size under which incoming files in chat messages will be downloaded
automatically.
- Parameters:
size
- The size in bytes, -1 to disable the autodownload feature, 0 to
download them all no matter the size
-
getMediaDevice
Gets the name of the currently assigned sound device for media.
- Returns:
- The name of the currently assigned sound device for capture.
-
setMediaDevice
Sets the sound device used for media.
- Parameters:
devid
- The device name as returned by linphone_core_get_sound_devices- Returns:
- 0
-
getMediaEncryption
MediaEncryption getMediaEncryption()Get the media encryption policy being used for RTP packets.
- Returns:
- The
MediaEncryption
policy being used.
-
setMediaEncryption
Choose the media encryption policy to be used for RTP packets.
- Parameters:
menc
- The media encryption policy to be used.- Returns:
- 0 if successful, any other value otherwise.
-
setMediaEncryptionMandatory
void setMediaEncryptionMandatory(boolean mandatory) 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.- Parameters:
mandatory
- true to set it mandatory; false otherwise.
-
setMediaNetworkReachable
void setMediaNetworkReachable(boolean reachable) 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 needsetNetworkReachable(boolean)
.- Parameters:
reachable
- true if network is reachable, false otherwise
-
getMediaResourceMode
MediaResourceMode getMediaResourceMode()This function returns the media resource mode for this core.
- Returns:
- The media resource mode
-
setMediaResourceMode
Sets the media resources mode.
Value values are: unique and shared. When the mode is set to unique, then only
one call in the state StreamsRunning is allowed. While acepting a call, the
core will try to free media resource used by the current call. If it is
unsuccessful, then the call is not accepted. If mode is set to shared, then the
media resources of the current call (if any) are not emptied when taking a new
call. If the user whishes to free them, he/she is responsible to call
linphone_core_preempt_sound_resources himself/herself- Parameters:
mode
- the chosen mode
-
isMicEnabled
boolean isMicEnabled()Tells whether the microphone is enabled.
- Returns:
- true if the microphone is enabled, false if disabled.
-
setMicEnabled
void setMicEnabled(boolean enable) Enable or disable the microphone.
This effectively enable or disable microphone (mute) for currently the running
call or conference if any, as well as it applies to future currently running
calls or conferences.- Parameters:
enable
- true to enable the microphone, false to disable it.
-
getMicGainDb
float getMicGainDb()Get microphone gain in db.
- Returns:
- The current microphone gain
-
setMicGainDb
void setMicGainDb(float level) Allow to control microphone level: gain in db.
- Parameters:
level
- The new microphone level
-
getMissedCallsCount
int getMissedCallsCount()Get the number of missed calls.
Once checked, this counter can be reset withresetMissedCallsCount()
.- Returns:
- The number of missed calls.
-
getMtu
int getMtu()Returns the maximum transmission unit size in bytes.
-
setMtu
void setMtu(int mtu) Sets the maximum transmission unit size in bytes.
This information is useful for sending RTP packets. Default value is 1500.- Parameters:
mtu
- The MTU in bytes
-
getNatAddress
Deprecated.12/10/2022Deprecated.
Get the public IP address of NAT being used.- Returns:
- The public IP address of NAT being used.
-
setNatAddress
Deprecated.12/10/2022Deprecated.
This function was used to force a given IP address to appear in SDP.
Unfortunately, this cannot work as explained by
https://www.rfc-editor.org/rfc/rfc5389#section-2 .- Parameters:
addr
- The public IP address of NAT to use.
-
getNatPolicy
Get The policy that is used to pass through NATs/firewalls.
It may be overridden by a NAT policy for a specific proxy config.- Returns:
NatPolicy
object in use.
see:AccountParams.getNatPolicy()
-
setNatPolicy
Set the policy to use to pass through NATs/firewalls.
It may be overridden by a NAT policy for a specific proxy config.- Parameters:
policy
-NatPolicy
object
see:AccountParams.setNatPolicy(org.linphone.core.NatPolicy)
-
getNativePreviewWindowId
Get the native window handle of the video preview window.
seesetNativeVideoWindowId(java.lang.Object)
for details about window_id
There is a special case for Qt :getNativePreviewWindowId()
returns a
#QQuickFramebufferObject::Renderer. Note : Qt blocks GUI thread when calling
createRenderer(), so it is safe to call linphone functions there if needed.- Returns:
- The native window handle of the video preview window.
-
setNativePreviewWindowId
Set the native window id where the preview video (local camera) is to be
displayed.
This has to be used in conjonction withusePreviewWindow(boolean)
. seesetNativeVideoWindowId(java.lang.Object)
for general details about window_id
On Android : #org.linphone.mediastream.video.capture.CaptureTextureView is used
forsetNativePreviewWindowId(java.lang.Object)
. It is inherited from #TextureView and
takes care of rotating the captured image from the camera and scale it to keep
it's ratio.- Parameters:
windowId
- The native window id where the preview video is to be
displayed.
-
isNativeRingingEnabled
boolean isNativeRingingEnabled()Returns whether the native ringing is enabled or not.
- Returns:
- True if we use the native ringing, false otherwise
-
setNativeRingingEnabled
void setNativeRingingEnabled(boolean enable) Sets whether to use the native ringing (Android only).
- Parameters:
enable
- True to enable native ringing, false otherwise
-
getNativeVideoWindowId
Get the native window handle of the video window.
see linphone_core_set_native_video_window_id for details about window_id
There is a special case for Qt :getNativeVideoWindowId()
returns a
#QQuickFramebufferObject::Renderer. Note : Qt blocks GUI thread when calling
createRenderer(), so it is safe to call linphone functions there if needed.- Returns:
- The native window handle of the video window.
-
setNativeVideoWindowId
Set the native video window id where the video is to be displayed.
On Desktop platforms(MacOS, Linux, Windows), the display filter is "MSOGL" by
default. That means : If window_id is not set or set to
LINPHONE_VIDEO_DISPLAY_NONE, then the core will not create its own window,
unless the special id LINPHONE_VIDEO_DISPLAY_AUTO is given. This is currently
only supported for Linux X11 (#Window type), Windows UWP (#SwapChainPanel type)
and Windows (#HWND type).
The CSharp Wrapper on Windows for UWP takes directly a #SwapChainPanel without
Marshalling. On other platforms, window_id is a #MSOglContextInfo defined in
msogl.h of mediastreamer2 There is a special case for Qt : The "MSQOGL" filter
must be selected by using linphone_core_set_video_display_filter. Setting
window id is only used to stop rendering by passing
LINPHONE_VIDEO_DISPLAY_NONE.getNativeVideoWindowId()
returns a
#QQuickFramebufferObject::Renderer andcreateNativeVideoWindowId()
creates one. After a creation,setNativeVideoWindowId(java.lang.Object)
must be called
with the new object.
On mobile operating systems, LINPHONE_VIDEO_DISPLAY_AUTO is not supported and
window_id depends of the platform : iOS : It is a #UIView. Android : It is a
#TextureView.- Parameters:
windowId
- The native window id where the remote video is to be displayed.
-
setNetworkReachable
void setNetworkReachable(boolean reachable) This method is called by the application to notify the linphone core library
when network is reachable.
Calling this method with true trigger linphone to initiate a registration
process for all proxies. Calling this method disables the automatic network
detection mode. It means you must call this method after each network state
changes.- Parameters:
reachable
- true if network is reachable, false otherwise
-
getNortpTimeout
int getNortpTimeout()Gets the value of the no-rtp timeout.
When no RTP or RTCP packets have been received for a whileCore
will
consider the call is broken (remote end crashed or disconnected from the
network), and thus will terminate the call. The no-rtp timeout is the duration
above which the call is considered broken.- Returns:
- The value of the no-rtp timeout in seconds
-
setNortpTimeout
void setNortpTimeout(int seconds) Sets the no-rtp timeout value in seconds.
- Parameters:
seconds
- The no-rtp timeout value to use in seconds
see:getNortpTimeout()
for details.
-
getOutputAudioDevice
Gets the output audio device for the current call.
- Returns:
- The output audio device for the current or first call, null if there is
no call.
-
setOutputAudioDevice
- Parameters:
audioDevice
- TheAudioDevice
. null does nothing.
-
getPlayFile
Get the wav file that is played when putting somebody on hold, or when files
are used instead of soundcards (seesetUseFiles(boolean)
).
The file is a 16 bit linear wav file.- Returns:
- The path to the file that is played when putting somebody on hold.
-
setPlayFile
Sets a wav file to be played when putting somebody on hold, or when files are
used instead of soundcards (seesetUseFiles(boolean)
).
The file must be a 16 bit linear wav file.- Parameters:
file
- The path to the file to be played when putting somebody on hold.
-
getPlaybackDevice
Gets the name of the currently assigned sound device for playback.
- Returns:
- The name of the currently assigned sound device for playback.
-
setPlaybackDevice
Sets the sound device used for playback.
- Parameters:
devid
- The device name as returned by linphone_core_get_sound_devices- Returns:
- 0
-
getPlaybackGainDb
float getPlaybackGainDb()Get playback gain in db before entering sound card.
- Returns:
- The current playback gain
-
setPlaybackGainDb
void setPlaybackGainDb(float level) Allow to control play level before entering sound card: gain in db.
- Parameters:
level
- The new play level
-
getPreferredFramerate
float getPreferredFramerate()- Returns:
- frame rate in number of frames per seconds.
-
setPreferredFramerate
void setPreferredFramerate(float fps) Set the preferred frame rate for video.
Based on the available bandwidth constraints and network conditions, the video
encoder remains free to lower the framerate. There is no warranty that the
preferred frame rate be the actual framerate. used during a call. Default value
is 0, which means "use encoder's default fps value".- Parameters:
fps
- the target frame rate in number of frames per seconds.
-
getPreferredVideoDefinition
Get the preferred video definition for the stream that is captured and sent to
the remote party.
- Returns:
- The preferred
VideoDefinition
-
setPreferredVideoDefinition
Set the preferred video definition for the stream that is captured and sent to
the remote party.
All standard video definitions are accepted on the receive path.- Parameters:
videoDefinition
-VideoDefinition
object
-
setPreferredVideoDefinitionByName
Sets the preferred video definition by its name.
CallFactory.getSupportedVideoDefinitions()
to have a list of supported
video definitions.- Parameters:
name
- The name of the definition to set
-
getPresenceModel
Get my presence model.
- Returns:
- A
PresenceModel
object, or null if no presence model has been
set.
-
setPresenceModel
Set my presence model.
- Parameters:
presence
-PresenceModel
-
getPreviewVideoDefinition
Get the definition of the captured video.
- Returns:
- The captured
VideoDefinition
if it was previously set bysetPreviewVideoDefinition(org.linphone.core.VideoDefinition)
, otherwise a 0x0 LinphoneVideoDefinition.
see:setPreviewVideoDefinition(org.linphone.core.VideoDefinition)
-
setPreviewVideoDefinition
Set the video definition for the captured (preview) video.
This method is for advanced usage where a video capture must be set
independently of the definition of the stream actually sent through the call.
This allows for example to have the preview window in High Definition even if
due to bandwidth constraint the sent video definition is small. Using this
feature increases the CPU consumption, since a rescaling will be done
internally.- Parameters:
videoDefinition
-VideoDefinition
object
-
setPreviewVideoDefinitionByName
- Parameters:
name
- The name of the definition to set
-
getPrimaryContact
Returns the default identity when no proxy configuration is used.
- Returns:
- the primary contact identity
-
setPrimaryContact
Sets the local "from" identity.
This data is used in absence of any proxy configuration or when no default
proxy configuration is set. SeeProxyConfig
- Parameters:
contact
- the contact to set- Returns:
- 0 if successful, -1 otherwise
-
getPrimaryContactParsed
Deprecated.22/10/2018 UsecreatePrimaryContactParsed()
instead.- Returns:
- a
Address
object.
-
getProvisioningUri
Get provisioning URI.
- Returns:
- the provisioning URI.
-
setProvisioningUri
Set URI where to download xml configuration file at startup.
This can also be set from configuration file or factory config file, from
[misc] section, item "config-uri". Calling this function does not load the
configuration. It will write the value into configuration so that configuration
from remote URI will take place at nextCore
start.- Parameters:
uri
- the http or https uri to use in order to download the configuration.
Passing null will disable remote provisioning.- Returns:
- -1 if uri could not be parsed, 0 otherwise. Note that this does not
check validity of URI endpoint nor scheme and download may still fail.
-
getProxyConfigList
Returns an unmodifiable list of entered proxy configurations.
- Returns:
- A list of
ProxyConfig
.
-
getPushIncomingCallTimeout
int getPushIncomingCallTimeout()- Returns:
- The current push incoming call timeout in seconds
-
setPushIncomingCallTimeout
void setPushIncomingCallTimeout(int seconds) Configure the minimum interval between a push notification and the
corresponding incoming INVITE.
If exceeded, Linphone Call is transitioned to CallError and further incoming
invite associated to this push is declined if any.- Parameters:
seconds
- The new timeout in seconds
-
getPushNotificationConfig
Gets the push notification configuration object if it exists.
- Returns:
- the
PushNotificationConfig
if it exists, null otherwise.
-
isPushNotificationEnabled
boolean 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- Returns:
- true if push notifications are enabled, false otherwise
-
setPushNotificationEnabled
void setPushNotificationEnabled(boolean enable) Enable or disable push notifications on Android & iOS.
If enabled, it will try to get the push token add configure each account with
push_notification_allowed set to true with push parameters. IOS: will also
instanciate a PushRegistry, so make sure that your app does not instanciate one
too or there will be a conflict.- Parameters:
enable
- true to enable push notifications, false to disable
-
isQrcodeVideoPreviewEnabled
boolean isQrcodeVideoPreviewEnabled()Tells whether QRCode is enabled in the preview.
- Returns:
- A boolean value telling whether QRCode is enabled in the preview.
-
setQrcodeVideoPreviewEnabled
void setQrcodeVideoPreviewEnabled(boolean enable) Controls QRCode enablement.
- Parameters:
enable
- A boolean value telling whether the QRCode is enabled in the
preview.
-
isRealtimeTextEnabled
boolean isRealtimeTextEnabled()Gets if realtime text is enabled or not.
- Returns:
- true if realtime text is enabled, false otherwise
-
isRecordAwareEnabled
boolean isRecordAwareEnabled()Gets if the record aware feature is enabled or not.
- Returns:
- true if the record aware feature is enabled, false otherwise.
-
setRecordAwareEnabled
void setRecordAwareEnabled(boolean enable) Enables the record aware feature that will warn other users when recording.
- Parameters:
enable
- true to activate the record aware feature, false to disable it.
-
getRecordFile
Get the wav file where incoming stream is recorded, when files are used instead
of soundcards (seesetUseFiles(boolean)
).
This feature is different from call recording (CallParams.setRecordFile(java.lang.String)
) The file is a 16 bit linear wav file.- Returns:
- The path to the file where incoming stream is recorded.
-
setRecordFile
Sets a wav file where incoming stream is to be recorded, when files are used
instead of soundcards (seesetUseFiles(boolean)
).
This feature is different from call recording (CallParams.setRecordFile(java.lang.String)
) The file will be a 16 bit linear wav file.- Parameters:
file
- The path to the file where incoming stream is to be recorded.
-
getRemoteRingbackTone
Get the ring back tone played to far end during incoming calls.
- Returns:
- the path to the remote ring back tone to be played.
-
setRemoteRingbackTone
Specify a ring back tone to be played to far end during incoming calls.
- Parameters:
ring
- The path to the remote ring back tone to be played.
-
isRetransmissionOnNackEnabled
boolean isRetransmissionOnNackEnabled()Tells whether NACK context is enabled or not.
- Returns:
- A boolean value telling whether NACK context is enabled or not
-
setRetransmissionOnNackEnabled
void setRetransmissionOnNackEnabled(boolean enable) Turns NACK context on or off.
- Parameters:
enable
- A boolean value telling whether to enable NACK context
-
getRing
Returns the path to the wav file used for ringing.
- Returns:
- The path to the wav file used for ringing.
-
setRing
Sets the path to a wav file used for ringing.
The file must be a wav 16bit linear. If null, ringing is disable unless
#linphone_core_get_use_native_ringing() is enabled, in which case we use the
device ringtone.- Parameters:
path
- The path to a wav file to be used for ringing, null to disable or
use device ringing depending on #linphone_core_get_use_native_ringing().
-
getRingDuringIncomingEarlyMedia
boolean getRingDuringIncomingEarlyMedia()Tells whether the ring play is enabled during an incoming early media call.
-
setRingDuringIncomingEarlyMedia
void setRingDuringIncomingEarlyMedia(boolean enable) Enable or disable the ring play during an incoming early media call.
- Parameters:
enable
- A boolean value telling whether to enable ringing during an
incoming early media call.
-
getRingback
Returns the path to the wav file used for ringing back.
- Returns:
- The path to the wav file used for ringing back.
-
setRingback
Sets the path to a wav file used for ringing back.
Ringback means the ring that is heard when it's ringing at the remote party.
The file must be a wav 16bit linear.- Parameters:
path
- The path to a wav file to be used for ringing back.
-
getRingerDevice
Gets the name of the currently assigned sound device for ringing.
- Returns:
- The name of the currently assigned sound device for ringing.
-
setRingerDevice
Sets the sound device used for ringing.
- Parameters:
devid
- The device name as returned by linphone_core_get_sound_devices- Returns:
- 0
-
getRootCa
Gets the path to a file or folder containing the trusted root CAs (PEM format)
- Returns:
- The path to a file or folder containing the trusted root CAs.
-
setRootCa
Sets the path to a file or folder containing trusted root CAs (PEM format)
- Parameters:
path
- The path to a file or folder containing trusted root CAs.
-
setRootCaData
Sets the trusted root CAs (PEM format)
- Parameters:
data
- The trusted root CAs as a string
-
isRtpBundleEnabled
boolean isRtpBundleEnabled()Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.
See https://datatracker.ietf.org/doc/html/rfc8843 for more information.- Returns:
- a boolean indicating the enablement of rtp bundle mode.
-
setRtpBundleEnabled
void setRtpBundleEnabled(boolean value) Enables or disables RTP bundle mode (Media Multiplexing).
See https://datatracker.ietf.org/doc/html/rfc8843 for more information about
the feature. When enabled, liblinphone will try to negociate the use of a
single port for all streams when doing an outgoing call. It automatically
enables rtcp-mux. This feature can also be enabled per-call usingCallParams
.- Parameters:
value
- a boolean to indicate whether the feature is to be enabled.
-
isSdp200AckEnabled
boolean isSdp200AckEnabled()Media offer control param for SIP INVITE.
- Returns:
- true if INVITE has to be sent whitout SDP.
-
setSdp200AckEnabled
void setSdp200AckEnabled(boolean enable) Control when media offer is sent in SIP INVITE.
- Parameters:
enable
- true if INVITE has to be sent whitout SDP.
-
isSelfViewEnabled
boolean isSelfViewEnabled()Tells whether video self view during call is enabled or not.
- Returns:
- A boolean value telling whether self view is enabled
see:#enableSelfView
for details.
-
setSelfViewEnabled
void setSelfViewEnabled(boolean enable) Enables or disable self view during calls.
- Parameters:
enable
- A boolean value telling whether to enable self view Self-view
refers to having local webcam image inserted in corner of the video window
during calls. This function works at any time, including during calls.
-
setSenderNameHiddenInForwardMessageEnabled
void setSenderNameHiddenInForwardMessageEnabled(boolean enable) Enable whether or not to hide sender name in forward message.
- Parameters:
enable
- whether or not to enable the feature
-
isSessionExpiresEnabled
boolean isSessionExpiresEnabled()Check if the Session Timers feature is enabled.
-
setSessionExpiresEnabled
void setSessionExpiresEnabled(boolean enabled) Enable the Session Timers support.
- Parameters:
enabled
- Enable or disable it
-
getSessionExpiresMinValue
int getSessionExpiresMinValue()Returns the session expires min value, 90 by default.
-
setSessionExpiresMinValue
void setSessionExpiresMinValue(int min) Sets the session expires minSE value, forced to a minimum of 90 by default.
-
getSessionExpiresRefresherValue
SessionExpiresRefresher getSessionExpiresRefresherValue()Returns the session expires refresher value.
-
setSessionExpiresRefresherValue
Sets the session expires refresher value.
- Parameters:
refresher
- TheSessionExpiresRefresher
configuration value
-
getSessionExpiresValue
int getSessionExpiresValue()Returns the session expires value.
-
setSessionExpiresValue
void setSessionExpiresValue(int expires) Sets the session expires value, 0 by default.
-
getSipDscp
int getSipDscp()Get the DSCP field for SIP signaling channel.
The DSCP defines the quality of service in IP packets.- Returns:
- The current DSCP value
-
setSipDscp
void setSipDscp(int dscp) Set the DSCP field for SIP signaling channel.
The DSCP defines the quality of service in IP packets.- Parameters:
dscp
- The DSCP value to set
-
setSipNetworkReachable
void setSipNetworkReachable(boolean reachable) 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 needsetNetworkReachable(boolean)
.- Parameters:
reachable
- true if network is reachable, false otherwise
-
getSipTransportTimeout
int getSipTransportTimeout()Get the SIP transport timeout, which represents the maximum time permitted to
establish a connection to a SIP server.
- Returns:
- The SIP transport timeout in milliseconds.
-
setSipTransportTimeout
void setSipTransportTimeout(int timeoutMs) Set the SIP transport timeout, which represents the maximum time permitted to
establish a connection to a SIP server.
- Parameters:
timeoutMs
- The SIP transport timeout in milliseconds.
-
getSoundDevicesList
Deprecated.10/04/2021 UsegetAudioDevices()
instead.Gets the list of the available sound devices.
- Returns:
- An unmodifiable array of strings contanining the names of the available
sound devices that is null terminated.
-
getSrtpCryptoSuites
Get the crypto suites available to the core.
- Returns:
- a comma separated list of supported suites
-
setSrtpCryptoSuites
Set the crypto suites available to the core.
- Parameters:
suites
- comma separated list of supported suites
-
getStaticPicture
Get the path to the image file streamed when "Static picture" is set as the
video device.
- Returns:
- The path to the image file streamed when "Static picture" is set as the
video device.
-
setStaticPicture
Set the path to the image file to stream when "Static picture" is set as the
video device.
- Parameters:
path
- The path to the image file to use.
-
getStaticPictureFps
float getStaticPictureFps()Get the frame rate for static picture.
- Returns:
- The frame rate used for static picture.
-
setStaticPictureFps
int setStaticPictureFps(float fps) Set the frame rate for static picture.
- Parameters:
fps
- The new frame rate to use for static picture.
-
getStunServer
Get the STUN server address being used.
- Returns:
- The STUN server address being used.
-
setStunServer
Set the STUN server address to use when the firewall policy is set to STUN.
- Parameters:
server
- The STUN server address to use.
-
getSupportedFileFormatsList
Returns a null terminated table of strings containing the file format extension
supported for call recording.
- Returns:
- The supported formats, typically 'wav' and 'mkv'.
-
setSupportedTag
Set the supported tags.
-
getTag100RelSupportLevel
SupportLevel getTag100RelSupportLevel()Get the support level of the 100rel attribute.
- Returns:
- The 100 rel support level
-
setTag100RelSupportLevel
Define what level of support is provided to the 100rel attribute.
- Parameters:
level
- support level of 100rel
-
setTcapLineMergingEnabled
void setTcapLineMergingEnabled(boolean merge) Define whether tcap lines are going to be merged if capability negotiation
(RFC5939) is supported.
- Parameters:
merge
- true to merge tcap lines with consecutive indexes; false
otherwise.
-
isTcapLinesMergingEnabled
boolean isTcapLinesMergingEnabled()Check if tcap lines are going to the merged if the capability negotiation
(RFC5939) is supported or not.
- Returns:
- true if tcap lines with consecutive indexes are going to be merged;
false otherwise.
-
getTextPayloadTypes
Return the list of the available text payload types.
- Returns:
- 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.
-
setTextPayloadTypes
Redefine the list of the available payload types.
- Parameters:
payloadTypes
- The new list of payload types. The core does not take
ownership on it.
-
getTextPort
int getTextPort()Gets the UDP port used for text streaming.
- Returns:
- The UDP port used for text streaming
-
setTextPort
void setTextPort(int port) Sets the UDP port used for text streaming.
A value if -1 will request the system to allocate the local port randomly. This
is recommended in order to avoid firewall warnings.- Parameters:
port
- The UDP port to use for text streaming
-
getTextPortsRange
Get the text port range from which is randomly chosen the UDP port used for
text streaming.
- Returns:
- a
Range
object
-
getTlsCert
Gets the TLS certificate.
- Returns:
- the TLS certificate or null if not set yet.
-
setTlsCert
Sets a TLS certificate used for TLS authentication The certificate won't be
stored, you have to set it after eachCore
startup.
- Parameters:
tlsCert
- the TLS certificate.
-
getTlsCertPath
Gets the path to the TLS certificate file.
- Returns:
- the TLS certificate path or null if not set yet.
-
setTlsCertPath
Sets a TLS certificate path used for TLS authentication The path will be stored
in the rc file and automatically restored on startup.
- Parameters:
tlsCertPath
- path to the TLS certificate.
-
getTlsKey
Gets the TLS key.
- Returns:
- the TLS key or null if not set yet.
-
setTlsKey
Sets a TLS key used for TLS authentication The key won't be stored, you have to
set it after eachCore
startup.
- Parameters:
tlsKey
- the TLS key.
-
getTlsKeyPath
Gets the path to the TLS key file.
- Returns:
- the TLS key path or null if not set yet.
-
setTlsKeyPath
Sets a TLS key path used for TLS authentication The path will be stored in the
rc file and automatically restored on startup.
- Parameters:
tlsKeyPath
- path to the TLS key.
-
getTransports
Retrieves the port configuration used for each transport (udp, tcp, tls).
A zero value port for a given transport means the transport is not used. A
value of LC_SIP_TRANSPORT_RANDOM (-1) means the port is to be chosen randomly
by the system. A value of LC_SIP_TRANSPORT_DONTBIND (-2) means that the socket
will not be bound explicitely, in other words liblinphone won't listen for
incoming connections at all. This mode is suitable for a pure client
application (ex: a mobile application).- Returns:
- A
Transports
structure with the configured ports
-
setTransports
Sets the ports to be used for each of transport (UDP or TCP) 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 choosen
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).- Parameters:
transports
- A #LinphoneSipTransports structure giving the ports to use- Returns:
- 0
-
getTransportsUsed
Retrieves the real port number assigned for each sip transport (udp, tcp, tls).
A zero value means that the transport is not activated. If
LC_SIP_TRANSPORT_RANDOM was passed to linphone_core_set_sip_transports, the
random port choosed by the system is returned.- Returns:
- A
Transports
structure with the ports being used
-
getTunnel
get tunnel instance if available
- Returns:
Tunnel
or null if not available.
-
getUnreadChatMessageCount
int getUnreadChatMessageCount()Return the global unread chat message count.
- Returns:
- The global unread chat message count.
-
getUnreadChatMessageCountFromActiveLocals
int getUnreadChatMessageCountFromActiveLocals()Return the unread chat message count for all active local address.
(Primary contact + proxy configs.)- Returns:
- The unread chat message count.
-
getUploadBandwidth
int getUploadBandwidth()- Returns:
- the upload bandiwdth in kbits/s, 0 for infinite
-
setUploadBandwidth
void setUploadBandwidth(int bandwidth) Sets maximum 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.- Parameters:
bandwidth
- the bandwidth in kbits/s, 0 for infinite
-
getUploadPtime
int getUploadPtime()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.
- Returns:
- the upload packetization time set
-
setUploadPtime
void setUploadPtime(int ptime) 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.
- Parameters:
ptime
- the upload packetization time to set
-
getUpnpExternalIpaddress
Return the external ip address of router.
In some cases the uPnP can have an external ip address but not a usable uPnP
(state different of Ok).- Returns:
- a null terminated string containing the external ip address. If the the
external ip address is not available return null.
-
getUpnpState
UpnpState getUpnpState()Return the internal state of uPnP.
- Returns:
- an LinphoneUpnpState.
-
getUseFiles
boolean getUseFiles()Gets whether linphone is currently streaming audio from and to files, rather
than using the soundcard.
- Returns:
- A boolean value representing whether linphone is streaming audio from
and to files or not.
-
setUseFiles
void setUseFiles(boolean yesno) Ask the core to stream audio from and to files, instead of using the soundcard.
- Parameters:
yesno
- A boolean value asking to stream audio from and to files or not.
-
getUseInfoForDtmf
boolean getUseInfoForDtmf()Indicates whether SIP INFO is used to send digits.
- Returns:
- A boolean value telling whether SIP INFO is used to send digits
-
setUseInfoForDtmf
void setUseInfoForDtmf(boolean useInfo) Sets whether SIP INFO is to be used to send digits.
- Parameters:
useInfo
- A boolean value telling whether to use SIP INFO to send digits
-
getUseRfc2833ForDtmf
boolean getUseRfc2833ForDtmf()Indicates whether RFC2833 is used to send digits.
- Returns:
- A boolean value telling whether RFC2833 is used to send digits
-
setUseRfc2833ForDtmf
void setUseRfc2833ForDtmf(boolean useRfc2833) Sets whether RFC2833 is to be used to send digits.
- Parameters:
useRfc2833
- A boolean value telling whether to use RFC2833 to send digits
-
getUserAgent
Gets the user-agent as a string.
- Returns:
- liblinphone's user agent as a string.
-
getUserCertificatesPath
Get the path to the directory storing the user's certificates.
- Returns:
- The path to the directory storing the user's certificates.
-
setUserCertificatesPath
Set the path to the directory storing the user's x509 certificates (used by
dtls)
- Parameters:
path
- The path to the directory to use to store the user's certificates.
-
isVibrationOnIncomingCallEnabled
boolean isVibrationOnIncomingCallEnabled()Gets whether the device will vibrate while an incoming call is ringing (Android
only).
- Returns:
- true if the device will vibrate (if possible), false otherwise
-
setVibrationOnIncomingCallEnabled
void setVibrationOnIncomingCallEnabled(boolean enable) Enable vibration will incoming call is ringing (Android only).
-
getVideoActivationPolicy
Get the default policy for video.
SeesetVideoActivationPolicy(org.linphone.core.VideoActivationPolicy)
for more details.- Returns:
- The video policy being used
-
setVideoActivationPolicy
Sets the default policy for video.
This policy defines whether:- Parameters:
policy
- TheVideoActivationPolicy
to use
-
isVideoAdaptiveJittcompEnabled
boolean isVideoAdaptiveJittcompEnabled()Tells whether the video adaptive jitter compensation is enabled.
- Returns:
- true if the video adaptive jitter compensation is enabled, false
otherwise.
-
setVideoAdaptiveJittcompEnabled
void setVideoAdaptiveJittcompEnabled(boolean enable) Enable or disable the video adaptive jitter compensation.
- Parameters:
enable
- true to enable the video adaptive jitter compensation, false to
disable it.
-
isVideoCaptureEnabled
boolean isVideoCaptureEnabled()Tells whether video capture is enabled.
- Returns:
- true if video capture is enabled, false if disabled.
-
setVideoCaptureEnabled
void setVideoCaptureEnabled(boolean enable) Enable or disable video capture.
This function does not have any effect during calls. It just indicates the
Core
to initiate future calls with video capture or not.- Parameters:
enable
- true to enable video capture, false to disable it.
-
getVideoCodecPriorityPolicy
CodecPriorityPolicy getVideoCodecPriorityPolicy()Get the current priority policy for video codecs (payload types).
SeeCodecPriorityPolicy
for more details.- Returns:
- the current
CodecPriorityPolicy
-
setVideoCodecPriorityPolicy
Set the priority policy for video codecs (payload types).
Since version 5.3, the default value isCodecPriorityPolicy.Auto
unless
the core's configuration file describes a list of video payload type to use.
This is to preserve backward compatibility for upgrading applications. See
CodecPriorityPolicy
for more details.- Parameters:
policy
- theCodecPriorityPolicy
to apply
-
getVideoDevice
Returns the name of the currently active video device.
- Returns:
- The name of the currently active video device.
-
setVideoDevice
Sets the active video device.
- Parameters:
id
- The name of the video device to use as returned by
linphone_core_get_video_devices
-
getVideoDevicesList
Gets the list of the available video capture devices.
- Returns:
- An unmodifiable array of strings contanining the names of the available
video capture devices that is null terminated.
-
isVideoDisplayEnabled
boolean isVideoDisplayEnabled()Tells whether video display is enabled.
- Returns:
- true if video display is enabled, false if disabled.
-
setVideoDisplayEnabled
void setVideoDisplayEnabled(boolean enable) Enable or disable video display.
This function does not have any effect during calls. It just indicates the
Core
to initiate future calls with video display or not.- Parameters:
enable
- true to enable video display, false to disable it.
-
getVideoDisplayFilter
Get the name of the mediastreamer2 filter used for rendering video.
- Returns:
- The currently selected video display filter.
-
setVideoDisplayFilter
Set the name of the mediastreamer2 filter to be used for rendering video.
This is for advanced users of the library, mainly to workaround hardware/driver
bugs.- Parameters:
filterName
- the filter name to use or null to use default.
-
getVideoDscp
int getVideoDscp()Get the DSCP field for outgoing video streams.
The DSCP defines the quality of service in IP packets.- Returns:
- The current DSCP value
-
setVideoDscp
void setVideoDscp(int dscp) Set the DSCP field for outgoing video streams.
The DSCP defines the quality of service in IP packets.- Parameters:
dscp
- The DSCP value to set
-
isVideoEnabled
boolean isVideoEnabled()Returns true if either capture or display is enabled, false otherwise.
same as (#videoCaptureEnabled
|#videoDisplayEnabled
)- Returns:
- true if either capture or display is enabled, false otherwise.
-
getVideoJittcomp
int getVideoJittcomp()Returns the nominal video jitter buffer size in milliseconds.
- Returns:
- The nominal video jitter buffer size in milliseconds
-
setVideoJittcomp
void setVideoJittcomp(int milliseconds) Sets the nominal video jitter buffer size in milliseconds.
The value takes effect immediately for all running and pending calls, if any. A
value of 0 disables the jitter buffer.- Parameters:
milliseconds
- the jitter buffer size in milliseconds
-
getVideoMulticastAddr
Use to get multicast address to be used for video stream.
- Returns:
- an ipv4/6 multicast address, or default value.
-
setVideoMulticastAddr
Use to set multicast address to be used for video stream.
- Parameters:
ip
- an ipv4/6 multicast address.- Returns:
- 0 in case of success
-
isVideoMulticastEnabled
boolean isVideoMulticastEnabled()Use to get multicast state of video stream.
- Returns:
- true if subsequent calls will propose multicast ip set by
setVideoMulticastAddr(java.lang.String)
-
setVideoMulticastEnabled
void setVideoMulticastEnabled(boolean yesno) Use to enable multicast rtp for video stream.
If enabled, outgoing calls put a multicast address fromgetVideoMulticastAddr()
into video cline. In case of outgoing call video stream is sent to this
multicast address. For incoming calls behavior is unchanged.- Parameters:
yesno
- if yes, subsequent outgoing calls will propose multicast ip set by
setVideoMulticastAddr(java.lang.String)
-
getVideoMulticastTtl
int getVideoMulticastTtl()Use to get multicast ttl to be used for video stream.
- Returns:
- a time to leave value
-
setVideoMulticastTtl
int setVideoMulticastTtl(int ttl) Use to set multicast ttl to be used for video stream.
- Parameters:
ttl
- value or -1 if not used. [0..255] default value is 1- Returns:
- 0 in case of success
-
getVideoPayloadTypes
Return the list of the available video payload types.
- Returns:
- A freshly allocated list of the available payload types.
-
setVideoPayloadTypes
Redefine the list of the available video payload types.
Calling this function if the video codec priority policy is
LinphoneCodecPriorityPolicyAuto turns video codec priority policy to basic
scheme, since application is not supposed to control the order of video codecs
when LinphoneCodecPriorityPolicyAuto is selected, by definition. (seesetVideoCodecPriorityPolicy(org.linphone.core.CodecPriorityPolicy)
)- Parameters:
payloadTypes
- The new list of codecs. The core does not take ownership on
it.
-
getVideoPort
int getVideoPort()Gets the UDP port used for video streaming.
- Returns:
- The UDP port used for video streaming
-
setVideoPort
void setVideoPort(int port) Sets the UDP port used for video streaming.
A value of -1 will request the system to allocate the local port randomly. This
is recommended in order to avoid firewall warnings.- Parameters:
port
- The UDP port to use for video streaming
-
getVideoPortsRange
Get the video port range from which is randomly chosen the UDP port used for
video streaming.
- Returns:
- a
Range
object
-
getVideoPreset
Get the video preset used for video calls.
- Returns:
- The name of the video preset used for video calls (can be null if the
default video preset is used).
-
setVideoPreset
Set the video preset to be used for video calls.
- Parameters:
preset
- The name of the video preset to be used (can be null to use the
default video preset).
-
isVideoPreviewEnabled
boolean isVideoPreviewEnabled()Tells whether video preview is enabled.
- Returns:
- A boolean value telling whether video preview is enabled
-
setVideoPreviewEnabled
void setVideoPreviewEnabled(boolean enable) Controls video preview enablement.
- Parameters:
enable
- A boolean value telling whether the video preview is to be shown
Video preview refers to the action of displaying the local webcam image to the
user while not in call.
-
setVideoSourceReuseEnabled
void setVideoSourceReuseEnabled(boolean enable) 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.- Parameters:
enable
- true to enable video source reuse. false to disable it for
subsequent calls.
-
isWifiOnlyEnabled
boolean isWifiOnlyEnabled()Tells whether Wifi only mode is enabled or not.
warning: Only works for Android platform.- Returns:
- A boolean value telling whether Wifi only mode is enabled or not
-
setWifiOnlyEnabled
void setWifiOnlyEnabled(boolean enable) Turns Wifi only mode on or off.
If enabled, app won't register when active network isn't WiFi or Ethernet.
warning: Only works for Android platform.- Parameters:
enable
- A boolean value telling whether to enable IPv6 support
-
isZeroRtpPortForStreamInactiveEnabled
boolean isZeroRtpPortForStreamInactiveEnabled()Check if RTP port is set to 0 when a stream is inactive.
- Returns:
- true if the RTP port is set to 0 if the stream direction is inactive;
false otherwise.
-
setZeroRtpPortForStreamInactiveEnabled
void setZeroRtpPortForStreamInactiveEnabled(boolean enable) Define whether RTP port is set to 0 when a stream is inactive.
- Parameters:
enable
- true to set the RTP port to 0 if the stream direction is
inactive; false otherwise.
-
getZrtpAvailableKeyAgreementList
Return the list of the available ZRTP key agreement algorithns.
- Returns:
- A freshly allocated list of the available algorithms. The list must be
destroyed with bctbx_list_free() after usage. The elements of the list haven't
to be unref.
-
isZrtpGoClearEnabled
boolean isZrtpGoClearEnabled()Check if the ZRTP go clear is enabled or not.
- Returns:
- true if ZTRP go clear is enabled; false otherwise.
-
setZrtpGoClearEnabled
void setZrtpGoClearEnabled(boolean enabled) Define whether ZRTP go clear is enabled.
-
getZrtpKeyAgreementList
Return the ordonated list of the ZRTP key agreement algorithns currently
configured.
- Returns:
- A freshly allocated list of the available algorithms. The list must be
destroyed with bctbx_list_free() after usage. The elements of the list haven't
to be unref.
-
setZrtpKeyAgreementSuites
Redefine the list of prefered ZRTP key agreement algorithms.
- Parameters:
keyAgreements
- The new list of key agreements algorithms, in order of
preference. The core does not take ownership on it. The setting accepts a
maximum of 7 algorithms, if the list is longer, only the first 7 available
algorithms are selected
-
getZrtpSecretsFile
Get the path to the file storing the zrtp secrets cache.
- Returns:
- The path to the file storing the zrtp secrets cache.
-
setZrtpSecretsFile
Set the path to the file storing the zrtp secrets cache.
- Parameters:
file
- The path to the file to use to store the zrtp secrets cache.
-
activateAudioSession
void activateAudioSession(boolean actived) 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. -
addAccount
Add an account.
This will start registration on the proxy, if registration is enabled.- Parameters:
account
- theAccount
to add- Returns:
- 0 if successful, -1 otherwise
-
addAllToConference
int 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.- Returns:
- 0 if succeeded. Negative number if failed
warning: This function guarantees that the local endpoint is added to the
conference.
-
addAuthInfo
Adds authentication information to theCore
.
That piece of information will be used during all SIP transactions that require
authentication.- Parameters:
info
- TheAuthInfo
to add.
-
addContentTypeSupport
Add support for the specified content type.
It is the application responsibility to handle it correctly afterwards.- Parameters:
contentType
- The content type to add support for
-
addFriendList
Add a friend list.
- Parameters:
list
-FriendList
object
-
addLdap
Add or update a LDAP server and save it to the configuration.
- Parameters:
ldap
- The LDAP to add/update.
-
addLinphoneSpec
Add the given linphone specs to the list of functionalities the linphone client
supports.
- Parameters:
spec
- The spec to add
-
addProvisioningHeader
Add an extra header for retrieving the remote provisioning (checksetProvisioningUri(java.lang.String)
).
This can also be set from configuration file or factory config file, from[misc]
section, item "config-uri-headers_X" where X is the index of the header
starting by 0.- Parameters:
headerName
- the header to use when downloading the configuration.value
- the value to use when downloading the configuration.
-
addProxyConfig
Add a proxy configuration.
This will start registration on the proxy, if registration is enabled.- Parameters:
config
- theProxyConfig
to add- Returns:
- 0 if successful, -1 otherwise
-
addSupportedTag
This function controls signaling features supported by the core.
They are typically included in a SIP Supported header.- Parameters:
tag
- The feature tag name
-
addToConference
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.- Parameters:
call
- The current call with the participant to add- Returns:
- 0 if succeeded. Negative number if failed
-
audioRouteChanged
Deprecated.07/01/2020 now handled in the linphone SDK directlySpecial function to indicate if the audio route is changed.
Must be called in the callback of AVAudioSessionRouteChangeNotification. -
chatRoomGetDefaultEphemeralMode
ChatRoom.EphemeralMode chatRoomGetDefaultEphemeralMode()Gets the default ephemeral message mode @core core the linphone core.
- Returns:
- the default ephemeral message mode
ChatRoom#EphemeralMode
-
chatRoomSetDefaultEphemeralMode
Sets the default ephemeral message mode.
- Parameters:
mode
- default ephemeral message modeChatRoom#EphemeralMode
-
checkForUpdate
Checks if a new version of the application is available.
- Parameters:
currentVersion
- The current version of the application
-
clearAccounts
void clearAccounts()Erase all account from config.
-
clearAllAuthInfo
void clearAllAuthInfo()Clear all authentication information.
-
clearCallLogs
void clearCallLogs()Erase the call log.
-
clearLdaps
void clearLdaps()Erase all LDAP from the configuration.
-
clearProvisioningHeaders
void clearProvisioningHeaders() -
clearProxyConfig
void clearProxyConfig()Erase all proxies from config.
-
configSync
int configSync()Writes the config file to disk.
- Returns:
- 0 if successful, -1 otherwise
-
configureAudioSession
void 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. -
createAccount
- Parameters:
params
-AccountParams
object- Returns:
Account
with default values set
-
createAccountCreator
- Parameters:
xmlrpcUrl
- The URL to the XML-RPC server.- Returns:
- The new
AccountCreator
object.
-
createAccountParams
Create an account params using default values from Linphone core.
- Returns:
AccountParams
with default values set
-
createAddress
- Parameters:
address
- String containing the user supplied address- Returns:
- The create
Address
object
-
createCallLog
@NonNull CallLog createCallLog(@NonNull Address from, @NonNull Address to, Call.Dir dir, int duration, long startTime, long connectedTime, Call.Status status, boolean videoEnabled, float quality) - Parameters:
from
-Address
of callerto
-Address
of calleedir
-Call#Dir
of callduration
- call length in secondsstartTime
- timestamp of call start timeconnectedTime
- timestamp of call connectionstatus
-Call#Status
of callvideoEnabled
- whether video was enabled or not for this callquality
- call quality- Returns:
- a
CallLog
object
-
createCallParams
Create aCallParams
suitable forinviteWithParams(java.lang.String, org.linphone.core.CallParams)
,
linphone_core_accept_call_with_params,
linphone_core_accept_early_media_with_params or
linphone_core_accept_call_update.
The parameters are initialized according to the currentCore
configuration and the last used localCallParams
, the ones passed
throughCall.update(org.linphone.core.CallParams)
,Call.acceptWithParams(org.linphone.core.CallParams)
or
linphone_call_accept_update_with_params().- Parameters:
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:
- A new
CallParams
object.
-
createChatRoom
@Nullable ChatRoom createChatRoom(@NonNull ChatRoomParams params, @Nullable Address localAddr, @NonNull Address[] participants) Create a chat room.
- Parameters:
params
- The chat room creation parametersChatRoomParams
localAddr
-Address
representing the local proxy configuration to
use for the chat room creation or nullparticipants
- The initial list of participants of the chat room.- Returns:
- The newly created chat room (can be an existing one if backend is
Basic) or null.
-
createChatRoom
@Deprecated @Nullable ChatRoom createChatRoom(@NonNull ChatRoomParams params, @NonNull Address localAddr, @NonNull String subject, @NonNull Address[] participants) Deprecated.Create a chat room.
- Parameters:
params
- The chat room creation parametersChatRoomParams
localAddr
-Address
representing the local proxy configuration to
use for the chat room creationsubject
- The subject of the group chat roomparticipants
- The initial list of participants of the chat room- Returns:
- The newly created chat room.
-
createChatRoom
@Deprecated @Nullable ChatRoom createChatRoom(@NonNull ChatRoomParams params, String subject, @NonNull Address[] participants) Deprecated.Create a chat room.
- Parameters:
params
- The chat room creation parametersChatRoomParams
participants
- The initial list of participants of the chat room.- Returns:
- The newly created chat room.
-
createChatRoom
@Deprecated @Nullable ChatRoom createChatRoom(@NonNull String subject, @NonNull Address[] participants) Deprecated.- Parameters:
subject
- The subject of the group chat roomparticipants
- The initial list of participants of the chat room.- Returns:
- The newly created chat room.
-
createChatRoom
@Deprecated @Nullable ChatRoom createChatRoom(@NonNull ChatRoomParams params, @NonNull Address localAddr, @NonNull Address participant) Deprecated.- Parameters:
params
- The chat room creation parametersChatRoomParams
localAddr
-Address
representing the local proxy configuration to
use for the chat room creationparticipant
-Address
representing the initial participant to add
to the chat room- Returns:
- The newly created chat room.
-
createChatRoom
Deprecated.- Parameters:
participant
-Address
representing the initial participant to add
to the chat room- Returns:
- The newly created chat room.
-
createClientGroupChatRoom
Deprecated.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 callChatRoom.addParticipants(org.linphone.core.Address[])
to create at the
server side and add participants to it. Also, the created chat room will not be
a one-to-one chat room even ifChatRoom.addParticipants(org.linphone.core.Address[])
is called with
only one participant.- Parameters:
subject
- The subject of the group chat roomfallback
- 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:
- The newly created client-side group chat room.
-
createClientGroupChatRoom
@Deprecated @Nullable ChatRoom createClientGroupChatRoom(@NonNull String subject, boolean fallback, boolean encrypted) Deprecated.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 callChatRoom.addParticipants(org.linphone.core.Address[])
to create at the
server side and add participants to it. Also, the created chat room will not be
a one-to-one chat room even ifChatRoom.addParticipants(org.linphone.core.Address[])
is called with
only one participant.- Parameters:
subject
- The subject of the group chat roomfallback
- 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 failsencrypted
- Boolean value telling whether we should apply encryption or
not on chat messages sent and received on this room.- Returns:
- The newly created client-side group chat room.
-
createConferenceParams
Create some default conference parameters for instanciating a conference with
createConferenceWithParams(org.linphone.core.ConferenceParams)
.
- Parameters:
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:
- 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.
- Returns:
- A pointer on the freshly created
ConferenceScheduler
.
-
createConferenceWithParams
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. SeeConferenceParams.setConferenceFactoryAddress(org.linphone.core.Address)
for more
details.- Parameters:
params
- Parameters of the conference. SeeConferenceParams
.- Returns:
- A pointer on the freshly created conference
Conference
. That
object will be automatically freed by the core after callingterminateConference()
.
-
createConfig
-
createContent
Create a content with default values from Linphone core.
- Returns:
Content
object with default values set
-
createDefaultChatRoomParams
Creates and returns the default chat room parameters.
- Returns:
- A
ChatRoomParams
object
-
createFriend
Create a default LinphoneFriend.
- Returns:
- The created
Friend
object
-
createFriendList
- Returns:
- A new
FriendList
object.
-
createFriendWithAddress
-
createInfoMessage
Creates an empty info message.
- Returns:
- a new LinphoneInfoMessage.
The info message can later be filled with information usingInfoMessage.addHeader(java.lang.String, java.lang.String)
orInfoMessage.setContent(org.linphone.core.Content)
, and finally sent with
linphone_core_send_info_message().
-
createLdap
Create an empty LDAP search.
Ldap.setParams(org.linphone.core.LdapParams)
must be call to save the parameters in the configuration
file.- Returns:
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, useLdap.setParams(org.linphone.core.LdapParams)
.
The newly created LDAP fromcreateLdap()
.- Returns:
LdapParams
with default values set.
-
createLdapWithParams
Create a LDAP search using given parameters and store them in the configuration
file.
- Parameters:
params
-LdapParams
object- Returns:
Ldap
with default values set
-
createLocalPlayer
@Nullable Player createLocalPlayer(@Nullable String soundCardName, @Nullable String videoDisplayName, @Nullable Object windowId) Create an independent media file player.
This player support WAVE and MATROSKA formats.- Parameters:
soundCardName
- Playback sound card. If null, the ringer sound card set in
Core
will be usedvideoDisplayName
- Video display. If null, the video display set inCore
will be usedwindowId
- Id of the drawing window. Depend of video out- Returns:
- A pointer on the new instance. null if failed.
-
createMagicSearch
- Returns:
- The created
MagicSearch
object
-
createNatPolicy
- Returns:
- A new
NatPolicy
object.
-
createNativePreviewWindowId
Create a native window handle for the video preview window.
seesetNativeVideoWindowId(java.lang.Object)
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.setNativePreviewWindowId(java.lang.Object)
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.- Returns:
- The native window handle of the video preview window.
-
createNativeVideoWindowId
Create a native window handle for the video window.
seesetNativeVideoWindowId(java.lang.Object)
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.setNativeVideoWindowId(java.lang.Object)
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.- Returns:
- The native window handle of the video window.
-
createNotify
Create an out-of-dialog notification, specifying the destination resource, the
event name.
The notification can be send withEvent.notify(org.linphone.core.Content)
.- Parameters:
resource
- the destination resourceevent
- the event name- Returns:
- a
Event
holding the context of the notification.
-
createOneShotPublish
Create a publish context for a one-shot publish.
After being created, the publish must be sent usingEvent.sendPublish(org.linphone.core.Content)
.
TheEvent
is automatically terminated when the publish transaction is
finished, either with success or failure. The application must not callEvent.terminate()
for such one-shot publish.- Parameters:
resource
- the resource uri for the eventevent
- the event name- Returns:
- the
Event
holding the context of the publish.
-
createPresenceActivity
@NonNull PresenceActivity createPresenceActivity(PresenceActivity.Type acttype, @Nullable String description) - Parameters:
acttype
- ThePresenceActivity#Type
to set for the activity.description
- An additional description of the activity to set for the
activity. Can be null if no additional description is to be added.- Returns:
- The created
PresenceActivity
object.
-
createPresenceModel
Create a default LinphonePresenceModel.
- Returns:
- The created
PresenceModel
object.
-
createPresenceModelWithActivity
@NonNull PresenceModel createPresenceModelWithActivity(PresenceActivity.Type acttype, @Nullable String description) - Parameters:
acttype
- ThePresenceActivity#Type
to set for the activity of the
created model.description
- An additional description of the activity to set for the
activity. Can be null if no additional description is to be added.- Returns:
- The created
PresenceModel
object.
-
createPresenceModelWithActivityAndNote
@NonNull PresenceModel createPresenceModelWithActivityAndNote(PresenceActivity.Type acttype, @Nullable String description, @NonNull String note, @Nullable String lang) Create aPresenceModel
with the given activity type, activity
description, note content and note language.
- Parameters:
acttype
- ThePresenceActivity#Type
to set for the activity of the
created model.description
- An additional description of the activity to set for the
activity. Can be null if no additional description is to be added.note
- The content of the note to be added to the created model.lang
- The language of the note to be added to the created model.- Returns:
- The created
PresenceModel
object.
-
createPresenceNote
- Parameters:
content
- The content of the note to be created.lang
- The language of the note to be created.- Returns:
- The created
PresenceNote
object.
-
createPresencePerson
- Parameters:
id
- The id of the person to be created.- Returns:
- The created
PresencePerson
object.
-
createPresenceService
@NonNull PresenceService createPresenceService(@NonNull String id, PresenceBasicStatus basicStatus, @NonNull String contact) - Parameters:
id
- The id of the service to be created.basicStatus
- The basic status of the service to be created.contact
- A string containing a contact information corresponding to the
service to be created.- Returns:
- The created
PresenceService
object.
-
createPrimaryContactParsed
- Returns:
- a
Address
object.
-
createProxyConfig
Create a proxy config with default values from Linphone core.
- Returns:
ProxyConfig
with default values set
-
createPublish
Create a publish context for an event state.
After being created, the publish must be sent usingEvent.sendPublish(org.linphone.core.Content)
.
After expiry, the publication is refreshed unless it is terminated before.- Parameters:
resource
- the resource uri for the eventevent
- the event nameexpires
- the lifetime of event being published, -1 if no associated
duration, in which case it will not be refreshed.- Returns:
- the
Event
holding the context of the publish.
-
createRecorder
Create a media file recorder.
This recorder support WAVE and MATROSKA formats.- Parameters:
params
- TheRecorderParams
that will contains all recorder
parameters.- Returns:
- 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.- Returns:
- A pointer on the newly created instance.
-
createSubscribe
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. Unlikesubscribe(org.linphone.core.Address, java.lang.String, int, org.linphone.core.Content)
the subscription
isn't sent immediately. It will be send when callingEvent.sendSubscribe(org.linphone.core.Content)
.- Parameters:
resource
- the destination resourceevent
- the event nameexpires
- the whished duration of the subscription- Returns:
- a
Event
holding the context of the created subcription.
-
createSubscribe
@NonNull Event createSubscribe(@NonNull Address resource, @NonNull ProxyConfig proxy, @NonNull String event, int expires) 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. Unlikesubscribe(org.linphone.core.Address, java.lang.String, int, org.linphone.core.Content)
the subscription
isn't sent immediately. It will be send when callingEvent.sendSubscribe(org.linphone.core.Content)
.- Parameters:
resource
- the destination resourceproxy
- the proxy configuration to useevent
- the event nameexpires
- the whished duration of the subscription- Returns:
- a
Event
holding the context of the created subcription.
-
createXmlRpcSession
- Parameters:
url
- The URL to the XML-RPC server. Must be NON null.- Returns:
- The new
XmlRpcSession
object.
-
deleteChatRoom
Removes a chatroom including all message history from the LinphoneCore.
- Parameters:
chatRoom
- AChatRoom
object
-
deleteConferenceInformation
Deletes a conference information from DB.
- Parameters:
conferenceInfo
- theConferenceInfo
to delete.
-
didRegisterForRemotePush
Sets device_token when application
didRegisterForRemoteNotificationsWithDeviceToken (IOS only).
- Parameters:
deviceToken
- (NSData *).
-
didRegisterForRemotePushWithStringifiedToken
Sets device_token when application
didRegisterForRemoteNotificationsWithDeviceToken (IOS only).
- Parameters:
deviceTokenStr
- extracted from the Data objectf received in
didRegisterForRemoteNotificationsWithDeviceToken ios function. Append ":remote"
after data formating..
-
disableChat
Inconditionnaly disable incoming chat messages.
- Parameters:
denyReason
- the deny reason (Reason.None
has no effect).
-
enableChat
void enableChat()Enable reception of incoming chat messages.
By default it is enabled but it can be disabled withdisableChat(org.linphone.core.Reason)
. -
ensureRegistered
Deprecated.09/03/2022 SeeprocessPushNotification(java.lang.String)
instead.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. -
enterBackground
void enterBackground()This method is called by the application to notify the linphone core library
when it enters background mode.
-
enterConference
Deprecated.09/03/2021 UseConference.enter()
instead.Join the local participant to the running conference.
- Returns:
- 0 if succeeded. Negative number if failed
-
enterForeground
void enterForeground()This method is called by the application to notify the linphone core library
when it enters foreground mode.
-
fileFormatSupported
Returns whether a specific file format is supported.
see: linphone_core_get_supported_file_formats- Parameters:
fmt
- The format extension (wav, mkv).- Returns:
- true if the file format is supported, false otherwise
-
findAuthInfo
@Nullable AuthInfo findAuthInfo(@Nullable String realm, @NonNull String username, @Nullable String sipDomain) 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.- Parameters:
realm
- the authentication 'realm' (optional)username
- the SIP username to be authenticated (mandatory)sipDomain
- the SIP domain name (optional)- Returns:
- a
AuthInfo
if found.
-
findCallFromUri
Deprecated.27/10/2020. UsegetCallByRemoteAddress2(org.linphone.core.Address)
instead.Search from the list of current calls if a remote address match uri.
- Parameters:
uri
- which should match call remote uri- Returns:
Call
or null if no match is found.
-
findCallLog
Get the call log matching the call id, or null if can't be found.
- Parameters:
callId
- Call id of the call log to findlimit
- Search limit of the most recent call logs to find- Returns:
- A call log matching the call id if any.
-
findCallLogFromCallId
Get the call log matching the call id, or null if can't be found.
- Parameters:
callId
- Call id of the call log to find- Returns:
- A call log matching the call id if any.
-
findChatRoom
Deprecated.Find a chat room.
No reference is transfered to the application. TheCore
keeps a
reference on the chat room.- Parameters:
peerAddr
- a linphone address.localAddr
- a linphone address.- Returns:
ChatRoom
where messaging can take place.
-
findConferenceInformationFromUri
Retrieve the conference information linked to the provided URI if any.
- Parameters:
uri
-Address
of the uri.- Returns:
- The
ConferenceInfo
found if any, null otherwise.
-
findContactsByChar
-
findFriend
-
findFriendByPhoneNumber
- Parameters:
phoneNumber
- The phone number to use to search the friend.- Returns:
- The
Friend
object corresponding to the given phone number or
null if not found.
-
findFriends
- Parameters:
address
- The address to use to search the friends.- Returns:
- A list of
Friend
corresponding to the given address.
-
findOneToOneChatRoom
@Deprecated @Nullable ChatRoom findOneToOneChatRoom(@NonNull Address localAddr, @NonNull Address participantAddr, boolean encrypted) Deprecated.Find a one to one chat room.
No reference is transfered to the application. TheCore
keeps a
reference on the chat room.- Parameters:
localAddr
- a linphone address.participantAddr
- a linphone address.encrypted
- whether to look for an encrypted chat room or not- Returns:
ChatRoom
where messaging can take place.
-
getAccountByIdkey
- Parameters:
idkey
- An arbitrary idkey string associated to an account.- Returns:
- the
Account
object for the given idkey value, or null if none
found
-
getCallByCallid
Get the call by callid.
- Returns:
- call
Call
, return null if there is no call find.
-
getCallByRemoteAddress
Deprecated.08/07/2020 usegetCallByRemoteAddress2(org.linphone.core.Address)
insteadGet the call with the remote_address specified.
- Parameters:
remoteAddress
- The remote address of the call that we want to get- Returns:
- The call if it has been found, null otherwise.
-
getCallByRemoteAddress2
-
getCallHistory
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. -
getChatRoom
Deprecated.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. TheCore
keeps a reference on the
chat room. warning: This method is prone to errors, usesearchChatRoom(org.linphone.core.ChatRoomParams, org.linphone.core.Address, org.linphone.core.Address, org.linphone.core.Address[])
instead- Parameters:
addr
- a linphone address.- Returns:
ChatRoom
where messaging can take place.
-
getChatRoom
Deprecated.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. TheCore
keeps a reference on the
chat room. warning: This method is prone to errors, usesearchChatRoom(org.linphone.core.ChatRoomParams, org.linphone.core.Address, org.linphone.core.Address, org.linphone.core.Address[])
instead- Parameters:
peerAddr
- a linphone address.localAddr
- a linphone address.- Returns:
ChatRoom
where messaging can take place.
-
getChatRoomFromUri
Deprecated.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. TheCore
keeps a reference on the
chat room. warning: This method is prone to errors, usesearchChatRoom(org.linphone.core.ChatRoomParams, org.linphone.core.Address, org.linphone.core.Address, org.linphone.core.Address[])
instead- Parameters:
to
- The destination address for messages.- Returns:
ChatRoom
where messaging can take place.
-
getConferenceInformationListAfterTime
Retrieve the list of conference information on DB after a certain time.
- Parameters:
time
- Time to retrieve conference info.- Returns:
- The list of conference infos .
-
getFriendByRefKey
- Parameters:
key
- The reference key to use to search the friend.- Returns:
- The
Friend
object corresponding to the given reference key.
-
getFriendListByName
- Parameters:
name
- the name of the list- Returns:
- the first
FriendList
object or null.
-
getPayloadType
Get payload type from mime type and clock rate.
This function searches in audio and video codecs for the given payload type
name and clockrate.- Parameters:
type
- payload mime type (I.E SPEEX, PCMU, VP8)rate
- can be LINPHONE_FIND_PAYLOAD_IGNORE_RATEchannels
- number of channels, can be
LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS- Returns:
- Returns null if not found. If a
PayloadType
is returned, it
must be released with linphone_payload_type_unref after using it.
-
getProxyConfigByIdkey
- Parameters:
idkey
- An arbitrary idkey string associated to a proxy configuration- Returns:
- the
ProxyConfig
object for the given idkey value, or null if
none found
-
getUnreadChatMessageCountFromLocal
Return the unread chat message count for a given local address.
- Parameters:
address
-Address
object.- Returns:
- The unread chat message count.
-
getZrtpStatus
Get the zrtp sas validation status for a peer uri.
Once the SAS has been validated or rejected, the status will never return to
Unknown (unless you delete your cache)- Parameters:
addr
- the peer uri- Returns:
- - LinphoneZrtpPeerStatusUnknown: this uri is not present in cache OR
during calls with the active device, SAS never was validated or rejected
-
hasBuiltinEchoCanceller
boolean hasBuiltinEchoCanceller()Check whether the device has a hardware echo canceller.
- Returns:
- true if it does, false otherwise
-
hasCrappyOpengl
boolean hasCrappyOpengl()Check whether the device is flagged has crappy opengl.
- Returns:
- true if crappy opengl flag is set, false otherwise
-
inCall
boolean inCall()Tells whether there is a call running.
- Returns:
- A boolean value telling whether a call is currently running or not
-
interpretUrl
Deprecated.on 18/07/2022, useinterpretUrl(java.lang.String)
instead.Constructs aAddress
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, @domain will be added if not present using default proxy
config. see:ProxyConfig.normalizeSipUri(java.lang.String)
for documentation.- Parameters:
url
- the url to parse- Returns:
- the
Address
matching the url or null in case of failure.
-
interpretUrl
Constructs aAddress
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, @domain will be added if not present using default proxy
config. see:ProxyConfig.normalizeSipUri(java.lang.String)
for documentation.- Parameters:
url
- the url to parseapplyInternationalPrefix
- 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:
- the
Address
matching the url or null in case of failure.
-
invite
Initiates an outgoing call.
The application doesn't own a reference to the returned LinphoneCall object.
Use linphone_call_ref to safely keep the LinphoneCall pointer valid within your
application.- Parameters:
url
- The destination of the call (sip address, or phone number).- Returns:
- A
Call
object or null in case of failure.
-
inviteAddress
Initiates an outgoing call given a destinationAddress
TheAddress
can be constructed directly usingFactory.createAddress(java.lang.String)
, or created by
interpretUrl(java.lang.String)
.
The application doesn't own a reference to the returnedCall
object.
Use linphone_call_ref to safely keep theCall
pointer valid within your
application.- Parameters:
addr
- The destination of the call (sip address).- Returns:
- A
Call
object or null in case of failure.
-
inviteAddressWithParams
Initiates an outgoing call given a destinationAddress
TheAddress
can be constructed directly usingFactory.createAddress(java.lang.String)
, or created by
interpretUrl(java.lang.String)
.
The application doesn't own a reference to the returnedCall
object.
Use linphone_call_ref to safely keep theCall
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.- Parameters:
addr
- The destination of the call (sip address).params
- Call parameters- Returns:
- A
Call
object or null in case of failure.
-
inviteAddressWithParams
@Nullable Call inviteAddressWithParams(@NonNull Address addr, @NonNull CallParams params, @Nullable String subject, @Nullable Content content) Initiates an outgoing call given a destinationAddress
TheAddress
can be constructed directly usingFactory.createAddress(java.lang.String)
, or created by
interpretUrl(java.lang.String)
.
The application doesn't own a reference to the returnedCall
object.
Use linphone_call_ref to safely keep theCall
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.- Parameters:
addr
- The destination of the call (sip address).params
- Call parameterssubject
- Subject of the callcontent
- Body of the SIP INVITE- Returns:
- A
Call
object or null in case of failure.
-
inviteWithParams
Initiates an outgoing call according to supplied call parameters The
application doesn't own a reference to the returnedCall
object.
Use linphone_call_ref to safely keep theCall
pointer valid within your
application.- Parameters:
url
- The destination of the call (sip address, or phone number).params
- theCallParams
call parameters- Returns:
- A
Call
object or null in case of failure.
-
isContentTypeSupported
Tells whether a content type is supported.
- Parameters:
contentType
- The content type to check- Returns:
- A boolean value telling whether the specified content type is supported
or not.
-
isMediaEncryptionSupported
Check if media encryption is supported.
- Parameters:
menc
- The media encryption policy to be used.- Returns:
- true if the media encryption is supported, false otherwise
-
isMediaFilterSupported
Checks if the given media filter is loaded and usable.
This is for advanced users of the library, mainly to expose mediastreamer video
filter status.- Parameters:
filtername
- the filter name- Returns:
- true if the filter is loaded and usable, false otherwise
-
isPluginLoaded
Tells whether a plugin is loaded or not.
- Parameters:
name
- name of the plugin- Returns:
- A boolean value telling whether the plugin has been loaded
-
iterate
void iterate()Main loop function.
It is crucial that your application call it periodically.
iterate()
performs various backgrounds tasks: -
ldapAvailable
boolean ldapAvailable()Tells if LDAP is available.
- Returns:
- true if LDAP is available, false otherwise
-
leaveConference
Deprecated.09/03/2021 UseConference.leave()
instead.Make the local participant leave the running conference.
- Returns:
- 0 if succeeded. Negative number if failed
-
limeX3DhAvailable
boolean limeX3DhAvailable()Tells if LIME X3DH is available.
-
loadConfigFromXml
Update current config with the content of a xml config file.
- Parameters:
xmlUri
- the path to the xml file
-
mediaEncryptionSupported
Check if a media encryption type is supported.
- Parameters:
menc
-MediaEncryption
- Returns:
- whether a media encryption scheme is supported by the
Core
engine
-
migrateLogsFromRcToDb
void migrateLogsFromRcToDb()Migrates the call logs from the linphonerc to the database if not done yet.
-
migrateToMultiTransport
int 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 toiterate()
- Returns:
- 1 if migration was done, 0 if not done because unnecessary or already
done, -1 in case of error.
-
notifyAllFriends
Notify all friends that have subscribed.
- Parameters:
presence
-PresenceModel
to notify
-
notifyNotifyPresenceReceived
Notifies the upper layer that a presence status has been received by calling
the appropriate callback if one has been set.
This method is for advanced usage, where customization of the liblinphone's
internal behavior is required.- Parameters:
linphoneFriend
- theFriend
whose presence information has been
received.
-
notifyNotifyPresenceReceivedForUriOrTel
void notifyNotifyPresenceReceivedForUriOrTel(@NonNull Friend linphoneFriend, @NonNull String uriOrTel, @NonNull PresenceModel 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.- Parameters:
linphoneFriend
- theFriend
whose presence information has been
received.uriOrTel
- telephone number or sip uripresenceModel
- thePresenceModel
that has been modified
-
pauseAllCalls
int pauseAllCalls()Pause all currently running calls.
- Returns:
- 0
-
playDtmf
void playDtmf(char dtmf, int durationMs) Plays a dtmf sound to the local user.
- Parameters:
dtmf
- DTMF to play ['0'..'16'] | '#' | '#'durationMs
- Duration in ms, -1 means play until next further call to
stopDtmf()
-
playLocal
Plays an audio file to the local user.
This function works at any time, during calls, or when no calls are running. It
doesn't request the underlying audio system to support multiple playback
streams.- Parameters:
audiofile
- The path to an audio file in wav PCM 16 bit format- Returns:
- 0 on success, -1 on error
-
preemptSoundResources
int 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.- Returns:
- An integer returning the exit value. If it is 0, sound resources have
been emptied. Otherwise, sound resources are busy and cannot be freed
immediately.
-
previewOglRender
void previewOglRender()Call generic OpenGL render for a given core.
-
processPushNotification
Call this method when you receive a push notification (if you handle push
notifications manually).
It will ensure the proxy configs are correctly registered to the proxy server,
so the call or the message will be correctly delivered.- Parameters:
callId
- the Call-ID of the MESSAGE or INVITE for which the push was
received and to wait for.
-
publish
@Nullable Event publish(@NonNull Address resource, @NonNull String event, int expires, @NonNull Content body) Publish an event state.
This first create aEvent
withcreatePublish(org.linphone.core.Address, java.lang.String, int)
and callsEvent.sendPublish(org.linphone.core.Content)
to actually send it. After expiry, the publication is refreshed unless it is
terminated before.- Parameters:
resource
- the resource uri for the eventevent
- the event nameexpires
- the lifetime of event being published, -1 if no associated
duration, in which case it will not be refreshed.body
- the actual published data- Returns:
- the
Event
holding the context of the publish.
-
realtimeTextGetKeepaliveInterval
int realtimeTextGetKeepaliveInterval()Gets keep alive interval of real time text.
- Returns:
- keep alive interval of real time text.
-
realtimeTextSetKeepaliveInterval
void realtimeTextSetKeepaliveInterval(int interval) Set keep alive interval for real time text.
- Parameters:
interval
- The keep alive interval of real time text, 25000 by default.
-
refreshRegisters
void refreshRegisters()force registration refresh to be initiated upon next iterate
-
rejectSubscriber
Black list a friend.
same asFriend.setIncSubscribePolicy(org.linphone.core.SubscribePolicy)
withSubscribePolicy.SPDeny
policy;- Parameters:
linphoneFriend
-Friend
to reject
-
reloadMsPlugins
Reload mediastreamer2 plugins from specified directory.
- Parameters:
path
- the path from where plugins are to be loaded, pass null to use
default (compile-time determined) plugin directory.
-
reloadSoundDevices
void 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. -
reloadVideoDevices
void 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. -
removeAccount
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.- Parameters:
account
- theAccount
to remove
-
removeAuthInfo
Removes an authentication information object.
- Parameters:
info
- TheAuthInfo
to remove.
-
removeCallLog
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.- Parameters:
callLog
-CallLog
object to remove.
-
removeContentTypeSupport
Remove support for the specified content type.
It is the application responsibility to handle it correctly afterwards.- Parameters:
contentType
- The content type to remove support for
-
removeFriendList
Removes a friend list.
- Parameters:
list
-FriendList
object
-
removeFromConference
Remove a call from the conference.
- Parameters:
call
- a call that has been previously merged into the conference.
After removing the remote participant belonging to the supplied call, the call
becomes a normal call in paused state. If one single remote participant is left
alone together with the local user in the conference after the removal, then
the conference is automatically transformed into a simple call in
StreamsRunning state. The conference's resources are then automatically
destroyed.
In other words, unlessleaveConference()
is explicitly called, the last
remote participant of a conference is automatically put in a simple call in
running state.- Returns:
- 0 if successful, -1 otherwise.
-
removeLdap
Remove a LDAP from the configuration.
- Parameters:
ldap
- The LDAP to remove.
-
removeLinphoneSpec
Remove the given linphone specs from the list of functionalities the linphone
client supports.
- Parameters:
spec
- The spec to remove
-
removeProxyConfig
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.- Parameters:
config
- theProxyConfig
to remove
-
removeSupportedTag
Remove a supported tag.
- Parameters:
tag
- The tag to remove
see:addSupportedTag(java.lang.String)
-
resetEchoCancellationCalibration
void resetEchoCancellationCalibration()Clears all state resulting from a previous echo canceller calibration
procedure, which restores default policy and settings for echo cancellation.
see:#enableEchoCancellation
andstartEchoCancellerCalibration()
-
resetMissedCallsCount
void resetMissedCallsCount()Reset the counter of missed calls.
-
searchChatRoom
@Nullable ChatRoom searchChatRoom(@Nullable ChatRoomParams params, @Nullable Address localAddr, @Nullable Address remoteAddr, @Nullable Address[] participants) Find a chat room.
- Parameters:
params
- The chat room parameters to matchChatRoomParams
or null
localAddr
-Address
representing the local proxy configuration or
nullremoteAddr
-Address
to search for or nullparticipants
- The participants that must be present in the chat room to
find.- Returns:
- A matching chat room or null if none matches.
-
searchConference
@Nullable Conference searchConference(@Nullable ConferenceParams params, @Nullable Address localAddr, @Nullable Address remoteAddr, @Nullable Address[] participants) Find a conference.
- Parameters:
params
- The conference parameters to matchConferenceParams
or
nulllocalAddr
-Address
representing the local proxy configuration or
nullremoteAddr
-Address
to search for or nullparticipants
- The participants that must be present in the chat room to
find- Returns:
- A pointer on
Conference
satisfying the non-null function
arguments or null if none matches
-
searchConference
Find a conference.
- Parameters:
conferenceAddr
-Address
representing the conference address- Returns:
- A pointer on
Conference
whose conference address is the one
provided as argument or null if none matches
-
setAudioPortRange
void setAudioPortRange(int minPort, int maxPort) Sets the UDP port range from which to randomly select the port used for audio
streaming.
- Parameters:
minPort
- The lower bound of the audio port range to usemaxPort
- The upper bound of the audio port range to use
-
setQrcodeDecodeRect
void setQrcodeDecodeRect(int x, int y, int w, int h) Set the rectangle where the decoder will search a QRCode.
- Parameters:
x
- axisy
- axisw
- widthh
- height
-
setTextPortRange
void setTextPortRange(int minPort, int maxPort) Sets the UDP port range from which to randomly select the port used for text
streaming.
- Parameters:
minPort
- The lower bound of the text port range to usemaxPort
- The upper bound of the text port range to use
-
setTone
Assign an audio file to be played as a specific tone id.
This function typically allows to customize telephony tones per country.- Parameters:
toneId
- the #LinphoneToneIdaudiofile
- a wav file to be played or null to disable it.
-
setUserAgent
Set the user agent string used in SIP messages.
Set the user agent string used in SIP messages as "[ua_name]/[version]". No
slash character will be printed if null is given to "version". If null is given
to "ua_name" and "version" both, the User-agent header will be empty.
This function should be called just after linphone_factory_create_core ideally.- Parameters:
name
- Name of the user agent.version
- Version of the user agent.
-
setVideoPortRange
void setVideoPortRange(int minPort, int maxPort) Sets the UDP port range from which to randomly select the port used for video
streaming.
- Parameters:
minPort
- The lower bound of the video port range to usemaxPort
- The upper bound of the video port range to use
-
soundDeviceCanCapture
Deprecated.08/07/2020 useAudioDevice
API instead()Tells whether a specified sound device can capture sound.
- Parameters:
device
- the device name as returned by linphone_core_get_sound_devices- Returns:
- A boolean value telling whether the specified sound device can capture
sound
-
soundDeviceCanPlayback
Deprecated.08/07/2020 useAudioDevice
API instead()Tells whether a specified sound device can play sound.
- Parameters:
device
- the device name as returned by linphone_core_get_sound_devices- Returns:
- A boolean value telling whether the specified sound device can play
sound
-
soundResourcesLocked
boolean 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 usesoundResourcesLocked()
to know whether it is
possible at a given time to start a new outgoing call. When the function
returns true, an application should not allow the user to start an outgoing
call.- Returns:
- A boolean value telling whether a call will need the sound resources in
near future
-
start
int start()Start aCore
object after it has been instantiated and not
automatically started.
Also re-initialize aCore
object that has been stopped usingstop()
. Must be called only ifGlobalState
is either Ready of Off. State will
changed to Startup, Configuring and then On.- Returns:
- 0: success, -1: global failure, -2: could not connect database
-
startConferenceRecording
Deprecated.14/09/2021 UseConference.startRecording(java.lang.String)
instead.Start recording the running conference.
- Parameters:
path
- Path to the file where the recording will be written- Returns:
- 0 if succeeded. Negative number if failed
-
startEchoCancellerCalibration
int startEchoCancellerCalibration()Starts an echo calibration of the sound devices, in order to find adequate
settings for the echo canceler automatically.
- Returns:
- LinphoneStatus whether calibration has started or not.
-
startEchoTester
int startEchoTester(int rate) Start the simulation of call to test the latency with an external device.
- Parameters:
rate
- Sound sample rate.- Returns:
- -1 in case of failure, 1 otherwise.
-
stop
void stop()Stop aCore
object after it has been instantiated and started.
If stopped, it can be started again usingstart()
. Must be called only
ifGlobalState
is either On. State will changed to Shutdown and then
Off. -
stopAsync
void stopAsync()Stop asynchronously aCore
object after it has been instantiated and
started.
State changes to Shutdown theniterate()
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 ifGlobalState
is On. WhenGlobalState
is OffCore
can be started again using
start()
. -
stopConferenceRecording
Deprecated.14/09/2021 UseConference.stopRecording()
instead.Stop recording the running conference.
- Returns:
- 0 if succeeded. Negative number if failed
-
stopDtmf
void stopDtmf() -
stopEchoTester
int stopEchoTester()Stop the simulation of call.
-
stopRinging
void 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. -
subscribe
@NonNull Event subscribe(@NonNull Address resource, @NonNull String event, int expires, @Nullable Content body) 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.- Parameters:
resource
- the destination resourceevent
- the event nameexpires
- the whished duration of the subscriptionbody
- an optional body, may be null.- Returns:
- a
Event
holding the context of the created subcription.
-
takePreviewSnapshot
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.- Parameters:
file
- a path where to write the jpeg content.- Returns:
- 0 if successful, -1 otherwise (typically if jpeg format is not
supported).
-
terminateAllCalls
int terminateAllCalls()Terminates all the calls.
- Returns:
- 0
-
terminateConference
int 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.- Returns:
- 0 if succeeded. Negative number if failed
-
uploadLogCollection
void uploadLogCollection()Upload the log collection to the configured server url.
-
usePreviewWindow
void usePreviewWindow(boolean yesno) Tells the core to use a separate window for local camera preview video, instead
of inserting local view within the remote video window.
- Parameters:
yesno
- true to use a separate window, false to insert the preview in the
remote video window.
-
verifyServerCertificates
void verifyServerCertificates(boolean yesno) Specify whether the tls server certificate must be verified when connecting to
a SIP/TLS server.
- Parameters:
yesno
- A boolean value telling whether the tls server certificate must be
verified
-
verifyServerCn
void verifyServerCn(boolean yesno) Specify whether the tls server certificate common name must be verified when
connecting to a SIP/TLS server.
- Parameters:
yesno
- A boolean value telling whether the tls server certificate common
name must be verified
-
videoSupported
boolean videoSupported()Test if video is supported.
- Returns:
- true if the library was built with video support, false otherwise
-
compressLogCollection
Compress the log collection in a single file.
- Returns:
- The path of the compressed log collection file (to be freed calling
ms_free()).
-
enableLogCollection
Enable the linphone core log collection to upload logs on a server.
- Parameters:
state
-LogCollectionState
value telling whether to enable log
collection or not.
-
getLogCollectionMaxFileSize
@NonNull int getLogCollectionMaxFileSize()Get the max file size in bytes of the files used for log collection.
- Returns:
- The max file size in bytes of the files used for log collection.
-
getLogCollectionPath
Get the path where the log files will be written for log collection.
- Returns:
- The path where the log files will be written.
-
getLogCollectionPrefix
Get the prefix of the filenames that will be used for log collection.
- Returns:
- The prefix of the filenames used for log collection.
-
getPostQuantumAvailable
boolean getPostQuantumAvailable()Are PostQuantum algoritms available.
- Returns:
- true if Post Quantum algorithms are available false otherwise
-
getVersion
Returns liblinphone's version as a string.
- Returns:
- the current version of the
Core
-
logCollectionEnabled
LogCollectionState logCollectionEnabled()Tells whether the linphone core log collection is enabled.
- Returns:
- The
LogCollectionState
of theCore
log collection.
-
resetLogCollection
void resetLogCollection()Reset the log collection by removing the log files.
-
serializeLogs
void serializeLogs()Enable logs serialization (output logs from either the thread that creates the
linphone core or the thread that callsiterate()
).
Must be called before creating the linphone core. -
setLogCollectionMaxFileSize
void setLogCollectionMaxFileSize(int size) 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 callingenableLogCollection(org.linphone.core.LogCollectionState)
. If you increase max
size on runtime, logs chronological order COULD be broken.- Parameters:
size
- The max file size in bytes of the files used for log collection.
-
setLogCollectionPath
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 withenableLogCollection(org.linphone.core.LogCollectionState)
before doing modifications.- Parameters:
path
- The path where the log files will be written.
-
setLogCollectionPrefix
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
enableLogCollection(org.linphone.core.LogCollectionState)
before doing modifications.- Parameters:
prefix
- The prefix to use for the filenames for log collection.
-
tunnelAvailable
boolean tunnelAvailable()True if tunnel support was compiled.
- Returns:
- true if library was built with tunnel, false otherwise
-
upnpAvailable
boolean upnpAvailable()Return the availability of uPnP.
- Returns:
- true if uPnP is available otherwise return false.
-
vcardSupported
boolean vcardSupported()Tells whether VCARD support is builtin.
- Returns:
- true if VCARD is supported, false otherwise.
-
addListener
-
removeListener
-
setUserData
Sets the object to store in this object user's data- Parameters:
data
- the object to store
-
getUserData
Object getUserData()Gets the object stored in this object user's data- Returns:
- the object store if any, null otherwise
-
getNativePointer
long getNativePointer()Gets the native pointer used by this class to make native method calls.- Returns:
- the nativer pointer, as long
-
toString
String toString()
-