Linphone

Namespace Linphone

Classes

Account

Object that represents a Linphone Account.

This object replaces the deprecated ProxyConfig. Use a AccountParams object to configure it.

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.

Note that authenticated accounts should have a corresponding AuthInfo added to the Core to register properly.

Address

Object that represents a parsed SIP address.

A SIP address is made of display name, username, domain name, port, and various uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'. You can create an address using Linphone.Factory.CreateAddress() or Linphone.Core.InterpretUrl() and both will return a null object if it doesn't match the grammar defined by the standard. This object is used in almost every other major objects to identity people (including yourself) & servers. The Address has methods to extract and manipulate all parts of the address.

AudioDevice

Object holding audio device information.

It contains the name of the device, it's type if available (Earpiece, Speaker, Bluetooth, etc..) and capabilities (input, output or both) the name of the driver that created it (filter in mediastreamer). You can use the AudioDevice objects to configure default input/output devices or do it dynamically during a call. To get the list of available devices, use AudioDevices. This list will be limited to one device of each type. Use ExtendedAudioDevices for a complete list.

AuthInfo

Object holding authentication information.

In most case, authentication information consists of a username and password. If realm isn't set, it will be deduced automatically from the first authentication challenge as for the hash algorithm. Sometimes, a userid is required by the proxy and then domain can be useful to discriminate different credentials. You can also use this object if you need to use a client certificate. Once created and filled, a AuthInfo must be added to the Core in order to become known and used automatically when needed. Use Linphone.Core.AddAuthInfo() for that purpose. The Core object can take the initiative to request authentication information when needed to the application through the authentication_requested() callback of it's LinphoneCoreCbs. The application can respond to this information request later using Linphone.Core.AddAuthInfo(). This will unblock all pending authentication transactions and retry them with authentication headers.

Buffer

The object representing a data buffer.

Call

This object represents a call issued or received by the Core.

Linphone only allows at most one active call at any given time and it will be in StreamsRunning. However, if the core is locally hosting a Conference, you may have some or all the calls in the conference in StreamsRunning as well as an additional active call outside of the conference in StreamsRunning if the local participant of the Conference is not part of it. You can get the CallState of the call using State, it's current CallParams with CurrentParams and the latest statistics by calling AudioStats or VideoStats.

CallListener

That class holds all the callbacks which are called by LinphoneCall objects.

Use linphone_factory_create_call_cbs to create an instance. Then, call the callback setters on the events you need to monitor and pass the object to a LinphoneCall instance through linphone_call_add_callbacks.

CallLog

Object used to keep track of all calls initiated, received or missed.

It contains the call ID, date & time at which the call took place and it's duration (0 if it wasn't answered). You can also know if video was enabled or not or if it was a conference, as well as it's average quality. If needed, you can also create a fake CallLog using Linphone.Core.CreateCallLog(), otherwise use CallLogs or even CallLog to get the log of an ongoing call.

CallParams

An object containing various parameters of a Call.

You can specify your params while answering an incoming call using Linphone.Call.AcceptWithParams() or while initiating an outgoing call with Linphone.Core.InviteAddressWithParams(). This object can be created using Linphone.Core.CreateCallParams(), using null for the call pointer if you plan to use it for an outgoing call. For each call, three CallParams are available: yours, your correspondent's and the one that describe the current state of the call that is the result of the negociation between the previous two. For example, you might enable a certain feature in your call param but this feature can be denied in the remote's configuration, hence the difference.

CallStats

This object carry various statistic informations regarding the quality of an audio or video stream for a given Call.

To receive these informations periodically and as soon as they are computed, implement the call_stats_updated() callback inside a LinphoneCoreCbs. At any time, the application can access latest computed statistics using AudioStats and VideoStats.

ChatMessage

An chat message is the object that is sent or received through a ChatRoom.

To create a ChatMessage, use CreateEmptyMessage(), then either add text using Linphone.ChatMessage.AddUtf8TextContent() or a Content with file informations using Linphone.ChatMessage.AddFileContent(). A valid Content for file transfer must contain a type and subtype, the name of the file and it's size. Finally call Send() to send it. To send files through a ChatMessage, you need to have configured a file transfer server URL with FileTransferServer. On the receiving side, either use Linphone.ChatMessage.DownloadContent() to download received files or enable auto-download in the Core using MaxSizeForAutoDownloadIncomingFiles, -1 disabling the feature and 0 always downloading files no matter it's size. Keep in mind a ChatMessage created by a Basic ChatRoom can only contain one Content, either text or file.

