linphone Namespace Reference

Classes
class	Account
class	AccountCreator
class	AccountCreatorListener
class	AccountDevice
class	AccountListener
class	AccountManagerServices
class	AccountManagerServicesRequest
class	AccountManagerServicesRequestListener
class	AccountParams
class	Address
class	Alert
class	AlertListener
class	AudioDevice
class	AuthInfo
class	BearerToken
class	Buffer
class	Call
class	CallListener
class	CallLog
class	CallParams
class	CallStats
class	CardDavParams
class	ChatMessage
class	ChatMessageListener
class	ChatMessageReaction
class	ChatParams
class	ChatRoom
class	ChatRoomListener
class	ChatRoomParams
class	ComposingParticipant
class	Conference
class	ConferenceInfo
class	ConferenceListener
class	ConferenceParams
class	ConferenceScheduler
class	ConferenceSchedulerListener
class	Config
class	Content
class	Core
class	CoreListener
class	DialPlan
class	Dictionary
class	DigestAuthenticationPolicy
class	EktInfo
class	ErrorInfo
class	Event
class	EventListener
class	EventLog
class	Factory
class	Friend
class	FriendDevice
class	FriendList
class	FriendListener
class	FriendListListener
class	FriendPhoneNumber
class	Headers
class	ImNotifPolicy
class	InfoMessage
class	Ldap
class	LdapParams
class	LoggingService
class	LoggingServiceListener
class	MagicSearch
class	MagicSearchListener
class	MessageWaitingIndication
class	MessageWaitingIndicationSummary
class	NatPolicy
class	Participant
class	ParticipantDevice
class	ParticipantDeviceIdentity
class	ParticipantDeviceListener
class	ParticipantImdnState
class	ParticipantInfo
class	PayloadType
class	Player
class	PlayerListener
class	PresenceActivity
class	PresenceModel
class	PresenceNote
class	PresencePerson
class	PresenceService
class	ProxyConfig
class	PushNotificationConfig
class	PushNotificationMessage
class	Range
class	Recorder
class	RecorderParams
class	RemoteContactDirectory
class	SearchResult
class	SignalInformation
class	Transports
class	Tunnel
class	TunnelConfig
class	Vcard
class	VideoActivationPolicy
class	VideoDefinition
class	VideoSourceDescriptor
class	XmlRpcRequest
class	XmlRpcRequestListener
class	XmlRpcSession

Typedefs
typedef int	Status

