org.linphone.core

Interface CoreListener

All Known Implementing Classes:

CoreListenerStub

public interface CoreListener

That class holds all the callbacks which are called by LinphoneCore.

Once created, add your LinphoneCoreCbs using linphone_core_add_listener. Keep a
reference on it as long as you need it. You can use
linphone_core_remove_listener to remove it but that isn't mandatory.
The same applies to all listeners in our API.

Method Summary

Modifier and Type	Method and Description
void	onAudioDeviceChanged(Core core, AudioDevice audioDevice) Callback prototype telling that the audio device for at least one call has changed.
void	onAudioDevicesListUpdated(Core core) Callback prototype telling the audio devices list has been updated.
void	onAuthenticationRequested(Core core, AuthInfo authInfo, AuthMethod method) Callback for requesting authentication information to application or user.
void	onBuddyInfoUpdated(Core core, Friend linphoneFriend) Callback prototype when using the buddy plugin.
void	onCallCreated(Core core, Call call) Callback notifying that a new LinphoneCall (either incoming or outgoing) has been created.
void	onCallEncryptionChanged(Core core, Call call, boolean mediaEncryptionEnabled, java.lang.String authenticationToken) Call encryption changed callback.
void	onCallIdUpdated(Core core, java.lang.String previousCallId, java.lang.String currentCallId) Callback to notify the callid of a call has been updated.
void	onCallLogUpdated(Core core, CallLog callLog) Callback to notify a new call-log entry has been added.
void	onCallStateChanged(Core core, Call call, Call.State state, java.lang.String message) Call state notification callback.
void	onCallStatsUpdated(Core core, Call call, CallStats callStats) Callback for receiving quality statistics for calls.
void	onChatRoomEphemeralMessageDeleted(Core core, ChatRoom chatRoom) Callback prototype telling that a LinphoneChatRoom ephemeral message has expired.
void	onChatRoomRead(Core core, ChatRoom chatRoom) Chat room marked as read callback.
void	onChatRoomStateChanged(Core core, ChatRoom chatRoom, ChatRoom.State state) Callback prototype telling that a LinphoneChatRoom state has changed.
void	onChatRoomSubjectChanged(Core core, ChatRoom chatRoom) Callback prototype telling that a LinphoneChatRoom subject has changed.
void	onConferenceStateChanged(Core core, Conference conference, Conference.State state) Callback prototype telling that a LinphoneConference state has changed.
void	onConfiguringStatus(Core core, ConfiguringState status, java.lang.String message) Callback prototype for configuring status changes notification.
void	onDtmfReceived(Core core, Call call, int dtmf) Callback for being notified of DTMFs received.
void	onEcCalibrationAudioInit(Core core) Function prototype used by #linphone_core_cbs_set_ec_calibrator_audio_init().
void	onEcCalibrationAudioUninit(Core core) Function prototype used by #linphone_core_cbs_set_ec_calibrator_audio_uninit().
void	onEcCalibrationResult(Core core, EcCalibratorStatus status, int delayMs) Function prototype used by #linphone_core_cbs_set_ec_calibrator_result().
void	onFirstCallStarted(Core core) Callback prototype telling a call has started (incoming or outgoing) while there was no other call.
void	onFriendListCreated(Core core, FriendList friendList) Callback prototype for reporting when a friend list has been added to the core friends list.
void	onFriendListRemoved(Core core, FriendList friendList) Callback prototype for reporting when a friend list has been removed from the core friends list.
void	onGlobalStateChanged(Core core, GlobalState state, java.lang.String message) Global state notification callback.
void	onImeeUserRegistration(Core core, boolean status, java.lang.String userId, java.lang.String info) Callback prototype telling that an Instant Message Encryption Engine user registered on the server with or without success.
void	onInfoReceived(Core core, Call call, InfoMessage message) Callback prototype for receiving info messages.
void	onIsComposingReceived(Core core, ChatRoom chatRoom) Is composing notification callback prototype.
void	onLastCallEnded(Core core) Callback prototype telling the last call has ended (#LinphoneCore.get_calls_nb() returns 0)
void	onLogCollectionUploadProgressIndication(Core core, int offset, int total) Callback prototype for reporting log collection upload progress indication.
void	onLogCollectionUploadStateChanged(Core core, Core.LogCollectionUploadState state, java.lang.String info) Callback prototype for reporting log collection upload state change.
void	onMessageReceived(Core core, ChatRoom chatRoom, ChatMessage message) Chat message callback prototype.
void	onMessageReceivedUnableDecrypt(Core core, ChatRoom chatRoom, ChatMessage message) Chat message not decrypted callback prototype.
void	onMessageSent(Core core, ChatRoom chatRoom, ChatMessage message) Called after the #send method of the LinphoneChatMessage was called.
void	onNetworkReachable(Core core, boolean reachable) Callback prototype for reporting network change either automatically detected or notified by linphone_core_set_network_reachable.
void	onNewSubscriptionRequested(Core core, Friend linphoneFriend, java.lang.String url) Reports that a new subscription request has been received and wait for a decision.
void	onNotifyPresenceReceived(Core core, Friend linphoneFriend) Report status change for a friend previously added to the LinphoneCore with linphone_core_add_friend().
void	onNotifyPresenceReceivedForUriOrTel(Core core, Friend linphoneFriend, java.lang.String uriOrTel, PresenceModel presenceModel) Reports presence model change for a specific URI or phone number of a friend.
void	onNotifyReceived(Core core, Event linphoneEvent, java.lang.String notifiedEvent, Content body) Callback prototype for notifying the application about notification received from the network.
void	onPublishStateChanged(Core core, Event linphoneEvent, PublishState state) Callback prototype for notifying the application about changes of publish states.
void	onQrcodeFound(Core core, java.lang.String result) Callback prototype telling the result of decoded qrcode.
void	onReferReceived(Core core, java.lang.String referTo) Callback prototype for when a refer is received.
void	onRegistrationStateChanged(Core core, ProxyConfig proxyConfig, RegistrationState state, java.lang.String message) Registration state notification callback prototype.
void	onSubscribeReceived(Core core, Event linphoneEvent, java.lang.String subscribeEvent, Content body) Callback prototype for notifying the application about subscription received from the network.
void	onSubscriptionStateChanged(Core core, Event linphoneEvent, SubscriptionState state) Callback prototype for notifying the application about changes of subscription states, including arrival of new subscriptions.
void	onTransferStateChanged(Core core, Call transfered, Call.State callState) Callback for notifying progresses of transfers.
void	onVersionUpdateCheckResultReceived(Core core, VersionUpdateCheckResult result, java.lang.String version, java.lang.String url) Callback prototype for reporting the result of a version update check.

Method Detail

onCallIdUpdated

void onCallIdUpdated(@NonNull
                     Core core,
                     @NonNull
                     java.lang.String previousCallId,
                     @NonNull
                     java.lang.String currentCallId)

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

This is done typically when a call retry.

Parameters:

core - the LinphoneCore

previousCallId - the previous callid.

currentCallId - the new callid.

onCallEncryptionChanged

void onCallEncryptionChanged(@NonNull
                             Core core,
                             @NonNull
                             Call call,
                             boolean mediaEncryptionEnabled,
                             @Nullable
                             java.lang.String authenticationToken)

Call encryption changed callback.

Parameters:

core - the LinphoneCore

call - the LinphoneCall on which encryption is changed.

mediaEncryptionEnabled - whether encryption is activated.

authenticationToken - an authentication_token, currently set for ZRTP kind
of encryption only.

onFriendListCreated

void onFriendListCreated(@NonNull
                         Core core,
                         @NonNull
                         FriendList friendList)

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

Parameters:

core - LinphoneCore object

friendList - LinphoneFriendList object

onChatRoomSubjectChanged

void onChatRoomSubjectChanged(@NonNull
                              Core core,
                              @NonNull
                              ChatRoom chatRoom)

Callback prototype telling that a LinphoneChatRoom subject has changed.

Parameters:

core - LinphoneCore object

chatRoom - The LinphoneChatRoom object for which the subject has changed

onEcCalibrationAudioInit

void onEcCalibrationAudioInit(@NonNull
                              Core core)

Function prototype used by #linphone_core_cbs_set_ec_calibrator_audio_init().

Parameters:

core - The LinphoneCore.

onBuddyInfoUpdated

void onBuddyInfoUpdated(@NonNull
                        Core core,
                        @NonNull
                        Friend linphoneFriend)

Callback prototype when using the buddy plugin.

Parameters:

core - the LinphoneCore

linphoneFriend - the LinphoneFriend that has been updated

onCallStateChanged

void onCallStateChanged(@NonNull
                        Core core,
                        @NonNull
                        Call call,
                        Call.State state,
                        @NonNull
                        java.lang.String message)

Call state notification callback.

Parameters:

core - the LinphoneCore

call - the LinphoneCall object whose state is changed.

state - the new LinphoneCallState of the call

message - a non null informational message about the state.

onPublishStateChanged

void onPublishStateChanged(@NonNull
                           Core core,
                           @NonNull
                           Event linphoneEvent,
                           PublishState state)

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

Parameters:

core - LinphoneCore object

linphoneEvent - the LinphoneEvent

state - the new LinphonePublishState

onAudioDevicesListUpdated

void onAudioDevicesListUpdated(@NonNull
                               Core core)

Callback prototype telling the audio devices list has been updated.

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

Parameters:

core - LinphoneCore object

onMessageSent

void onMessageSent(@NonNull
                   Core core,
                   @NonNull
                   ChatRoom chatRoom,
                   @NonNull
                   ChatMessage message)

Called after the #send method of the LinphoneChatMessage was called.

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

Parameters:

core - LinphoneCore object

chatRoom - LinphoneChatRoom involved in this conversation. Can be be
created by the framework in case the From-URI is not present in any chat room.

message - LinphoneChatMessage outgoing message

onTransferStateChanged

void onTransferStateChanged(@NonNull
                            Core core,
                            @NonNull
                            Call transfered,
                            Call.State callState)

Callback for notifying progresses of transfers.

Parameters:

core - the LinphoneCore

transfered - the LinphoneCall that was transfered

callState - the LinphoneCallState of the call to transfer target at the
far end.

onMessageReceived

void onMessageReceived(@NonNull
                       Core core,
                       @NonNull
                       ChatRoom chatRoom,
                       @NonNull
                       ChatMessage message)

Chat message callback prototype.

Parameters:

core - LinphoneCore object

chatRoom - LinphoneChatRoom involved in this conversation. Can be created
by the framework in case the From-URI is not present in any chat room.

message - LinphoneChatMessage incoming message

onVersionUpdateCheckResultReceived

void onVersionUpdateCheckResultReceived(@NonNull
                                        Core core,
                                        @NonNull
                                        VersionUpdateCheckResult result,
                                        java.lang.String version,
                                        @Nullable
                                        java.lang.String url)

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

Parameters:

core - LinphoneCore object

result - The result of the version update check

url - The url where to download the new version if the result is
#LinphoneVersionUpdateCheckNewVersionAvailable

onLastCallEnded

void onLastCallEnded(@NonNull
                     Core core)

Callback prototype telling the last call has ended
(#LinphoneCore.get_calls_nb() returns 0)

Parameters:

core - LinphoneCore object

onEcCalibrationAudioUninit

void onEcCalibrationAudioUninit(@NonNull
                                Core core)

Function prototype used by #linphone_core_cbs_set_ec_calibrator_audio_uninit().

Parameters:

core - The LinphoneCore.

onChatRoomEphemeralMessageDeleted

void onChatRoomEphemeralMessageDeleted(@NonNull
                                       Core core,
                                       @NonNull
                                       ChatRoom chatRoom)

Callback prototype telling that a LinphoneChatRoom ephemeral message has
expired.

Parameters:

core - LinphoneCore object

chatRoom - The LinphoneChatRoom object for which a message has expired.

onFriendListRemoved

void onFriendListRemoved(@NonNull
                         Core core,
                         @NonNull
                         FriendList friendList)

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

Parameters:

core - LinphoneCore object

friendList - LinphoneFriendList object

onChatRoomStateChanged

void onChatRoomStateChanged(@NonNull
                            Core core,
                            @NonNull
                            ChatRoom chatRoom,
                            ChatRoom.State state)

Callback prototype telling that a LinphoneChatRoom state has changed.

Parameters:

core - LinphoneCore object

chatRoom - The LinphoneChatRoom object for which the state has changed

state - the current LinphoneChatRoomState

onLogCollectionUploadProgressIndication

void onLogCollectionUploadProgressIndication(@NonNull
                                             Core core,
                                             int offset,
                                             int total)

Callback prototype for reporting log collection upload progress indication.

Parameters:

core - LinphoneCore object

offset - the number of bytes sent since the start of the upload

total - the total number of bytes to upload

onChatRoomRead

void onChatRoomRead(@NonNull
                    Core core,
                    @NonNull
                    ChatRoom chatRoom)

Chat room marked as read callback.

Parameters:

core - LinphoneCore object

chatRoom - LinphoneChatRoom that has been marked as read.

onConferenceStateChanged

void onConferenceStateChanged(@NonNull
                              Core core,
                              @NonNull
                              Conference conference,
                              Conference.State state)

Callback prototype telling that a LinphoneConference state has changed.

Parameters:

core - LinphoneCore object

conference - The LinphoneConference object for which the state has changed

state - the current LinphoneChatRoomState

onAuthenticationRequested

void onAuthenticationRequested(@NonNull
                               Core core,
                               @NonNull
                               AuthInfo authInfo,
                               @NonNull
                               AuthMethod method)

Callback for requesting authentication information to application or user.

Parameters:

core - the LinphoneCore

authInfo - a LinphoneAuthInfo pre-filled with username, realm and domain
values as much as possible

method - the type of authentication requested as LinphoneAuthMethod enum
Application shall reply to this callback using linphone_core_add_auth_info.

onDtmfReceived

void onDtmfReceived(@NonNull
                    Core core,
                    @NonNull
                    Call call,
                    int dtmf)

Callback for being notified of DTMFs received.

Parameters:

core - the LinphoneCore

call - the LinphoneCall that received the dtmf

dtmf - the ascii code of the dtmf

onLogCollectionUploadStateChanged

void onLogCollectionUploadStateChanged(@NonNull
                                       Core core,
                                       Core.LogCollectionUploadState state,
                                       @NonNull
                                       java.lang.String info)

Callback prototype for reporting log collection upload state change.

Parameters:

core - LinphoneCore object

state - The state of the log collection upload

info - Additional information: error message in case of error state, URL
of uploaded file in case of success.

onNotifyPresenceReceived

void onNotifyPresenceReceived(@NonNull
                              Core core,
                              @NonNull
                              Friend linphoneFriend)

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

Parameters:

core - LinphoneCore object

linphoneFriend - Updated LinphoneFriend

onNewSubscriptionRequested

void onNewSubscriptionRequested(@NonNull
                                Core core,
                                @NonNull
                                Friend linphoneFriend,
                                @NonNull
                                java.lang.String url)

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

note: A subscription request is notified by this function only if the
LinphoneSubscribePolicy for the given LinphoneFriend has been set to
LinphoneSPWait. See linphone_friend_set_inc_subscribe_policy.

Parameters:

core - LinphoneCore object

linphoneFriend - The LinphoneFriend aimed by the subscription.

url - URI of the subscriber

onInfoReceived

void onInfoReceived(@NonNull
                    Core core,
                    @NonNull
                    Call call,
                    @NonNull
                    InfoMessage message)

Callback prototype for receiving info messages.

Parameters:

core - the LinphoneCore

call - the call whose info message belongs to.

message - the info message.

onNetworkReachable

void onNetworkReachable(@NonNull
                        Core core,
                        boolean reachable)

Callback prototype for reporting network change either automatically detected
or notified by linphone_core_set_network_reachable.

Parameters:

core - the LinphoneCore

reachable - true if network is reachable.

onSubscriptionStateChanged

void onSubscriptionStateChanged(@NonNull
                                Core core,
                                @NonNull
                                Event linphoneEvent,
                                SubscriptionState state)

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

Parameters:

core - LinphoneCore object

linphoneEvent - the LinphoneEvent

state - the new LinphoneSubscriptionState

onRegistrationStateChanged

void onRegistrationStateChanged(@NonNull
                                Core core,
                                @NonNull
                                ProxyConfig proxyConfig,
                                RegistrationState state,
                                @NonNull
                                java.lang.String message)

Registration state notification callback prototype.

Parameters:

core - the LinphoneCore

proxyConfig - the LinphoneProxyConfig which state has changed

state - the current LinphoneRegistrationState

message - a non null informational message about the state

onCallCreated

void onCallCreated(@NonNull
                   Core core,
                   @NonNull
                   Call call)

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

Parameters:

core - LinphoneCore object that has created the call

call - The newly created LinphoneCall object

onConfiguringStatus

void onConfiguringStatus(@NonNull
                         Core core,
                         ConfiguringState status,
                         @Nullable
                         java.lang.String message)

Callback prototype for configuring status changes notification.

Parameters:

core - the LinphoneCore

status - the current LinphoneConfiguringState

message - informational message.

onNotifyReceived

void onNotifyReceived(@NonNull
                      Core core,
                      @NonNull
                      Event linphoneEvent,
                      @NonNull
                      java.lang.String notifiedEvent,
                      @NonNull
                      Content body)

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

Parameters:

core - LinphoneCore object

linphoneEvent - the LinphoneEvent received

notifiedEvent - The event as string

body - the LinphoneContent of the event

onQrcodeFound

void onQrcodeFound(@NonNull
                   Core core,
                   @Nullable
                   java.lang.String result)

Callback prototype telling the result of decoded qrcode.

Parameters:

core - LinphoneCore object

result - The result of the decoded qrcode

onAudioDeviceChanged

void onAudioDeviceChanged(@NonNull
                          Core core,
                          @NonNull
                          AudioDevice audioDevice)

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

Parameters:

core - LinphoneCore object

audioDevice - the newly used LinphoneAudioDevice object

onIsComposingReceived

void onIsComposingReceived(@NonNull
                           Core core,
                           @NonNull
                           ChatRoom chatRoom)

Is composing notification callback prototype.

Parameters:

core - LinphoneCore object

chatRoom - LinphoneChatRoom involved in the conversation.

onReferReceived

void onReferReceived(@NonNull
                     Core core,
                     @NonNull
                     java.lang.String referTo)

Callback prototype for when a refer is received.

Parameters:

core - the LinphoneCore

referTo - the address of the refer

onImeeUserRegistration

void onImeeUserRegistration(@NonNull
                            Core core,
                            boolean status,
                            @NonNull
                            java.lang.String userId,
                            @NonNull
                            java.lang.String info)

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

Parameters:

core - LinphoneCore object

status - the return status of the registration action.

userId - the userId published on the encryption engine server

info - information about failure

onEcCalibrationResult

void onEcCalibrationResult(@NonNull
                           Core core,
                           EcCalibratorStatus status,
                           int delayMs)

Function prototype used by #linphone_core_cbs_set_ec_calibrator_result().

Parameters:

core - The LinphoneCore.

status - The LinphoneEcCalibratorStatus of the calibrator.

delayMs - The measured delay if available.

onSubscribeReceived

void onSubscribeReceived(@NonNull
                         Core core,
                         @NonNull
                         Event linphoneEvent,
                         @NonNull
                         java.lang.String subscribeEvent,
                         @NonNull
                         Content body)

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

Parameters:

core - LinphoneCore object

linphoneEvent - the LinphoneEvent received

subscribeEvent - The event as string

body - the LinphoneContent of the event

onCallLogUpdated

void onCallLogUpdated(@NonNull
                      Core core,
                      @NonNull
                      CallLog callLog)

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

This is done typically when a call terminates.

Parameters:

core - the LinphoneCore

callLog - the new LinphoneCallLog entry added.

onFirstCallStarted

void onFirstCallStarted(@NonNull
                        Core core)

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

Parameters:

core - LinphoneCore object

onMessageReceivedUnableDecrypt

void onMessageReceivedUnableDecrypt(@NonNull
                                    Core core,
                                    @NonNull
                                    ChatRoom chatRoom,
                                    @NonNull
                                    ChatMessage message)

Chat message not decrypted callback prototype.

Parameters:

core - LinphoneCore object

chatRoom - LinphoneChatRoom involved in this conversation. Can be be
created by the framework in case the from-URI is not present in any chat room.

message - LinphoneChatMessage incoming message

onGlobalStateChanged

void onGlobalStateChanged(@NonNull
                          Core core,
                          GlobalState state,
                          @NonNull
                          java.lang.String message)

Global state notification callback.

Parameters:

core - the LinphoneCore.

state - the LinphoneGlobalState

message - informational message.

onCallStatsUpdated

void onCallStatsUpdated(@NonNull
                        Core core,
                        @NonNull
                        Call call,
                        @NonNull
                        CallStats callStats)

Callback for receiving quality statistics for calls.

Parameters:

core - the LinphoneCore

call - the call

callStats - the call statistics.

onNotifyPresenceReceivedForUriOrTel

void onNotifyPresenceReceivedForUriOrTel(@NonNull
                                         Core core,
                                         @NonNull
                                         Friend linphoneFriend,
                                         @NonNull
                                         java.lang.String uriOrTel,
                                         @NonNull
                                         PresenceModel presenceModel)

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

Parameters:

core - LinphoneCore object

linphoneFriend - LinphoneFriend object

uriOrTel - The URI or phone number for which the presence model has
changed

presenceModel - The new LinphonePresenceModel