ChatMessageListener

An object to handle the callbacks for the handling a LinphoneChatMessage objects.

ChatRoom

A chat room is the place where ChatMessage are exchanged.

To create (or find) a ChatRoom, you first need a ChatRoomParams object. A chat room is uniquely identified by it's local and remote SIP addresses, meaning you can only have one chat room between two accounts (unless the backend is FlexisipChat). Then you can call Linphone.Core.SearchChatRoom() or Linphone.Core.CreateChatRoom(). Be careful as a FlexisipChat backend ChatRoom will be created asynchronously, so make sure you add a LinphoneChatRoomCbs to the returned object to be notified when it will be in state Created. All chat rooms are loaded from database when the Core starts, and you can get them using ChatRooms. This method doesn't return empty chat rooms nor ones for which the local address doesn't match an existing ProxyConfig identity, unless you specify otherwise in the [misc] section of your configuration file by setting hide_empty_chat_rooms=0 and/or hide_chat_rooms_from_removed_proxies=0.

ChatRoomListener

An object to handle the callbacks for the handling a LinphoneChatRoom objects.

ChatRoomParams

Object defining parameters for a ChatRoom.

Can be created with CreateDefaultChatRoomParams(). You can use IsValid to check if your configuration is valid or not. If the ChatRoom backend is Basic, then no other parameter is required, but ChatMessage sent and received won't benefit from all features a FlexisipChat can offer like conversation with multiple participants and a subject, end-to-end encryption, ephemeral messages, etc... but this type is the only one that can interoperate with other SIP clients or with non-flexisip SIP proxies.

Conference

A conference is the object that allow to make calls when there are 2 or more participants.

To create (or find) a Conference, you first need a ConferenceParams object. Linphone.Core.CreateConferenceWithParams() allows you to create a conference. A conference is uniquely identified by a conference address, meaning you can have more than one conference between two accounts. As of now, each Core can host only 1 conference but it can be part of many conferences as a remote participant. To find a conference among those a core is part of, you can call Linphone.Core.SearchConference().

ConferenceInfo

Object defining all information related to a conference.

ConferenceListener

An object to handle the callbacks for the handling a LinphoneConference objects.

Use linphone_factory_create_conference_cbs to create an instance. Then pass the object to a LinphoneConference instance through linphone_conference_add_callbacks.

ConferenceParams

Object defining parameters for a Conference.

Can be created by calling function Linphone.Core.CreateConferenceParams().

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.

The format of the configuration file is a .ini like format: Various types can be used: strings and lists of strings, integers, floats, booleans (written as 0 or 1) and range of integers. Usually a Core is initialized using two Config, one default (where configuration changes through API calls will be saved) and one named 'factory' which is read-only and overwrites any setting that may exists in the default one. It is also possible to use only one (either default or factory) or even none.

Content

This object holds data that can be embedded in a signaling message.

Use CreateContent() to create it, and then you should set at least it's type and subtype and fill the buffer with your data. A Content can be multipart (contain other contents), have file information (name, path, size), be encrypted, have custom headers, etc... It is mainly used to send information through a ChatMessage.

Core

Main object to instanciate and on which to keep a reference.

This object is the first object to instanciante, and will allow you to perform all kind of tasks. To create it, use either Linphone.Factory.CreateCore() or Linphone.Factory.CreateCoreWithConfig(), see Config for more information about factory and default config. On some platforms like Android or iOS you will need to give it the Context of your application. Once the Core is in state Ready, use Start(). It will then go to state On and from that you can start using it for calls and chat messages. It is recommended to add a LinphoneCoreCbs listener using Linphone.Core.AddCallbacks() to it to monitor different events. To be able to receive events from the network, you must schedule a call Iterate() often, like every 20ms. On Android & iOS IsAutoIterateEnabled is enabled by default so you don't have to worry about that unless you disable it using linphone_core_set_auto_iterate_enabled or by setting in the [misc] section of your configuration auto_iterate=0.

CoreListener

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

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

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.

All ErrorInfo object returned by the liblinphone API are readonly and transcients. For safety they must be used immediately after obtaining them. Any other function call to the liblinphone may change their content or invalidate the pointer.

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.

