Package org.linphone.core

Interface Summary

Interface	Description
Account	Object that represents a Linphone Account.
AccountCreator	The object used to configure an account on a server via XML-RPC, see https://wiki.linphone.org/xwiki/wiki/public/view/Lib/Features/Override%20account%20creator%20request/.
AccountCreatorListener	An object to handle the responses callbacks for handling the LinphoneAccountCreator operations.
AccountListener	An object to handle the callbacks for the handling of LinphoneAccount objects.
AccountParams	Object that is used to set the different parameters of a Account.
Address	Object that represents a parsed SIP address.
AudioDevice	Object holding audio device information.
AuthInfo	Object holding authentication information.
Buffer	The object representing a data buffer.
Call	This object represents a call issued or received by the Core.
CallListener	That class holds all the callbacks which are called by LinphoneCall objects.
CallLog	Object used to keep track of all calls initiated, received or missed.
CallParams	An object containing various parameters of a Call.
CallStats	This object carry various statistic informations regarding the quality of an audio or video stream for a given Call.
ChatMessage	An chat message is the object that is sent or received through a ChatRoom .
ChatMessageListener	An object to handle the callbacks for the handling a LinphoneChatMessage objects.
ChatRoom	A chat room is the place where ChatMessage are exchanged.
ChatRoomListener	An object to handle the callbacks for the handling a LinphoneChatRoom objects.
ChatRoomParams	Object defining parameters for a ChatRoom.
Conference	A conference is the object that allow to make calls when there are 2 or more participants.
ConferenceInfo	Object defining all information related to a conference.
ConferenceListener	An object to handle the callbacks for the handling a LinphoneConference objects.
ConferenceParams	Object defining parameters for a Conference.
ConferenceScheduler	Object used to create remote conferences and send ICS to notify participants.
ConferenceSchedulerListener	An object to handle the callbacks of LinphoneConferenceScheduler object.
Config	This object is used to manipulate a configuration file.
Content	This object holds data that can be embedded in a signaling message.
Core	Main object to instanciate and on which to keep a reference.
CoreListener	That class holds all the callbacks which are called by LinphoneCore.
DialPlan	Represents a dial plan.
DigestAuthenticationPolicy	The LinphoneDigestAuthenticationPolicy holds parameters relative to digest authentication procedures.
ErrorInfo	Object representing full details about a signaling error or status.
Event	Object representing an event state, which is subcribed or published.
EventListener	An object to handle the callbacks for handling the LinphoneEvent operations.
EventLog	Object that represents an event that must be stored in database.
Friend	This object is used to store a SIP address.
FriendList	This object representing a list of Friend.
FriendListener	An object to handle the callbacks for LinphoneFriend.
FriendListListener	An object to handle the callbacks for LinphoneFriend synchronization.
FriendPhoneNumber	Object that represents a Friend's phone number.
Headers	Object representing a chain of protocol headers.
ImNotifPolicy	Policy to use to send/receive instant messaging composing/delivery/display notifications.
InfoMessage	Object representing an informational message sent or received by the core.
Ldap	Object that represents a Linphone Ldap.
LdapParams	Object that is used to set the different parameters of a Ldap.
LoggingService	Singleton class giving access to logging features.
LoggingServiceListener	Listener for LinphoneLoggingService.
MagicSearch	A MagicSearch is used to do specifics searchs.
MagicSearchListener	A LinphoneMagicSearchCbs is used to do specifics searchs.
NatPolicy	Policy to use to pass through NATs/firewalls.
Participant	Identifies a member of a Conference or ChatRoom.
ParticipantDevice	This object represents a unique device for a member of a Conference or ChatRoom.
ParticipantDeviceIdentity	This object is only used on server side for ChatRoom with ChatRoomBackend.FlexisipChat backend.
ParticipantDeviceListener	An object to handle the callbacks for the handling a LinphoneParticipantDevice objects.
ParticipantImdnState	This object represents the delivery/display state of a given chat message for a given participant.
PayloadType	Object representing an RTP payload type.
Player	Player interface.
PlayerListener	An object to handle the callbacks for the handling a LinphonePlayer objects.
PresenceActivity	Presence activity type holding information about a presence activity.
PresenceModel	Presence model type holding information about the presence of a person.
PresenceNote	Presence note type holding information about a presence note.
PresencePerson	Presence person holding information about a presence person.
PresenceService	Presence service type holding information about a presence service.
ProxyConfig	Deprecated. 06/04/2020 Use Account object instead
PushNotificationConfig	Object holding push notification config that will be set in the contact URI parameters of the Contact header in the REGISTER, if the AccountParams is configured to allow push notifications, see AccountParams.setPushNotificationAllowed(boolean) .
PushNotificationMessage	Object holding chat message data received by a push notification on iOS platform only.
Range	Structure describing a range of integers.
Recorder	Object used to record the audio or video of a call.
RecorderParams	Object containing various parameters of a Recorder.
SearchResult	The LinphoneSearchResult object represents a result of a search.
Transports	SIP transports & ports configuration object.
Tunnel	Linphone tunnel object.
TunnelConfig	Tunnel settings.
Vcard	Object storing contact information using vCard 4.0 format.
VideoActivationPolicy	Object describing policy regarding video streams establishments.
VideoDefinition	This object represents a video definition, eg.
VideoSourceDescriptor	Object that is used to describe a video source.
XmlRpcRequest	The XmlRpcRequest object representing a XML-RPC request to be sent.
XmlRpcRequestListener	An object to handle the callbacks for handling the LinphoneXmlRpcRequest operations.
XmlRpcSession	The XmlRpcSession object used to send XML-RPC requests and handle their responses.

Class Summary

