Liblinphone
5.3.0
|
Namespace that holds all liblinphone's API classes and enumerations. More...
Classes | |
class | Account |
Object that represents a Linphone Account. More... | |
class | 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/. More... | |
class | AccountCreatorListener |
An object to handle the responses callbacks for handling the AccountCreator operations. More... | |
class | AccountListener |
An object to handle the callbacks for the handling of Account objects. More... | |
class | AccountParams |
Object that is used to set the different parameters of a Account. More... | |
class | Address |
Object that represents a parsed SIP address. More... | |
class | Alert |
Object that represents an alert. More... | |
class | AlertListener |
Object that represents a callback attached to an alert. More... | |
class | AudioDevice |
Object holding audio device information. More... | |
class | AuthInfo |
Object holding authentication information. More... | |
class | Buffer |
The object representing a data buffer. More... | |
class | Call |
This object represents a call issued or received by the Core. More... | |
class | CallListener |
That class holds all the callbacks which are called by Call objects. More... | |
class | CallLog |
Object used to keep track of all calls initiated, received or missed. More... | |
class | CallParams |
An object containing various parameters of a Call. More... | |
class | CallStats |
This object carry various statistic informations regarding the quality of an audio or video stream for a given Call. More... | |
class | ChatMessage |
An chat message is the object that is sent or received through a ChatRoom. More... | |
class | ChatMessageListener |
An object to handle the callbacks for the handling a ChatMessage objects. More... | |
class | ChatMessageReaction |
A chat message reaction is an emoji sent by someone in the same chat room to react to a specific ChatMessage. More... | |
class | ChatRoom |
A chat room is the place where ChatMessage are exchanged. More... | |
class | ChatRoomListener |
An object to handle the callbacks for the handling a ChatRoom objects. More... | |
class | ChatRoomParams |
Object defining parameters for a ChatRoom. More... | |
class | Conference |
A conference is the object that allow to make calls when there are 2 or more participants. More... | |
class | ConferenceInfo |
Object defining all information related to a conference. More... | |
class | ConferenceListener |
An object to handle the callbacks for the handling a Conference objects. More... | |
class | ConferenceParams |
Object defining parameters for a Conference. More... | |
class | ConferenceScheduler |
Object used to create remote conferences and send ICS to notify participants. More... | |
class | ConferenceSchedulerListener |
An object to handle the callbacks of ConferenceScheduler object. More... | |
class | Config |
This object is used to manipulate a configuration file. More... | |
class | Content |
This object holds data that can be embedded in a signaling message. More... | |
class | Core |
Main object to instanciate and on which to keep a reference. More... | |
class | CoreListener |
That class holds all the callbacks which are called by Core. More... | |
class | DialPlan |
Represents a dial plan. More... | |
class | Dictionary |
Object that represents key-value pair container. More... | |
class | DigestAuthenticationPolicy |
The LinphoneDigestAuthenticationPolicy holds parameters relative to digest authentication procedures. More... | |
class | ErrorInfo |
Object representing full details about a signaling error or status. More... | |
class | Event |
Object representing an event state, which is subcribed or published. More... | |
class | EventListener |
An object to handle the callbacks for handling the LinphoneEvent operations. More... | |
class | EventLog |
Object that represents an event that must be stored in database. More... | |
class | Factory |
The factory is a singleton object devoted to the creation of all the objects of Liblinphone that cannot be created by Core itself. More... | |
class | Friend |
This object is used to store a SIP address. More... | |
class | FriendList |
This object representing a list of Friend. More... | |
class | FriendListener |
An object to handle the callbacks for Friend. More... | |
class | FriendListListener |
An object to handle the callbacks for Friend synchronization. More... | |
class | FriendPhoneNumber |
Object that represents a Friend's phone number. More... | |
class | Headers |
Object representing a chain of protocol headers. More... | |
class | ImNotifPolicy |
Policy to use to send/receive instant messaging composing/delivery/display notifications. More... | |
class | InfoMessage |
Object representing an informational message sent or received by the core. More... | |
class | Ldap |
Object that represents a Linphone Ldap. More... | |
class | LdapParams |
Object that is used to set the different parameters of a Ldap. More... | |
class | LoggingService |
Singleton class giving access to logging features. More... | |
class | LoggingServiceListener |
Listener for LoggingService. More... | |
class | MagicSearch |
A MagicSearch is used to do specifics searchs. More... | |
class | MagicSearchListener |
A MagicSearchListener is used to do specifics searchs. More... | |
class | NatPolicy |
Policy to use to pass through NATs/firewalls. More... | |
class | Participant |
Identifies a member of a Conference or ChatRoom. More... | |
class | ParticipantDevice |
This object represents a unique device for a member of a Conference or ChatRoom. More... | |
class | ParticipantDeviceIdentity |
This object is only used on server side for ChatRoom with ChatRoom::Backend::FlexisipChat backend. More... | |
class | ParticipantDeviceListener |
An object to handle the callbacks for the handling a ParticipantDevice objects. More... | |
class | ParticipantImdnState |
This object represents the delivery/display state of a given chat message for a given participant. More... | |
class | ParticipantInfo |
Object defining all information related to a participant. More... | |
class | PayloadType |
Object representing an RTP payload type. More... | |
class | Player |
Player interface. More... | |
class | PlayerListener |
An object to handle the callbacks for the handling a Player objects. More... | |
class | PresenceActivity |
Presence activity type holding information about a presence activity. More... | |
class | PresenceModel |
Presence model type holding information about the presence of a person. More... | |
class | PresenceNote |
Presence note type holding information about a presence note. More... | |
class | PresencePerson |
Presence person holding information about a presence person. More... | |
class | PresenceService |
Presence service type holding information about a presence service. More... | |
class | ProxyConfig |
Represents an account configuration to be used by Core. More... | |
class | 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(). More... | |
class | PushNotificationMessage |
Object holding chat message data received by a push notification on iOS platform only. More... | |
class | Range |
Structure describing a range of integers. More... | |
class | Recorder |
Object used to record the audio or video of a call. More... | |
class | RecorderParams |
Object containing various parameters of a Recorder. More... | |
class | SearchResult |
The LinphoneSearchResult object represents a result of a search. More... | |
class | SignalInformation |
Object to get signal (wifi/4G etc...) informations. More... | |
class | Transports |
SIP transports & ports configuration object. More... | |
class | Tunnel |
Linphone tunnel object. More... | |
class | TunnelConfig |
Tunnel settings. More... | |
class | Vcard |
Object storing contact information using vCard 4.0 format. More... | |
class | VideoActivationPolicy |
Object describing policy regarding video streams establishments. More... | |
class | VideoDefinition |
This object represents a video definition, eg. More... | |
class | VideoSourceDescriptor |
Object that is used to describe a video source. More... | |
class | XmlRpcRequest |
The XmlRpcRequest object representing a XML-RPC request to be sent. More... | |
class | XmlRpcRequestListener |
An object to handle the callbacks for handling the XmlRpcRequest operations. More... | |
class | XmlRpcSession |
The XmlRpcSession object used to send XML-RPC requests and handle their responses. More... | |
Typedefs | |
typedef int | Status |
Enumerations | |
enum | AVPFMode { AVPFMode::Default = -1, AVPFMode::Disabled = 0, AVPFMode::Enabled = 1 } |
Enum describing RTP AVPF activation modes. More... | |
enum | AuthMethod { AuthMethod::HttpDigest = 0, AuthMethod::Tls = 1 } |
Enum describing the authentication methods. More... | |
enum | CodecPriorityPolicy { CodecPriorityPolicy::Basic = 0, CodecPriorityPolicy::Auto = 1 } |
Codec priority policies. More... | |
enum | ConfiguringState { Successful = 0, Failed = 1, Skipped = 2 } |
Describes the state of the remote configuring process of the Core object, 'Skipped' when the feature is disabled. | |
enum | ConsolidatedPresence { Online = 0, Busy = 1, DoNotDisturb = 2, Offline = 3 } |
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. | |
enum | EcCalibratorStatus { EcCalibratorStatus::InProgress = 0, EcCalibratorStatus::Done = 1, EcCalibratorStatus::Failed = 2, EcCalibratorStatus::DoneNoEcho = 3 } |
Enum describing the result of the echo canceller calibration process. More... | |
enum | GlobalState { GlobalState::Off = 0, GlobalState::Startup = 1, GlobalState::On = 2, GlobalState::Shutdown = 3, GlobalState::Configuring = 4, GlobalState::Ready = 5 } |
Describes the global state of the Core object. More... | |
enum | IceState { IceState::NotActivated = 0, IceState::Failed = 1, IceState::InProgress = 2, IceState::HostConnection = 3, IceState::ReflexiveConnection = 4, IceState::RelayConnection = 5 } |
Enum describing ICE states. More... | |
enum | LimeState { LimeState::Disabled = 0, LimeState::Mandatory = 1, LimeState::Preferred = 2 } |
enum | LogCollectionState { Disabled = 0, Enabled = 1, EnabledWithoutPreviousLogHandler = 2 } |
Whether or not to keep a file with the logs. | |
enum | LogLevel { LogLevel::Debug = 1<<0, LogLevel::Trace = 1<<1, LogLevel::Message = 1<<2, LogLevel::Warning = 1<<3, LogLevel::Error = 1<<4, LogLevel::Fatal = 1<<5 } |
Verbosity levels of log messages. More... | |
enum | MediaDirection { MediaDirection::Invalid = -1, MediaDirection::Inactive = 0, MediaDirection::SendOnly = 1, MediaDirection::RecvOnly = 2, MediaDirection::SendRecv = 3 } |
Indicates for a given media the stream direction. More... | |
enum | MediaEncryption { MediaEncryption::None = 0, MediaEncryption::SRTP = 1, MediaEncryption::ZRTP = 2, MediaEncryption::DTLS = 3 } |
Enum describing type of media encryption types. More... | |
enum | MediaResourceMode { MediaResourceMode::ExclusiveMediaResources = 0, MediaResourceMode::SharedMediaResources = 1 } |
Media resource usage. More... | |
enum | PresenceBasicStatus { PresenceBasicStatus::Open = 0, PresenceBasicStatus::Closed = 1 } |
Basic status as defined in section 4.1.4 of RFC 3863. More... | |
enum | Privacy { Privacy::None = 0, Privacy::User = 1, Privacy::Header = 2, Privacy::Session = 4, Privacy::Id = 8, Privacy::Critical = 16, Privacy::Default = 32768 } |
Defines privacy policy to apply as described by rfc3323. More... | |
enum | PublishState { PublishState::None = 0, PublishState::IncomingReceived = 1, PublishState::Ok = 2, PublishState::Error = 3, PublishState::Expiring = 4, PublishState::Cleared = 5, PublishState::Terminating = 6, PublishState::OutgoingProgress = 7 } |
Enum for publish states. More... | |
enum | Reason { Reason::None = 0, Reason::NoResponse = 1, Reason::Forbidden = 2, Reason::Declined = 3, Reason::NotFound = 4, Reason::NotAnswered = 5, Reason::Busy = 6, Reason::UnsupportedContent = 7, Reason::BadEvent = 8, Reason::IOError = 9, Reason::DoNotDisturb = 10, Reason::Unauthorized = 11, Reason::NotAcceptable = 12, Reason::NoMatch = 13, Reason::MovedPermanently = 14, Reason::Gone = 15, Reason::TemporarilyUnavailable = 16, Reason::AddressIncomplete = 17, Reason::NotImplemented = 18, Reason::BadGateway = 19, Reason::SessionIntervalTooSmall = 20, Reason::ServerTimeout = 21, Reason::Unknown = 22, Reason::Transferred = 23, Reason::ConditionalRequestFailed = 24 } |
Enum describing various failure reasons or contextual information for some events. More... | |
enum | RegistrationState { RegistrationState::None = 0, RegistrationState::Progress = 1, RegistrationState::Ok = 2, RegistrationState::Cleared = 3, RegistrationState::Failed = 4, RegistrationState::Refreshing = 5 } |
Describes proxy registration states. More... | |
enum | SessionExpiresRefresher { Unspecified = 0, UAS = 1, UAC = 2 } |
Session Timers refresher. | |
enum | SignalStrengthUnit { Rssi = 0, Dbm = 1 } |
All signal units that a device can use. | |
enum | SignalType { Wifi = 0, Mobile = 1, Other = 2 } |
All signal types that a device can use. | |
enum | SrtpSuite { AESCM128HMACSHA180 = 0, AESCM128HMACSHA132 = 1, AES192CMHMACSHA180 = 2, AES192CMHMACSHA132 = 3, AES256CMHMACSHA180 = 4, AES256CMHMACSHA132 = 5, AEADAES128GCM = 6, AEADAES256GCM = 7, Invalid = 255 } |
Enum describing type of SRTP encryption suite. | |
enum | StreamType { Audio = 0, Video = 1, Text = 2, Unknown = 3 } |
Enum describing the stream types. | |
enum | SubscribePolicy { SubscribePolicy::SPWait = 0, SubscribePolicy::SPDeny = 1, SubscribePolicy::SPAccept = 2 } |
Enum controlling behavior for incoming subscription request. More... | |
enum | SubscriptionDir { SubscriptionDir::Incoming = 0, SubscriptionDir::Outgoing = 1, SubscriptionDir::InvalidDir = 2 } |
Enum for subscription direction (incoming or outgoing). More... | |
enum | SubscriptionState { SubscriptionState::None = 0, SubscriptionState::OutgoingProgress = 1, SubscriptionState::IncomingReceived = 2, SubscriptionState::Pending = 3, SubscriptionState::Active = 4, SubscriptionState::Terminated = 5, SubscriptionState::Error = 6, SubscriptionState::Expiring = 7 } |
Enum for subscription states. More... | |
enum | SupportLevel { SupportLevel::NoSupport = 0, SupportLevel::Optional = 1, SupportLevel::Mandatory = 2 } |
enum | ToneID { ToneID::Undefined = 0, ToneID::Busy = 1, ToneID::CallWaiting = 2, ToneID::CallOnHold = 3, ToneID::CallLost = 4, ToneID::CallEnd = 5, ToneID::CallNotAnswered = 6 } |
Enum listing frequent telephony tones. More... | |
enum | TransportType { Udp = 0, Tcp = 1, Tls = 2, Dtls = 3 } |
Enum describing transport type for LinphoneAddress. | |
enum | UpnpState { UpnpState::Idle = 0, UpnpState::Pending = 1, UpnpState::Adding = 2, UpnpState::Removing = 3, UpnpState::NotAvailable = 4, UpnpState::Ok = 5, UpnpState::Ko = 6, UpnpState::Blacklisted = 7 } |
Enum describing uPnP states. More... | |
enum | VersionUpdateCheckResult { UpToDate = 0, NewVersionAvailable = 1, Error = 2 } |
Enum describing the result of a version update check. | |
enum | VideoSourceType { Unknown, VideoSourceType::Call, VideoSourceType::Camera, VideoSourceType::Image } |
Enum representing the type of a video source. More... | |
enum | XmlRpcArgType { None = 0, Int = 1, String = 2, StringStruct = 3 } |
Enum describing the types of argument for LinphoneXmlRpcRequest. | |
enum | XmlRpcStatus { Pending = 0, Ok = 1, Failed = 2 } |
Enum describing the status of a LinphoneXmlRpcRequest. | |
enum | ZrtpKeyAgreement { Invalid = 0, Dh2K = 1, Dh3K = 2, Ec25 = 3, Ec38 = 4, Ec52 = 5, X255 = 6, X448 = 7, K255 = 8, K448 = 9, Kyb1 = 10, Kyb2 = 11, Kyb3 = 12, Hqc1 = 13, Hqc2 = 14, Hqc3 = 15, K255Kyb512 = 16, K255Hqc128 = 17, K448Kyb1024 = 18, K448Hqc256 = 19, K255Kyb512Hqc128 = 20, K448Kyb1024Hqc256 = 21 } |
Enum describing the ZRTP key exchange algorithns. | |
enum | ZrtpPeerStatus { ZrtpPeerStatus::Unknown = 0, ZrtpPeerStatus::Invalid = 1, ZrtpPeerStatus::Valid = 2 } |
Enum describing the ZRTP SAS validation status of a peer URI. More... | |
Namespace that holds all liblinphone's API classes and enumerations.
|
strong |
|
strong |
|
strong |
Codec priority policies.
Enumerator | |
---|---|
Basic | In this mode, codecs have initial default ordering, that can be changed by the application The answerer of a call accepts codecs with the order given in the offer. |
Auto | In this mode, the codec list is managed by the Core according to hardware capabilities in the goal of optimizing video quality and user experience. |
|
strong |
Enum describing the result of the echo canceller calibration process.
|
strong |
Describes the global state of the Core object.
Enumerator | |
---|---|
Off | State in which we're in after Core::stop(). |
Startup | Transient state for when we call Core::start() |
On | Indicates Core has been started and is up and running. |
Shutdown | Transient state for when we call Core::stop() |
Configuring | Transient state between Startup and On if there is a remote provisionning URI configured. |
Ready | Core state after being created by linphone_factory_create_core, generally followed by a call to Core::start() |
|
strong |
Enum describing ICE states.
|
strong |
|
strong |
|
strong |
Indicates for a given media the stream direction.
|
strong |
|
strong |
|
strong |
|
strong |
Defines privacy policy to apply as described by rfc3323.
Enumerator | |
---|---|
None | Privacy services must not perform any privacy function. |
User | Request that privacy services provide a user-level privacy function. |
Header | Request that privacy services modify headers that cannot be set arbitrarily by the user (Contact/Via). |
Session | Request that privacy services provide privacy for session media. |
Id | rfc3325 The presence of this privacy type in a Privacy header field indicates that the user would like the Network Asserted Identity to be kept private with respect to SIP entities outside the Trust Domain with which the user authenticated. |
Critical | Privacy service must perform the specified services or fail the request. |
Default | Special keyword to use privacy as defined either globally or by proxy using ProxyConfig::setPrivacy() |
|
strong |
Enum for publish states.
Enumerator | |
---|---|
None | Initial state, do not use. |
IncomingReceived | An incoming publish is received. |
Ok | Publish is accepted. |
Error | Publish encoutered an error, Event::getReason() gives reason code. |
Expiring | Publish is about to expire, only sent if [sip]->refresh_generic_publish property is set to 0. |
Cleared | Event has been un published. |
Terminating | Publish is about to terminate. |
OutgoingProgress | An outgoing publish was created and submitted. |
|
strong |
Enum describing various failure reasons or contextual information for some events.
Enumerator | |
---|---|
None | No reason has been set by the core. |
NoResponse | No response received from remote. |
Forbidden | Authentication failed due to bad credentials or resource forbidden. |
Declined | The call has been declined. |
NotFound | Destination of the call was not found. |
NotAnswered | The call was not answered in time (request timeout) |
Busy | Phone line was busy. |
UnsupportedContent | Unsupported content. |
BadEvent | Bad event. |
IOError | Transport error: connection failures, disconnections etc... |
DoNotDisturb | Do not disturb reason. |
Unauthorized | Operation is unauthorized because missing credential. |
NotAcceptable | Operation is rejected due to incompatible or unsupported media parameters. |
NoMatch | Operation could not be executed by server or remote client because it didn't have any context for it. |
MovedPermanently | Resource moved permanently. |
Gone | Resource no longer exists. |
TemporarilyUnavailable | Temporarily unavailable. |
AddressIncomplete | Address incomplete. |
NotImplemented | Not implemented. |
BadGateway | Bad gateway. |
SessionIntervalTooSmall | The received request contains a Session-Expires header field with a duration below the minimum timer. |
ServerTimeout | Server timeout. |
Unknown | Unknown reason. |
Transferred | The call has been transferred. |
ConditionalRequestFailed | Conditional Request Failed. |
|
strong |
|
strong |
|
strong |
|
strong |
Enum for subscription states.
Enumerator | |
---|---|
None | Initial state, should not be used. |
OutgoingProgress | An outgoing subcription was sent. |
IncomingReceived | An incoming subcription is received. |
Pending | Subscription is pending, waiting for user approval. |
Active | Subscription is accepted. |
Terminated | Subscription is terminated normally. |
Error | Subscription was terminated by an error, indicated by Event::getReason() |
Expiring | Subscription is about to expire, only sent if [sip]->refresh_generic_subscribe property is set to 0. |
|
strong |
|
strong |
Enum listing frequent telephony tones.
Enumerator | |
---|---|
Undefined | Not a tone. |
Busy | Busy tone. |
CallWaiting | Call waiting tone. |
CallOnHold | Call on hold tone. |
CallLost | Tone played when call is abruptly disconnected (media lost) |
CallEnd | When the call end for any reason but lost. |
CallNotAnswered | When the call is not answered. |
|
strong |
Enum describing uPnP states.
|
strong |
|
strong |