For example, all chat related events are wrapped in an EventLog, and many callbacks use this kind of type as parameter. Use Type to get the EventLogType it refers to, and then you can use one of the accessor methods to get the underlying object, for example ChatMessage for a ChatMessage.

Factory

The factory is a singleton object devoted to the creation of all the objects of Liblinphone that cannot be created by Core itself.

It is also used to configure a few behaviors before creating the Core, like the logs verbosity or collection.

Friend

This object is used to store a SIP address.

Friend is mainly used to implement an adressbook feature, and are used as data for the MagicSearch object. If your proxy supports it, you can also use it to subscribe to presence information. The objects are stored in a FriendList which are in turn stored inside the Core. They can be stored inside a database if the path to it is configured, otherwise they will be lost after the Core is destroyed. Thanks to the vCard plugin, you can also store more information like phone numbers, organization, etc...

FriendList

This object representing a list of Friend.

You can use it to store contacts locally or synchronize them through CardDAV protocol.

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.

It provides read/write access to the headers of the underlying protocol.

ImNotifPolicy

Policy to use to send/receive instant messaging composing/delivery/display notifications.

The sending of this information is done as in the RFCs 3994 (is_composing) and 5438 (imdn delivered/displayed).

InfoMessage

Object representing an informational message sent or received by the core.

Ldap

Object that represents a Linphone Ldap.

Use a LdapParams object to configure it.

LdapParams

Object that is used to set the different parameters of a Ldap.

LinphoneException

All methods that returns a LinphoneStatus with a value != 0 as an error code in C are translated in C# by throwing a LinphoneException

LinphoneObject

LinphoneWrapper

Only contains the LIB_NAME value that represents the library in which all DllImport are made

LoggingService

Singleton class giving access to logging features.

It supports custom domain, writing into a file as well as several verbosity levels. The LinphoneLoggingServiceCbs listener allows you to be notified each time a log is printed. As the LoggingService is a singleton, use Linphone.LoggingService. to get it.

LoggingServiceListener

Listener for LinphoneLoggingService.

MagicSearch

A MagicSearch is used to do specifics searchs.

MagicSearchListener

A LinphoneMagicSearchCbs is used to do specifics searchs.

MediastreamerFactory

NatPolicy

Policy to use to pass through NATs/firewalls.

Participant

Identifies a member of a Conference or ChatRoom.

A participant is identified by it's SIP address. It can have many ParticipantDevice.

ParticipantDevice

This object represents a unique device for a member of a Conference or ChatRoom.

Devices are identified by the gruu parameter inside the Address which can be obtained by Address. It is specially usefull to know the security level of each device inside an end-to-end encrypted ChatRoom. You can get a list of all ParticipantDevice using Devices.

ParticipantDeviceIdentity

This object is only used on server side for ChatRoom with FlexisipChat backend.

ParticipantDeviceListener

An object to handle the callbacks for the handling a LinphoneParticipantDevice objects.

Use linphone_factory_create_participant_device_cbs to create an instance. Then pass the object to a LinphoneParticipantDevice instance through linphone_participant_device_add_callbacks.

ParticipantImdnState

This object represents the delivery/display state of a given chat message for a given participant.

It also contains a timestamp at which this participant state has changed. Use Linphone.ChatMessage.ParticipantsByImdnState to get all ParticipantImdnState for a given state. From there use Participant to get the Participant object if you need it.

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

Represents an account configuration to be used by Core.

In addition to the AuthInfo that stores the credentials, you need to configure a ProxyConfig as well to be able to connect to a proxy server. A minimal proxy config consists of an identity address (sip:username@domain.tld) and the proxy server address,

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 PushNotificationAllowed.

This object can be accessed through the AccountParams object, which can be obtained from your Account object.

PushNotificationMessage

Object holding chat message data received by a push notification on iOS platform only.

This object is a subset of ChatMessage, so only a few methods of it's parent are available, like linphone_push_notification_message_get_text_content and linphone_push_notification_message_get_subject, just enough to be able to build a notification to show the user.

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.

Indicates which transport among UDP, TCP, TLS and DTLS should be enabled and if so on which port to listen. You can use special values like LC_SIP_TRANSPORT_DISABLED (0), LC_SIP_TRANSPORT_RANDOM (-1) and LC_SIP_TRANSPORT_DONTBIND (-2). Once configuration is complete, use Transports to apply it. This will be saved in configuration file so you don't have to do it each time the Core starts.

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.