Enumerations
enum class	AVPFMode {   Default = -1 ,   Disabled = 0 ,   Enabled = 1 }
enum class	AuthMethod {   HttpDigest = 0 ,   Tls = 1 ,   Bearer = 2 ,   Basic = 3 }
enum class	BaudotMode {   Voice ,   Tty ,   HearingCarryOver ,   VoiceCarryOver }
enum class	BaudotStandard {   Us ,   Europe }
enum class	CodecPriorityPolicy {   Basic = 0 ,   Auto = 1 }
enum class	ConfiguringState {   Successful = 0 ,   Failed = 1 ,   Skipped = 2 }
enum class	ConsolidatedPresence {   Online = 0 ,   Busy = 1 ,   DoNotDisturb = 2 ,   Offline = 3 }
enum class	EcCalibratorStatus {   InProgress = 0 ,   Done = 1 ,   Failed = 2 ,   DoneNoEcho = 3 }
enum class	EphemeralChatMessagePolicy {   Default = 0 ,   Individual = 1 }
enum class	GlobalState {   Off = 0 ,   Startup = 1 ,   On = 2 ,   Shutdown = 3 ,   Configuring = 4 ,   Ready = 5 }
enum class	IceState {   NotActivated = 0 ,   Failed = 1 ,   InProgress = 2 ,   HostConnection = 3 ,   ReflexiveConnection = 4 ,   RelayConnection = 5 }
enum class	LimeState {   Disabled = 0 ,   Mandatory = 1 ,   Preferred = 2 }
enum class	LogCollectionState {   Disabled = 0 ,   Enabled = 1 ,   EnabledWithoutPreviousLogHandler = 2 }
enum class	LogLevel {   Debug = 1<<0 ,   Trace = 1<<1 ,   Message = 1<<2 ,   Warning = 1<<3 ,   Error = 1<<4 ,   Fatal = 1<<5 }
enum class	MediaDirection {   Invalid = -1 ,   Inactive = 0 ,   SendOnly = 1 ,   RecvOnly = 2 ,   SendRecv = 3 }
enum class	MediaEncryption {   None = 0 ,   SRTP = 1 ,   ZRTP = 2 ,   DTLS = 3 }
enum class	MediaFileFormat {   Unknown ,   Wav ,   Mkv ,   Smff }
enum class	MediaResourceMode {   Exclusive = 0 ,   Shared = 1 }
enum class	PresenceBasicStatus {   Open = 0 ,   Closed = 1 }
enum class	Privacy {   None = 0 ,   User = 1 ,   Header = 2 ,   Session = 4 ,   Id = 8 ,   Critical = 16 ,   Default = 32768 }
enum class	PublishState {   None = 0 ,   IncomingReceived = 1 ,   Ok = 2 ,   Error = 3 ,   Expiring = 4 ,   Cleared = 5 ,   Terminating = 6 ,   OutgoingProgress = 7 ,   Refreshing = 8 }
enum class	Reason {   None = 0 ,   NoResponse = 1 ,   Forbidden = 2 ,   Declined = 3 ,   NotFound = 4 ,   NotAnswered = 5 ,   Busy = 6 ,   UnsupportedContent = 7 ,   BadEvent = 8 ,   IOError = 9 ,   DoNotDisturb = 10 ,   Unauthorized = 11 ,   NotAcceptable = 12 ,   NoMatch = 13 ,   MovedPermanently = 14 ,   Gone = 15 ,   TemporarilyUnavailable = 16 ,   AddressIncomplete = 17 ,   NotImplemented = 18 ,   BadGateway = 19 ,   SessionIntervalTooSmall = 20 ,   ServerTimeout = 21 ,   Unknown = 22 ,   Transferred = 23 ,   ConditionalRequestFailed = 24 ,   SasCheckRequired = 25 }
enum class	RegistrationState {   None = 0 ,   Progress = 1 ,   Ok = 2 ,   Cleared = 3 ,   Failed = 4 ,   Refreshing = 5 }
enum class	SearchDirection {   Up = 0 ,   Down = 1 }
enum class	SecurityLevel {   Unsafe = 0 ,   None = 1 ,   EndToEndEncrypted = 2 ,   EndToEndEncryptedAndVerified = 3 ,   PointToPointEncrypted = 4 }
enum class	SessionExpiresRefresher {   Unspecified = 0 ,   UAS = 1 ,   UAC = 2 }
enum class	SignalStrengthUnit {   Rssi = 0 ,   Dbm = 1 }
enum class	SignalType {   Wifi = 0 ,   Mobile = 1 ,   Other = 2 }
enum class	SrtpSuite {   AESCM128HMACSHA180 = 0 ,   AESCM128HMACSHA132 = 1 ,   AES192CMHMACSHA180 = 2 ,   AES192CMHMACSHA132 = 3 ,   AES256CMHMACSHA180 = 4 ,   AES256CMHMACSHA132 = 5 ,   AEADAES128GCM = 6 ,   AEADAES256GCM = 7 ,   Invalid = 255 }
enum class	StreamType {   Audio = 0 ,   Video = 1 ,   Text = 2 ,   Unknown = 3 }
enum class	SubscribePolicy {   SPWait = 0 ,   SPDeny = 1 ,   SPAccept = 2 }
enum class	SubscriptionDir {   Incoming = 0 ,   Outgoing = 1 ,   InvalidDir = 2 }
enum class	SubscriptionState {   None = 0 ,   OutgoingProgress = 1 ,   IncomingReceived = 2 ,   Pending = 3 ,   Active = 4 ,   Terminated = 5 ,   Error = 6 ,   Expiring = 7 }
enum class	SupportLevel {   NoSupport = 0 ,   Optional = 1 ,   Mandatory = 2 }
enum class	ToneID {   Undefined = 0 ,   Busy = 1 ,   CallWaiting = 2 ,   CallOnHold = 3 ,   CallLost = 4 ,   CallEnd = 5 ,   CallNotAnswered = 6 ,   SasCheckRequired = 7 }
enum class	TransportType {   Udp = 0 ,   Tcp = 1 ,   Tls = 2 ,   Dtls = 3 }
enum class	UpnpState {   Idle = 0 ,   Pending = 1 ,   Adding = 2 ,   Removing = 3 ,   NotAvailable = 4 ,   Ok = 5 ,   Ko = 6 ,   Blacklisted = 7 }
enum class	VersionUpdateCheckResult {   UpToDate = 0 ,   NewVersionAvailable = 1 ,   Error = 2 }
enum class	VideoSourceScreenSharingType {   Display ,   Window ,   Area }
enum class	VideoSourceType {   Unknown ,   Call ,   Camera ,   Image ,   ScreenSharing }
enum class	XmlRpcArgType {   None = 0 ,   Int = 1 ,   String = 2 ,   StringStruct = 3 }
enum class	XmlRpcStatus {   Pending = 0 ,   Ok = 1 ,   Failed = 2 }
enum class	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 ,   Mlk1 = 22 ,   Mlk2 = 23 ,   Mlk3 = 24 ,   K255Mlk512 = 25 ,   K448Mlk1024 = 26 }
enum class	ZrtpPeerStatus {   Unknown = 0 ,   Invalid = 1 ,   Valid = 2 }