Class	Description
AccountCreatorListenerStub
AccountListenerStub
CallListenerStub
ChatMessageListenerStub
ChatRoomListenerStub
ConferenceListenerStub
ConferenceSchedulerListenerStub
CoreListenerStub
EventListenerStub
Factory	The factory is a singleton object devoted to the creation of all the objects of Liblinphone that cannot be created by Core itself.
FriendListenerStub
FriendListListenerStub
LoggingServiceListenerStub
MagicSearchListenerStub
ParticipantDeviceListenerStub
PlayerListenerStub
Utils
XmlRpcRequestListenerStub

Enum Summary

Enum	Description
AccountCreator.ActivationCodeStatus
AccountCreator.DomainStatus
AccountCreator.EmailStatus
AccountCreator.LanguageStatus
AccountCreator.PasswordStatus
AccountCreator.PhoneNumberStatus
AccountCreator.Status
AccountCreator.TransportStatus
AccountCreator.UsernameStatus
AccountCreatorAlgoStatus	Enum describing algorithm checking, used by the AccountCreator.
AccountCreatorBackend	Enum describing backend used in the AccountCreator.
AddressFamily	Enum describing Ip family.
AudioDevice.Capabilities
AudioDevice.Type
AuthMethod	Enum describing the authentication methods.
AVPFMode	Enum describing RTP AVPF activation modes.
Call.Dir
Call.State
Call.Status
ChatMessage.Direction
ChatMessage.State
ChatRoom.State
ChatRoomBackend	ChatRoomBackend is used to indicate the backend implementation of a chat room.
ChatRoomCapabilities	ChatRoomCapabilities is used to indicate the capabilities of a chat room.
ChatRoomEncryptionBackend	ChatRoomEncryptionBackend is used to indicate the encryption engine used by a chat room.
ChatRoomEphemeralMode	ChatRoomEphemeralMode is used to the ephemeral message mode used by a chat room.
ChatRoomSecurityLevel	TODO move to encryption engine object when available ChatRoomSecurityLevel is used to indicate the encryption security level of a chat room.
Conference.State
ConferenceInfo.State
ConferenceJoiningMode	Mode of joining conference.
ConferenceLayout	ConferenceLayout is used to indicate the layout used by the conference.
ConferenceParticipantListType	Type of conference participant list.
ConferenceScheduler.State
ConfiguringState	Describes the state of the remote configuring process of the Core object, 'Skipped' when the feature is disabled.
ConsolidatedPresence	Consolidated presence information: 'online' means the user is open for communication, 'busy' means the user is open for communication but involved in an other activity, 'do not disturb' means the user is not open for communication, and 'offline' means that no presence information is available.
Core.LogCollectionUploadState
EcCalibratorStatus	Enum describing the result of the echo canceller calibration process.
EventLog.SecurityEventType
EventLog.Type
FriendCapability	Enum describing the capabilities of a Friend, populated through presence subscribe/notify process.
FriendList.Status
FriendList.SyncStatus
FriendListType	The types of FriendList.
GlobalState	Describes the global state of the Core object.
IceState	Enum describing ICE states.
LdapAuthMethod	Enum describing how the authentification will be made.
LdapCertVerificationMode	Enum describing server certificates verification modes.
LdapCheck	Enum describing errors in LDAP parameters.
LdapDebugLevel	Enum Debug verbosity for OpenLdap.
LimeState
LogCollectionState	Whether or not to keep a file with the logs.
LogLevel	Verbosity levels of log messages.
MagicSearchAggregation	Enum describing how to merge SearchResult from MagicSearch.
MagicSearchSource	Enum describing the search categories for Magic Search.
MediaDirection	Indicates for a given media the stream direction.
MediaEncryption	Enum describing type of media encryption types.
MediaResourceMode	Media resource usage.
ParticipantDeviceDisconnectionMethod	ParticipantDeviceDisconnectionMethod is used to indicate how a participant left a conference.
ParticipantDeviceJoiningMethod	ParticipantDeviceJoiningMethod is used to indicate how a participant joined a conference or if it is the focus.
ParticipantDeviceState	ParticipantDeviceState is used to list all states a participant device can be in
Player.State
PresenceActivity.Type
PresenceBasicStatus	Basic status as defined in section 4.1.4 of RFC 3863.
Privacy	Defines privacy policy to apply as described by rfc3323.
PublishState	Enum for publish states.
Reason	Enum describing various failure reasons or contextual information for some events.
RecorderFileFormat	Enum representing the file format of a recording.
RecorderState	Enum representing the state of a recording.
RegistrationState	Describes proxy registration states.
SessionExpiresRefresher	Session Timers refresher.
SrtpSuite	Enum describing type of SRTP encryption suite.
StreamType	Enum describing the stream types.
SubscribePolicy	Enum controlling behavior for incoming subscription request.
SubscriptionDir	Enum for subscription direction (incoming or outgoing).
SubscriptionState	Enum for subscription states.
SupportLevel
ToneID	Enum listing frequent telephony tones.
TransportType	Enum describing transport type for LinphoneAddress.
Tunnel.Mode
UpnpState	Enum describing uPnP states.
VersionUpdateCheckResult	Enum describing the result of a version update check.
VideoSourceType	Enum representing the type of a video source.
XmlRpcArgType	Enum describing the types of argument for LinphoneXmlRpcRequest.
XmlRpcStatus	Enum describing the status of a LinphoneXmlRpcRequest.
ZrtpKeyAgreement	Enum describing the ZRTP key exchange algorithns.
ZrtpPeerStatus	Enum describing the ZRTP SAS validation status of a peer URI.

Exception Summary

Exception	Description
CoreException