Use AutomaticallyAccept and AutomaticallyInitiate to tell the Core to automatically accept or initiate video during calls. Even if disabled, you'll still be able to add it later while the call is running.

VideoDefinition

This object represents a video definition, eg.

it's width, it's height and possibly it's name. It is mostly used to configure the default video size sent by your camera during a video call with PreferredVideoDefinition method.

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.

Structs

Core.MSOglContextInfo

Enums

AccountCreatorActivationCodeStatus

Enum describing activation code checking, used by the AccountCreator.

AccountCreatorAlgoStatus

Enum describing algorithm checking, used by the AccountCreator.

AccountCreatorBackend

Enum describing backend used in the AccountCreator.

AccountCreatorDomainStatus

Enum describing domain checking, used by the AccountCreator.

AccountCreatorEmailStatus

Enum describing email checking, used by the AccountCreator.

AccountCreatorLanguageStatus

Enum describing language checking, used by the AccountCreator.

AccountCreatorPasswordStatus

Enum describing password checking, used by the AccountCreator.

AccountCreatorPhoneNumberStatus

Enum describing phone number checking, used by the AccountCreator.

AccountCreatorStatus

Enum describing the status of server request, used by the AccountCreator.

AccountCreatorTransportStatus

Enum describing transport checking, used by the AccountCreator.

AccountCreatorUsernameStatus

Enum describing username checking, used by the AccountCreator.

AddressFamily

Enum describing Ip family.

AudioDeviceCapabilities

AudioDeviceCapabilities enum represents whether a device can record audio, play audio or both

AudioDeviceType

AudioDeviceType enum represents the different types of an audio device.

AuthMethod

Enum describing the authentication methods.

AVPFMode

Enum describing RTP AVPF activation modes.

CallDir

Enum representing the direction of a call.

CallState

CallState enum represents the different states a call can reach into.

The application is notified of a state change through the LinphoneCoreVTable::call_state_changed callback.

CallStatus

Enum representing the status of a call.

ChatMessageDirection

ChatMessageDirection is used to indicate if a message is outgoing or incoming.

ChatMessageState

ChatMessageState is used to notify if messages have been successfully delivered or not.

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.

ChatRoomState

ChatRoomState is used to indicate the current state of a chat room.

ConferenceInfoState

ConferenceInfoState is used to list all states of a conference info object

ConferenceJoiningMode

Mode of joining conference.

ConferenceLayout

ConferenceLayout is used to indicate the layout used by the conference.

ConferenceParticipantListType

Type of conference participant list.

When participant list is closed, no more participants can be added other than those declared when creating the conference When participant list is open, other people can join the conference upon invitation of a participant no more participants can be added other than those declared when creating the conference

ConferenceSchedulerState

Describes conference scheduler possible states.

It is notified via the conference_scheduler_state_changed callback in LinphoneConferenceSchedulerCbs.

ConferenceState

ConferenceState is used to indicate the current state of a conference.

ConfiguringState

Describes the state of the remote configuring process of the Core object, 'Skipped' when the feature is disabled.

It is notified via the configuring_status() callback in LinphoneCoreCbs.

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.

CoreLogCollectionUploadState

Used to notify if log collection upload have been succesfully delivered or not.

EcCalibratorStatus

Enum describing the result of the echo canceller calibration process.

EventLogType

EventLogType is used to indicate the type of an event.

Useful for cast.

FriendCapability

Enum describing the capabilities of a Friend, populated through presence subscribe/notify process.

FriendListStatus

Enum describing the status of a LinphoneFriendList operation.

FriendListSyncStatus

Enum describing the status of a CardDAV synchronization.

FriendListType

The types of FriendList.

GlobalState

Describes the global state of the Core object.

It is notified via the global_state_changed() callback in LinphoneCoreCbs.

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

PlayerState

The state of a Player.

PresenceActivityType

Activities as defined in section 3.2 of RFC 4480.

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.

It is notified via the registration_state_changed() callback in LinphoneCoreCbs.

SecurityEventType

SecurityEventType is used to indicate the type of security event.

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.

Use by IncSubscribePolicy

SubscriptionDir

Enum for subscription direction (incoming or outgoing).

SubscriptionState

Enum for subscription states.

Terminated and Error are final states.

SupportLevel

ToneID

Enum listing frequent telephony tones.

TransportType

Enum describing transport type for LinphoneAddress.

TunnelMode

Enum describing the tunnel modes.

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.