Detailed Description

Namespace that holds all liblinphone's API classes and enumerations.

Enumeration Type Documentation

AuthMethod

enum class linphone::AuthMethod

strong

Enum describing the authentication methods.

Enumerator
HttpDigest	Digest authentication requested.
Tls	Client certificate requested.
Bearer	Bearer authentication.
Basic	Basic authentication.

AVPFMode

enum class linphone::AVPFMode

strong

Enum describing RTP AVPF activation modes.

Enumerator
Default	Use default value defined at upper level.
Disabled	AVPF is disabled.
Enabled	AVPF is enabled.

BaudotMode

enum class linphone::BaudotMode

strong

BaudotMode enum represents the Baudot mode to use for the call.

Enumerator
Voice	Send and receive audio.
Tty	Send and receive Baudot tones.
HearingCarryOver	Send Baudot tones, but receive audio.
VoiceCarryOver	Send audio, but receive Baudot tones.

BaudotStandard

enum class linphone::BaudotStandard

strong

BaudotStandard enum represents the Baudot standard to use to send Baudot tones in the call.

Enumerator
Us	Send 45.45 baud US Baudot tones.
Europe	Send 50 baud European Baudot tones.

CodecPriorityPolicy

enum class linphone::CodecPriorityPolicy

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.

EcCalibratorStatus

enum class linphone::EcCalibratorStatus

strong

Enum describing the result of the echo canceller calibration process.

Enumerator
InProgress	The echo canceller calibration process is on going.
Done	The echo canceller calibration has been performed and produced an echo delay measure.
Failed	The echo canceller calibration process has failed.
DoneNoEcho	The echo canceller calibration has been performed and no echo has been detected.

EphemeralChatMessagePolicy

enum class linphone::EphemeralChatMessagePolicy

strong

Ephemeral chat message policies.

Enumerator
Default	In this mode, an ephemeral chat message expires at the same time for all participants, when every participant has read the message and its lifetime expires.
Individual	In this mode, an ephemeral chat message expires independently for each participant, after the duration of the lifetime once this participant has read the message.

GlobalState

enum class linphone::GlobalState

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()

IceState

enum class linphone::IceState

strong

Enum describing ICE states.

Enumerator
NotActivated	ICE has not been activated for this call or stream.
Failed	ICE processing has failed.
InProgress	ICE process is in progress.
HostConnection	ICE has established a direct connection to the remote host.
ReflexiveConnection	ICE has established a connection to the remote host through one or several NATs.
RelayConnection	ICE has established a connection through a relay.

LimeState

enum class linphone::LimeState

strong

Enumerator
Disabled	Lime is not used at all.
Mandatory	Lime is always used.
Preferred	Lime is used only if we already shared a secret with remote.

LogLevel

enum class linphone::LogLevel

strong

Verbosity levels of log messages.

Enumerator
Debug	Level for debug messages.
Trace	Level for traces.
Message	Level for information messages.
Warning	Level for warning messages.
Error	Level for error messages.
Fatal	Level for fatal error messages.

MediaDirection

enum class linphone::MediaDirection

strong

Indicates for a given media the stream direction.

