public interface Core
Modifier and Type | Interface and Description |
---|---|
static class |
Core.LogCollectionUploadState |
Modifier and Type | Method and Description |
---|---|
int |
acceptCall(Call call)
Deprecated.
Use
Call.accept() instead. Deprecated since 2017-02-13. |
int |
acceptCallUpdate(Call call,
CallParams params)
Deprecated.
Use
Call.acceptUpdate(org.linphone.core.CallParams) instead. Deprecated since 2017-02-13. |
int |
acceptCallWithParams(Call call,
CallParams params)
Deprecated.
Use
Call.acceptWithParams(org.linphone.core.CallParams) instead. Deprecated since
2017-02-13. |
int |
acceptEarlyMedia(Call call)
Deprecated.
Use
Call.acceptEarlyMedia() instead. Deprecated since
2017-02-13. |
int |
acceptEarlyMediaWithParams(Call call,
CallParams params)
Deprecated.
|
void |
activateAudioSession(boolean actived)
Special function to indicate if the audio session is activated.
|
boolean |
adaptiveRateControlEnabled()
Returns whether adaptive rate control is enabled.
|
int |
addAllToConference()
Add all current calls into the conference.
|
void |
addAuthInfo(AuthInfo info)
Adds authentication information to the
Core . |
void |
addFriend(Friend fr)
Deprecated.
use
FriendList.addFriend(org.linphone.core.Friend) instead. |
void |
addFriendList(FriendList list)
Add a friend list.
|
void |
addLinphoneSpec(java.lang.String spec)
Add the given linphone specs to the list of functionalities the linphone client
supports.
|
void |
addListener(CoreListener listener) |
int |
addProxyConfig(ProxyConfig config)
Add a proxy configuration.
|
void |
addSupportedTag(java.lang.String tag)
This function controls signaling features supported by the core.
|
int |
addToConference(Call call)
Add a participant to the conference.
|
boolean |
audioAdaptiveJittcompEnabled()
Tells whether the audio adaptive jitter compensation is enabled.
|
boolean |
audioMulticastEnabled()
Use to get multicast state of audio stream.
|
void |
audioRouteChanged()
Special function to indicate if the audio route is changed.
|
boolean |
callkitEnabled()
Special function to check if the callkit is enabled, False by default.
|
boolean |
chatEnabled()
Returns whether chat is enabled.
|
void |
checkForUpdate(java.lang.String currentVersion)
Checks if a new version of the application is available.
|
void |
clearAllAuthInfo()
Clear all authentication information.
|
void |
clearCallLogs()
Erase the call log.
|
void |
clearProxyConfig()
Erase all proxies from config.
|
java.lang.String |
compressLogCollection()
Compress the log collection in a single file.
|
boolean |
conferenceServerEnabled()
Tells whether the conference server feature is enabled.
|
AccountCreator |
createAccountCreator(java.lang.String xmlrpcUrl)
Create a
AccountCreator and set Linphone Request callbacks. |
Address |
createAddress(java.lang.String address)
Create a
Address object by parsing the user supplied address, given as
a string. |
AuthInfo |
createAuthInfo(java.lang.String username,
java.lang.String userid,
java.lang.String passwd,
java.lang.String ha1,
java.lang.String realm,
java.lang.String domain)
|
CallLog |
createCallLog(Address from,
Address to,
Call.Dir dir,
int duration,
long startTime,
long connectedTime,
Call.Status status,
boolean videoEnabled,
float quality)
Creates a fake LinphoneCallLog.
|
CallParams |
createCallParams(@Nullable Call call)
Create a
CallParams suitable for inviteWithParams(java.lang.String, org.linphone.core.CallParams) , acceptCallWithParams(org.linphone.core.Call, org.linphone.core.CallParams) , acceptEarlyMediaWithParams(org.linphone.core.Call, org.linphone.core.CallParams) , acceptCallUpdate(org.linphone.core.Call, org.linphone.core.CallParams) . |
ChatRoom |
createChatRoom(Address participant) |
ChatRoom |
createChatRoom(ChatRoomParams params,
Address localAddr,
Address participant) |
ChatRoom |
createChatRoom(ChatRoomParams params,
Address localAddr,
java.lang.String subject,
Address[] participants)
Create a chat room.
|
ChatRoom |
createChatRoom(ChatRoomParams params,
java.lang.String subject,
Address[] participants)
Create a chat room.
|
ChatRoom |
createChatRoom(java.lang.String subject,
Address[] participants) |
ChatRoom |
createClientGroupChatRoom(java.lang.String subject,
boolean fallback)
Create a client-side group chat room.
|
ChatRoom |
createClientGroupChatRoom(java.lang.String subject,
boolean fallback,
boolean encrypted)
Create a client-side group chat room.
|
ConferenceParams |
createConferenceParams()
Create some default conference parameters for instanciating a a conference with
createConferenceWithParams(org.linphone.core.ConferenceParams) . |
Conference |
createConferenceWithParams(ConferenceParams params)
Create a conference.
|
Config |
createConfig(java.lang.String filename)
Create a
Config object from a user config file. |
Content |
createContent()
Create a content with default values from Linphone core.
|
ChatRoomParams |
createDefaultChatRoomParams()
Creates and returns the default chat room parameters.
|
Friend |
createFriend()
Create a default LinphoneFriend.
|
FriendList |
createFriendList()
Create a new empty
FriendList object. |
Friend |
createFriendWithAddress(java.lang.String address)
Create a
Friend from the given address. |
InfoMessage |
createInfoMessage()
Creates an empty info message.
|
Player |
createLocalPlayer(java.lang.String soundCardName,
java.lang.String videoDisplayName,
java.lang.Object windowId)
Create an independent media file player.
|
MagicSearch |
createMagicSearch()
Create a
MagicSearch object. |
NatPolicy |
createNatPolicy()
Create a new
NatPolicy object with every policies being disabled. |
NatPolicy |
createNatPolicyFromConfig(java.lang.String ref)
|
Event |
createNotify(Address resource,
java.lang.String event)
Create an out-of-dialog notification, specifying the destination resource, the
event name.
|
Event |
createOneShotPublish(Address resource,
java.lang.String event)
Create a publish context for a one-shot publish.
|
PresenceActivity |
createPresenceActivity(PresenceActivity.Type acttype,
java.lang.String description)
Create a
PresenceActivity with the given type and description. |
PresenceModel |
createPresenceModel()
Create a default LinphonePresenceModel.
|
PresenceModel |
createPresenceModelWithActivity(PresenceActivity.Type acttype,
java.lang.String description)
Create a
PresenceModel with the given activity type and activity
description. |
PresenceModel |
createPresenceModelWithActivityAndNote(PresenceActivity.Type acttype,
java.lang.String description,
java.lang.String note,
java.lang.String lang)
Create a
PresenceModel with the given activity type, activity
description, note content and note language. |
PresenceNote |
createPresenceNote(java.lang.String content,
java.lang.String lang)
Create a
PresenceNote with the given content and language. |
PresencePerson |
createPresencePerson(java.lang.String id)
Create a
PresencePerson with the given id. |
PresenceService |
createPresenceService(java.lang.String id,
PresenceBasicStatus basicStatus,
java.lang.String contact)
Create a
PresenceService with the given id, basic status and contact. |
Address |
createPrimaryContactParsed()
Same as
getPrimaryContact() but the result is a Address
object instead of const char *. |
ProxyConfig |
createProxyConfig()
Create a proxy config with default values from Linphone core.
|
Event |
createPublish(Address resource,
java.lang.String event,
int expires)
Create a publish context for an event state.
|
Event |
createSubscribe(Address resource,
ProxyConfig proxy,
java.lang.String event,
int expires)
Create an outgoing subscription, specifying the destination resource, the event
name, and an optional content body.
|
Event |
createSubscribe(Address resource,
java.lang.String event,
int expires)
Create an outgoing subscription, specifying the destination resource, the event
name, and an optional content body.
|
XmlRpcSession |
createXmlRpcSession(java.lang.String url)
Create a
XmlRpcSession for a given url. |
int |
declineCall(Call call,
Reason reason)
Deprecated.
Use
Call.decline(org.linphone.core.Reason) instead. Deprecated since 2017-02-13. |
int |
deferCallUpdate(Call call)
Deprecated.
Use
Call.deferUpdate() instead |
void |
deleteChatRoom(ChatRoom cr)
Removes a chatroom including all message history from the LinphoneCore.
|
void |
disableChat(Reason denyReason)
Inconditionnaly disable incoming chat messages.
|
boolean |
dnsSearchEnabled()
Tells whether DNS search (use of local domain if the fully qualified name did
return results) is enabled.
|
boolean |
dnsSrvEnabled()
Tells whether DNS SRV resolution is enabled.
|
boolean |
echoCancellationEnabled()
Returns true if echo cancellation is enabled.
|
boolean |
echoLimiterEnabled()
Tells whether echo limiter is enabled.
|
void |
enableAdaptiveRateControl(boolean enabled)
Enable adaptive rate control.
|
void |
enableAudioAdaptiveJittcomp(boolean enable)
Enable or disable the audio adaptive jitter compensation.
|
void |
enableAudioMulticast(boolean yesno)
Use to enable multicast rtp for audio stream.
|
void |
enableCallkit(boolean enabled)
Special function to enable the callkit.
|
void |
enableChat()
Enable reception of incoming chat messages.
|
void |
enableConferenceServer(boolean enable)
Enable the conference server feature.
|
void |
enableDnsSearch(boolean enable)
Enable or disable DNS search (use of local domain if the fully qualified name
did return results).
|
void |
enableDnsSrv(boolean enable)
Enable or disable DNS SRV resolution.
|
void |
enableEchoCancellation(boolean val)
Enables or disable echo cancellation.
|
void |
enableEchoLimiter(boolean val)
Enables or disable echo limiter.
|
void |
enableFriendListSubscription(boolean enable)
Sets whether or not to start friend lists subscription when in foreground.
|
void |
enableIpv6(boolean val)
Turns IPv6 support on or off.
|
void |
enableKeepAlive(boolean enable)
Enables signaling keep alive, small udp packet sent periodically to keep udp
NAT association.
|
void |
enableLime(LimeState val)
Deprecated.
Use linphone_core_enable_lime_x3dh instead. Depreacted since
2019-02-04
|
void |
enableLimeX3Dh(boolean enable)
Tells to LinphoneCore to use LIME X3DH.
|
void |
enableLogCollection(LogCollectionState state)
Enable the linphone core log collection to upload logs on a server.
|
void |
enableMic(boolean enable)
Enable or disable the microphone.
|
void |
enableQrcodeVideoPreview(boolean val)
Controls QRCode enablement.
|
void |
enableRetransmissionOnNack(boolean val)
Turns NACK context on or off.
|
void |
enableRtpBundle(boolean value)
Enables or disables RTP bundle mode (Media Multiplexing).
|
void |
enableSdp200Ack(boolean enable)
Control when media offer is sent in SIP INVITE.
|
void |
enableSelfView(boolean val)
Enables or disable self view during calls.
|
void |
enableSenderNameHiddenInForwardMessage(boolean enable)
Enable whether or not to hide sender name in forward message.
|
void |
enableVideoAdaptiveJittcomp(boolean enable)
Enable or disable the video adaptive jitter compensation.
|
void |
enableVideoCapture(boolean enable)
Enable or disable video capture.
|
void |
enableVideoDisplay(boolean enable)
Enable or disable video display.
|
void |
enableVideoMulticast(boolean yesno)
Use to enable multicast rtp for video stream.
|
void |
enableVideoPreview(boolean val)
Controls video preview enablement.
|
void |
enableVideoSourceReuse(boolean enable)
Enable or disable video source reuse when switching from preview to actual
video call.
|
void |
enableWifiOnly(boolean val)
Turns Wifi only mode on or off.
|
void |
ensureRegistered()
Call this method when you receive a push notification.
|
void |
enterBackground()
This method is called by the application to notify the linphone core library
when it enters background mode.
|
int |
enterConference()
Join the local participant to the running conference.
|
void |
enterForeground()
This method is called by the application to notify the linphone core library
when it enters foreground mode.
|
boolean |
fileFormatSupported(java.lang.String fmt)
Returns whether a specific file format is supported.
|
AuthInfo |
findAuthInfo(java.lang.String realm,
java.lang.String username,
java.lang.String sipDomain)
Find authentication info matching realm, username, domain criteria.
|
Call |
findCallFromUri(java.lang.String uri)
Search from the list of current calls if a remote address match uri.
|
CallLog |
findCallLogFromCallId(java.lang.String callId)
Get the call log matching the call id, or null if can't be found.
|
ChatRoom |
findChatRoom(Address peerAddr,
Address localAddr)
Find a chat room.
|
Address[] |
findContactsByChar(java.lang.String filter,
boolean sipOnly)
Retrieves a list of
Address sort and filter. |
Friend |
findFriend(Address addr)
Search a
Friend by its address. |
Friend[] |
findFriends(Address addr)
Search all
Friend matching an address. |
ChatRoom |
findOneToOneChatRoom(Address localAddr,
Address participantAddr)
Deprecated.
Use linphone_core_find_one_to_one_chat_room_2 instead
|
ChatRoom |
findOneToOneChatRoom(Address localAddr,
Address participantAddr,
boolean encrypted)
Find a one to one chat room.
|
java.lang.String |
getAdaptiveRateAlgorithm()
Returns which adaptive rate algorithm is currently configured for future calls.
|
int |
getAudioDscp()
Get the DSCP field for outgoing audio streams.
|
int |
getAudioJittcomp()
Returns the nominal audio jitter buffer size in milliseconds.
|
java.lang.String |
getAudioMulticastAddr()
Use to get multicast address to be used for audio stream.
|
int |
getAudioMulticastTtl()
Use to get multicast ttl to be used for audio stream.
|
PayloadType[] |
getAudioPayloadTypes()
Return the list of the available audio payload types.
|
int |
getAudioPort()
Gets the UDP port used for audio streaming.
|
Range |
getAudioPortsRange()
Get the audio port range from which is randomly chosen the UDP port used for
audio streaming.
|
AuthInfo[] |
getAuthInfoList()
Returns an unmodifiable list of currently entered
AuthInfo . |
AVPFMode |
getAvpfMode()
Return AVPF enablement.
|
int |
getAvpfRrInterval()
Return the avpf report interval in seconds.
|
@Nullable Call |
getCallByRemoteAddress(java.lang.String remoteAddress)
Get the call with the remote_address specified.
|
Call |
getCallByRemoteAddress2(Address remoteAddress)
Get the call with the remote_address specified.
|
CallLog[] |
getCallHistory(Address peerAddr,
Address localAddr)
Get the list of call logs (past calls).
|
CallLog[] |
getCallHistoryForAddress(Address addr)
Deprecated.
Use linphone_core_get_call_history_2 instead. Deprecated since
2018-10-29.
|
CallLog[] |
getCallLogs()
Get the list of call logs (past calls).
|
java.lang.String |
getCallLogsDatabasePath()
Gets the database filename where call logs will be stored.
|
Call[] |
getCalls()
Gets the current list of calls.
|
int |
getCallsNb()
Get the number of Call.
|
int |
getCameraSensorRotation()
Get the camera sensor rotation.
|
java.lang.String |
getCaptureDevice()
Gets the name of the currently assigned sound device for capture.
|
java.lang.String |
getChatDatabasePath()
Deprecated.
2018-01-10
|
ChatRoom |
getChatRoom(Address addr)
Get a basic chat room whose peer is the supplied address.
|
ChatRoom |
getChatRoom(Address peerAddr,
Address localAddr)
Get a basic chat room.
|
ChatRoom |
getChatRoomFromUri(java.lang.String to)
Get a basic chat room for messaging from a sip uri like
sip:joe@sip.linphone.org.
|
ChatRoom[] |
getChatRooms()
Returns an list of chat rooms.
|
Conference |
getConference()
Get a pointer on the internal conference object.
|
float |
getConferenceLocalInputVolume()
Get the set input volume of the local participant.
|
int |
getConferenceSize()
Get the number of participant in the running conference.
|
Config |
getConfig()
Returns the LpConfig object used to manage the storage (config) file.
|
ConsolidatedPresence |
getConsolidatedPresence()
Get my consolidated presence.
|
Call |
getCurrentCall()
Gets the current call.
|
Address |
getCurrentCallRemoteAddress()
Get the remote address of the current call.
|
VideoDefinition |
getCurrentPreviewVideoDefinition()
Get the effective video definition provided by the camera for the captured
video.
|
FriendList |
getDefaultFriendList()
Retrieves the first list of
Friend from the core. |
ProxyConfig |
getDefaultProxyConfig() |
java.lang.String |
getDefaultVideoDisplayFilter()
Get the name of the default mediastreamer2 filter used for rendering video on
the current platform.
|
int |
getDelayedTimeout()
Gets the delayed timeout See
setDelayedTimeout(int) for details. |
int |
getDeviceRotation()
Gets the current device orientation.
|
boolean |
getDnsSetByApp()
Tells if the DNS was set by an application.
|
int |
getDownloadBandwidth()
Retrieve the maximum available download bandwidth.
|
int |
getDownloadPtime()
Get audio packetization time linphone expects to receive from peer.
|
java.lang.String |
getEchoCancellerFilterName()
Get the name of the mediastreamer2 filter used for echo cancelling.
|
java.lang.String |
getFileTransferServer()
Get the globaly set http file transfer server to be used for content type
application/vnd.gsma.rcs-ft-http+xml.
|
Friend |
getFriendByRefKey(java.lang.String key)
Search a
Friend by its reference key. |
FriendList |
getFriendListByName(java.lang.String name)
Retrieves the list of
Friend from the core that has the given display
name. |
java.lang.String |
getFriendsDatabasePath()
Gets the database filename where friends will be stored.
|
FriendList[] |
getFriendsLists()
Retrieves the list of
FriendList from the core. |
boolean |
getGuessHostname()
Returns true if hostname part of primary contact is guessed automatically.
|
java.lang.String |
getHttpProxyHost()
Get http proxy address to be used for signaling.
|
int |
getHttpProxyPort()
Get http proxy port to be used for signaling.
|
java.lang.String |
getIdentity()
Gets the default identity SIP address.
|
ImNotifPolicy |
getImNotifPolicy()
Get the
ImNotifPolicy object controlling the instant messaging
notifications. |
int |
getInCallTimeout()
Gets the in call timeout See
setInCallTimeout(int) for details. |
int |
getIncTimeout()
Returns the incoming call timeout See
setIncTimeout(int) for details. |
CallLog |
getLastOutgoingCallLog()
Get the latest outgoing call log.
|
java.lang.String |
getLimeX3DhServerUrl()
Get the x3dh server url.
|
java.lang.String |
getLinphoneSpecs()
Deprecated.
Use linphone_core_get_linphone_specs_list instead. Deprecated since
2019-02-07
|
java.lang.String[] |
getLinphoneSpecsList()
Get the list of linphone specs string values representing what functionalities
the linphone client supports.
|
int |
getLogCollectionMaxFileSize()
Get the max file size in bytes of the files used for log collection.
|
java.lang.String |
getLogCollectionPath()
Get the path where the log files will be written for log collection.
|
java.lang.String |
getLogCollectionPrefix()
Get the prefix of the filenames that will be used for log collection.
|
java.lang.String |
getLogCollectionUploadServerUrl()
Gets the url of the server where to upload the collected log files.
|
int |
getLogLevelMask()
Deprecated.
Use
LoggingService.getLogLevelMask() instead. Deprecated
since 2017-10-10. |
int |
getMaxCalls()
Get the maximum number of simultaneous calls Linphone core can manage at a
time.
|
int |
getMaxSizeForAutoDownloadIncomingFiles()
Gets the size under which incoming files in chat messages will be downloaded
automatically.
|
java.lang.String |
getMediaDevice()
Gets the name of the currently assigned sound device for media.
|
MediaEncryption |
getMediaEncryption()
Get the media encryption policy being used for RTP packets.
|
Factory |
getMediastreamerFactory()
Gets the mediastreamer's factory
|
float |
getMicGainDb()
Get microphone gain in db.
|
int |
getMissedCallsCount()
Get the number of missed calls.
|
int |
getMtu()
Returns the maximum transmission unit size in bytes.
|
java.lang.String |
getNatAddress()
Get the public IP address of NAT being used.
|
java.lang.Object |
getNativePreviewWindowId()
Get the native window handle of the video preview window.
|
java.lang.Object |
getNativeVideoWindowId()
Get the native window handle of the video window.
|
NatPolicy |
getNatPolicy()
Get The policy that is used to pass through NATs/firewalls.
|
int |
getNortpTimeout()
Gets the value of the no-rtp timeout.
|
PayloadType |
getPayloadType(java.lang.String type,
int rate,
int channels)
Get payload type from mime type and clock rate.
|
java.lang.String |
getPlaybackDevice()
Gets the name of the currently assigned sound device for playback.
|
float |
getPlaybackGainDb()
Get playback gain in db before entering sound card.
|
java.lang.String |
getPlayFile()
Get the wav file that is played when putting somebody on hold, or when files
are used instead of soundcards (see
setUseFiles(boolean) ). |
float |
getPreferredFramerate()
Returns the preferred video framerate, previously set by
setPreferredFramerate(float) . |
VideoDefinition |
getPreferredVideoDefinition()
Get the preferred video definition for the stream that is captured and sent to
the remote party.
|
PresenceModel |
getPresenceModel()
Get my presence model.
|
VideoDefinition |
getPreviewVideoDefinition()
Get the definition of the captured video.
|
java.lang.String |
getPrimaryContact()
Returns the default identity when no proxy configuration is used.
|
Address |
getPrimaryContactParsed()
Deprecated.
Use
createPrimaryContactParsed() instead. Deprecated
since 2018-10-22. |
java.lang.String |
getProvisioningUri()
Get provisioning URI.
|
ProxyConfig |
getProxyConfigByIdkey(java.lang.String idkey) |
ProxyConfig[] |
getProxyConfigList()
Returns an unmodifiable list of entered proxy configurations.
|
java.lang.String |
getRecordFile()
Get the wav file where incoming stream is recorded, when files are used instead
of soundcards (see
setUseFiles(boolean) ). |
java.lang.String |
getRemoteRingbackTone()
Get the ring back tone played to far end during incoming calls.
|
java.lang.String |
getRing()
Returns the path to the wav file used for ringing.
|
java.lang.String |
getRingback()
Returns the path to the wav file used for ringing back.
|
boolean |
getRingDuringIncomingEarlyMedia()
Tells whether the ring play is enabled during an incoming early media call.
|
java.lang.String |
getRingerDevice()
Gets the name of the currently assigned sound device for ringing.
|
java.lang.String |
getRootCa()
Gets the path to a file or folder containing the trusted root CAs (PEM format)
|
boolean |
getSessionExpiresEnabled()
Check if the Session Timers feature is enabled.
|
int |
getSessionExpiresMinValue()
Returns the session expires min value, 90 by default.
|
SessionExpiresRefresher |
getSessionExpiresRefresherValue()
Returns the session expires refresher value.
|
int |
getSessionExpiresValue()
Returns the session expires value.
|
int |
getSipDscp()
Get the DSCP field for SIP signaling channel.
|
int |
getSipTransportTimeout()
Get the SIP transport timeout.
|
java.lang.String[] |
getSoundDevicesList()
Gets the list of the available sound devices.
|
java.lang.String |
getStaticPicture()
Get the path to the image file streamed when "Static picture" is set as the
video device.
|
float |
getStaticPictureFps()
Get the frame rate for static picture.
|
java.lang.String |
getStunServer()
Get the STUN server address being used.
|
java.lang.String[] |
getSupportedFileFormatsList()
Returns a null terminated table of strings containing the file format extension
supported for call recording.
|
PayloadType[] |
getTextPayloadTypes()
Return the list of the available text payload types.
|
int |
getTextPort()
Gets the UDP port used for text streaming.
|
Range |
getTextPortsRange()
Get the text port range from which is randomly chosen the UDP port used for
text streaming.
|
java.lang.String |
getTlsCert()
Gets the TLS certificate.
|
java.lang.String |
getTlsCertPath()
Gets the path to the TLS certificate file.
|
java.lang.String |
getTlsKey()
Gets the TLS key.
|
java.lang.String |
getTlsKeyPath()
Gets the path to the TLS key file.
|
Transports |
getTransports()
Retrieves the port configuration used for each transport (udp, tcp, tls).
|
Transports |
getTransportsUsed()
Retrieves the real port number assigned for each sip transport (udp, tcp, tls).
|
Tunnel |
getTunnel()
get tunnel instance if available
|
int |
getUnreadChatMessageCount()
Return the global unread chat message count.
|
int |
getUnreadChatMessageCountFromActiveLocals()
Return the unread chat message count for all active local address.
|
int |
getUnreadChatMessageCountFromLocal(Address address)
Return the unread chat message count for a given local address.
|
int |
getUploadBandwidth()
Retrieve the maximum available upload bandwidth.
|
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.
|
java.lang.String |
getUpnpExternalIpaddress()
Return the external ip address of router.
|
UpnpState |
getUpnpState()
Return the internal state of uPnP.
|
boolean |
getUseFiles()
Gets whether linphone is currently streaming audio from and to files, rather
than using the soundcard.
|
boolean |
getUseInfoForDtmf()
Indicates whether SIP INFO is used to send digits.
|
java.lang.String |
getUserAgent() |
java.lang.String |
getUserCertificatesPath()
Get the path to the directory storing the user's certificates.
|
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
boolean |
getUseRfc2833ForDtmf()
Indicates whether RFC2833 is used to send digits.
|
java.lang.String |
getVersion()
Returns liblinphone's version as a string.
|
VideoActivationPolicy |
getVideoActivationPolicy()
Get the default policy for video.
|
java.lang.String |
getVideoDevice()
Returns the name of the currently active video device.
|
java.lang.String[] |
getVideoDevicesList()
Gets the list of the available video capture devices.
|
java.lang.String |
getVideoDisplayFilter()
Get the name of the mediastreamer2 filter used for rendering video.
|
int |
getVideoDscp()
Get the DSCP field for outgoing video streams.
|
int |
getVideoJittcomp()
Returns the nominal video jitter buffer size in milliseconds.
|
java.lang.String |
getVideoMulticastAddr()
Use to get multicast address to be used for video stream.
|
int |
getVideoMulticastTtl()
Use to get multicast ttl to be used for video stream.
|
PayloadType[] |
getVideoPayloadTypes()
Return the list of the available video payload types.
|
int |
getVideoPort()
Gets the UDP port used for video streaming.
|
Range |
getVideoPortsRange()
Get the video port range from which is randomly chosen the UDP port used for
video streaming.
|
java.lang.String |
getVideoPreset()
Get the video preset used for video calls.
|
java.lang.String |
getZrtpSecretsFile()
Get the path to the file storing the zrtp secrets cache.
|
ZrtpPeerStatus |
getZrtpStatus(java.lang.String addr)
Get the zrtp sas validation status for a peer uri.
|
boolean |
hasBuiltinEchoCanceller()
Check whether the device has a hardware echo canceller.
|
boolean |
hasCrappyOpengl()
Check whether the device is flagged has crappy opengl.
|
boolean |
inCall()
Tells whether there is a call running.
|
Address |
interpretUrl(java.lang.String url)
See linphone_proxy_config_normalize_sip_uri for documentation.
|
Call |
invite(java.lang.String url)
Initiates an outgoing call.
|
Call |
inviteAddress(Address addr)
Initiates an outgoing call given a destination
Address The Address can be constructed directly using linphone_address_new, or created by
interpretUrl(java.lang.String) . |
Call |
inviteAddressWithParams(Address addr,
CallParams params)
Initiates an outgoing call given a destination
Address The Address can be constructed directly using linphone_address_new, or created by
interpretUrl(java.lang.String) . |
Call |
inviteWithParams(java.lang.String url,
CallParams params)
Initiates an outgoing call according to supplied call parameters The
application doesn't own a reference to the returned
Call object. |
boolean |
ipv6Enabled()
Tells whether IPv6 is enabled or not.
|
boolean |
isEchoCancellerCalibrationRequired()
Check whether the device is echo canceller calibration is required.
|
boolean |
isFriendListSubscriptionEnabled()
Returns whether or not friend lists subscription are enabled.
|
boolean |
isIncomingInvitePending()
Tells whether there is an incoming invite pending.
|
boolean |
isInConference()
Indicates whether the local participant is part of a conference.
|
boolean |
isMediaEncryptionMandatory()
Check if the configured media encryption is mandatory or not.
|
boolean |
isMediaFilterSupported(java.lang.String filtername)
Checks if the given media filter is loaded and usable.
|
boolean |
isNetworkReachable()
return network state either as positioned by the application or by linphone
itself.
|
boolean |
isSenderNameHiddenInForwardMessage()
Returns whether or not sender name is hidden in forward message.
|
void |
iterate()
Main loop function.
|
boolean |
keepAliveEnabled()
Is signaling keep alive enabled.
|
int |
leaveConference()
Make the local participant leave the running conference.
|
boolean |
limeAvailable()
Deprecated.
Use linphone_core_lime_x3dh_available instead. Depreacted since
2019-02-04
|
LimeState |
limeEnabled()
Deprecated.
Use linphone_core_lime_x3dh_enabled instead. Depreacted since
2019-02-04
|
boolean |
limeX3DhAvailable()
Tells if LIME X3DH is available.
|
boolean |
limeX3DhEnabled()
Tells wether LIME X3DH is enabled or not.
|
void |
loadConfigFromXml(java.lang.String xmlUri)
Update current config with the content of a xml config file.
|
LogCollectionState |
logCollectionEnabled()
Tells whether the linphone core log collection is enabled.
|
boolean |
mediaEncryptionSupported(MediaEncryption menc)
Check if a media encryption type is supported.
|
boolean |
micEnabled()
Tells whether the microphone is enabled.
|
void |
migrateLogsFromRcToDb()
Migrates the call logs from the linphonerc to the database if not done yet.
|
int |
migrateToMultiTransport()
Migrate configuration so that all SIP transports are enabled.
|
void |
notifyAllFriends(PresenceModel presence)
Notify all friends that have subscribed.
|
void |
notifyNotifyPresenceReceived(Friend lf)
Notifies the upper layer that a presence status has been received by calling
the appropriate callback if one has been set.
|
void |
notifyNotifyPresenceReceivedForUriOrTel(Friend lf,
java.lang.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 |
pauseAllCalls()
Pause all currently running calls.
|
int |
pauseCall(Call call)
Deprecated.
Use
Call.pause() instead. Deprecated since 2017-02-13. |
void |
playDtmf(char dtmf,
int durationMs)
Plays a dtmf sound to the local user.
|
int |
playLocal(java.lang.String audiofile)
Plays an audio file to the local user.
|
void |
previewOglRender()
Call generic OpenGL render for a given core.
|
Event |
publish(Address resource,
java.lang.String event,
int expires,
Content body)
Publish an event state.
|
boolean |
qrcodeVideoPreviewEnabled()
Tells whether QRCode is enabled in the preview.
|
boolean |
realtimeTextEnabled()
Gets if realtime text is enabled or not.
|
int |
realtimeTextGetKeepaliveInterval()
Gets keep alive interval of real time text.
|
void |
realtimeTextSetKeepaliveInterval(int interval)
Set keep alive interval for real time text.
|
int |
redirectCall(Call call,
java.lang.String redirectUri)
Deprecated.
Use
Call.redirect(java.lang.String) instead. Deprecated since 2017-02-13. |
void |
refreshRegisters()
force registration refresh to be initiated upon next iterate
|
void |
rejectSubscriber(Friend lf)
Black list a friend.
|
void |
reloadMsPlugins(java.lang.String path)
Reload mediastreamer2 plugins from specified directory.
|
void |
reloadSoundDevices()
Update detection of sound devices.
|
void |
reloadVideoDevices()
Update detection of camera devices.
|
void |
removeAuthInfo(AuthInfo info)
Removes an authentication information object.
|
void |
removeCallLog(CallLog callLog)
Remove a specific call log from call history list.
|
void |
removeFriendList(FriendList list)
Removes a friend list.
|
int |
removeFromConference(Call call)
Remove a call from the conference.
|
void |
removeLinphoneSpec(java.lang.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(java.lang.String tag)
Remove a supported tag.
|
void |
resetLogCollection()
Reset the log collection by removing the log files.
|
void |
resetMissedCallsCount()
Reset the counter of missed calls.
|
int |
resumeCall(Call call)
Deprecated.
Use
Call.resume() instead. Deprecated since 2017-02-13. |
boolean |
retransmissionOnNackEnabled()
Tells whether NACK context is enabled or not.
|
boolean |
rtpBundleEnabled()
Returns whether RTP bundle mode (also known as Media Multiplexing) is enabled.
|
boolean |
sdp200AckEnabled()
Media offer control param for SIP INVITE.
|
boolean |
selfViewEnabled()
Tells whether video self view during call is enabled or not.
|
void |
serializeLogs()
Enable logs serialization (output logs from either the thread that creates the
linphone core or the thread that calls
iterate() ). |
void |
setAdaptiveRateAlgorithm(java.lang.String algorithm)
Sets adaptive rate algorithm.
|
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 |
setAudioMulticastAddr(java.lang.String ip)
Use to set multicast address to be used 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 |
setAvpfMode(AVPFMode mode)
Enable RTCP feedback (also known as RTP/AVPF profile).
|
void |
setAvpfRrInterval(int interval)
Set the avpf report interval in seconds.
|
void |
setCallErrorTone(Reason reason,
java.lang.String audiofile)
Assign an audio file to be played locally upon call failure, for a given
reason.
|
void |
setCallLogsDatabasePath(java.lang.String path)
Sets the database filename where call logs will be stored.
|
int |
setCaptureDevice(java.lang.String devid)
Sets the sound device used for capture.
|
void |
setChatDatabasePath(java.lang.String path)
Deprecated.
2018-01-10: Use only for migration purposes
|
void |
setConsolidatedPresence(ConsolidatedPresence presence)
Set my consolidated presence.
|
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 |
setDnsServers(java.lang.String[] servers)
Forces liblinphone to use the supplied list of dns servers, instead of system's
ones.
|
void |
setDnsServersApp(java.lang.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 |
setDownloadBandwidth(int bw)
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 |
setEchoCancellerFilterName(java.lang.String filtername)
Set the name of the mediastreamer2 filter to be used for echo cancelling.
|
void |
setEnableSipUpdate(int value)
Enable or disable the UPDATE method support.
|
void |
setExpectedBandwidth(int bw)
Sets expected available upload bandwidth This is IP bandwidth, in kbit/s.
|
void |
setFileTransferServer(java.lang.String serverUrl)
Globaly set an http file transfer server to be used for content type
application/vnd.gsma.rcs-ft-http+xml.
|
void |
setFriendsDatabasePath(java.lang.String path)
Sets the database filename where friends will be stored.
|
void |
setGuessHostname(boolean val)
Tells
Core to guess local hostname automatically in primary contact. |
void |
setHttpProxyHost(java.lang.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 |
setLimeX3DhServerUrl(java.lang.String url)
Set the x3dh server url.
|
void |
setLinphoneSpecs(java.lang.String specs)
Deprecated.
Use linphone_core_set_linphone_specs_list or
linphone_core_add_linphone_spec instead. Deprecated since 2019-02-07
|
void |
setLinphoneSpecsList(java.lang.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(java.lang.String path)
Set the path of a directory where the log files will be written for log
collection.
|
void |
setLogCollectionPrefix(java.lang.String prefix)
Set the prefix of the filenames that will be used for log collection.
|
void |
setLogCollectionUploadServerUrl(java.lang.String serverUrl)
Set the url of the server where to upload the collected log files.
|
void |
setLogLevelMask(int mask)
Deprecated.
Use
LoggingService.setLogLevel(org.linphone.core.LogLevel) instead. Deprecated since
2017-10-10. |
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(java.lang.String devid)
Sets the sound device used for media.
|
int |
setMediaEncryption(MediaEncryption menc)
Choose the media encryption policy to be used for RTP packets.
|
void |
setMediaEncryptionMandatory(boolean m)
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 value)
This method is called by the application to notify the linphone core library
when the media (RTP) network is reachable.
|
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(java.lang.String addr)
Set the public IP address of NAT when using the firewall policy is set to use
NAT.
|
void |
setNativePreviewWindowId(java.lang.Object id)
Set the native window id where the preview video (local camera) is to be
displayed.
|
void |
setNativeVideoWindowId(java.lang.Object id)
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 value)
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.
|
int |
setPlaybackDevice(java.lang.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(java.lang.String file)
Sets a wav file to be played when putting somebody on hold, or when files are
used instead of soundcards (see
setUseFiles(boolean) ). |
void |
setPreferredFramerate(float fps)
Set the preferred frame rate for video.
|
void |
setPreferredVideoDefinition(VideoDefinition vdef)
Set the preferred video definition for the stream that is captured and sent to
the remote party.
|
void |
setPreferredVideoSizeByName(java.lang.String name)
|
void |
setPresenceModel(PresenceModel presence)
Set my presence model.
|
void |
setPreviewVideoDefinition(VideoDefinition vdef)
Set the video definition for the captured (preview) video.
|
void |
setPreviewVideoSizeByName(java.lang.String name)
Deprecated.
|
int |
setPrimaryContact(java.lang.String contact)
Sets the local "from" identity.
|
int |
setProvisioningUri(java.lang.String uri)
Set URI where to download xml configuration file at startup.
|
void |
setQrcodeDecodeRect(int x,
int y,
int w,
int h)
Set the rectangle where the decoder will search a QRCode.
|
void |
setRecordFile(java.lang.String file)
Sets a wav file where incoming stream is to be recorded, when files are used
instead of soundcards (see
setUseFiles(boolean) ). |
void |
setRemoteRingbackTone(java.lang.String ring)
Specify a ring back tone to be played to far end during incoming calls.
|
void |
setRing(java.lang.String path)
Sets the path to a wav file used for ringing.
|
void |
setRingback(java.lang.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(java.lang.String devid)
Sets the sound device used for ringing.
|
void |
setRootCa(java.lang.String path)
Sets the path to a file or folder containing trusted root CAs (PEM format)
|
void |
setRootCaData(java.lang.String data)
Sets the trusted root CAs (PEM format)
|
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 |
setSessionExpiresRefresherValue(SessionExpiresRefresher refresher)
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 value)
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.
|
int |
setStaticPicture(java.lang.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(java.lang.String server)
Set the STUN server address to use when the firewall policy is set to STUN.
|
void |
setSupportedTag(java.lang.String tags)
Set the supported tags.
|
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(java.lang.String tlsCert)
Sets a TLS certificate used for TLS authentication The certificate won't be
stored, you have to set it after each
Core startup. |
void |
setTlsCertPath(java.lang.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 |
setTlsKey(java.lang.String tlsKey)
Sets a TLS key used for TLS authentication The key won't be stored, you have to
set it after each
Core startup. |
void |
setTlsKeyPath(java.lang.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.
|
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 bw)
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(java.lang.String uaName,
java.lang.String version)
Set the user agent string used in SIP messages.
|
void |
setUserCertificatesPath(java.lang.String path)
Set the path to the directory storing the user's x509 certificates (used by
dtls)
|
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
void |
setUseRfc2833ForDtmf(boolean useRfc2833)
Sets whether RFC2833 is to be used to send digits.
|
void |
setVideoActivationPolicy(VideoActivationPolicy policy)
Sets the default policy for video.
|
int |
setVideoDevice(java.lang.String id)
Sets the active video device.
|
void |
setVideoDisplayFilter(java.lang.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 |
setVideoMulticastAddr(java.lang.String ip)
Use to set multicast address to be used 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(java.lang.String preset)
Set the video preset to be used for video calls.
|
void |
setZrtpSecretsFile(java.lang.String file)
Set the path to the file storing the zrtp secrets cache.
|
boolean |
soundDeviceCanCapture(java.lang.String device)
Tells whether a specified sound device can capture sound.
|
boolean |
soundDeviceCanPlayback(java.lang.String device)
Tells whether a specified sound device can play sound.
|
boolean |
soundResourcesLocked()
Check if a call will need the sound resources in near future (typically an
outgoing call that is awaiting response).
|
int |
start()
Start a
Core object after it has been instantiated and not
automatically started. |
int |
startConferenceRecording(java.lang.String path)
Start recording the running conference.
|
void |
startDtmfStream()
Special function to warm up dtmf feeback stream.
|
int |
startEchoCancellerCalibration()
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 a
Core object after it has been instantiated and started. |
void |
stopAsync()
Stop asynchronously a
Core object after it has been instantiated and
started. |
int |
stopConferenceRecording()
Stop recording the running conference.
|
void |
stopDtmf()
Stops playing a dtmf started by
playDtmf(char, int) . |
void |
stopDtmfStream()
Special function to stop dtmf feed back function.
|
int |
stopEchoTester()
Stop the simulation of call.
|
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.
|
Event |
subscribe(Address resource,
java.lang.String event,
int expires,
@Nullable Content body)
Create an outgoing subscription, specifying the destination resource, the event
name, and an optional content body.
|
int |
takePreviewSnapshot(java.lang.String file)
Take a photo of currently from capture device and write it into a jpeg file.
|
int |
terminateAllCalls()
Terminates all the calls.
|
int |
terminateCall(Call call)
Deprecated.
Use
Call.terminate() instead. Deprecated since 2017-02-13. |
int |
terminateConference()
Terminate the running conference.
|
int |
transferCall(Call call,
java.lang.String referTo)
Deprecated.
Use
Call.transfer(java.lang.String) instead. Deprecated since 2017-02-13. |
int |
transferCallToAnother(Call call,
Call dest)
Deprecated.
Use
Call.transferToAnother(org.linphone.core.Call) instead. Deprecated since
2017-02-13. |
boolean |
tunnelAvailable()
True if tunnel support was compiled.
|
int |
updateCall(Call call,
CallParams params)
Deprecated.
Use
Call.update(org.linphone.core.CallParams) instead. Deprecated since 2017-02-13. |
void |
uploadLogCollection()
Upload the log collection to the configured server url.
|
boolean |
upnpAvailable()
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 |
vcardSupported()
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 |
videoAdaptiveJittcompEnabled()
Tells whether the video adaptive jitter compensation is enabled.
|
boolean |
videoCaptureEnabled()
Tells whether video capture is enabled.
|
boolean |
videoDisplayEnabled()
Tells whether video display is enabled.
|
boolean |
videoEnabled()
Returns true if either capture or display is enabled, true otherwise.
|
boolean |
videoMulticastEnabled()
Use to get multicast state of video stream.
|
boolean |
videoPreviewEnabled()
Tells whether video preview is enabled.
|
boolean |
videoSupported()
Test if video is supported.
|
boolean |
wifiOnlyEnabled()
Tells whether Wifi only mode is enabled or not.
|
Factory getMediastreamerFactory()
java.lang.String getAdaptiveRateAlgorithm()
setAdaptiveRateAlgorithm(java.lang.String)
void setAdaptiveRateAlgorithm(java.lang.String algorithm)
algorithm
- the adaptive rate control algorithm. Currently two values are
supported: 'advanced', which is the default value, or 'basic'.boolean adaptiveRateControlEnabled()
enableAdaptiveRateControl(boolean)
void enableAdaptiveRateControl(boolean enabled)
boolean audioAdaptiveJittcompEnabled()
void enableAudioAdaptiveJittcomp(boolean enable)
enable
- to enable the audio adaptive jitter compensation, true to
disable it.int getAudioDscp()
void setAudioDscp(int dscp)
dscp
- The DSCP value to setint getAudioJittcomp()
void setAudioJittcomp(int milliseconds)
java.lang.String getAudioMulticastAddr()
int setAudioMulticastAddr(java.lang.String ip)
ip
- an ipv4/6 multicast addressboolean audioMulticastEnabled()
void enableAudioMulticast(boolean yesno)
yesno
- if yes, subsequent calls will propose multicast ip set by
linphone_core_set_audio_multicast_addrint getAudioMulticastTtl()
int setAudioMulticastTtl(int ttl)
ttl
- value or -1 if not used. [0..255] default value is 1PayloadType[] getAudioPayloadTypes()
PayloadType
objects. LinphonePayloadType 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.void setAudioPayloadTypes(PayloadType[] payloadTypes)
payloadTypes
- A list of PayloadType
objects. LinphonePayloadType
The new list of payload types. The core does not take ownership on it.int getAudioPort()
void setAudioPort(int port)
port
- The UDP port to use for audio streamingRange getAudioPortsRange()
Range
objectAuthInfo[] getAuthInfoList()
AuthInfo
.AuthInfo
objects. LinphoneAuthInfoAVPFMode getAvpfMode()
setAvpfMode(org.linphone.core.AVPFMode)
.void setAvpfMode(AVPFMode mode)
ProxyConfig
with ProxyConfig.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.mode
- The AVPF mode to use.int getAvpfRrInterval()
void setAvpfRrInterval(int interval)
ProxyConfig.setAvpfRrInterval(int)
.interval
- The report interval in secondsCallLog[] getCallLogs()
CallLog
objects. LinphoneCallLogjava.lang.String getCallLogsDatabasePath()
void setCallLogsDatabasePath(java.lang.String path)
path
- filesystem pathboolean callkitEnabled()
void enableCallkit(boolean enabled)
Call[] getCalls()
iterate()
. Similarly the Call
objects
inside it might be destroyed without prior notice. To hold references to Call
object into your program, you must use linphone_call_ref.Call
objects. LinphoneCallint getCallsNb()
int getCameraSensorRotation()
java.lang.String getCaptureDevice()
int setCaptureDevice(java.lang.String devid)
devid
- The device name as returned by linphone_core_get_sound_devices@Deprecated java.lang.String getChatDatabasePath()
@Deprecated void setChatDatabasePath(java.lang.String path)
path
- the database pathboolean chatEnabled()
ChatRoom[] getChatRooms()
ChatRoom
objects. LinphoneChatRoomConference getConference()
Conference
or null if no conference are going onfloat getConferenceLocalInputVolume()
boolean conferenceServerEnabled()
void enableConferenceServer(boolean enable)
enable
- A boolean value telling whether to enable or disable the
conference server featureint getConferenceSize()
Config getConfig()
ConsolidatedPresence getConsolidatedPresence()
void setConsolidatedPresence(ConsolidatedPresence presence)
presence
- LinphoneConsolidatedPresence valueCall getCurrentCall()
Address getCurrentCallRemoteAddress()
VideoDefinition getCurrentPreviewVideoDefinition()
VideoDefinition
See also: setPreviewVideoDefinition(org.linphone.core.VideoDefinition)
FriendList getDefaultFriendList()
Friend
from the core.FriendList
object or nullProxyConfig getDefaultProxyConfig()
void setDefaultProxyConfig(ProxyConfig config)
Core
use the
identity associated with the proxy configuration in all incoming and outgoing
calls.config
- The proxy configuration to use as the default one.java.lang.String getDefaultVideoDisplayFilter()
int getDelayedTimeout()
setDelayedTimeout(int)
for details.void setDelayedTimeout(int seconds)
seconds
- The new delayed timeoutint getDeviceRotation()
setDeviceRotation(int)
void setDeviceRotation(int rotation)
rotation
- The orientation to useboolean dnsSearchEnabled()
void enableDnsSearch(boolean enable)
enable
- to enable DNS search, true to disable it.void setDnsServers(java.lang.String[] servers)
servers
- A list of const char * objects. const char * 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.void setDnsServersApp(java.lang.String[] servers)
servers
- A list of const char * objects. const char * 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.boolean getDnsSetByApp()
boolean dnsSrvEnabled()
void enableDnsSrv(boolean enable)
enable
- to enable DNS SRV resolution, true to disable it.int getDownloadBandwidth()
setDownloadBandwidth(int)
.void setDownloadBandwidth(int bw)
bw
- the bandwidth in kbits/s, 0 for infiniteint getDownloadPtime()
void setDownloadPtime(int ptime)
boolean echoCancellationEnabled()
void enableEchoCancellation(boolean val)
val
- A boolean value telling whether echo cancellation is to be enabled
or disabled.java.lang.String getEchoCancellerFilterName()
void setEchoCancellerFilterName(java.lang.String filtername)
filtername
- The name of the mediastreamer2 filter to be used for echo
cancellingboolean echoLimiterEnabled()
void enableEchoLimiter(boolean val)
val
- to enable echo limiter, true to disable it.void setEnableSipUpdate(int value)
value
- Enable or disable itvoid setExpectedBandwidth(int bw)
bw
- the bandwidth in kbits/s, 0 for infinitejava.lang.String getFileTransferServer()
void setFileTransferServer(java.lang.String serverUrl)
serverUrl
- URL of the file server like
https://file.linphone.org/upload.phpvoid enableFriendListSubscription(boolean enable)
enable
- whether or not to enable the featurejava.lang.String getFriendsDatabasePath()
void setFriendsDatabasePath(java.lang.String path)
path
- filesystem pathFriendList[] getFriendsLists()
FriendList
from the core.FriendList
objects. LinphoneFriendList a list of
FriendList
boolean getGuessHostname()
void setGuessHostname(boolean val)
Core
to guess local hostname automatically in primary contact.java.lang.String getHttpProxyHost()
void setHttpProxyHost(java.lang.String host)
host
- Hostname of IP adress of the http proxy (can be null to disable).int getHttpProxyPort()
void setHttpProxyPort(int port)
port
- of the http proxy.java.lang.String getIdentity()
getPrimaryContact()
). If a default proxy is
set it returns the registered identity on the proxy.ImNotifPolicy getImNotifPolicy()
ImNotifPolicy
object controlling the instant messaging
notifications.ImNotifPolicy
object.int getInCallTimeout()
setInCallTimeout(int)
for details.void setInCallTimeout(int seconds)
seconds
- The new timeout in secondsint getIncTimeout()
setIncTimeout(int)
for details.void setIncTimeout(int seconds)
seconds
- The new timeout in secondsboolean ipv6Enabled()
enableIpv6(boolean)
for more details on how IPv6 is supported in
liblinphone.void enableIpv6(boolean val)
val
- A boolean value telling whether to enable IPv6 supportboolean isEchoCancellerCalibrationRequired()
boolean isFriendListSubscriptionEnabled()
boolean isInConference()
Conference.removeParticipant(org.linphone.core.Address)
instead.boolean isIncomingInvitePending()
boolean isMediaEncryptionMandatory()
boolean isNetworkReachable()
boolean isSenderNameHiddenInForwardMessage()
boolean keepAliveEnabled()
void enableKeepAlive(boolean enable)
enable
- A boolean value telling whether signaling keep alive is to be
enabledCallLog getLastOutgoingCallLog()
boolean limeX3DhEnabled()
void enableLimeX3Dh(boolean enable)
enable
- A boolean value telling whether to enable or disable LIME X3DHjava.lang.String getLimeX3DhServerUrl()
void setLimeX3DhServerUrl(java.lang.String url)
url
- The x3dh server url@Deprecated java.lang.String getLinphoneSpecs()
@Deprecated void setLinphoneSpecs(java.lang.String specs)
specs
- The linphone specs to setjava.lang.String[] getLinphoneSpecsList()
void setLinphoneSpecsList(java.lang.String[] specs)
specs
- A list of char * objects. char * The list of string specs to setjava.lang.String getLogCollectionUploadServerUrl()
void setLogCollectionUploadServerUrl(java.lang.String serverUrl)
serverUrl
- The url of the server where to upload the collected log files.int getMaxCalls()
void setMaxCalls(int max)
max
- number of simultaneous callsint getMaxSizeForAutoDownloadIncomingFiles()
void setMaxSizeForAutoDownloadIncomingFiles(int size)
size
- The size in bytes, -1 to disable the autodownload feature, 0 to
download them all no matter the sizejava.lang.String getMediaDevice()
int setMediaDevice(java.lang.String devid)
devid
- The device name as returned by linphone_core_get_sound_devicesMediaEncryption getMediaEncryption()
int setMediaEncryption(MediaEncryption menc)
menc
- The media encryption policy to be used.void setMediaEncryptionMandatory(boolean m)
m
- to set it mandatory; true otherwise.void setMediaNetworkReachable(boolean value)
setNetworkReachable(boolean)
.boolean micEnabled()
void enableMic(boolean enable)
enable
- to enable the microphone, true to disable it.float getMicGainDb()
void setMicGainDb(float level)
level
- The new microphone levelint getMissedCallsCount()
resetMissedCallsCount()
.int getMtu()
void setMtu(int mtu)
mtu
- The MTU in bytesjava.lang.String getNatAddress()
void setNatAddress(java.lang.String addr)
addr
- The public IP address of NAT to use.NatPolicy getNatPolicy()
NatPolicy
object in use.
See also: ProxyConfig.getNatPolicy()
void setNatPolicy(NatPolicy policy)
policy
- NatPolicy
object
See also: ProxyConfig.setNatPolicy(org.linphone.core.NatPolicy)
java.lang.Object getNativePreviewWindowId()
void setNativePreviewWindowId(java.lang.Object id)
usePreviewWindow(boolean)
. MacOS,
Linux, Windows: if not set or zero the core will create its own window, unless
the special id -1 is given.id
- The native window id where the preview video is to be displayedjava.lang.Object getNativeVideoWindowId()
void setNativeVideoWindowId(java.lang.Object id)
void setNetworkReachable(boolean value)
int getNortpTimeout()
Core
will
consider the call is broken (remote end crashed or disconnected from the
network), and thus will terminate the call. The no-rtp timeout is the duration
above which the call is considered broken.void setNortpTimeout(int seconds)
seconds
- The no-rtp timeout value to use in seconds
See also: getNortpTimeout()
for details.java.lang.String getPlayFile()
setUseFiles(boolean)
).
The file is a 16 bit linear wav file.void setPlayFile(java.lang.String file)
setUseFiles(boolean)
).
The file must be a 16 bit linear wav file.file
- The path to the file to be played when putting somebody on hold.java.lang.String getPlaybackDevice()
int setPlaybackDevice(java.lang.String devid)
devid
- The device name as returned by linphone_core_get_sound_devicesfloat getPlaybackGainDb()
void setPlaybackGainDb(float level)
level
- The new play levelfloat getPreferredFramerate()
setPreferredFramerate(float)
.void setPreferredFramerate(float fps)
fps
- the target frame rate in number of frames per seconds.VideoDefinition getPreferredVideoDefinition()
VideoDefinition
void setPreferredVideoDefinition(VideoDefinition vdef)
vdef
- VideoDefinition
object@Deprecated void setPreferredVideoSizeByName(java.lang.String name)
Factory.createVideoDefinitionFromName(java.lang.String)
and setPreferredVideoDefinition(org.linphone.core.VideoDefinition)
insteadPresenceModel getPresenceModel()
PresenceModel
object, or null if no presence model has been
set.void setPresenceModel(PresenceModel presence)
presence
- PresenceModel
VideoDefinition getPreviewVideoDefinition()
VideoDefinition
if it was previously set by setPreviewVideoDefinition(org.linphone.core.VideoDefinition)
, otherwise a 0x0 LinphoneVideoDefinition.
See also: setPreviewVideoDefinition(org.linphone.core.VideoDefinition)
void setPreviewVideoDefinition(VideoDefinition vdef)
vdef
- VideoDefinition
object@Deprecated void setPreviewVideoSizeByName(java.lang.String name)
Factory.createVideoDefinitionFromName(java.lang.String)
and setPreviewVideoDefinition(org.linphone.core.VideoDefinition)
insteadjava.lang.String getPrimaryContact()
int setPrimaryContact(java.lang.String contact)
ProxyConfig
@Deprecated Address getPrimaryContactParsed()
createPrimaryContactParsed()
instead. Deprecated
since 2018-10-22.getPrimaryContact()
but the result is a Address
object instead of const char *.java.lang.String getProvisioningUri()
int setProvisioningUri(java.lang.String uri)
Core
start.uri
- the http or https uri to use in order to download the configuration.
Passing null will disable remote provisioning.ProxyConfig[] getProxyConfigList()
ProxyConfig
objects. LinphoneProxyConfigboolean qrcodeVideoPreviewEnabled()
void enableQrcodeVideoPreview(boolean val)
val
- A boolean value telling whether the QRCode is enabled in the
preview.boolean realtimeTextEnabled()
java.lang.String getRecordFile()
setUseFiles(boolean)
).
This feature is different from call recording (CallParams.setRecordFile(java.lang.String)
) The file is a 16 bit linear wav file.void setRecordFile(java.lang.String file)
setUseFiles(boolean)
).
This feature is different from call recording (CallParams.setRecordFile(java.lang.String)
) The file will be a 16 bit linear wav file.file
- The path to the file where incoming stream is to be recorded.java.lang.String getRemoteRingbackTone()
void setRemoteRingbackTone(java.lang.String ring)
ring
- The path to the ring back tone to be played.boolean retransmissionOnNackEnabled()
void enableRetransmissionOnNack(boolean val)
val
- A boolean value telling whether to enable NACK contextjava.lang.String getRing()
void setRing(java.lang.String path)
path
- The path to a wav file to be used for ringingboolean getRingDuringIncomingEarlyMedia()
void setRingDuringIncomingEarlyMedia(boolean enable)
enable
- A boolean value telling whether to enable ringing during an
incoming early media call.java.lang.String getRingback()
void setRingback(java.lang.String path)
path
- The path to a wav file to be used for ringing backjava.lang.String getRingerDevice()
int setRingerDevice(java.lang.String devid)
devid
- The device name as returned by linphone_core_get_sound_devicesjava.lang.String getRootCa()
void setRootCa(java.lang.String path)
path
- The path to a file or folder containing trusted root CAsvoid setRootCaData(java.lang.String data)
data
- The trusted root CAs as a stringboolean rtpBundleEnabled()
void enableRtpBundle(boolean value)
CallParams
.value
- a boolean to indicate whether the feature is to be enabled.boolean sdp200AckEnabled()
void enableSdp200Ack(boolean enable)
enable
- true if INVITE has to be sent whitout SDP.boolean selfViewEnabled()
enableSelfView(boolean)
for details.void enableSelfView(boolean val)
val
- 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.void enableSenderNameHiddenInForwardMessage(boolean enable)
enable
- whether or not to enable the featureboolean getSessionExpiresEnabled()
void setSessionExpiresEnabled(boolean enabled)
enabled
- Enable or disable itint getSessionExpiresMinValue()
void setSessionExpiresMinValue(int min)
SessionExpiresRefresher getSessionExpiresRefresherValue()
void setSessionExpiresRefresherValue(SessionExpiresRefresher refresher)
refresher
- The refresher configuration valueint getSessionExpiresValue()
void setSessionExpiresValue(int expires)
int getSipDscp()
void setSipDscp(int dscp)
dscp
- The DSCP value to setvoid setSipNetworkReachable(boolean value)
setNetworkReachable(boolean)
.int getSipTransportTimeout()
void setSipTransportTimeout(int timeoutMs)
timeoutMs
- The SIP transport timeout in milliseconds.java.lang.String[] getSoundDevicesList()
java.lang.String getStaticPicture()
int setStaticPicture(java.lang.String path)
path
- The path to the image file to use.float getStaticPictureFps()
int setStaticPictureFps(float fps)
fps
- The new frame rate to use for static picture.java.lang.String getStunServer()
void setStunServer(java.lang.String server)
server
- The STUN server address to use.java.lang.String[] getSupportedFileFormatsList()
void setSupportedTag(java.lang.String tags)
PayloadType[] getTextPayloadTypes()
PayloadType
objects. LinphonePayloadType 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.void setTextPayloadTypes(PayloadType[] payloadTypes)
payloadTypes
- A list of PayloadType
objects. LinphonePayloadType
The new list of payload types. The core does not take ownership on it.int getTextPort()
void setTextPort(int port)
port
- The UDP port to use for text streamingRange getTextPortsRange()
Range
objectjava.lang.String getTlsCert()
void setTlsCert(java.lang.String tlsCert)
Core
startup.tlsCert
- the TLS certificatejava.lang.String getTlsCertPath()
void setTlsCertPath(java.lang.String tlsCertPath)
tlsCertPath
- path to the TLS certificatejava.lang.String getTlsKey()
void setTlsKey(java.lang.String tlsKey)
Core
startup.tlsKey
- the TLS keyjava.lang.String getTlsKeyPath()
void setTlsKeyPath(java.lang.String tlsKeyPath)
tlsKeyPath
- path to the TLS keyTransports getTransports()
Transports
structure with the configured portsint setTransports(Transports transports)
transports
- A #LinphoneSipTransports structure giving the ports to useTransports getTransportsUsed()
Transports
structure with the ports being usedTunnel getTunnel()
Tunnel
or null if not availableint getUnreadChatMessageCount()
int getUnreadChatMessageCountFromActiveLocals()
int getUploadBandwidth()
setUploadBandwidth(int)
.void setUploadBandwidth(int bw)
bw
- the bandwidth in kbits/s, 0 for infiniteint getUploadPtime()
void setUploadPtime(int ptime)
java.lang.String getUpnpExternalIpaddress()
UpnpState getUpnpState()
boolean getUseFiles()
void setUseFiles(boolean yesno)
yesno
- A boolean value asking to stream audio from and to files or not.boolean getUseInfoForDtmf()
void setUseInfoForDtmf(boolean useInfo)
useInfo
- A boolean value telling whether to use SIP INFO to send digitsboolean getUseRfc2833ForDtmf()
void setUseRfc2833ForDtmf(boolean useRfc2833)
useRfc2833
- A boolean value telling whether to use RFC2833 to send digitsjava.lang.String getUserAgent()
java.lang.String getUserCertificatesPath()
void setUserCertificatesPath(java.lang.String path)
path
- The path to the directory to use to store the user's certificates.VideoActivationPolicy getVideoActivationPolicy()
setVideoActivationPolicy(org.linphone.core.VideoActivationPolicy)
for more details.void setVideoActivationPolicy(VideoActivationPolicy policy)
boolean videoAdaptiveJittcompEnabled()
void enableVideoAdaptiveJittcomp(boolean enable)
enable
- to enable the video adaptive jitter compensation, true to
disable it.boolean videoCaptureEnabled()
void enableVideoCapture(boolean enable)
Core
to initiate future calls with video capture or not.enable
- to enable video capture, true to disable it.java.lang.String getVideoDevice()
int setVideoDevice(java.lang.String id)
id
- The name of the video device to use as returned by
linphone_core_get_video_devicesjava.lang.String[] getVideoDevicesList()
boolean videoDisplayEnabled()
void enableVideoDisplay(boolean enable)
Core
to initiate future calls with video display or not.enable
- to enable video display, true to disable it.java.lang.String getVideoDisplayFilter()
void setVideoDisplayFilter(java.lang.String filtername)
int getVideoDscp()
void setVideoDscp(int dscp)
dscp
- The DSCP value to setboolean videoEnabled()
int getVideoJittcomp()
void setVideoJittcomp(int milliseconds)
java.lang.String getVideoMulticastAddr()
int setVideoMulticastAddr(java.lang.String ip)
ip
- an ipv4/6 multicast addressboolean videoMulticastEnabled()
void enableVideoMulticast(boolean yesno)
yesno
- if yes, subsequent outgoing calls will propose multicast ip set by
linphone_core_set_video_multicast_addrint getVideoMulticastTtl()
int setVideoMulticastTtl(int ttl)
ttl
- value or -1 if not used. [0..255] default value is 1PayloadType[] getVideoPayloadTypes()
PayloadType
objects. LinphonePayloadType 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.void setVideoPayloadTypes(PayloadType[] payloadTypes)
payloadTypes
- A list of PayloadType
objects. LinphonePayloadType
The new list of codecs. The core does not take ownership on it.int getVideoPort()
void setVideoPort(int port)
port
- The UDP port to use for video streamingRange getVideoPortsRange()
Range
objectjava.lang.String getVideoPreset()
void setVideoPreset(java.lang.String preset)
preset
- The name of the video preset to be used (can be null to use the
default video preset).boolean videoPreviewEnabled()
void enableVideoPreview(boolean val)
val
- 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.void enableVideoSourceReuse(boolean enable)
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.enable
- to enable video source reuse. true to disable it for subsequent
calls.boolean wifiOnlyEnabled()
void enableWifiOnly(boolean val)
val
- A boolean value telling whether to enable IPv6 supportjava.lang.String getZrtpSecretsFile()
void setZrtpSecretsFile(java.lang.String file)
file
- The path to the file to use to store the zrtp secrets cache.@Deprecated int acceptCall(Call call)
Call.accept()
instead. Deprecated since 2017-02-13.Call
object.
The application can later accept the call using this method.call
- The Call
object representing the call to be answered@Deprecated int acceptCallUpdate(Call call, CallParams params)
Call.acceptUpdate(org.linphone.core.CallParams)
instead. Deprecated since 2017-02-13.Call.getRemoteParams()
can be used to get information about the
call parameters requested by the other party, such as whether a video stream is
requested.
When the user accepts or refuse the change, acceptCallUpdate(org.linphone.core.Call, org.linphone.core.CallParams)
can
be done to answer to the other party. If params is null, then the same call
parameters established before the update request will continue to be used (no
change). If params is not null, then the update will be accepted according to
the parameters passed. Typical example is when a user accepts to start video,
then params should indicate that video stream should be used (see CallParams.enableVideo(boolean)
).params
- A CallParams
object describing the call parameters to
accept@Deprecated int acceptCallWithParams(Call call, CallParams params)
Call.acceptWithParams(org.linphone.core.CallParams)
instead. Deprecated since
2017-02-13.Call
object.
The application can later accept the call using this method.params
- The specific parameters for this call, for example whether video
is accepted or not. Use null to use default parameters@Deprecated int acceptEarlyMedia(Call call)
Call.acceptEarlyMedia()
instead. Deprecated since
2017-02-13.acceptEarlyMediaWithParams(org.linphone.core.Call, org.linphone.core.CallParams)
with null
call parameters.call
- The incoming call to acceptacceptEarlyMediaWithParams(org.linphone.core.Call, org.linphone.core.CallParams)
@Deprecated int acceptEarlyMediaWithParams(Call call, CallParams params)
Call.acceptEarlyMediaWithParams(org.linphone.core.CallParams)
instead.acceptCall(org.linphone.core.Call)
or acceptCallWithParams(org.linphone.core.Call, org.linphone.core.CallParams)
.params
- The call parameters to use (can be null)void activateAudioSession(boolean actived)
int addAllToConference()
void addAuthInfo(AuthInfo info)
Core
.
That piece of information will be used during all SIP transactions that require
authentication.info
- The AuthInfo
to add.@Deprecated void addFriend(Friend fr)
FriendList.addFriend(org.linphone.core.Friend)
instead.fr
- Friend
to addvoid addFriendList(FriendList list)
list
- FriendList
objectvoid addLinphoneSpec(java.lang.String spec)
spec
- The spec to addint addProxyConfig(ProxyConfig config)
void addSupportedTag(java.lang.String tag)
tag
- The feature tag nameint addToConference(Call call)
call
- The current call with the participant to addvoid audioRouteChanged()
void checkForUpdate(java.lang.String currentVersion)
currentVersion
- The current version of the applicationvoid clearAllAuthInfo()
void clearCallLogs()
void clearProxyConfig()
AccountCreator createAccountCreator(java.lang.String xmlrpcUrl)
AccountCreator
and set Linphone Request callbacks.xmlrpcUrl
- The URL to the XML-RPC server. Must be NON null.AccountCreator
object.Address createAddress(java.lang.String address)
Address
object by parsing the user supplied address, given as
a string.address
- String containing the user supplied addressAddress
object@Deprecated AuthInfo createAuthInfo(java.lang.String username, java.lang.String userid, java.lang.String passwd, java.lang.String ha1, java.lang.String realm, java.lang.String domain)
Factory.createAuthInfo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
instead.domain
- String containing the SIP domain for which this authentication
information is valid, if it has to be restricted for a single SIP domain.AuthInfo
with default values setCallLog createCallLog(Address from, Address to, Call.Dir dir, int duration, long startTime, long connectedTime, Call.Status status, boolean videoEnabled, float quality)
quality
- call qualityCallParams createCallParams(@Nullable @Nullable Call call)
CallParams
suitable for inviteWithParams(java.lang.String, org.linphone.core.CallParams)
, acceptCallWithParams(org.linphone.core.Call, org.linphone.core.CallParams)
, acceptEarlyMediaWithParams(org.linphone.core.Call, org.linphone.core.CallParams)
, acceptCallUpdate(org.linphone.core.Call, org.linphone.core.CallParams)
.
The parameters are initialized according to the current Core
configuration and the current state of the LinphoneCall.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.CallParams
objectChatRoom createChatRoom(ChatRoomParams params, java.lang.String subject, Address[] participants)
participants
- A list of Address
objects. LinphoneAddress The
initial list of participants of the chat roomChatRoom createChatRoom(java.lang.String subject, Address[] participants)
participants
- A list of Address
objects. LinphoneAddress The
initial list of participants of the chat roomChatRoom createChatRoom(ChatRoomParams params, Address localAddr, Address participant)
participant
- Address
representing the initial participant to add
to the chat roomChatRoom createChatRoom(Address participant)
participant
- Address
representing the initial participant to add
to the chat roomChatRoom createChatRoom(ChatRoomParams params, Address localAddr, java.lang.String subject, Address[] participants)
participants
- A list of Address
objects. LinphoneAddress The
initial list of participants of the chat roomChatRoom createClientGroupChatRoom(java.lang.String subject, boolean fallback)
ChatRoom.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 if ChatRoom.addParticipants(org.linphone.core.Address[])
is called with
only one participant.fallback
- Boolean value telling whether we should plan on being able to
fallback to a basic chat room if the client-side group chat room creation failsChatRoom createClientGroupChatRoom(java.lang.String subject, boolean fallback, boolean encrypted)
ChatRoom.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 if ChatRoom.addParticipants(org.linphone.core.Address[])
is called with
only one participant.encrypted
- Boolean value telling whether we should apply encryption or
not on chat messages sent and received on this room.ConferenceParams createConferenceParams()
createConferenceWithParams(org.linphone.core.ConferenceParams)
.Conference createConferenceWithParams(ConferenceParams params)
params
- Parameters of the conference. See ConferenceParams
.terminateConference()
.Config createConfig(java.lang.String filename)
Config
object from a user config file.filename
- The filename of the config file to read to fill the
instantiated Config
Content createContent()
Content
object with default values setChatRoomParams createDefaultChatRoomParams()
Friend createFriend()
Friend
objectFriendList createFriendList()
FriendList
object.FriendList
object.Friend createFriendWithAddress(java.lang.String address)
Friend
from the given address.InfoMessage createInfoMessage()
InfoMessage.addHeader(java.lang.String, java.lang.String)
or InfoMessage.setContent(org.linphone.core.Content)
, and finally sent with
linphone_core_send_info_message().Player createLocalPlayer(java.lang.String soundCardName, java.lang.String videoDisplayName, java.lang.Object windowId)
windowId
- Id of the drawing window. Depend of video outMagicSearch createMagicSearch()
MagicSearch
object.MagicSearch
objectNatPolicy createNatPolicy()
NatPolicy
object with every policies being disabled.NatPolicy
object.NatPolicy createNatPolicyFromConfig(java.lang.String ref)
Event createNotify(Address resource, java.lang.String event)
Event.notify(org.linphone.core.Content)
.event
- the event nameEvent
holding the context of the notification.Event createOneShotPublish(Address resource, java.lang.String event)
Event.sendPublish(org.linphone.core.Content)
.
The Event
is automatically terminated when the publish transaction is
finished, either with success or failure. The application must not call Event.terminate()
for such one-shot publish.event
- the event nameEvent
holding the context of the publish.PresenceActivity createPresenceActivity(PresenceActivity.Type acttype, java.lang.String description)
PresenceActivity
with the given type and description.description
- An additional description of the activity to set for the
activity. Can be null if no additional description is to be added.PresenceActivity
object.PresenceModel createPresenceModel()
PresenceModel
object.PresenceModel createPresenceModelWithActivity(PresenceActivity.Type acttype, java.lang.String description)
PresenceModel
with the given activity type and activity
description.description
- An additional description of the activity to set for the
activity. Can be null if no additional description is to be added.PresenceModel
object.PresenceModel createPresenceModelWithActivityAndNote(PresenceActivity.Type acttype, java.lang.String description, java.lang.String note, java.lang.String lang)
PresenceModel
with the given activity type, activity
description, note content and note language.lang
- The language of the note to be added to the created model.PresenceModel
object.PresenceNote createPresenceNote(java.lang.String content, java.lang.String lang)
PresenceNote
with the given content and language.lang
- The language of the note to be created.PresenceNote
object.PresencePerson createPresencePerson(java.lang.String id)
PresencePerson
with the given id.id
- The id of the person to be created.PresencePerson
object.PresenceService createPresenceService(java.lang.String id, PresenceBasicStatus basicStatus, java.lang.String contact)
PresenceService
with the given id, basic status and contact.contact
- A string containing a contact information corresponding to the
service to be created.PresenceService
object.Address createPrimaryContactParsed()
getPrimaryContact()
but the result is a Address
object instead of const char *.ProxyConfig createProxyConfig()
ProxyConfig
with default values setEvent createPublish(Address resource, java.lang.String event, int expires)
Event.sendPublish(org.linphone.core.Content)
.
After expiry, the publication is refreshed unless it is terminated before.expires
- the lifetime of event being published, -1 if no associated
duration, in which case it will not be refreshed.Event
holding the context of the publish.Event createSubscribe(Address resource, ProxyConfig proxy, java.lang.String event, int expires)
subscribe(org.linphone.core.Address, java.lang.String, int, org.linphone.core.Content)
the
subscription isn't sent immediately. It will be send when calling Event.sendSubscribe(org.linphone.core.Content)
.expires
- the whished duration of the subscriptionEvent
holding the context of the created subcription.Event createSubscribe(Address resource, java.lang.String event, int expires)
subscribe(org.linphone.core.Address, java.lang.String, int, org.linphone.core.Content)
the
subscription isn't sent immediately. It will be send when calling Event.sendSubscribe(org.linphone.core.Content)
.expires
- the whished duration of the subscriptionEvent
holding the context of the created subcription.XmlRpcSession createXmlRpcSession(java.lang.String url)
XmlRpcSession
for a given url.url
- The URL to the XML-RPC server. Must be NON null.XmlRpcSession
object.@Deprecated int declineCall(Call call, Reason reason)
Call.decline(org.linphone.core.Reason)
instead. Deprecated since 2017-02-13.reason
- The reason for rejecting the call: LinphoneReasonDeclined or
LinphoneReasonBusy@Deprecated int deferCallUpdate(Call call)
Call.deferUpdate()
insteadCore
from performing an automatic answer.
When receiving a #LinphoneCallUpdatedByRemote state notification (ie an
incoming reINVITE), the default behaviour of Core
is defined by the
"defer_update_default" option of the "sip" section of the config. If this
option is 0 (the default) then the Core
automatically answers the
reINIVTE with call parameters unchanged. However when for example when the
remote party updated the call to propose a video stream, it can be useful to
prompt the user before answering. This can be achieved by calling deferCallUpdate(org.linphone.core.Call)
during the call state notification, to deactivate the
automatic answer that would just confirm the audio but reject the video. Then,
when the user responds to dialog prompt, it becomes possible to call acceptCallUpdate(org.linphone.core.Call, org.linphone.core.CallParams)
to answer the reINVITE, with eventually video enabled in
the CallParams
argument.
The #LinphoneCallUpdatedByRemote notification can also arrive when receiving an
INVITE without SDP. In such case, an unchanged offer is made in the 200Ok, and
when the ACK containing the SDP answer is received,
#LinphoneCallUpdatedByRemote is triggered to notify the application of possible
changes in the media session. However in such case defering the update has no
meaning since we just generating an offer.call
- The call for which to defer the updatedeferCallUpdate(org.linphone.core.Call)
was done
outside a valid #LinphoneCallUpdatedByRemote notificationvoid deleteChatRoom(ChatRoom cr)
cr
- A ChatRoom
objectvoid disableChat(Reason denyReason)
denyReason
- the deny reason (LinphoneReasonNone has no effect).void enableChat()
disableChat(org.linphone.core.Reason)
.@Deprecated void enableLime(LimeState val)
Core
to use Linphone Instant Messaging encryption.val
- The new lime statevoid ensureRegistered()
void enterBackground()
int enterConference()
void enterForeground()
boolean fileFormatSupported(java.lang.String fmt)
fmt
- The format extension (wav, mkv).AuthInfo findAuthInfo(java.lang.String realm, java.lang.String username, java.lang.String sipDomain)
sipDomain
- the SIP domain name (optional)AuthInfo
Call findCallFromUri(java.lang.String uri)
uri
- which should match call remote uriCall
or null is no match is foundCallLog findCallLogFromCallId(java.lang.String callId)
callId
- Call id of the call log to findChatRoom findChatRoom(Address peerAddr, Address localAddr)
Core
keeps a
reference on the chat room.localAddr
- a linphone address.ChatRoom
where messaging can take place.Address[] findContactsByChar(java.lang.String filter, boolean sipOnly)
Address
sort and filter.Friend findFriend(Address addr)
Friend
by its address.addr
- The address to use to search the friend.Friend
object corresponding to the given address.ChatRoom findOneToOneChatRoom(Address localAddr, Address participantAddr, boolean encrypted)
Core
keeps a
reference on the chat room.encrypted
- whether to look for an encrypted chat room or notChatRoom
where messaging can take place.@Deprecated ChatRoom findOneToOneChatRoom(Address localAddr, Address participantAddr)
Core
keeps a
reference on the chat room.participantAddr
- a linphone address.ChatRoom
where messaging can take place.@Nullable @Nullable Call getCallByRemoteAddress(java.lang.String remoteAddress)
remoteAddress
- The remote address of the call that we want to getCall getCallByRemoteAddress2(Address remoteAddress)
remoteAddress
- Call
of the call if foundCallLog[] getCallHistory(Address peerAddr, Address localAddr)
@Deprecated CallLog[] getCallHistoryForAddress(Address addr)
Address
.
At the contrary of linphone_core_get_call_logs, it is your responsibility to
unref the logs and free this list once you are done using it.ChatRoom getChatRoom(Address peerAddr, Address localAddr)
Core
keeps a reference on the chat room.localAddr
- a linphone address.ChatRoom
where messaging can take place.ChatRoom getChatRoom(Address addr)
Core
keeps a reference on the chat room.addr
- a linphone address.ChatRoom
where messaging can take place.ChatRoom getChatRoomFromUri(java.lang.String to)
Core
keeps a reference on the chat room.to
- The destination address for messages.ChatRoom
where messaging can take place.Friend getFriendByRefKey(java.lang.String key)
Friend
by its reference key.key
- The reference key to use to search the friend.Friend
object corresponding to the given reference key.FriendList getFriendListByName(java.lang.String name)
Friend
from the core that has the given display
name.name
- the name of the listFriendList
object or nullPayloadType getPayloadType(java.lang.String type, int rate, int channels)
channels
- number of channels, can be
LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELSPayloadType
is returned, it
must be released with linphone_payload_type_unref after using it.
Warning: The returned payload type is allocated as a floating reference i.e.
the reference counter is initialized to 0.ProxyConfig getProxyConfigByIdkey(java.lang.String idkey)
idkey
- An arbitrary idkey string associated to a proxy configurationint getUnreadChatMessageCountFromLocal(Address address)
address
- Address
object.ZrtpPeerStatus getZrtpStatus(java.lang.String addr)
addr
- the peer uriboolean hasBuiltinEchoCanceller()
boolean hasCrappyOpengl()
boolean inCall()
Address interpretUrl(java.lang.String url)
Call invite(java.lang.String url)
url
- The destination of the call (sip address, or phone number).Call
object or null in case of failureCall inviteAddress(Address addr)
Address
The Address
can be constructed directly using linphone_address_new, or created by
interpretUrl(java.lang.String)
.
The application doesn't own a reference to the returned Call
object.
Use linphone_call_ref to safely keep the Call
pointer valid within your
application.addr
- The destination of the call (sip address).Call
object or null in case of failureCall inviteAddressWithParams(Address addr, CallParams params)
Address
The Address
can be constructed directly using linphone_address_new, or created by
interpretUrl(java.lang.String)
.
The application doesn't own a reference to the returned Call
object.
Use linphone_call_ref to safely keep the Call
pointer valid within your
application.params
- Call parametersCall
object or null in case of failureCall inviteWithParams(java.lang.String url, CallParams params)
Call
object.
Use linphone_call_ref to safely keep the Call
pointer valid within your
application.params
- Call parametersCall
object or null in case of failureboolean isMediaFilterSupported(java.lang.String filtername)
filtername
- the filter namevoid iterate()
iterate()
performs various backgrounds tasks:int leaveConference()
@Deprecated boolean limeAvailable()
@Deprecated LimeState limeEnabled()
boolean limeX3DhAvailable()
void loadConfigFromXml(java.lang.String xmlUri)
xmlUri
- the path to the xml fileboolean mediaEncryptionSupported(MediaEncryption menc)
menc
- LinphoneMediaEncryptionCore
enginevoid migrateLogsFromRcToDb()
int migrateToMultiTransport()
iterate()
void notifyAllFriends(PresenceModel presence)
presence
- PresenceModel
to notifyvoid notifyNotifyPresenceReceived(Friend lf)
lf
- the Friend
whose presence information has been received.void notifyNotifyPresenceReceivedForUriOrTel(Friend lf, java.lang.String uriOrTel, PresenceModel presenceModel)
presenceModel
- the PresenceModel
that has been modifiedint pauseAllCalls()
@Deprecated int pauseCall(Call call)
Call.pause()
instead. Deprecated since 2017-02-13.setPlayFile(java.lang.String)
, this file will
be played to the remote user.
The only way to resume a paused call is to call resumeCall(org.linphone.core.Call)
.call
- The call to pauseresumeCall(org.linphone.core.Call)
void playDtmf(char dtmf, int durationMs)
durationMs
- Duration in ms, -1 means play until next further call to
stopDtmf()
int playLocal(java.lang.String audiofile)
audiofile
- The path to an audio file in wav PCM 16 bit formatvoid previewOglRender()
Event publish(Address resource, java.lang.String event, int expires, Content body)
Event
with createPublish(org.linphone.core.Address, java.lang.String, int)
and calls
Event.sendPublish(org.linphone.core.Content)
to actually send it. After expiry, the publication is
refreshed unless it is terminated before.body
- the actual published dataEvent
holding the context of the publish.int realtimeTextGetKeepaliveInterval()
void realtimeTextSetKeepaliveInterval(int interval)
interval
- The keep alive interval of real time text, 25000 by default.@Deprecated int redirectCall(Call call, java.lang.String redirectUri)
Call.redirect(java.lang.String)
instead. Deprecated since 2017-02-13.redirectUri
- The URI to redirect the call tovoid refreshRegisters()
void rejectSubscriber(Friend lf)
Friend.setIncSubscribePolicy(org.linphone.core.SubscribePolicy)
with LinphoneSPDeny policy;lf
- Friend
to addvoid reloadMsPlugins(java.lang.String path)
path
- the path from where plugins are to be loaded, pass null to use
default (compile-time determined) plugin directory.void reloadSoundDevices()
void reloadVideoDevices()
void removeAuthInfo(AuthInfo info)
info
- The AuthInfo
to remove.void removeCallLog(CallLog callLog)
callLog
- CallLog
object to remove.void removeFriendList(FriendList list)
list
- FriendList
objectint removeFromConference(Call call)
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, unless leaveConference()
is explicitly called, the
last remote participant of a conference is automatically put in a simple call
in running state.void removeLinphoneSpec(java.lang.String spec)
spec
- The spec to removevoid removeProxyConfig(ProxyConfig config)
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.void removeSupportedTag(java.lang.String tag)
tag
- The tag to remove
See also: addSupportedTag(java.lang.String)
void resetMissedCallsCount()
@Deprecated int resumeCall(Call call)
Call.resume()
instead. Deprecated since 2017-02-13.pauseCall(org.linphone.core.Call)
.call
- The call to resumepauseCall(org.linphone.core.Call)
void setAudioPortRange(int minPort, int maxPort)
maxPort
- The upper bound of the audio port range to usevoid setCallErrorTone(Reason reason, java.lang.String audiofile)
audiofile
- a wav file to be played when such call failure happens.void setQrcodeDecodeRect(int x, int y, int w, int h)
h
- heightvoid setTextPortRange(int minPort, int maxPort)
maxPort
- The upper bound of the text port range to usevoid setUserAgent(java.lang.String uaName, java.lang.String version)
version
- Version of the user agent.void setVideoPortRange(int minPort, int maxPort)
maxPort
- The upper bound of the video port range to useboolean soundDeviceCanCapture(java.lang.String device)
device
- the device name as returned by linphone_core_get_sound_devicesboolean soundDeviceCanPlayback(java.lang.String device)
device
- the device name as returned by linphone_core_get_sound_devicesboolean soundResourcesLocked()
soundResourcesLocked()
to know whether it is
possible at a given time to start a new outgoing call. When the function
returns true, an application should not allow the user to start an outgoing
call.int start()
Core
object after it has been instantiated and not
automatically started.
Also re-initialize a Core
object that has been stopped using stop()
. Must be called only if LinphoneGlobalState is either Ready of Off.
State will changed to Startup, Configuring and then On.int startConferenceRecording(java.lang.String path)
path
- Path to the file where the recording will be writtenvoid startDtmfStream()
int startEchoCancellerCalibration()
int startEchoTester(int rate)
rate
- Sound sample rate.void stop()
void stopAsync()
Core
object after it has been instantiated and
started.
State changes to Shutdown then iterate()
must be called to allow the
Core to end asynchronous tasks (terminate call, etc.). When all tasks are
finished, State will change to Off. Must be called only if LinphoneGlobalState
is On. When LinphoneGlobalState is Off Core
can be started again using
start()
.int stopConferenceRecording()
void stopDtmf()
playDtmf(char, int)
.void stopDtmfStream()
int stopEchoTester()
void stopRinging()
Event subscribe(Address resource, java.lang.String event, int expires, @Nullable @Nullable Content body)
body
- an optional body, may be null.Event
holding the context of the created subcription.int takePreviewSnapshot(java.lang.String file)
file
- a path where to write the jpeg content.int terminateAllCalls()
@Deprecated int terminateCall(Call call)
Call.terminate()
instead. Deprecated since 2017-02-13.call
- The LinphoneCall object representing the call to be terminatedint terminateConference()
@Deprecated int transferCall(Call call, java.lang.String referTo)
Call.transfer(java.lang.String)
instead. Deprecated since 2017-02-13.referTo
- The destination the call is to be refered to@Deprecated int transferCallToAnother(Call call, Call dest)
Call.transferToAnother(org.linphone.core.Call)
instead. Deprecated since
2017-02-13.dest
- A running call whose remote person will receive the transfer@Deprecated int updateCall(Call call, CallParams params)
Call.update(org.linphone.core.CallParams)
instead. Deprecated since 2017-02-13.params
- The new call parameters to use (may be null)void uploadLogCollection()
void usePreviewWindow(boolean yesno)
yesno
- to use a separate window, true to insert the preview in the
remote video window.void verifyServerCertificates(boolean yesno)
yesno
- A boolean value telling whether the tls server certificate must be
verifiedvoid verifyServerCn(boolean yesno)
yesno
- A boolean value telling whether the tls server certificate common
name must be verifiedboolean videoSupported()
java.lang.String compressLogCollection()
void enableLogCollection(LogCollectionState state)
state
- #LinphoneLogCollectionState value telling whether to enable log
collection or not.int getLogCollectionMaxFileSize()
java.lang.String getLogCollectionPath()
java.lang.String getLogCollectionPrefix()
@Deprecated int getLogLevelMask()
LoggingService.getLogLevelMask()
instead. Deprecated
since 2017-10-10.java.lang.String getVersion()
LogCollectionState logCollectionEnabled()
void resetLogCollection()
void serializeLogs()
iterate()
).
Must be called before creating the linphone core.void setLogCollectionMaxFileSize(int size)
size
- The max file size in bytes of the files used for log collection.void setLogCollectionPath(java.lang.String path)
path
- The path where the log files will be written.void setLogCollectionPrefix(java.lang.String prefix)
prefix
- The prefix to use for the filenames for log collection.@Deprecated void setLogLevelMask(int mask)
LoggingService.setLogLevel(org.linphone.core.LogLevel)
instead. Deprecated since
2017-10-10.mask
- A bitmask of the log levels to set.boolean tunnelAvailable()
boolean upnpAvailable()
boolean vcardSupported()
void addListener(CoreListener listener)
void removeListener(CoreListener listener)
void setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()