Enumerator
Invalid	Default value, shouldn't be used.
Inactive	No active media not supported yet.
SendOnly	Media is only being sent, it won't be received.
RecvOnly	Media will only be received, nothing will be sent.
SendRecv	Media will be sent and received.

MediaEncryption

enum class linphone::MediaEncryption

strong

Enum describing type of media encryption types.

Enumerator
None	No media encryption is used.
SRTP	Use SRTP media encryption.
ZRTP	Use ZRTP media encryption.
DTLS	Use DTLS media encryption.

MediaFileFormat

enum class linphone::MediaFileFormat

strong

Enum representing the file format of a recording.

Enumerator
Mkv	< WAVE file format, .wav file extension.
Smff	< Standard Matroska file format, supports video, .mkv or .mka file extension.

MediaResourceMode

enum class linphone::MediaResourceMode

strong

Media resource usage.

Enumerator
Exclusive	Media resources are not shared.
Shared	Media resources are shared.

PresenceBasicStatus

enum class linphone::PresenceBasicStatus

strong

Basic status as defined in section 4.1.4 of RFC 3863.

Enumerator
Open	This value means that the associated contact element, if any, is ready to accept communication.
Closed	This value means that the associated contact element, if any, is unable to accept communication.

Privacy

enum class linphone::Privacy

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()

PublishState

enum class linphone::PublishState

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.
Refreshing	Publish is about to refresh.

Reason

enum class linphone::Reason

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.

RegistrationState

enum class linphone::RegistrationState

strong

Describes proxy registration states.

Enumerator
None	Initial state for registrations.
Progress	Registration is in progress.
Ok	Registration is successful.
Cleared	Unregistration succeeded.
Failed	Registration failed.
Refreshing	Registration refreshing.

SecurityLevel

enum class linphone::SecurityLevel

strong

Security level determined by type of encryption (point-to-point, end-to-end, etc...) and whether or not a SAS validation was made with the remote(s) end(s).

Enumerator
Unsafe	Security failure.
None	No encryption.
EndToEndEncrypted	End-to-end encrypted.
EndToEndEncryptedAndVerified	End-to-end encrypted and verified.
PointToPointEncrypted	Point-to-point encrypted.

SubscribePolicy

enum class linphone::SubscribePolicy

strong

Enum controlling behavior for incoming subscription request.

Enumerator
SPWait	Does not automatically accept an incoming subscription request.
SPDeny	Rejects incoming subscription request.
SPAccept	Automatically accepts a subscription request.

SubscriptionDir

enum class linphone::SubscriptionDir

strong

Enum for subscription direction (incoming or outgoing).

Enumerator
Incoming	Incoming subscription.
Outgoing	Outgoing subscription.
InvalidDir	Invalid subscription direction.

SubscriptionState

enum class linphone::SubscriptionState

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.

SupportLevel

enum class linphone::SupportLevel

strong

Enumerator
NoSupport	No support for the feature.
Optional	Optional support for the feature.
Mandatory	Mandatory support for the feature.

ToneID

enum class linphone::ToneID

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.
SasCheckRequired	When the SAS check is required.

UpnpState

enum class linphone::UpnpState

strong

Enum describing uPnP states.

Enumerator
Idle	uPnP is not activate
Pending	uPnP process is in progress
Adding	Internal use: Only used by port binding.
Removing	Internal use: Only used by port binding.
NotAvailable	uPnP is not available
Ok	uPnP is enabled
Ko	uPnP processing has failed
Blacklisted	IGD router is blacklisted.

VideoSourceScreenSharingType

enum class linphone::VideoSourceScreenSharingType

strong

Enum representing the sub type of the screen sharing.

Enumerator
Display	The screen sharing is done from a display.
Window	The screen sharing is done from a window.
Area	The screen sharing is done from an area.

VideoSourceType

enum class linphone::VideoSourceType

strong

Enum representing the type of a video source.

Enumerator
Call	The video source is another call.
Camera	The video source is a camera.
Image	The video source is an image.
ScreenSharing	The video source is a screen sharing.

ZrtpPeerStatus

enum class linphone::ZrtpPeerStatus

strong

Enum describing the ZRTP SAS validation status of a peer URI.

Enumerator
Unknown	Peer URI unkown or never validated/invalidated the SAS.
Invalid	Peer URI SAS rejected in database.
Valid	Peer URI SAS validated in database.